Difference between revisions of "Documentation:ToDo"
Jholsenback (talk | contribs) m (added a completed task) |
Jholsenback (talk | contribs) m (corrected typos) |
||
| Line 12: | Line 12: | ||
<p align="justify"> | <p align="justify"> | ||
The tutorial section is in fairly good shape, at this time these are some of the known action items: | The tutorial section is in fairly good shape, at this time these are some of the known action items: | ||
| − | :* all the tutorial section latex markup has been reviewed and | + | :* all the tutorial section latex markup has been reviewed and cleaned up |
::* corrections and cleanup on this page starting [[Documentation:Tutorial_Section_3.2#Creating the polynomial function|here]] | ::* corrections and cleanup on this page starting [[Documentation:Tutorial_Section_3.2#Creating the polynomial function|here]] | ||
:* a [[Documentation:Tutorial Section 3.3#Slope Map Tutorial|slope map tutorial]] was added | :* a [[Documentation:Tutorial Section 3.3#Slope Map Tutorial|slope map tutorial]] was added | ||
| Line 29: | Line 29: | ||
<p align="justify"> | <p align="justify"> | ||
Probably the biggest task of the bunch, someone needs to go through the [http://www.povray.org/beta/revision.txt change-log] to pick up the changes, and additions. These sections, probably not all inclusive, could be affected: | Probably the biggest task of the bunch, someone needs to go through the [http://www.povray.org/beta/revision.txt change-log] to pick up the changes, and additions. These sections, probably not all inclusive, could be affected: | ||
| − | :* all the reference section latex markup has been reviewed and | + | :* all the reference section latex markup has been reviewed and cleaned up |
::* for the [[Documentation:Reference Section 4#Blob|blob]] object (formula correction) | ::* for the [[Documentation:Reference Section 4#Blob|blob]] object (formula correction) | ||
::* various corrections on this page beginning with [[Documentation:Reference Section 4.1#Superquadric_Ellipsoid|superellipsoid]] object | ::* various corrections on this page beginning with [[Documentation:Reference Section 4.1#Superquadric_Ellipsoid|superellipsoid]] object | ||
| Line 53: | Line 53: | ||
===POV-Ray for Mac OS=== | ===POV-Ray for Mac OS=== | ||
<p align="justify"> | <p align="justify"> | ||
| − | 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 | + | 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 | :* image updates, additions or changes | ||
:* minimum system requirements update? | :* minimum system requirements update? | ||
Revision as of 11:25, 1 March 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:
- all the tutorial section latex markup has been reviewed and cleaned up
- corrections and cleanup on this page starting here
- a slope map tutorial was added
- the Questions and Tips section has a few stale links (Geocities)
- what happened to the effort to relocate those resources mentioned here
- overall verification of QandT external links
- these sub-sections of the appendices need updating:
- other issues ...
The Reference
Probably the biggest task of the bunch, someone needs to go through the change-log to pick up the changes, and additions. These sections, probably not all inclusive, could be affected:
- all the reference section latex markup has been reviewed and cleaned up
- for the blob object (formula correction)
- various corrections on this page beginning with superellipsoid object
- and finally these functions have been done
- command-line options
- identifiers and keywords
- global settings
- radiosity
- glass_old.inc deprecated definitions (use material wrapper)
- quick reference
- other issues ...
POV-Ray for Windows
What are some of the issue's with the Windows section? Again a review of the change-log might shed some light on any changes or additions that have occurred (if any). 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 ...