From OpenFOAMWiki

1 General

A reference about all the technical stuff for the Wiki can be found here: Editor's help of MediaWiki

A short overview for the impatient is given at the Editing overview

Policy and conventions are the 'house rules' of this Wiki.

2 Extensions

These are the extensions installed on this Wiki

2.1 Typesetting equations LaTeX-style

This is a standard feature of the MediaWiki: in order to enter an equation like E = m c^2 into the text you simply put math-tags around it:

<math>E = m c^2</math>

2.2 Having nice-looking source codes

The Geshi Syntax Highlighting extension (which is based on Geshi) allows you to typeset C++ (and other languages) in a more colorful way:

#include <iostream>
main() {
    std::cout << "Hello, Wiki!\n";

was produced by

#include <iostream>

main() {
    std::cout << "Hello, Wiki!\n";

For other languages use the correct tags (java, bash etc).

2.3 Citations

The cite extension allows you to add a linked, footnoted reference as in Wikipedia. Add the reference info in the text with:

C++ was created by Bjarne Stroustrup <ref>Stroustrup, B, ''The C++ Programming Language'', Addison-Wesley, pp 328, 1986</ref> in order to overcome perceived limitations of C.

This appears as

C++ was created by Bjarne Stroustrup [1] in order to overcome perceived limitations of C.

then create a Reference section at the bottom of the page and add the tag



Voila! The backend php script will fill out and format your reference list.

3 Useful templates

Templates are enclosed in double brackets: {{demoTemplate}}.

3.1 Decorative Template

The template {{OpenFOAM}} adds a link to the OpenFOAM-homepage.

3.2 Version Templates

This helps to group pages by the versions/forks/variants of OpenFOAM for which they are valid.

Version information starts with the template {{VersionInfo}} followed by the version templates {{Version1.x}} for which this page is valid. For instance

{{VersionInfo}}{{Version1.0}}{{Version1.2}}{{Version1.6}} {{Version1.4-dev}} {{Version1.6-ext}} {{Version3.0-ext}} {{versionOpenFOAMFoundationDev}}

is displayed as

Valid versions: OF version 10.png OF version 12.png OF version 16.png OF Version 23.png OF Version 14dev.png OF Version 16ext.png OF Version 30ext.png OF Version FoundationDev.png

meaning that information on this page is valid for:

  • OpenFOAM 1.0, 1.2, 1.6, 2.3;
  • foam-extend's OpenFOAM 1.4-dev, OpenFOAM 1.6-ext and foam-extend 3.0;
  • OpenFOAM development version that is provided by the OpenFOAM Foundation.

... but for some strange reason not for 1.1, 1.3 to 1.5, 1.5-dev and so on (or the status is unknown)

--Bgschaid 22:06, 31 May 2005 (CEST)

4 References

  1. Stroustrup, B, The C++ Programming Language, Addison-Wesley, pp 328, 1986