CFD Online Discussion Forums

CFD Online Discussion Forums (
-   CFD-Wiki (
-   -   Reference format (

jasond September 14, 2005 15:45

Reference format

Has a reference format been chosen? I think we need to set a uniform reference/citation format, especially before things have grown too much. I just copied from the Baldwin-Lomax article, but I think the format should be something specified somewhere.


Jonas Larsson September 14, 2005 17:00

Re: Reference format
We haven't really discussed it. I picked the format for the references in the Baldwin-Lomax article. FYI, you can see it here:

In short the format is:

* Order alphabetically after first author

* If you want to number the references use [1] - ( (1) is used for equations)

* Make a bulleted list

* Write author names in bold and as "Firstname1 Lastname1 and Firstname2 Lastname2"

* Write the title in italics and enclose it with ""

* Write the rest of the bibliographic info in normal text like this: Journal, Volume, Number, Pages, Date/Year

What do you think about this?

In any case we should make a template of it so that we can change the format later on. I made one such template. If you click on "edit" on the Baldwin-Lomax page and check the source for the last reference you can see how the template is used.

Another option which I thought a bit about is to make one global reference page for the entire wiki. But I think that this would be a bit difficult to maintain (there is no buildt in support for numbering references etc) and I think I prefer to have the references related to a page/article easily visibile right on that article.

What do you think? Any other suggestions on how to handle and/or format references?

zxaar September 14, 2005 17:08

Re: Reference format
I have a little problem, that how to give reference when i write something based on user documentations , say Fluent documentation. Because, for me major source of learning is fluent doc and i have added RNG k -epsilon model based on it.

Jonas Larsson September 14, 2005 17:28

Re: Reference format
Difficult questions. Let me write what I think about it spontanously.

First, the Wiki is not a research paper where it is mandatory to reference all sources and authors who have worked on the same problem. For the RNG k-epsilon model I would say that a reference to the Fluent manual is a bit questionable. The Fluent manual just repeats what has already been published in other papers. I think that the references we put in the Wiki should be references to the original sources and perhaps a few other references to followup papers or books that are good and provide additional information lacking in the original references.

However, it still has some value to inform readers that, as in the RNG k-eps case, the model formulation comes from the Fluent manual. Who knows, Fluent might have their own twist on this model and then people should be informed about where the formulation comes from. Best is of course if you, or someone else improving the article after you wrote it, could check out the original references. However, if you only have access to the Fluent manual then I'd suggest that you write a short note that the formulation was taken from there, but also include the original papers as references (they are most likely referenced in the Fluent manual).

Any other opinions?

About formatting a reference to a manual. For a manual without any author the template would not work very well. So perhaps you should just write it manually in a similar format (Reference Manual, Fluent 6, Volume ??, Chapter ??, Page ??, Year) where "Reference Manual, Fluent 6" is in bold.

zxaar September 14, 2005 17:38

Re: Reference format
There are some models for which its difficult to find the material, what user manuals do is, they write the model in terse form and most applicable form that is, by reading it user can certianly know how it is solved. Giving a reference to user manual is not bad idea, becuase in anycase we are giving the source of information. i guess it is better,

(Reference Manual, Fluent 6, Volume ??, Chapter ??, Page ??, Year), except for page ,so it could be this,

Reference Manual, FLUNET6.2, "Turbulence Modelling".

Praveen. C September 14, 2005 23:09

Re: Reference format
I agree. But I have one suggestion. It is customary to put textbook titles in italics and paper titles in quotations. Its a nice way to easily distinguish though it is a minor issue.

zxaar September 14, 2005 23:31

Re: Reference format
minor issues are important, like i was completely ignorant of this, i will make the changes where i put the references

Jonas Larsson September 15, 2005 04:49

Re: Reference format
Yea, you're right, so lets agree on that then. I have made two templates with a suggested reference format which you can use according to the following examples:

{{reference-paper|author=Granville, P. S.|year=1987|title=Baldwin-Lomax Factors for Turbulent Boundary Layers in Pressure Gradients|rest=AIAA Journal, Vol. 25, No. 12, pp. 1624-1627}}

{{reference-book|author=Batchelor, G. K.|year=2000|title=An Introduction to Fluid Dynamics|rest=ISBN 0521663962, 1st Edition, Ch. 5.7 Boundary Layers, pp.303}}

Note also that if you include the "ISBN #####" part in the "rest" section then the Wiki automatically hot-links this with pointers to Amazon and a few other online book stores where the book can be purchases - nice.

I have changed the reference in the previous mentioned Baldwin-Lomax article to use these templates, see:

If you all agreee with this suggestion I'll write a short note about it in the guidelines.

Jonas Larsson September 15, 2005 04:50

Re: Reference format
I forgot to say that we also perhaps need a 3rd template for referencing manuals (they usually don't have any author).

Praveen. C September 15, 2005 05:52

Re: Reference format
This is excellent. References can be totally standardized.

Sometimes papers or reports are available online. How would we link to them ? I suppose linking it within the title should work

title=[http://someurl Title of paper]

Jonas Larsson September 15, 2005 06:30

Re: Reference format
Yea, you can just include the link in the text you supply the template with. We can do this in a couple of different ways, either we make the title of the paper be a link as you suggest or we make a small "download" link at the end. I'm not sure what I prefer. For authors who have home-pages we might also hot-link their names.

I made an example of how it could look in the reference to Hrvoje's thesis here:

This example uses a (download) links instead of hot-linking the title. What do you guys prefer?

The danger with external links like this is that they tend to break with time as people re-arrange their homepages or change employers. So it will be tougher to maintain the Wiki. A different approach would be to instead ask for permission from those authors who have their papers online to also upload them to the wiki and link to them locally instead. That would reduce the risk of external links breaking with time.

Jonas Larsson September 15, 2005 06:58

Re: Reference format
I've thought a bit more about this and my suggestion is that if the book or paper is available for download as a pdf or so then we make a (download) link and if the book/paper has a home-page of some sort (in html) then hot-link that to the title. It is nice to be able to see that a link does not point to another web-page but to a pdf document or so.

Any objections, or do you agree?

Praveen. C September 15, 2005 22:55

Re: Reference format
Seems fine to me.

hafizah bte md.malik April 12, 2008 08:42

Re: Reference format
Just tell me how to write reference and also the format

All times are GMT -4. The time now is 16:59.