Wiki guidelines
From Diracwiki
These guidelines are meant to help, not to restrict. They are not definitive and all contributions/changes/improvements/ideas are most welcome.
Contents |
General guidelines
The user manual is for DIRAC developers but also for general users. It should be as simple, fast, and convenient as possible to find the necessary information. Please mark difficult to understand content with {{clarifyme}} (looks like[please clarify]) or {{example}} (looks like[please provide an example]). Such content can later be found automatically through this page.
Try to avoid internal variable names and too formal Fortran format specifications since they may confuse the general user. Try to use explicit examples which can be copy-pasted into the input file and adapted. Be careful with the blank characters in front of the input examples.
Slightly more useful for the developer:
== {{keyword|.PRINT}} ==
Set the print level.
''Arguments:'' Integer IPRLOC
''Default:'' IPRLOC = 1
More useful for the user (favored):
== {{keyword|.PRINT}} ==
Set the print level.
''Default:''
.PRINT
1
We should try to arrange keywords in a logical order. The user should be able to find related keywords either close to each other, or linked to each other.
Mediawiki syntax
A quick way to learn the syntax is to use "perturbation theory". Browse through this wiki or other Mediawiki-based wikis, find a part that looks almost like what you have in mind, click on edit (top of the page or on the right), then copy-paste the source to the new wiki page, adapt, and improve it. See also the Mediawiki user help, the Mediawiki magic words, and the Wikipedia how-to edit.
Formulas
Formulas can be written using a large subset of all TeX and amsmath commands. Tell the wiki that you are writing formulas by enclosing the TeX in math tags, like
<math>f(x) = \int_0^x dx</math>
which renders as 
. Note that you should not enclose your formulas in $$ or \begin{equation}.
File uploads
It is possible to upload files to a global file area of the wiki, and then link these files from particular pages. Files are uploaded through the link in the left hand side toolbox, and can be linked either as images
[[Image:yourimage.png]]
or, for non-image file types, as
[[Media:yourfile.zip]]
NB: All file names have to be unique. This means that you should name your files after the context where they appear. Names such as example.inp are strictly verboten.
Hints and suggestions
- If you use Firefox 2 and prefer to use an external text editor, check out a great tool called It's All Text (see also [1]).
- Server runs on UTC time, update your wiki preferences to set your own time zone.
References
Use the style templates {{article}}, {{book_chapter}}, {{book}}, and {{unpublished}} for references.
Example for an article:
<ref name="Saue:2002:jcomputchem">
{{article
| authors = T. Saue and T. Helgaker
| title = Four-component relativistic Kohn-Sham theory
| journal = J. Comput. Chem.
| volume = 23
| page = 814
| year = 2002
| doi = 10.1002/jcc.10066
}}
</ref>
The tag name="Saue:2002:jcomputchem" makes it possible to use the same reference several times within one wiki page. For a second (third ...) citation within the same page, it would be sufficient to type <ref name="Saue:2002:jcomputchem" /> (mind the closing XML slash character). It is important to provide the DOI to have a working link to the electronic version of the reference. If the DOI is not known (e.g. no electronic version exists), leave the entire doi line out.
Example for a book chapter:
<ref name="visscher:post-dhf">
{{book_chapter
| authors = L. Visscher
| title = Post Dirac-Hartree-Fock methods - Electron Correlation
| editors = P. Schwerdtfeger
| booktitle = Relativistic Electronic Structure Theory - Part 1: Fundamentals
| publisher = Elsevier
| address = Amsterdam
| year = 2002
}}
</ref>
Style templates
Style templates make it easier to have a common layout and to easily change the functionality for a larger number of objects inside the text.
Please use these style templates, improve them, and add new ones (see e.g. this guide).
| how you type it | how it looks |
| {{dirac}} | DIRAC |
| {{dirac04}} | DIRAC04 |
| {{dirac08}} | DIRAC08 |
| {{dalton}} | DALTON |
| {{grasp}} | GRASP |
| {{molfdir}} | MOLFDIR |
| {{relccsd}} | RELCCSD |
| {{lucita}} | LUCITA |
| {{keyword|.KEYWORD}} | .KEYWORD |
| {{unreleased_keyword|.KEYWORD}} | .KEYWORD |
| {{highlight|this}} | this |
| {{pink|INPUT}}{{green|INPUT}}{{blue|INPUT}}{{yellow|INPUT}}{{orange|INPUT}} | INPUTINPUTINPUTINPUTINPUT |
| {{fix_me|obsolete}} | obsolete |
| {{news|2007-02-07|Good news.}} | 2007-02-07 Good news. |
DIRAC amboxes
This section lists various DIRAC ambox (article message box) templates. Feel free to change them and to add new ones. For changing them edit the page and scroll to the bottom of the page.
| how you type it | how it looks | |||
| {{warning_unreleased_material}} |
| |||
| {{advanced_options}} |
| |||
| {{programmers_options}} |
|
Internal and external links
Link to an html page like this [http://www.povray.org/ POV-Ray] or like that [http://www.povray.org/].
Gives: Link to a html page like this POV-Ray or like that [2].
Link to the keyword .LVNEW on the same wiki page like this [[#.LVNEW|.LVNEW]].
Gives: Link to the keyword .LVNEW on the same wiki page like this .LVNEW.
Link to the keyword .EVCCNV on a different wiki page like this [[Manual:WAVE_FUNCTION:DHFCAL#.EVCCNV|.EVCCNV]].
Gives: Link to the keyword .EVCCNV on a different wiki page like this .EVCCNV.
Link to a [[Manual:One-electron operators|different wiki page]] like this.
Gives: Link to a different wiki page like this.
Units
It is not correct to write out units capitalized or pluralised, the correct way is to write: Å, a0, Hz, ångström, bohr, hertz, ... (see for instance [3]).
