Difference between revisions of "Documentation:ToDo"

From POV-Wiki
Jump to navigation Jump to search
m (added some completed tasks)
m (link update due to page move)
 
(18 intermediate revisions by the same user not shown)
Line 11: Line 11:
 
===The Tutorial===
 
===The Tutorial===
 
<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, and things that have already been done:
+
The tutorial section is in fairly good shape, at this time these are some of the known action items:
−
:* a [[Documentation:Tutorial Section 3.3#Slope Map Tutorial|slope map tutorial]] was added.
 
−
:* the [[Documentation:Tutorial Section 4#Questions and Tips|Questions and Tips]] section has a few stale links (Geocities).
 
−
::* what happened to the effort to relocate those resources mentioned [news:[email protected] here]
 
−
:* overall verification of QandT external links.
 
 
:* these sub-sections of the appendices need updating:
 
:* these sub-sections of the appendices need updating:
 
::* [[Documentation:Tutorial Section 5#The POV-Team|POV-Team]]
 
::* [[Documentation:Tutorial Section 5#The POV-Team|POV-Team]]
Line 25: Line 21:
  
 
===The Reference===
 
===The Reference===
−
<p align="justify">
+
Probably the biggest task of the bunch, 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 cleanup up
 
−
::* 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
 
−
::* more corrections and cleanup on this page starting [[Documentation:Tutorial_Section_3.2#Writing_the_polynomial_vector|here]]
 
−
::* and finally these [[Documentation:Reference Section 2.2#Sum and Product functions|functions]] have been done
 
 
:* [[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 7.2#glass.inc, glass_old.inc|glass_old.inc]] deprecated definitions (use material wrapper)
 
 
:* [[Documentation:Reference Section 8#Quick Reference|quick reference]]
 
:* [[Documentation:Reference Section 8#Quick Reference|quick reference]]
 
:* other issues ...
 
:* other issues ...
−
</p>
 
  
 
===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? Again a review of the [http://www.povray.org/beta/revision.txt change-log] might shed some light on any changes or additions that have occurred (if any). These <em>could</em> be action items:
+
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 52: Line 40:
 
===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 cleanup up or reworded. Additionally these action items should be considered:
+
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?
Line 80: Line 68:
 
:* other issues ...
 
:* other issues ...
 
</p>
 
</p>
 +
===Assigned Tasks===
 +
<p align="justify">
 +
This is a list of tasks that have been assigned:
 +
:* two people are chasing the stale links in the [[Documentation:Tutorial Section 4#Questions and Tips|Questions and Tips]] section
 +
</p>
 +
 +
===Completed Tasks===
 +
:* [[Documentation:LaTex_Files#Tutorial_Section|tutorial]] section LaTeX markup has been reviewed
 +
:* [[Documentation:LaTex_Files#Reference_Section|reference]] section LaTeX markup has been reviewed
 +
:* a [[Documentation:Tutorial Section 3.3#Slope Map Tutorial|slope map]] tutorial was added
 +
:* 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
 +
:* [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:

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
  • cleanup unnecessarily long external links
  • other issues ...

Assigned Tasks

This is a list of tasks that have been assigned:

Completed Tasks

Retrieved from "https://wiki.povray.org/content?title=Documentation:ToDo&oldid=2901"