Difference between revisions of "Documentation:ToDo"
Jholsenback (talk | contribs) m (updates) |
Jholsenback (talk | contribs) m (link update due to page move) |
||
(4 intermediate revisions by the same user not shown) | |||
Line 21: | Line 21: | ||
===The Reference=== | ===The Reference=== | ||
− | Probably the biggest task of the bunch, | + | Probably the biggest task of the bunch, these sections, probably not all inclusive, could be affected: |
:* [[Documentation:Reference Section 1#Command-line Options|command-line options]] | :* [[Documentation:Reference Section 1#Command-line Options|command-line options]] | ||
:* [[Documentation:Reference Section 2#Identifiers and Keywords|identifiers and keywords]] | :* [[Documentation:Reference Section 2#Identifiers and Keywords|identifiers and keywords]] | ||
:* [[Documentation:Reference Section 3.1#Global Settings|global settings]] | :* [[Documentation:Reference Section 3.1#Global Settings|global settings]] | ||
:* [[Documentation:Reference Section 3.2#Radiosity|radiosity]] | :* [[Documentation:Reference Section 3.2#Radiosity|radiosity]] | ||
− | |||
:* [[Documentation:Reference Section 8#Quick Reference|quick reference]] | :* [[Documentation:Reference Section 8#Quick Reference|quick reference]] | ||
:* other issues ... | :* other issues ... | ||
Line 32: | Line 31: | ||
===POV-Ray for Windows=== | ===POV-Ray for Windows=== | ||
<p align="justify"> | <p align="justify"> | ||
− | What are some of the issue's with the Windows section? | + | What are some of the issue's with the Windows section? These <em>could</em> be action items: |
:* codemax editor changes | :* codemax editor changes | ||
:* image updates, additions | :* image updates, additions | ||
Line 81: | Line 80: | ||
:* the [[Documentation:Tutorial_Section_4#Questions_and_Tips|Questions and Tips]] section has moved out of the documentation and into the [[Knowledgebase:POV-Ray_Questions_and_Tips|KB]] namespace | :* the [[Documentation:Tutorial_Section_4#Questions_and_Tips|Questions and Tips]] section has moved out of the documentation and into the [[Knowledgebase:POV-Ray_Questions_and_Tips|KB]] namespace | ||
:* famous quotes have been deleted | :* famous quotes have been deleted | ||
− | :* change-log review has been completed, here are the [[ | + | :* [http://www.povray.org/beta/changes.txt change-log] review has been completed, here are the [[Documentation:ToDo ChangeListReview#Change_Log_Extracts|results]] |
Latest revision as of 14:40, 16 August 2010
Introduction
This is an informational page, intended for contributors that wish to get involved with editing the documentation, and make it ready for the POV-Ray version 3.7 release. Please use the talk page for discussions.
Contributors should at least have a look at these notes for some important information about the content.
In no particular order (but by section) these are the tasks needed accomplish that goal.
The Tutorial
The tutorial section is in fairly good shape, at this time these are some of the known action items:
- these sub-sections of the appendices need updating:
- other issues ...
The Reference
Probably the biggest task of the bunch, these sections, probably not all inclusive, could be affected:
- command-line options
- identifiers and keywords
- global settings
- radiosity
- quick reference
- other issues ...
POV-Ray for Windows
What are some of the issue's with the Windows section? These could be action items:
- codemax editor changes
- image updates, additions
- minimum system requirements update (ie: drop win98?)
- other issues ...
POV-Ray for Mac OS
A Mac OS expert needs to be identified to make this section complete. There are some obvious references to previous version(s) that should probably be cleaned up or reworded. Additionally these action items should be considered:
- image updates, additions or changes
- minimum system requirements update?
- other issues ...
POV-Ray for Unix
A Unix expert needs to be identified to make this section complete. This is a pretty bare bones section, and aside from the 3.6 version references, there probably is little to do, however a review of the content is most likely a good idea. Additionally these action items should be considered:
- is this (I/O Restrictions) still an issue?
- need images?
- other issues ...
Housekeeping
These items are of lesser importance, but worth mentioning, as they could apply to all sections, so that's why they are listed here:
- if new images get added please observe naming convention.
- TutImgImageName.png
- RefImgImageName.png
- MacImgImageName.png
- WinImgImageName.png
- UnxImgImageName.png
- TutImgImageName.png
- cleanup unnecessarily long external links
- before: Tree designer by Johannes Hubert
- after: Tree Designer by Johannes Hubert
- other issues ...
Assigned Tasks
This is a list of tasks that have been assigned:
- two people are chasing the stale links in the Questions and Tips section
Completed Tasks
- tutorial section LaTeX markup has been reviewed
- reference section LaTeX markup has been reviewed
- a slope map tutorial was added
- the Questions and Tips section has moved out of the documentation and into the KB namespace
- famous quotes have been deleted
- change-log review has been completed, here are the results