CFD Online Discussion Forums

CFD Online Discussion Forums (http://www.cfd-online.com/Forums/)
-   OpenFOAM (http://www.cfd-online.com/Forums/openfoam/)
-   -   Feed back on the wiki (http://www.cfd-online.com/Forums/openfoam/73243-feed-back-wiki.html)

marupio March 2, 2010 19:21

Feed back on the wiki
 
I've written a number of 'how it works' articles in the wiki (see below). This is eating considerable amounts of my spare time. In your opinion, should I continue? Is this useful? Does the format work for you? etc.. I appreciate any feedback.

The object registry:
http://openfoamwiki.net/index.php/Snip_objectRegistry

The function of tmp<>:
http://openfoamwiki.net/index.php/Snip_tmp_explained

OpenFOAM's runtime selection mechanism:
http://openfoamwiki.net/index.php/Sn...tion_mechanism

-dave

lin March 2, 2010 21:43

Just have a glance of these. I think they are very useful. Many thanks for your kind work.

deepsterblue March 3, 2010 00:11

I must admit - the articles are very well written. It also captures the essence of the functionality provided by each class that you've described. I'm sure that a lot of folks would find your efforts very useful.
Thanks again.

olesen March 3, 2010 03:41

Quote:

Originally Posted by marupio (Post 248204)
I've written a number of 'how it works' articles in the wiki (see below). This is eating considerable amounts of my spare time. In your opinion, should I continue? Is this useful? Does the format work for you?

Nicely written!
IMO you should add a wiki page listing these content pages and ask Bernhard to link it to the top-level page so that people can find it quickly.

It is indeed amazing how long it does take to write (good) documentation!

ngj March 3, 2010 05:44

Excellent work, the use of tmp is much more clear to me now. Thanks:)

olesen March 3, 2010 06:14

Quote:

Originally Posted by ngj (Post 248282)
Excellent work, the use of tmp is much more clear to me now.

For some situations the Xfer container class can also be a useful means of managing memory for classes, especially for classes without ref counting.
The doxygen description is fairly useful: http://foam.sourceforge.net/doc/Doxy....html#_details

l_r_mcglashan March 3, 2010 10:08

Wow, these are really really good! They've helped me with a few things already.

gschaider March 3, 2010 11:18

Quote:

Originally Posted by olesen (Post 248255)
IMO you should add a wiki page listing these content pages and ask Bernhard to link it to the top-level page so that people can find it quickly.

No problem. What would be the general consensus on a "good, easy to find place"? (because in the past what I considered to be the 'natural' place for some stuff was not where people were looking for it - I'd go for section 4 on the MainPage)
BTW: if someone wants to collect these (or other pages) for offline-reading (not necessarily printing, save a tree) have a look at the "Create Book" option on the left. It makes it quite easy to collect a number of pages into a PDF

Bernhard

holger_marschall March 3, 2010 15:44

Quote:

Originally Posted by l_r_mcglashan (Post 248351)
Wow, these are really really good! They've helped me with a few things already.

Quote:

Originally Posted by ngj (Post 248282)
Excellent work, the use of tmp is much more clear to me now. Thanks

Quote:

Originally Posted by olesen (Post 248255)
Nicely written!
...
It is indeed amazing how long it does take to write (good) documentation!

Hi David,

I really have to assent to the positive feedbacks. Thanks for your effort and the very good documentation!

best regards,
Holger

marupio March 3, 2010 20:25

Thank-you all for the feedback! With all these positive comments, I guess I'll keep posting articles (as time.H allows).

Quote:

Originally Posted by olesen (Post 248255)
Nicely written!
IMO you should add a wiki page listing these content pages and ask Bernhard to link it to the top-level page so that people can find it quickly.

It is indeed amazing how long it does take to write (good) documentation!

Currently these are being collected under the Advanced Guide - Addendum:
http://openfoamwiki.net/index.php/Ma...rGuideAddendum
and linking through the FAQ as well.

Quote:

Originally Posted by gschaider (Post 248374)
No problem. What would be the general consensus on a "good, easy to find place"? (because in the past what I considered to be the 'natural' place for some stuff was not where people were looking for it - I'd go for section 4 on the MainPage)
BTW: if someone wants to collect these (or other pages) for offline-reading (not necessarily printing, save a tree) have a look at the "Create Book" option on the left. It makes it quite easy to collect a number of pages into a PDF

Bernhard

The main page is quite well organized. Section 4 sounds okay to me. Or Section 1, Wiki guide, or something. If there's going to be more of these type of articles, maybe we can start a subspace in the Wiki called "The Real Programmer's Guide" or something like that. But for now I'm okay with keeping them in the Addendum and FAQ. Wait and see?

Should I keep using the 'snip' format? (Will it be easy to move a bunch of these if we choose to?)

Thanks again,
-Dave

gschaider March 4, 2010 11:19

Quote:

Originally Posted by marupio (Post 248445)
Thank-you all for the feedback! With all these positive comments, I guess I'll keep posting articles (as time.H allows).

We're looking forward to it

Quote:

Originally Posted by marupio (Post 248445)
Currently these are being collected under the Advanced Guide - Addendum:
http://openfoamwiki.net/index.php/Ma...rGuideAddendum
and linking through the FAQ as well.



The main page is quite well organized.

Proof to the point. It wasn't designed by me ;)
Quote:

Originally Posted by marupio (Post 248445)
Section 4 sounds okay to me. Or Section 1, Wiki guide, or something.

I guess we'll stick with section 4.
Quote:

Originally Posted by marupio (Post 248445)
If there's going to be more of these type of articles, maybe we can start a subspace in the Wiki called &quot;The Real Programmer's Guide&quot; or something like that.

"The missing Programmer's manual"
Quote:

Originally Posted by marupio (Post 248445)
But for now I'm okay with keeping them in the Addendum and FAQ. Wait and see?

Should I keep using the 'snip' format? (Will it be easy to move a bunch of these if we choose to?)

That would be OK. I was toying with the idea of getting read of all the howto_-prefixes and instead organizing the stuff with Categories (where one would automatically get overview pages) and subpages (wasn't aware of these things when the Wiki was started), but never gotten around to do it (although it would improve the "self-organizhation" of the Wiki)
Bernhard

alberto March 4, 2010 13:19

Quote:

Originally Posted by marupio (Post 248204)
I've written a number of 'how it works' articles in the wiki (see below). This is eating considerable amounts of my spare time. In your opinion, should I continue? Is this useful? Does the format work for you?

In short: yes, yes and yes. Great work. :D

P.S. Just an idea: It might be also useful to keep one (this?) thread on the forum where who adds documentation to the wiki also puts the link to the page there, so to increase the wiki visibility. :cool:

Best,


All times are GMT -4. The time now is 01:45.