Help:Contents
From CFD-Wiki
(Difference between revisions)
(→References) |
(Note about putting text within equation and some typos) |
||
Line 23: | Line 23: | ||
*Do not start page titles with ''The''. For example ''The Navier-Stokes equations'' should be only ''Navier-Stokes equations''. | *Do not start page titles with ''The''. For example ''The Navier-Stokes equations'' should be only ''Navier-Stokes equations''. | ||
- | === Mathematical | + | === Mathematical formulae === |
- | * Write mathematical | + | * Write mathematical formulae indented with a ":" in the following way: |
<pre> | <pre> | ||
<nowiki> | <nowiki> | ||
Line 32: | Line 32: | ||
</pre> | </pre> | ||
- | * In pages with many | + | * In pages with many formulae which you need to reference in the text number the formulae using a HTML table like this: |
<pre> | <pre> | ||
<nowiki> | <nowiki> | ||
Line 45: | Line 45: | ||
* For definitions and equivalences use "<math>\equiv</math>" (<nowiki><math>\equiv</math></nowiki>) and use "<math>=</math>" (<nowiki><math>=</math></nowiki>) for equations. | * For definitions and equivalences use "<math>\equiv</math>" (<nowiki><math>\equiv</math></nowiki>) and use "<math>=</math>" (<nowiki><math>=</math></nowiki>) for equations. | ||
+ | |||
+ | * If you want to put some text within an equation, use the \mbox{} environment. For example | ||
+ | |||
+ | <pre> | ||
+ | <nowiki> | ||
+ | :<math> | ||
+ | \epsilon_{ijk} = 1, \mbox{ if all i, j, k are different and in cyclic order} | ||
+ | </math> | ||
+ | </nowiki> | ||
+ | </pre> | ||
+ | |||
+ | will produce | ||
+ | |||
+ | :<math> | ||
+ | \epsilon_{ijk} = 1, \mbox{ if all i, j, k are different and in cyclic order} | ||
+ | </math> | ||
===References=== | ===References=== |
Revision as of 02:46, 16 September 2005
Contents |
General guidelines for editors
- The Wiki needs your help!
- This Wiki will never be better than the information we all fill it with. Everyone with some knowledge about CFD can contribute, so please go ahead and add something about your area of expertise. Things can always be improved later on! It is much better with a short incomplete page on something than no page at all. An incomplete page will encourage others to work further on it. So add whatever you can and leave it to others to improve it later on.
- Write in a neutral point of view
- See the WikiPedia NPOV definition. This is especially important when writing about commercial products. We don't want a Wiki filled with commercial advertising.
- Please make sure that all material you add is free from any copyrights.
- Check the style guide below
Style guide
This Wiki has just been started so we don't have any well-established common style yet. However, below are a few recommendations that we seem to agree on so far. Feel free to add your own recommendations here, or write something on the talk page if you want to discuss it.
Naming pages/articles
- Name pages with lower-case letters on all words except the first character.
- 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 "Fluent - how to create movies". You can still link to it with a shorter link-title by using a piped link like this: [[Fluent - how to create movies | create movies]]
- Do not start page titles with The. For example The Navier-Stokes equations should be only Navier-Stokes equations.
Mathematical formulae
- Write mathematical formulae indented with a ":" in the following way:
:<math>LaTeX formula goes here</math>
- In pages with many formulae which you need to reference in the text number the formulae using a HTML table like this:
<table width="100%"> <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
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.
Help with editing
For some basic help on how to edit pages please visit WikiMedia Help for Editors or How to edit a page. For help with writing mathematical formulae, see the wikipedia help pages.