User:Jholsenback

Organization

Basically, I've been using this area as a scratch pad of sorts. Old pages that I didn't want to loose track of are listed here for easy access.

Scratch Pad

Syntax Diagram Examples

This is an example of the proposed format that's going to replace the pre-formatted text blocks which are currently being used, in the reference section narrative. Since there are some differences in the presentation of this construct in html and on this documentation Wiki, here's what you'll need to know.

1. The syntax diagram is now inside a div tag instead of pre tag.
2. The dt and dd elements of the list require that their ending tags be enclosed in the comments notation.
3. The first dt element that precedes the wiki link is required to properly align the link in the box.
4. Use underscores instead if spaces in the page address of the wiki link. The wiki parses to the first space to get the page address.
5. Please pick up the leading tabs when using copy and paste to maintain source readability when it's converted to html.
6. No edits or comments on this copy, go here instead.

Go to documentation Wiki

CAMERA:

camera { [CAMERA_ITEMS...] }

CAMERA_ITEMS:

CAMERA_TYPE | CAMERA_VECTOR | CAMERA_MODIFIER | CAMERA_IDENTIFIER

Reference Section Reorganization

Starting a new sub-section for notes ...

Image Layout Templates

• single image narrative on the right with captions

As suggested previously, the scattering color and extinction values were adjusted until the image looked good. In this kind of scene usually very small values are needed. Note how the container box is quite smaller than the room itself. Container boxes should always be sized as minimally as possible. If the box were as big as the room much higher values for samples would be needed for a good result, thus resulting in a much slower rendering.

more advanced scattering media example

• same as above only mirrored

As suggested previously, the scattering color and extinction values were adjusted until the image looked good. In this kind of scene usually very small values are needed. Note how the container box is quite smaller than the room itself. Container boxes should always be sized as minimally as possible. If the box were as big as the room much higher values for samples would be needed for a good result, thus resulting in a much slower rendering.

more advanced scattering media example

• panel of 3 with a border and captions

no radiosity	radiosity	difference w/o radiosity

Keyword Addition Example

This outlines the steps to add a new keyword to the documentation. In this case deprecated

• first determine where the descriptive passage goes then add it
• update the syntax diagram in the appropriate places
• update the Identifiers and Keywords list
• document any other place(s) that it's used
• add a table of contents entry

NEW Template Test Area

The New and Change templates can now be used inside a paragraph. See additional examples:

• This is a New feature as of version 3.7.1

• ... and this is a Change in behavior as of version 3.7.0

See also:

• Usage in tau
• also for the torus object

Archives

• Developers notes from when the Wiki-DocGen project started
• The source and notes on the LaTeX markup used in the documentation
• The change-log has been reviewed and the results are here

• Some text here just f(x) = x̂Γ for comparison.

• Some wiki-docgen process notes