Difference between revisions of "Main Policy"

Revision as of 21:34, 30 May 2005

This page gives an overview of the conventions in this Wiki.

1 Information submitted to this Wiki

TODO: License etc

The information in this Wiki is under the GNU Free Documentation License. This is the same license as the one used for the OpenFOAM manuals.

For more details and to learn about the consequences go to Project:Copyrights.

Please don't publish anything you don't have the rights for here. When in doubt include only a link to the material.

2 Semantic conventions

TODO: Information is structured similar to the OpenFOAM-sources etc

The general rule is:

• structure the information in this Wiki in the same way it is structured in the OpenFOAM distribution
  • The sections for solvers and other applications should have subsections that mirror the directory structure of their sources
  • The annotations to the manuals are organized in a structure that mirrors the chapters of the printed versions
• use the same nomenclature as the printed OpenFoam documentation (especially for symbols)

Reference the original source of information. One special case is if your source is a discussion from the OpenFOAM-message board: put a link to that discussion into your article.

2.1 What goes where

The main part of this Wiki is the FAQ. Therefor this section will explain what doesn't go into the FAQ, where it goes and why.

The basic rule is: the FAQ only should have articles that

• are of general interest (more than 3 persons have already asked that question or expressed interest in the answer)
• can be formulated as a short, precise questions
• can be answered in a few sentence

Therefor the exceptions are: TODO: To be continued

2.2 Information on the pages

TODO: Which information should go on which page type

• Application pages
• User pages
• Project pages
• Code snipplets

2.3 Ettiquetie

3 Technical conventions

TODO: naming of pages, etc