CFD Online Logo CFD Online URL
www.cfd-online.com
[Sponsors]
Home > Forums > OpenFOAM

Feed back on the wiki

Register Blogs Members List Search Today's Posts Mark Forums Read

Like Tree1Likes
  • 1 Post By marupio

Reply
 
LinkBack Thread Tools Display Modes
Old   March 2, 2010, 19:21
Default Feed back on the wiki
  #1
Senior Member
 
David Gaden
Join Date: Apr 2009
Location: Winnipeg, Canada
Posts: 397
Rep Power: 12
marupio is on a distinguished road
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
Noggin likes this.
marupio is offline   Reply With Quote

Old   March 2, 2010, 21:43
Default
  #2
lin
Senior Member
 
Hua Zen
Join Date: Mar 2009
Posts: 114
Rep Power: 8
lin is on a distinguished road
Just have a glance of these. I think they are very useful. Many thanks for your kind work.
lin is offline   Reply With Quote

Old   March 3, 2010, 00:11
Default
  #3
Senior Member
 
Sandeep Menon
Join Date: Mar 2009
Location: Amherst, MA
Posts: 386
Rep Power: 15
deepsterblue will become famous soon enough
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.
__________________
Sandeep Menon
University of Massachusetts Amherst
https://github.com/smenon
deepsterblue is offline   Reply With Quote

Old   March 3, 2010, 03:41
Default
  #4
Senior Member
 
Mark Olesen
Join Date: Mar 2009
Location: http://olesenm.github.io/
Posts: 777
Rep Power: 18
olesen will become famous soon enough
Quote:
Originally Posted by marupio View Post
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!
olesen is offline   Reply With Quote

Old   March 3, 2010, 05:44
Default
  #5
ngj
Senior Member
 
Niels Gjoel Jacobsen
Join Date: Mar 2009
Location: Rotterdam, The Netherlands
Posts: 1,592
Rep Power: 24
ngj will become famous soon enoughngj will become famous soon enough
Excellent work, the use of tmp is much more clear to me now. Thanks
ngj is offline   Reply With Quote

Old   March 3, 2010, 06:14
Default
  #6
Senior Member
 
Mark Olesen
Join Date: Mar 2009
Location: http://olesenm.github.io/
Posts: 777
Rep Power: 18
olesen will become famous soon enough
Quote:
Originally Posted by ngj View Post
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
olesen is offline   Reply With Quote

Old   March 3, 2010, 10:08
Default
  #7
Senior Member
 
Laurence R. McGlashan
Join Date: Mar 2009
Posts: 370
Rep Power: 14
l_r_mcglashan will become famous soon enough
Wow, these are really really good! They've helped me with a few things already.
__________________
Laurence R. McGlashan :: Website
l_r_mcglashan is offline   Reply With Quote

Old   March 3, 2010, 11:18
Default
  #8
Assistant Moderator
 
Bernhard Gschaider
Join Date: Mar 2009
Posts: 3,912
Rep Power: 40
gschaider will become famous soon enoughgschaider will become famous soon enough
Quote:
Originally Posted by olesen View Post
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
gschaider is offline   Reply With Quote

Old   March 3, 2010, 15:44
Default
  #9
Senior Member
 
Holger Marschall
Join Date: Mar 2009
Location: Darmstadt, Germany
Posts: 122
Rep Power: 10
holger_marschall is on a distinguished road
Send a message via Skype™ to holger_marschall
Quote:
Originally Posted by l_r_mcglashan View Post
Wow, these are really really good! They've helped me with a few things already.
Quote:
Originally Posted by ngj View Post
Excellent work, the use of tmp is much more clear to me now. Thanks
Quote:
Originally Posted by olesen View Post
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
__________________
Holger Marschall
web: http://www.holger-marschall.info
mail: holgermarschall@yahoo.de
holger_marschall is offline   Reply With Quote

Old   March 3, 2010, 20:25
Default
  #10
Senior Member
 
David Gaden
Join Date: Apr 2009
Location: Winnipeg, Canada
Posts: 397
Rep Power: 12
marupio is on a distinguished road
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 View Post
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 View Post
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
marupio is offline   Reply With Quote

Old   March 4, 2010, 11:19
Default
  #11
Assistant Moderator
 
Bernhard Gschaider
Join Date: Mar 2009
Posts: 3,912
Rep Power: 40
gschaider will become famous soon enoughgschaider will become famous soon enough
Quote:
Originally Posted by marupio View Post
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 View Post
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 View Post
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 View Post
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 View Post
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
gschaider is offline   Reply With Quote

Old   March 4, 2010, 13:19
Default
  #12
Senior Member
 
Alberto Passalacqua
Join Date: Mar 2009
Location: Ames, Iowa, United States
Posts: 1,894
Rep Power: 26
alberto will become famous soon enoughalberto will become famous soon enough
Quote:
Originally Posted by marupio View Post
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.

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.

Best,
__________________
Alberto Passalacqua

GeekoCFD - A free distribution based on openSUSE 64 bit with CFD tools, including OpenFOAM. Available as live DVD/USB, hard drive image and virtual image.
OpenQBMM - An open-source implementation of quadrature-based moment methods
alberto is offline   Reply With Quote

Reply

Tags
objectregistry, runtime selection, tmp, wiki

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are On


Similar Threads
Thread Thread Starter Forum Replies Last Post
Public Release of the Wiki Jonas Larsson CFD-Wiki 3 November 7, 2005 05:13
Wiki Layout Jonas Larsson CFD-Wiki 3 November 4, 2005 09:54
Wiki copyrights and licenses Jonas Larsson CFD-Wiki 15 October 3, 2005 17:23
CFD Wiki - We Need More Help! Jonas Larsson Main CFD Forum 0 September 26, 2005 08:11
Editors Wanted for a CFD Wiki Jonas Larsson Main CFD Forum 7 September 9, 2005 10:16


All times are GMT -4. The time now is 09:21.