Difference between revisions of "OpenTutorial:Manual of style"

From OpenTutorial
Jump to navigation Jump to search
 
 
Line 1: Line 1:
{{todo|todonote=Write a suggested manual of style}}
+
This is the OpenTutorial Manual of style. It's main purpose is to help to keep the tutorials placed on this site uniform and easy to read.
 +
 
 +
 
 +
=== Uniformity ===
 +
 
 +
If the tutorials on this website are written in a uniform manner then they will be easy for people to read, understand and contribute to them.
 +
 
 +
 
 +
==== Uniform Template ====
 +
 
 +
The following text needs to be the starting point for all tutorials written on OpenTutorial. To use it simply copy and paste it into any newly created tutorial, and replace the text enclosed in ` to reflect the correct content.
 +
 
 +
If a tutorial does not have this uniform format applied to it then it can either be edited to reflect the uniform format or it can be tagged for reformatting by placing the <nowiki>{{uniform}}</nowiki> template so it can be reformatted at another time.
 +
<pre>
 +
<nowiki>
 +
 
 +
 
 +
`This is where the brief description of the tutorial goes`
 +
 
 +
 
 +
== `This is where the title of the tutorial goes ` ==
 +
'Longer description of the tutorial here'
 +
 
 +
 
 +
=== 'Sub Headings for the Tutorial' ===
 +
'Tutorial Content'
 +
 
 +
 
 +
== See Also ==
 +
* [['Link to related tutorial']]
 +
* [['Link to related tutorial']]
 +
* [['Link to related tutorial']]
 +
 
 +
 
 +
 
 +
== Bibliography ==
 +
* ISBN ( `Insert ISBN Number Here`
 +
* ISBN ( `Insert ISBN Number Here`
 +
* ISBN ( `Insert ISBN Number Here`
 +
 
 +
 
 +
== Amazon's Related Products ==
 +
* ASIN ( `Insert ASIN Number Here`
 +
* ASIN ( `Insert ASIN Number Here`
 +
* ASIN ( `Insert ASIN Number Here`
 +
 
 +
 
 +
== External Links ==
 +
* [`Link to external site with description`]
 +
* [`Link to external site with description`]
 +
* [`Link to external site with description`]
 +
 
 +
 
 +
</nowiki>
 +
</pre>
 +
 
 +
 
 +
 
 +
{{todo|todonote=Finish}}

Latest revision as of 22:13, 13 March 2007

This is the OpenTutorial Manual of style. It's main purpose is to help to keep the tutorials placed on this site uniform and easy to read.


Uniformity

If the tutorials on this website are written in a uniform manner then they will be easy for people to read, understand and contribute to them.


Uniform Template

The following text needs to be the starting point for all tutorials written on OpenTutorial. To use it simply copy and paste it into any newly created tutorial, and replace the text enclosed in ` to reflect the correct content.

If a tutorial does not have this uniform format applied to it then it can either be edited to reflect the uniform format or it can be tagged for reformatting by placing the {{uniform}} template so it can be reformatted at another time.




`This is where the brief description of the tutorial goes`


== `This is where the title of the tutorial goes ` ==
'Longer description of the tutorial here'


=== 'Sub Headings for the Tutorial' ===
'Tutorial Content'


== See Also ==
* [['Link to related tutorial']]
* [['Link to related tutorial']]
* [['Link to related tutorial']]



== Bibliography ==
* ISBN ( `Insert ISBN Number Here`
* ISBN ( `Insert ISBN Number Here`
* ISBN ( `Insert ISBN Number Here`


== Amazon's Related Products ==
* ASIN ( `Insert ASIN Number Here`
* ASIN ( `Insert ASIN Number Here`
* ASIN ( `Insert ASIN Number Here`


== External Links ==
* [`Link to external site with description`]
* [`Link to external site with description`]
* [`Link to external site with description`]