Style guide : syntax

Fonts

Please do not apply any font types. This is handled by the publishing mechanism.

Captials

Capitalize the first letter only of the first word and of any proper nouns in a heading, and leave all of the other letters in lower case. Use "Rules and regulations", not "Rules and Regulations".

Italics

Italics are used for emphasis, but sparingly. Italics are also used for titles. The following should be italicised:

book titles such as Streaming Cookbook
titles of training courses such as Silenttv Workshop
titles of websites such as Floss Manuals
Periodicals (newspapers, journals, and magazines) such as Linux Journal
Articles, online manuals, essays or papers such as Streaming with Ogg Theora

Use italics when writing about words as words, or letters as letters (to indicate the use-mention distinction). This category may also use quotation marks to distinguish words as words. For example:

streaming is a word used to describe the sending of real time audio or video over the internet
"streaming" is a word used to describe the sennding of real time audio or video over the internet

Quotations

Use quote marks for quotations.

Use quotations when citing text from error messages, log files, or command line feedback. For example :

In the above example the command whoami is entered and the reply is "root"

Also use quotations when quoting interface text on software or in webpages, for example:

Click on "download" and you will see something similar to this
Choose from the "File" menu an option taht is suitable

Bold

Use bold for emphasis as you see necessary.

Bold Italic

Bold and italicise the use of Linux or DOS commands or keystrokes when they are used in a sentence. For example :

If you use ls -al this give you a list of all files and folders in a directory
To do this type su in the terminal and press enter, you will then be asked for a password

Headings

Please make sure your headings are in the correct order. There should always be a heading1 directly before a heading2 and a heading3 directly before a heading2 etc. Not following this causes problems with the publishing of some formats.


LOGIN REGISTER Search GUIDES HOW TO EDIT GOOD MANUAL WRITING SYNTAX GUIDELINES	Style guide : syntax Fonts Please do not apply any font types. This is handled by the publishing mechanism. Captials Capitalize the first letter only of the first word and of any proper nouns in a heading, and leave all of the other letters in lower case. Use "Rules and regulations", not "Rules and Regulations". Italics Italics are used for emphasis, but sparingly. Italics are also used for titles. The following should be italicised: book titles such as Streaming Cookbook titles of training courses such as Silenttv Workshop titles of websites such as Floss Manuals Periodicals (newspapers, journals, and magazines) such as Linux Journal Articles, online manuals, essays or papers such as Streaming with Ogg Theora Use italics when writing about words as words, or letters as letters (to indicate the use-mention distinction). This category may also use quotation marks to distinguish words as words. For example: streaming is a word used to describe the sending of real time audio or video over the internet "streaming" is a word used to describe the sennding of real time audio or video over the internet Quotations Use quote marks for quotations. Use quotations when citing text from error messages, log files, or command line feedback. For example : In the above example the command whoami is entered and the reply is "root" Also use quotations when quoting interface text on software or in webpages, for example: Click on "download" and you will see something similar to this Choose from the "File" menu an option taht is suitable Bold Use bold for emphasis as you see necessary. Bold Italic Bold and italicise the use of Linux or DOS commands or keystrokes when they are used in a sentence. For example : If you use ls -al this give you a list of all files and folders in a directory To do this type su in the terminal and press enter, you will then be asked for a password Headings Please make sure your headings are in the correct order. There should always be a heading1 directly before a heading2 and a heading3 directly before a heading2 etc. Not following this causes problems with the publishing of some formats.

GUIDES