Editing Guidelines
- The purpose of the manual is to explain concepts, not list classes and functions: that's what the reference is for. It is okay to name classes and functions, as long as the concepts are explained first.
- Please do not add any additional tutorials to the manual unless given explicit permission by the Panda3D developers.
- Make sure you add every page to the table of contents. You don't need to worry about the next/previous links at the top of every page - those will take care of themselves, as long as the table of contents is good.
- We have not yet figured out a practical way to document Panda3D's C++ side. Until we figure it out, please leave C++ code out of the manual. Exception: a separate section on a topic that's specific to C++ is OK.
- Some people will want to read the manual front to back. Think about the information you are adding and where it belongs in the sequence.
- I don't want casual users browsing the manual to be aware that this is a wiki - that is why I hid the login button. Try to avoid major giveaways.
- avoid the use of really wide preformatted text. If you must, insert this:
<span class="suppress-screenshots"></span>
This is a hack that will suppress the screenshots on the right hand side of the screen, giving you more space. If that's not enough, you need to reformat your text.
- To do a block of code, write it like this:
<pre class="codeblock">
information line 1
information line 2
information line 3
</pre>
- To write a function, variable, or class name, use <code>xyz</code>
|