CoCoons Project - Community-driven Documentation on OpenFOAM® Technology

holger_marschall · June 28, 2013, 03:22

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

Dear FOAMers,

I proudly announce

The CoCoons Project - Community-driven Documentation on OpenFOAM® Technology
www.cocoons-project.org

that has recently been launched!

CoCoons

is about the C++ programming language for Computational Continuum Numerics and its main principles: object orientation ('oo' in name), encapsulation (logo); code re-use, polymorphism and generic programming by inheritance and templated classes.
refers to self-contained ('encapsulated') documents embedded into an elaborated documentation framework - a modular approach to community-driven documentation of the OpenFOAM® CFD Toolbox for Computational Continuum Mechanics, which the project focuses on in a first step.

The CoCoons Project is essentially a team of experienced users (volunteers) with minimal central organization. It is hoped to establish a high quality system of documentation on OpenFOAM® Technology that is easy to use and search through.

All CoCoons documentation is freely available (incl. the source), licensed under the terms of the GNU Free Documentation License 1.3. CoCoons documentation is to be professionally published via partner publishing house and international journal (Elsevier) standing side by side with CoCoons Project. For more information please visit

CoCoons Project Homepage: http://www.cocoons-project.org
CoCoons Project Partners: http://www.cocoons-project.org/cocoo...juliaportfolio
FAQ Section - Why should I contribute?: http://www.cocoons-project.org/why-should-i-contributei

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

For typesetting CoCoons documentation we chose LaTeX - a high-quality typesetting system which includes features designed for the production of technical and scientific documentation, which is visually of high quality, consistent and clear appearance throughout, precise and concise. Using LaTeX templates along with an own LaTeX document class, style-file and macros specific for community-driven documentation on OpenFOAM® Technology, a professional layout is achieved for CoCoons documentation.

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

--------------------
The concept ...
--------------------
On the Website of the CoCoons Project, LaTeX-Templates are provided, that can be freely downloaded and modified, containing the current documentation status of

top-level utilities
top-level models
top-level solvers

as they come along with the OpenFOAM® releases or remixes. Accordingly, there is a CoCoons documentation download section where you can download

CoCoons Utility Guide to OpenFOAM® Technology
CoCoons Modeling Guide to OpenFOAM® Technology
CoCoons Solvers Guide to OpenFOAM® Technology

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 CoCoons Project, who will then 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, CoCoons documentation shall include the hosting of a tutorial collection on OpenFOAM® Technology on this website.

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

www.cocoons-project.org

... and keep FOAMing & contributing!

---
best regards
Holger Marschall

Disclaimer: This offering is not approved or endorsed by ESI® Group, ESI-OpenCFD® or the OpenFOAM® Foundation, the producer of the OpenFOAM® software and owner of the OpenFOAM® and OpenCFD® trademarks.

Cocoon® is a registered trade mark of the The Appache® Software Foundation (ASF). The above use has been officially approved by ASF within the scope of scientific computing. The author duly acknowledges the trademarks of ASF and refers to the official websites for Apache Cocoon (link).

holger_marschall · July 2, 2013, 03:31

Dear FOAMers,

thanks for the many positive feedbacks. Via E-mail I have been asked the following and I want to use the forum to make the answers available to everyone in the community:

Assume I want to start documenting a utility, how do I know no body else is working on the same thing?

As a part of the project, there is a site for monitoring documentation progress. Herein you find the categories 'Documents under Progress', 'Documents under Review' and 'Documents need Review' in order to avoid repetitive work. See http://www.cocoons-project.org/documentation-progress.

For being listed please use the forms provided on the website to contact me: http://www.cocoons-project.org/howto-contribute

Please follow the step-by-step instruction for contributions to the CoCoons Project provided in the FAQ section: http://www.cocoons-project.org/how-can-i-contributei
How can people of similar interest collaborate on the same project. One can think of an idea (involving Git) but I would like to know your approach?

"Everything Should Be Made as Simple as Possible, But Not Simpler".
It is my belief that a community-driven documentation effort should be as easy as possible in its workflow. Dealing with all specific cases and scenarios of collaborative/joint work on documentation would definitely be too much and confusing. This said, I really think it's up to you -- If you search for co-authors; how about opening a thread in this forum or on the discussion board of the Special Interest Group on OpenFOAM® documentation (link)? Want to use git: please check out bitbucket.org (it's great and free)?

Hope this is of help! In case of any questions, please don't hesitate to ask.

best regards,
Holger

holger_marschall · November 18, 2013, 01:50

Dear FOAMers,

The CoCoons Project on community-driven documentation of the OpenFOAM® CFD Toolbox has started some time ago. Thanks a lot for all your positive feedbacks and input to the project!

As a kick-off I now want to announce the

Documentation Marathon on OpenFOAM® over winter/spring 2013/14

The goal of this campaign is to launch The CoCoons Project, to get it off the ground and to provide the ideal setting for free high quality documentation on OpenFOAM® Technology.

To have a free high quality documentation system for OpenFOAM® is a big vision, and it will require YOUR help to make it happen! Please contribute. The CoCoons Project is a community project: we need your contributions, so don't be afraid to jump in! All high-quality contributions will be published (see CoCoons Project's Partners and CoCoons Project FAQ).

And as a must-have for a real Marathon, crossing the finish line in 1st of April 2014 there are rewards waiting for you, of course:

Every FOAMer who submits

1000 words of documentation on OpenFOAM®'s utilities, models and solvers wins a CoCoons Project T-Shirt
2500 words of documentation on OpenFOAM®'s utilities, models and solvers wins a CoCoons Project Polo-Shirt

sponsored by Engys Ltd. (Eugene de Villiers). Thanks a lot!

For more details have a look at

www.cocoons-project.org

... Have fun and KEEP FOAMing!

best regards,
Holger Marschall

CoCoons Project
contact@cocoons-project.org

holger_marschall · December 13, 2013, 09:14

Dear FOAMers,

I am happy to inform that the community-driven documentation effort of OpenFOAM® technology

The CoCoons Project - Community-driven Documentation on OpenFOAM® Technology
www.cocoons-project.org

takes quite some momentum: recently, the Documentation Marathon on OpenFOAM® over winter/spring 2013/14 has been started. For more information please read the corresponding post in this thread. Now, the category "Documentation Progress" has been updated. Have a look at

Updated section - CoCoons Documentation Progress
http://www.cocoons-project.org/documentation-progress

All professional contributions shall be published in book form! Consider contributing early and share your expertise! Keep FOAMing!

For more information start from the project's FAQ section:

best regards,
Holger Marschall

CoCoons Project
contact@cocoons-project.org

Zeppo · January 22, 2022, 13:58

The link http://www.cocoons-project.org doesn't seem to work anymore. It looks like the project is dead (unfortunately)

bigphil · February 2, 2022, 12:17

Quote:

Originally Posted by Zeppo

The link http://www.cocoons-project.org doesn't seem to work anymore. It looks like the project is dead (unfortunately)

It was a nice idea but never really took off.

In some ways, the OpenFOAM Journal (https://journal.openfoam.com) fills the gap.

holger_marschall · February 2, 2022, 14:42

Quote:

Originally Posted by bigphil

It was a nice idea but never really took off.

In some ways, the OpenFOAM Journal (https://journal.openfoam.com) fills the gap.

Hi all,

I tend to disagree partly. Yes, it never took off really which is a pitty. Certainly, the OpenFOAM Journal will fill another gab, but cannot replace technical documentation.

If there still is enough public interest, I would be delighted to revive this project. The situation has changed substantially.

Best regards,
Holger

June 28, 2013, 03:22	CoCoons Project - Community-driven Documentation on OpenFOAM® Technology	#1
holger_marschall Senior Member Holger Marschall Join Date: Mar 2009 Location: Darmstadt, Germany Posts: 125 Rep Power: 19	If I can't find a reindeer, I'll make one instead. - T. Grinch, 1957 Dear FOAMers, I proudly announce The CoCoons Project - Community-driven Documentation on OpenFOAM® Technology www.cocoons-project.org that has recently been launched! CoCoons is about the C++ programming language for Computational Continuum Numerics and its main principles: object orientation ('oo' in name), encapsulation (logo); code re-use, polymorphism and generic programming by inheritance and templated classes. refers to self-contained ('encapsulated') documents embedded into an elaborated documentation framework - a modular approach to community-driven documentation of the OpenFOAM® CFD Toolbox for Computational Continuum Mechanics, which the project focuses on in a first step. The CoCoons Project is essentially a team of experienced users (volunteers) with minimal central organization. It is hoped to establish a high quality system of documentation on OpenFOAM® Technology that is easy to use and search through. All CoCoons documentation is freely available (incl. the source), licensed under the terms of the GNU Free Documentation License 1.3. CoCoons documentation is to be professionally published via partner publishing house and international journal (Elsevier) standing side by side with CoCoons Project. For more information please visit CoCoons Project Homepage: http://www.cocoons-project.org CoCoons Project Partners: http://www.cocoons-project.org/cocoo...juliaportfolio FAQ Section - Why should I contribute?: http://www.cocoons-project.org/why-should-i-contributei -------------------- The basic idea ... -------------------- The basic idea was to create a Joomla-based website (a professional content managed system for web content) for community-driven documentation on OpenFOAM® Technology. This is quite flexible and professional in terms of layout, extensions and administrations. For typesetting CoCoons documentation we chose LaTeX - a high-quality typesetting system which includes features designed for the production of technical and scientific documentation, which is visually of high quality, consistent and clear appearance throughout, precise and concise. Using LaTeX templates along with an own LaTeX document class, style-file and macros specific for community-driven documentation on OpenFOAM® Technology, a professional layout is achieved for CoCoons documentation. The CMS Joomla! as well as LaTeX are both inherent parts of the CoCoons Project. It is strongly believed that both "ingredients" are crucial for a monolithic, coherent and attractive handbook/guide system. -------------------- The concept ... -------------------- On the Website of the CoCoons Project, LaTeX-Templates are provided, that can be freely downloaded and modified, containing the current documentation status of top-level utilities top-level models top-level solvers as they come along with the OpenFOAM® releases or remixes. Accordingly, there is a CoCoons documentation download section where you can download CoCoons Utility Guide to OpenFOAM® Technology CoCoons Modeling Guide to OpenFOAM® Technology CoCoons Solvers Guide to OpenFOAM® Technology 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 CoCoons Project, who will then 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, CoCoons documentation shall include the hosting of a tutorial collection on OpenFOAM® Technology on this website. -------------------- The Website ... -------------------- For more details please visit ... www.cocoons-project.org ... and keep FOAMing & contributing! --- best regards Holger Marschall Disclaimer: This offering is not approved or endorsed by ESI® Group, ESI-OpenCFD® or the OpenFOAM® Foundation, the producer of the OpenFOAM® software and owner of the OpenFOAM® and OpenCFD® trademarks. Cocoon® is a registered trade mark of the The Appache® Software Foundation (ASF). The above use has been officially approved by ASF within the scope of scientific computing. The author duly acknowledges the trademarks of ASF and refers to the official websites for Apache Cocoon (link). francois, mbeaudoin, philippose and 18 others like this. __________________ Holger Marschall web: http://www.holger-marschall.info mail: holgermarschall@yahoo.de Last edited by holger_marschall; June 28, 2013 at 05:42.

July 2, 2013, 03:31		#2
holger_marschall Senior Member Holger Marschall Join Date: Mar 2009 Location: Darmstadt, Germany Posts: 125 Rep Power: 19	Dear FOAMers, thanks for the many positive feedbacks. Via E-mail I have been asked the following and I want to use the forum to make the answers available to everyone in the community: Assume I want to start documenting a utility, how do I know no body else is working on the same thing? As a part of the project, there is a site for monitoring documentation progress. Herein you find the categories 'Documents under Progress', 'Documents under Review' and 'Documents need Review' in order to avoid repetitive work. See http://www.cocoons-project.org/documentation-progress. For being listed please use the forms provided on the website to contact me: http://www.cocoons-project.org/howto-contribute Please follow the step-by-step instruction for contributions to the CoCoons Project provided in the FAQ section: http://www.cocoons-project.org/how-can-i-contributei How can people of similar interest collaborate on the same project. One can think of an idea (involving Git) but I would like to know your approach? "Everything Should Be Made as Simple as Possible, But Not Simpler". It is my belief that a community-driven documentation effort should be as easy as possible in its workflow. Dealing with all specific cases and scenarios of collaborative/joint work on documentation would definitely be too much and confusing. This said, I really think it's up to you -- If you search for co-authors; how about opening a thread in this forum or on the discussion board of the Special Interest Group on OpenFOAM® documentation (link)? Want to use git: please check out bitbucket.org (it's great and free)? Hope this is of help! In case of any questions, please don't hesitate to ask. best regards, Holger __________________ Holger Marschall web: http://www.holger-marschall.info mail: holgermarschall@yahoo.de

November 18, 2013, 01:50	Documentation Marathon on OpenFOAM	#3
holger_marschall Senior Member Holger Marschall Join Date: Mar 2009 Location: Darmstadt, Germany Posts: 125 Rep Power: 19	Dear FOAMers, The CoCoons Project on community-driven documentation of the OpenFOAM® CFD Toolbox has started some time ago. Thanks a lot for all your positive feedbacks and input to the project! As a kick-off I now want to announce the Documentation Marathon on OpenFOAM® over winter/spring 2013/14 The goal of this campaign is to launch The CoCoons Project, to get it off the ground and to provide the ideal setting for free high quality documentation on OpenFOAM® Technology. To have a free high quality documentation system for OpenFOAM® is a big vision, and it will require YOUR help to make it happen! Please contribute. The CoCoons Project is a community project: we need your contributions, so don't be afraid to jump in! All high-quality contributions will be published (see CoCoons Project's Partners and CoCoons Project FAQ). And as a must-have for a real Marathon, crossing the finish line in 1st of April 2014 there are rewards waiting for you, of course: Every FOAMer who submits 1000 words of documentation on OpenFOAM®'s utilities, models and solvers wins a CoCoons Project T-Shirt 2500 words of documentation on OpenFOAM®'s utilities, models and solvers wins a CoCoons Project Polo-Shirt sponsored by Engys Ltd. (Eugene de Villiers). Thanks a lot! For more details have a look at www.cocoons-project.org ... Have fun and KEEP FOAMing! best regards, Holger Marschall CoCoons Project contact@cocoons-project.org philippose and wyldckat like this. __________________ Holger Marschall web: http://www.holger-marschall.info mail: holgermarschall@yahoo.de

December 13, 2013, 09:14	Update - Documentation Marathon on OpenFOAM	#4
holger_marschall Senior Member Holger Marschall Join Date: Mar 2009 Location: Darmstadt, Germany Posts: 125 Rep Power: 19	Dear FOAMers, I am happy to inform that the community-driven documentation effort of OpenFOAM® technology The CoCoons Project - Community-driven Documentation on OpenFOAM® Technology www.cocoons-project.org takes quite some momentum: recently, the Documentation Marathon on OpenFOAM® over winter/spring 2013/14 has been started. For more information please read the corresponding post in this thread. Now, the category "Documentation Progress" has been updated. Have a look at Updated section - CoCoons Documentation Progress http://www.cocoons-project.org/documentation-progress All professional contributions shall be published in book form! Consider contributing early and share your expertise! Keep FOAMing! For more information start from the project's FAQ section: Why contribute? How to contribute? CoCoons Project Partners best regards, Holger Marschall CoCoons Project contact@cocoons-project.org __________________ Holger Marschall web: http://www.holger-marschall.info mail: holgermarschall@yahoo.de

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
The FOAM Documentation Project - SHUT-DOWN	holger_marschall	OpenFOAM	242	March 7, 2013 12:30
Doxygen documentation	Tanay	OpenFOAM Installation	9	September 23, 2011 11:40
The FOAM Documentation Project	holger_marschall	OpenFOAM Announcements from Other Sources	0	October 12, 2009 14:16

January 22, 2022, 13:58		#5
Zeppo Senior Member Sergei Join Date: Dec 2009 Posts: 261 Rep Power: 21	The link http://www.cocoons-project.org doesn't seem to work anymore. It looks like the project is dead (unfortunately)