Documentation System - Wiki EngineWhat is it about?Wiki collects information about the OpenSource CFD toolbox OpenFOAM® and provides a platform for collaborative editing on manuals, step-by-step instruction and Howtos related to the OpenFOAM® CFD toolbox. The categories cover the topics - References
- Events
- Teaching and Training
- Usage
- Development
- Community
- News
- Links
How to contribute?For instructions on how to contribute to the OpenFOAM® Wiki please have a look here! Documentation System - Documentation ProjectWhat is it about?The FOAM Documentation Project is a community-driven initiative on documenting the CFD toolbox OpenFOAM®. It is hoped to establish a high quality system of FOAM documentation that is easy to use and search through. All FDP documentation is freely available, licensed under the terms of the GNU Free Documentation License 1.3. The main concept is to provide LaTeX templates on this site, that can be freely downloaded and modified, containing the current documentation status of - FOAM's top-level utilities
- FOAM's top-level models
- FOAM's top-level solvers
as they come along with the released FOAM distributions. Accordingly, there is a documentation download section where you can download- The FOAM Utility Guide
- The FOAM Modeling Guide
- The FOAM Solvers Guide
as pdf-files (Adobe® portable document format), which will be maintained and updated regularly. The objective of The FOAM Documentation Project (FDP) is to create and distribute a set of free high quality documentation for the FOAM CFD Toolbox. In order to provide this high quality documentation a quality assessment system is introduced:
Modifications to documentation cannot be uploaded directly to the FDP website but shall undergo a quality assessment as illustrated in the figure above: All corrected or extended documentation must be sent to a reviewer of a special interest group (SIG) or an expert registered as FDP reviewer.
The reviewed document will be sent to an administrator of the FDP, who will upload the contribution. The contributor and reviewer will be added to a list of authors and reviewers in the document. At the same time, the document version number will be increased accordingly. How to contribute?Currently no contribution is possible: The FOAM Documentation Project is currently on hold due to putative trademark infringements claimed by OpenCFD® Limited. However, in the meantime please contribute to the OpenFOAM® Wiki as a central documentation repository. |