Help:Editing

From OpenFOAMWiki

Contents 1 General 2 Extensions 2.1 Typesetting equations LaTeX-style 2.2 Having nice-looking source codes 3 Useful templates 3.1 Decorative Template 3.2 Version Templates

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 = mc² 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

<cpp>
#include <iostream>

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

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

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 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}}

is displayed as

Valid versions:

meaning that information on this page is valid for the versions 1.0 and 1.2, but for some strange reason not for 1.1 (or the status is unknown)

---

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