HydraWiki contribution manual

From HydraWiki
(Redirected from Brief contribution manual)
Jump to: navigation, search

The first step in contributing to the development of HydraWiki is to create a user account. Click on the Create account link on the upper right corner of the HydraWiki website and follow the instructions.

Creating/Editing new pages[edit]

To start writing an article first it is better to search the article title with the search tool, in order to make sure it does not exist. editing an existing article is very straightforward: click the "Edit" link on the right side over the article title.

Please do not forget to add the page into proper categories! (see below).

Easiest way to start a new article[edit]

The easiest way to start an article is to use the search tool. If the page for the searched title doesn't exist (using the search box and "Go" button on the top left corner of the page) then a link will be provided to create the new page. For example, one searches the HydraWiki for "Flow measurement" and there is no page already available, then a new page will be opened with a link to start a page with the searched title (Figure 1).

Figure 1: Start a new page with search tool

Clicking the link will lead to a new page creation window with writing environment(Figure 2). Writing inside the new empty page and saving the content, will create the new page with the searched phrase as its title. One important point is that if one requires to create the page with correct capitalization rule, the searched phrase must be written in the exact required form.

Figure 2: New page creation environment

Main elements of the markup text formatting of the wiki[edit]

Formatting the text in HydraWiki applies the Mediawiki markup language. This consists of normal characters like asterisks, apostrophes or equal signs which have a special function in the wiki, sometimes depending on their position. For example, to format a word in italic, include it in two pairs of apostrophes like ''this''. See the complete formatting documentation of the wiki markup language.

Citing and bibliography[edit]

For citing any reference use the <ref> tag, which allows to create references as footnotes on page. In wiki markup, like HTML, tags deliver special functions. The basic concept of the <ref> tag is that it inserts the text enclosed by the ref tags as a footnote in a designated section for references, which you indicate with the placeholder tag <references/> . for example the following reference element

<ref> reference 1 text body </ref>

is placed after the end of this sentence, which make the citation number and the footnote of the bibliography at the references section of this article [1] .

Multiple citation of the same reference[edit]

To give a reference a unique identifier, use <ref name="name">:

<ref name="name"> reference 2 text body </ref>

You can then refer to the same reference again by using a ref tag with the same name. The text inside the second tag doesn't matter, because the text already exists in the first reference. You can use a terminated empty ref tag that looks like this: <ref name="name" />.

Following is an example. After this sentence we refer to a reference (e.g. reference 2) for the first time [2]. Then, in the second time here, we refer to reference 2 with just using its tag name [2].

Figures[edit]

before adding a figure to an article, the user must usually upload the image file. After uploading the file, the normal syntax for displaying the image in Mediawiki is

[[File:filename.extension|options|caption]]

However, in HydraWiki we have added the CrossReference extension to be able to add figures and referring to them with automatic numbering. To add an image with automatic numbering use the following syntax as an example.

<figure id="fig:figureID"> [[File:example.jpg|thumb|center|400px|'''<xr id="fig:figureID" />''': caption text ]] </figure>

the following image is an example figure with the ID of "ExampleImage":

Figure 3: caption text

to make the above image we used the following sintax:

<figure id="fig:ExampleImage"> [[File:example.jpg|thumb|center|400px|'''<xr id="fig:ExampleImage" />''': caption text ]] </figure>


Refer to an image in the text using the CrossReference <xr> tag with the following example syntax

<xr id="fig:ExampleImage" /> ,

which refers to the example Figure 3.

Multiple figures[edit]

The multiple image template from Wikipedia has been imported to the HydralabWiki, and therefore the capabilities of this feature are available here (see sample image below). To get more information about inserting multiple images with the desired format please take a look at the comprehensive guide of this template.

A 2D LIDAR system
image of a 2D LIDAR.
A trout
image of a 3D LIDAR.
Figure 4: Both images have been rendered with the same height, and a total width of 420px

Mathematical formulae[edit]

Write mathematical formulae with the math tag. the syntax written between the tags is the same as LaTeX. for example writing the following line

<math> E = mc^2 </math>,

results in the following form

,

In Wikipedia the equations are recommended to be indented using one or more colons (:). for example the following

::<math> E = mc^2 </math>

is rendered as

.

Add the page to proper categories[edit]

Management and structuring the articles in Mediawiki is implemented by the concept of categorization, in order to group together pages on similar subjects. Categories allow articles to be placed in one or more groups and allow groups of categories to be further categorized. Therefore, there could be sub-categories and parent categories in a tree-like structure. In order to add a page to a category just Put the category name at the bottom of the page in editing mode as follows.

[[Category:CATEGORY NAME]]

Two important points worth mentioning are:

  • Be sure the category, which the page attributed to, is in the lowest level possible in its category tree.
  • A page can be associated with more than one category.

See also Content Structure in HydraWiki.

See also[edit]

References[edit]

  1. reference 1 citation text
  2. 2.0 2.1 reference 2 citation text