CFD-Wiki:Format and style guide
From CFD-Wiki
In order to maintain a common style and format throughout CFD-Wiki please try to follow the guidelines described here. If you want to suggest new guidelines or discuss formatting issues please post a message on the Wiki forum.
Contents |
Naming pages/articles
- Name pages with lower-case letters on all words except the first character. The only exception to this is names of persons and places etc. which you would also capitalize in the middle of a sentence. Due to software limitations the first character in the page name has to be capitalized.
- Make sure that the page-name fully identifies the content. For example don't name a page on how to create movies with Fluent "create movies". Instead call it something like "How to create movies in Fluent". You can still link to it with a shorter link-title by using a piped link like this: [[How to create movies in Fluent| create movies]]
- Do not start page titles with The. For example The Navier-Stokes equations should be only Navier-Stokes equations.
Section headings
- Start headings with ==Heading 1==. A single =Heading= produces a h1 heading and this is reserved for the page title, so please avoid these. Subheadings should be written as ===Subheading 1.1=== and ====Subheading 1.1.1====. Try not to skip a level.
- Name headings with the same capitalization as page names, a capital first letter and then small letters.
- External links should normally be placed in a section called ==External links== close to the bottom of the page (but before any reference section).
- References are normally placed in a section called ==References== at the end of the page.
Mathematical formulas
- Write mathematical formulas indented with a ":" in the following way:
:<math>LaTeX formula goes here</math>
- Try to avoid numbering your equations and instead reference them in the text by their names or describe them in words. Numbered equations creates problem when someone later adds an equation in the middle of a page. However, if you find it absolutely necessary to number your formulas please use a HTML table like this:
<table width="70%"> <tr><td> :<math> LaTeX for formula one goes here </math> </td><td width="5%">(1)</td></tr>
- For definitions and equivalences use "
" (<math>\equiv</math>) and use "
" (<math>=</math>) for equations.
- If you want to put some text within an equation, use the \mbox{} environment. For example
:<math>
\epsilon_{ijk} = 1, \mbox{ if all i, j, k are different and in cyclic order}
</math>
will produce
References
Always try to include references to the information you put in CFD-Wiki. We must ensure that CFD-Wiki contains correct information that has been published in peer-reviewed journals or books. For further information see CFD-Wiki:Citing sources.
Write references to publications in the following way:
- Placement: Place references in the article in which they are used, either in a ==References== section at the end or, if it is a very long article, in the section where the reference is used. If it is a long article you might also consider splitting it into smaller articles.
- Order: Order references alphabetically based on the name of the first author
- Numbering: If you want to number the references use square bracket like this: [1]
- Names: Write author names as "Lastname1, Firstname1 and Lastname2, Firstname2"
- Style: There are two different templates which you should use for references - the reference-paper template for scientific publications like journal articles, theses, etc. and the reference-book template for books. The two examples below illustrate how these templates should be used in the Wiki:
{{reference-paper|author=Granville, P. S.|year=1987|title=Baldwin-Lomax Factors for Turbulent
Boundary Layers in Pressure Gradients|rest=AIAA Journal, Vol. 25, No. 12, pp. 1624-1627}}
{{reference-book|author=Batchelor, G. K.|year=2000|title=An Introduction to Fluid
Dynamics|rest=ISBN 0521663962, 1st Edition, Ch. 5.7 Boundary Layers, pp.303}}
These two references would look like this:
- Granville, P. S. (1987), "Baldwin-Lomax Factors for Turbulent Boundary Layers in Pressure Gradients", AIAA Journal, Vol. 25, No. 12, pp. 1624-1627.
- Batchelor, G. K. (2000), An Introduction to Fluid Dynamics, ISBN 0521663962, 1st Edition, Ch. 5.7 Boundary Layers, pp.303.
- External links: An author's homepage can be linked to from the author name. Publications that have homepages can be linked to from the title. Publications that are available for download (pdf or similar) should be linked to with a special download link at the end. Here is an example:
{{reference-paper|author=[http://www.h.jasak.dial.pipex.com/ Hrvoje, Jasak]|year=1996|title=Error
Analysis and Estimation for the Finite Volume Method with Applications to Fluid Flows|rest=PhD
Thesis, Imperial College, University of London
([http://www.h.jasak.dsl.pipex.com/HrvojeJasakPhD.pdf download])}}
This reference would look like this:
- Hrvoje, Jasak (1996), "Error Analysis and Estimation for the Finite Volume Method with Applications to Fluid Flows", PhD Thesis, Imperial College, University of London (download).
- ISBN numbers: For publications that have ISBN numbers make sure to include these in the "rest" parameter using the format "ISBN 1234567890" (see book example above). If you do this the Wiki will automatically hot-link the ISBN to online book-stores.
Language
The preferred language in CFD-Wiki is American English. We need to pick one language variant and since 50% of our visitors come from the US we have chosen American English. If you are from a Commonwealth country and use "harbour" or "aluminium" or whatever, that's fine. We want your contributions, so don't worry too much about spelling. However, please don't be hurt if other contributors come around and change your spelling to American English for consistency.
Units
The preferred units in CFD-Wiki is SI-units (s, kg, m, W, ...).
Links to other sites
Try to put links to external sites in a dedicated == External links == section at the end of the article. The reason for this is that we as much as possible want the CFD-Wiki to be a stand-alone CFD reference and external links should only be used as references. A Wiki is not a link collection.
External links
- Wikipedia:Manual of Style, a wealth of good advice on how to write in Wikis.
- The Elements of Style, by William Strunk, Jr., a classic manual on English usage.
