Difference between revisions of "Main Policy"
m (→Semantic conventions) |
m (→Semantic conventions) |
||
| Line 12: | Line 12: | ||
== Semantic conventions == | == Semantic conventions == | ||
| − | |||
| − | |||
The general rule is: | The general rule is: | ||
| Line 28: | Line 26: | ||
The main part of this Wiki is the [[main_FAQ|FAQ]]. Therefor this section will explain what doesn't go into the [[main_FAQ|FAQ]], where it goes and why. | The main part of this Wiki is the [[main_FAQ|FAQ]]. Therefor this section will explain what doesn't go into the [[main_FAQ|FAQ]], where it goes and why. | ||
| − | The basic rule is: the [[main_FAQ|FAQ]] only should have articles that | + | The basic rule is: the [[main_FAQ|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) | * 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 formulated as a short, precise questions | ||
| Line 34: | Line 32: | ||
Therefor the exceptions are: | Therefor the exceptions are: | ||
| − | + | * if the question is about a solver or a utility and the answer is only applicable to that application then write it in the article in [[main_OFSolvers|Solvers]] or [[main_OFUtilities|Utilities]] | |
| + | * if the answer is too long consider writing an article in one of the categories (and reference that article in the [[main_FAQ|FAQ]]. Too long would mean (these numbers are only approximations): | ||
| + | ** More that 10 lines of C++-code (consider writing a [[main_CodeSnipplets|Code Snipplet]]) | ||
| + | ** More than 10 lines of text (consider writing in [[main_TipsAndTricks|Tips and Tricks]] or [main_HowTos|the How-Tos]]) | ||
| + | |||
| + | |||
=== Information on the pages === | === Information on the pages === | ||
| Line 40: | Line 43: | ||
TODO: Which information should go on which page type | TODO: Which information should go on which page type | ||
| − | + | ==== Application pages ==== | |
| − | + | ||
| − | + | ==== User pages ==== | |
| − | + | ||
| + | ==== Project pages ==== | ||
| + | |||
| + | ==== Code snipplets ==== | ||
=== Ettiquete === | === Ettiquete === | ||
Revision as of 11:32, 31 May 2005
This page gives an overview of the conventions in this Wiki.
Contents
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
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:
- if the question is about a solver or a utility and the answer is only applicable to that application then write it in the article in Solvers or Utilities
- if the answer is too long consider writing an article in one of the categories (and reference that article in the FAQ. Too long would mean (these numbers are only approximations):
- More that 10 lines of C++-code (consider writing a Code Snipplet)
- More than 10 lines of text (consider writing in Tips and Tricks or [main_HowTos|the How-Tos]])
2.2 Information on the pages
TODO: Which information should go on which page type
2.2.1 Application pages
2.2.2 User pages
2.2.3 Project pages
2.2.4 Code snipplets
2.3 Ettiquete
3 Technical conventions
TODO: naming of pages, etc
