[Openfoam-extend-stammtisch] The OpenFOAM Documentation Project

[Holger M. <hol...@ch...>]

Dear FOAMers,

I have some news that I wanted to introduce with some famous quotation ;)

    If I can't find a reindeer, I'll make one instead.
    - T. Grinch, 1957

... and I proudly announce

        The OpenFOAM Documentation Project
        
that has just gone online!

The OpenFOAM Documentation Project (OFDP) is essentially a team of experienced 
OpenFOAM users (volunteers) with minimal central organization. It is hoped to 
establish a high quality system of OpenFOAM documentation that is easy to use 
and search through. All OFDP documentation is freely available, licensed under 
the terms of the GNU Free Documentation License 1.3. 

--------------------
The basic idea ...
--------------------
The basic idea was to create a Joomla-based website (a professional content 
managed system for web content) for OpenFOAM documentation. This is quite 
flexible and professional in terms of layout, extensions and administrations.

For typesetting OpenFOAM documentation we chose LaTeX - a high-quality 
typesetting system which includes features designed for the production of 
technical and scientific documentation. Using LaTeX templates along with a own 
OFDP style-file and macros specific for OpenFOAM documentation, a professional 
layout is achieved for OFDP Documentation.

The CMS Joomla! as well as LaTeX are both inherent parts of the OFDP. It is 
strongly believed that both "ingredients" are crucial for a monolithic, coherent 
and attractive handbook/guide system for OpenFOAM.

--------------------
The concept ...
--------------------
On the Website of the OpenFOAM Documentation Project, LaTeX-Templates are 
provided, that can be freely downloaded and modified, containing the current 
documentation status of
  * OpenFOAM's top-level utilities
  * OpenFOAM's top-level models
  * OpenFOAM's top-level solvers  
as they come along with the released OpenFOAM distributions. Accordingly, there 
is a OFDP documentation download section where you can download
  * The OpenFOAM Utility Guide
  * The OpenFOAM Modeling Guide
  * The OpenFOAM Solvers Guide
as pdf-files, which will be maintained and updated regularly.

IMPORTANT: Any modifications CANNOT be uploaded directly but have to be sent to 
a third-party reviewer resp. an expert of a special interest group (SIG). The 
reviewed document will be sent to an administrator of the OFDP, 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.

In addition, the OFDP documentation includes integration of a list of all the 
major OpenFOAM documentation sites with similar goals and the hosting of a 
OpenFOAM tutorial collection on this website.

--------------------
The Website ...
--------------------
For more details please visit ...

        www.openfoam-documentation.org

... and keep FOAMing & contributing!

---
best regards
Holger Marschall

---
Dipl.-Ing. Holger Marschall

Lehrstuhl I für Technische Chemie
Technische Universität München
Lichtenbergstr. 4
D-85747 Garching
Germany

phone: +49 89 289-13508
fax:  +49 89 289-13513
e-mail: hol...@ch...
www: www.ch.tum.de/tc1

---
This message and any attachments is intended for the named addressee(s)
only and may contain information that is privileged and/or confidential.
If you receive this message in error, please delete it and immediately
notify the sender. Any copying, dissemination or disclosure, either whole
or partial, by a person who is not the named addressee is prohibited. We
use virus scanning software but disclaim any liability for viruses or
other devices which remain in this message or any attachments.
---