Differences

This shows you the differences between two versions of the page.

--- wiki:conventions [2016/04/08 14:55] – created Yann Pouillon
+++ wiki:conventions [2016/04/08 16:53] (current) – [General conventions] Yann Pouillon
@@ Line 1: / Line 1: @@
 ====== Conventions and formatting ======
-In the following, we will use //italic fonts// to represent build-system components, options, and files, e.g. the //configure// script or the //with_mpi// option. Commands entered by the user will be wrapped in frames and use a fixed-space font, as follows:
+===== General conventions =====
+In this wiki, we use //italic fonts// to represent software components, options, and files, e.g. the //configure// script, the //with_mpi// option, or the //src/21_hashfuncs%%/%%// directory. Commands entered by the user are usually wrapped in frames and use a fixed-space font, as follows:
 <code>../configure --enable-openmp --with-mpi="/usr/local"</code>
-Whenever possible, we will refer to the options of the //configure// script as shell variables, which is the way they appear in the configuration file of Abinit. There, their names contain letters, digits, and underscores. On the command line, all underscores are replaced with dashes and option names are prefixed with 2 dashes. As an example, the option to specify the Fortran compiler vendor appears as //with_fc_vendor// in the configuration file, while it is typed //%%--%%with-fc-vendor// on the command line.
 The //~abinit// keyword represents the top source directory of Abinit wherever it appears.
+<WRAP tip>To be found more easily, tips, tricks, advice, and notes, are written in yellow boxes with a light bulb on their left-hand side.</WRAP>
+<WRAP important>**IMPORTANT** \\ Essential information that you should read with good care is displayed in orange boxes with a warning sign on the left-hand side.</WRAP>
+===== Interactive shell commands =====
+Many examples described on this wiki assume that the user is using a [[wp>Terminal_emulator|terminal]] to interact with Abinit. A terminal is a text window running a [[wp>Shell_(computing)|shell]], which is a program executing commands entered by the user. Please click on the links within this section, look at your operating system documentation, and/or look on internet for "Opening a terminal" if you are not familiar with terminals and shells.
+When describing interactive shell commands, we use the [[wp>Bourne_shell|Bourne Shell]] conventions, since this is the most portable shell available and it is the one used by various components of Abinit. All commands entered by the user start with a dollar sign and a space character -- which should not be typed when you reproduce the examples on your own computer -- and their output is reproduced verbatim just below. In the following example:
+<code>
+$ cat abinit.in
+ecut 12.0
+znucl 1
+acell 1.0 1.0 1.0
+xred 0.0 0.0 0.0
+...
+</code>
+the user types ''%%'%%cat abinit.in%%'%%'' followed by the enter key, which displays the contents of the //abinit.in// file on the console.