Documentation:ToDo

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 of the LaTeX used in the documentation are here

• a slope map tutorial was added
• the Questions and Tips section has moved out of the documentation and into the KB namespace
• these sub-sections of the appendices need updating:

• POV-Team
• The TAG
• what version?
• add a POV-Ray 3.7 development section?

• 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

• 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:

• the change-log is currently being reviewed
• two people are chasing the stale links in the Questions and Tips section

Completed Tasks

This is a list of tasks that have been completed: