Join / Forgotten your password?
 
HomeFeaturesStoreForumsWikiWorkshopsJobsPortfolioGalleryEvents Members
 
> CGWiki Home       > Community Portal       > Current Events      > Recent Changes     > Random Page       > Join       > Support Forum       > Help     
 

CGWiki:Tutorial Sample

Structure

CGWiki Article Structure


A typical article on CGWiki will consist of a brief summary of the article, followed by a more detailed description, ending with a list of external links, acknowledgements, and the category of the article, as in the example below. Note that for because there are so many different types of articles, this is just a basic template, and you may well want to add things to this basic structure.

Example Article


Contents

Brief Description

This is a brief summary of the contents of this article. It should be informative enough for the reader to decide whether this is the article he is looking for, without getting into details.

Section 1

This is where more detailed information goes. If people read this, we can assume they have already read the summary above and are interested in learning more about the topic.

A Subsection

This is simply a subsection of Section 1. Note the way it is listed in the table of contents.


Section 2

More information..


Acknowledgements

If you have used external sources for your articles it is considered polite to acknowledge them here.

External Links


The wiki markup for the above article looks like this:

==Brief Description==
This is a brief summary of the contents of this article. It should be informative enough for 
the reader to decide whether this is the article he is looking for, without getting into details.

==Section 1==
This is where more detailed information goes. If people read this, we can assume they have
already read the summary above and are interested in learning more about the topic.

===A Subsection===
This is simply a subsection of Section 1. Note the way it is listed in the table of contents.


==Section 2==
More information..


==Acknowledgements==
If you have used external sources for your articles it is considered polite to acknowledge them 
here. 

==External Links==
*[http://www.cgsociety.org/ CGSociety]: Simple external link.

[[Category:Help Pages]]


Please note: that the table of contents is displayed automatically when CGWiki determines it is needed. However, you can force the display of the table of contents by inserting

__TOC__

in the document. Similarly, you can hide the table of contents by inserting

__NOTOC__