Wiki HowTo & Guidelines - LuxRender Wiki
Luxrender GPL Physically Based Renderer

Wiki HowTo & Guidelines

Personal tools

From LuxRender Wiki

Jump to: navigation, search

This document is intended for people who want to contribute to writing user documentation for LuxRender.

Contents

required skills

For most of the documentation work, basic skills in LuxRender and a 3d program suffice. A big part of the work consists of testing what various settings do, sometimes combined with reading about them on various on-line sources.

Some work requires a more thorough understanding of computer graphics, or requires specific knowledge may only be available in the PBRT book.

tasks to be done

A list of tasks to be done is present on the Documentation_todo page.

wiki layout

An introduction to using various layout options can be found on [1]. On this wiki, there is a Sandbox page where you can freely experiment without breaking anything.

how to get started

Unless you know exactly what you want to work on -in which case you can just start without asking- please send a message to [Abel] using the message system on the forum, or post in the documentation section of the forum. Both the forum and the wiki require registration.

target audience

In the main documentation of this wiki, basic understanding of 3d software should be assumed. This means for example that when discussing bump maps, the concept does not need to be explained in the text. However, when adding a caption to an image illustrating the effect of bump maps in LuxRender, it would be good to point out what the effect is - for example "a brick wall with and without bump maps - the use of bump maps results in a sense of depth in the joints".

Regardless of the assumption of basic knowledge, any term that may be unfamiliar to readers should be explained in the glossary.

language

For the time being, English is the only language being used on this wiki. Once the documentation gets to a more stable state, translations may be added.

images

First and foremost, images need to clearly show the effects that are being explained. If you manage to make them good looking at the same time, even better.

Horizontal images are better suited for this medium than vertical ones as they keep the wiki pages more compact. For a consistent look, images with a width of 720, 360, 240 or 180 pixels are preferred. When presenting multiple images comparing the effect of changes in a certain setting, please combine them in a horizontal strip.

copyright and license

Any contributions to the LuxRender Wiki are released under the GNU Free Documentation License. Please respect copyright of sources that do not come with the same license. When quoting a source, make clear that you are doing so and include a link to the original document.