Difference between revisions of "Help:Contents"

From Planck Legacy Archive Wiki
Jump to: navigation, search
(Guidelines for development)
Line 5: Line 5:
  
 
== Guidelines for development ==
 
== Guidelines for development ==
 +
In order to keep the development of the wiki under control we would like to ask all contributors to follow a set of very simple guidelines.
 +
 +
*If your contribution can be logically appended to one of the pages already available
 +
*If you find a typo
 +
*If you would like to propose extensive changes to an already existing page that was mostly contributed by somebody else please use the discussion page
 +
 +
Note that as all contributors have access to the entire wiki and therefore the enforcement of the rules aboves depends on all he contributors following them
  
 
== Use of the available extensions ==
 
== Use of the available extensions ==

Revision as of 17:08, 9 January 2012

Organisation of the Explanatory Supplement[edit]

The explanatory supplement is organised in terms of what MediaWiki calls Categories. Using categories provides an automatic mechanism for Index and Table of Contents generation that would otherwise be time consuming and error prone. On top of that, there are a number of extensions based on the category concept, providing a useful set of features for the development, maintenance and use of this Wiki.

Each of the entries in the table of contents in the Main Page is a category. Categories are pages (and for the ES one expects them to be reasonably self contained for the subject they cover) and can independently be added to a Collection. A typical example can be found in the Section: a user interested in frequency maps may or may not be interested in timelines as well but will certainly be interested in understanding the formats the maps are stored, the naming conventions, the size of the maps and will most likely also look for the details of the map making process possibly in the form of papers explaining algorithms. It will therefore make sense for the frequency maps page to contain sections on format, naming conventions, size and references to the map making process. On the other hand, the description of the timelines will most naturally appear under a different page. In order not to end up with a huge number of separate pages, instead of creating a page for frequency maps only we grouped all the map products under a single page which is also a category. After all, it is not entirely unexpected that a user interested in frequency maps may also be interested in other types of maps.

Guidelines for development[edit]

In order to keep the development of the wiki under control we would like to ask all contributors to follow a set of very simple guidelines.

  • If your contribution can be logically appended to one of the pages already available
  • If you find a typo
  • If you would like to propose extensive changes to an already existing page that was mostly contributed by somebody else please use the discussion page
Note that as all contributors have access to the entire wiki and therefore the enforcement of the rules aboves depends on all he contributors following them

Use of the available extensions[edit]

MathJax[edit]

The MathJax extension allows the use of MathJax, a display engine for mathematics providing high quality mathematics fonts. The main interest for the ES lies in its ability to produce high quality display of latex formulae with no need for any extra tags. Equations may simply be written in Latex and MathJax will recognize the Latex Tags.

Simple mathematical expressions can be easily written inline. The following

$x^2 + y^2 +z^2 = 1$

will be displayed by MathJax as $x^2 + y^2 +z^2 = 1$.

We can write complex equations and even make use of \newcommand as illustrated by the following lines.

$
  \newcommand{\Re}{\mathrm{Re}\,}
  \newcommand{\pFq}[5]{{}_{#1}\mathrm{F}_{#2} \left( \genfrac{}{}{0pt}{}{#3}{#4} \bigg| {#5} \right)}
$
\begin{align}
  \label{def:Wns}
  W_n (s)
  &:= 
  \int_{[0, 1]^n} 
    \left| \sum_{k = 1}^n \mathrm{e}^{2 \pi \mathrm{i} \, x_k} \right|^s \mathrm{d}\boldsymbol{x}
\end{align}

\begin{align}
  \label{eq:W3k}
  W_3(k) &= \Re \, \pFq32{\frac12, -\frac k2, -\frac k2}{1, 1}{4}.
\end{align}

MathJax will display these as $

 \newcommand{\Re}{\mathrm{Re}\,}
 \newcommand{\pFq}[5]{{}_{#1}\mathrm{F}_{#2} \left( \genfrac{}{}{0pt}{}{#3}{#4} \bigg| {#5} \right)}

$ \begin{align}

 \label{def:Wns}
 W_n (s)
 &:= 
 \int_{[0, 1]^n} 
   \left| \sum_{k = 1}^n \mathrm{e}^{2 \pi \mathrm{i} \, x_k} \right|^s \mathrm{d}\boldsymbol{x}

\end{align}

\begin{align}

 \label{eq:W3k}
 W_3(k) &= \Re \, \pFq32{\frac12, -\frac k2, -\frac k2}{1, 1}{4}.

\end{align}

We can also refer to equations with a valid \label using the latex \eqref command. The second of the two eqautions above can be referred to with

\eqref{eq:W3k}

resulting in a correct reference to equation \eqref{eq:W3k} above. Note the reference works as a link. Clicking it you will be taken to the equation referred to.

Collection[edit]

The Collection extension allows a user to organise a set of pages as a book that can be converted to pdf. This comes handy for a user that is interested in a few sections of the ES but would rather print only the contents of the sections of interested than the entire ES. The user adds each section of interest to a book using a button on the toolbar. When the selection is complete the generate pdf button is pressed and a pdf version of the selected section, including a table of contents, is generated.

This section is still incomplete waiting for the extension to be installed.

CategoryTree[edit]

Common tasks[edit]

Including figures[edit]

Linking to other pages in the ES[edit]

Linking to external pages[edit]

Uploading documents[edit]

Adding new section[edit]

Explanatory Supplement