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

Naming articles

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

Reply
 
LinkBack Thread Tools Display Modes
Old   December 7, 2005, 07:51
Default Naming articles
  #1
Jonas Larsson
Guest
 
Posts: n/a
About selecting page-names. I noticed that we have some ambigious page-names in the CFD-Wiki now.

Remember that the Wiki in itself does not have any buildt-in structure. We have created some kind of structure in the way we link between pages, but there is no inherent tree-structure in a wiki and any page can link to any other page. This makes it important to name pages so that the name is unique and fully identifies the content.

For example, lets say that we have special page on how to linearise and discretize a source term in a certain turbulence model. At first one might be tempted to just call this page "Source term handling" and link to it from the page describing the turbulence model in questions. However, this is not a unique title - there might be many different source terms in different turbulence models, combustion models or whatever that need special handling. Neither does the title fully describe the content. A better title would be something like "Linearisation and discretization of the turbulent production source term in the SST k-omega turbulence model". With this page-name it would be natural to link to this page from many different places - like for example both from the page describing the turbulence models, from a page about special source-term handling in the numerics section and perhaps also from a page describing a CFD code which uses this special handling. Links to this page can of course be made shorter by using the piped-link functionality to give a different link name that fits better with the page that contains the link.
  Reply With Quote

Reply

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
SnappyHexMesh STL patch naming gregorv OpenFOAM Mesh Utilities 1 July 23, 2008 07:05
Turbulence Section Naming Convention Jonas Larsson CFD-Wiki 5 May 29, 2006 09:45
CFDWiki Articles & Wikipedia Articles TSaad CFD-Wiki 6 April 6, 2006 18:35
File naming convention roncresswell OpenFOAM Installation 3 December 6, 2005 06:01
Naming User Defined Scalars Greg Perkins FLUENT 0 March 7, 2000 00:10


All times are GMT -4. The time now is 03:25.