Editing Help:Manual

Welcome to the ENVRI wiki manual! This page contains instructions for navigating and contributing to the wiki.

'''New to wikis?''' Not to worry! The amount of menus and tabs can seem daunting at first, but once you get the hang of it, you'll find that this way of organising information can be quite powerful. You'll find all the basics below.

__TOC__

=🧭 Navigation=

At its core, every page of a wiki is a normal webpage, and you navigate by clicking links (which look [[:Help:Manual#Navigation|like this]]). Pages contain regular web content: text, images, video, and so on. Here's an example:
* [[Specification report of common test protocols and intercomparison methodologies|Specification report of common test protocols and intercomparison methodologies]]

A [[Thispageshouldnotexist|red link]] means that the page does not (yet) exist on the wiki. We'll talk more about this under "Contributing" below.

If you get lost, you can always return to the '''[[Main Page|Main Page]]''', either by using the first link in the '''navigation bar''' to the left side of your screen, or by clicking the logo to the top right. Also try using the '''search bar''' in the top right corner.

=🗃️ Categories=

Pages have no particular order, so to help sort them they are organised into '''categories'''. Pages can belong to multiple categories, so there are many ways to sort a page. To find which categories a page belongs to, scroll down to the very bottom of that page. (However, note that this page doesn't belong to any category!) You'll find a '''category bar''' showing which categories the page balongs to:

[[File:Categories bar example.png|800px]]

Clicking on any of the blue links will take you to a '''category page''', which lists all the pages and/or sub-categories which belong to that category. These have the "Category:" prefix in their title. Here are a couple of different kinds of category pages:
* [[:Category:Page_Tree]] contains only other categories (in fact, the ones that appear in the navigation bar).
* [[:Category:ENVRIplus|ENVRIplus]] contains both page content (text, images, and tables), sub-categories, and other pages.

Most pages belong to a sub-category of one or more '''top-level categories'''. The top-level categories are: document type, domain, keyword, project, and theme. You can always find these in the navigation bar to the left. Pages usually don't belong directly to top-level categories, but rather to a more specific sub-category. Click the little triangles next to the top-level categories to show their sub-categories. Remember that the [[Main Page|Main Page]] contains a more complete listing of categories, and more space to fold them open!

[[File:Top-level categories example.gif|600px]]

'''That's it!''' With this you should be able to find your way around the wiki. If you feel that you would like more help, don't hesitate to contact us at manager@envri.eu! This manual will also be expanded with time, including images and video material.

=✏️ Contributing=

So you've found an error, or you'd like to contribute some new knowledge to the wiki. Now what?

What makes a wiki different is that anyone can edit the pages – so the good news are that you can get started right away! You can edit the page you're on by using the '''"Edit" tab''' in the top right corner (next to the search bar). You can find all previous edits of a given page under the "View history" tab.

[[File:Search bar and edit controls example.png|550px]]

<div class="mbox">⚠️ Be aware that anonymous edits may be revoked! If you want to contribute more, and in your own name, please contact us and get a permanent user name.</div>

All content is written using so-called '''wikitext'''. For regular body text, simply write. For '''headings''', surround your heading with '=' signs according to its hierarchical depth. <nowiki>=Level 1 heading=, ==Level 2 sub-heading==, ===Level 3 sub-heading===</nowiki>, and so on. Here are some basic text formatting options:

{| class="wikitable"
! scope="col" | 1️⃣ Writing this...
! scope="col" | 2️⃣ ...results in this.
|-
| <nowiki>For ''italic text'', use two single apostrophes.</nowiki>
| For ''italic text'', use two single apostrophes.
|-
| <nowiki>For '''bolded text''', use triple apostrophes.</nowiki>
| For '''bolded text''', use triple apostrophes.
|-
| <nowiki>Here's a link to the [[Main Page]]. Here's a mis-spelled link to the [[main page]].</nowiki>
| Here's a link to the [[Main Page]]. Here's a mis-spelled link to the [[main page]].
|-
| <nowiki>For external links, simply paste the URL: https://www.envri.eu/. For a custom link text, use only a single bracket containing [https://www.envri.eu/ the URL and desired link text].</nowiki>
| For external links, simply paste the URL: https://www.envri.eu/. For a custom link text, use only a single bracket containing [https://www.envri.eu/ the URL and desired link text].
|-
| <nowiki>Use the "ref" tag to generate <ref>automatically numbered</ref> footnotes, which will appear <ref>like this</ref> in the "References" section.</nowiki>
| Use the "ref" tag to generate <ref>automatically numbered</ref> footnotes, which will appear <ref>like this</ref> in the "References" section.
|-
| <nowiki>The "References" section appears wherever the... <references /> ...tag is placed on the page.</nowiki>
| The "References" section appears wherever the <references /> tag is placed on the page.
|-
| <nowiki>* at the start of a new line</nowiki><br /><nowiki>* starts a list.</nowiki><br /><nowiki># Creates a numbered list</nowiki><br /><nowiki># like so.</nowiki>
|
* at the start of a new line
* starts a list.
# Creates a numbered list
# like so.
|}

For '''more options''', you can refer to MediaWiki's own manuals on [https://www.mediawiki.org/wiki/Help:Formatting Formatting] and [https://www.mediawiki.org/wiki/Links Links].

==🏷️ (Re-)categorising pages==

Do you think a page is missing from a category, or has been mis-categorised? Nice catch! You can re-categorise the page changing its '''category tags'''.
# Start by looking inside the top-level categories for a more suitable sub-category.
# Edit the page which you want to (re-)categorise, and look for the category tags. They are generally (but not always) found at the bottom of the page, and look something like this: <nowiki>[Category: Report] [Category: Solid Earth] [Category: ENVRIplus]</nowiki>.
# Delete the wrong categories and add the rights ones. Save your edits.

==🌱 Creating new pages and categories==

So you want to create a completely '''new page''', or perhaps even a completely '''new category?'''

# Write the title of your new page into the search bar. For a category, use the "Category:" prefix, so, eg. "Category:My New Category".
# Click the '''bold, red link''' after "Create the page . . . on this wiki".
# Enter your content, add the correct category tags, and save your edits.
# Done!

[[File:Non-existing page search example.png|500px]]

==📊 Figures and tables==

To insert a '''figure''' into a page:
# First, upload your image file using the [[Special:Upload|"Upload file" special page]], also found in the navigation bar, under "Tools".
# Name and describe your file in a clear and explanatory way. Don't forget to add category tags! There is a [[:Category:Images]], where most images belong.
# On the page where you want to insert the figure, insert the link [[File:Your_full_filename_here]]. For image formatting options, see MediaWiki's manual on [https://www.mediawiki.org/wiki/Help:Images Images].
# Optional: For best practice, use the following syntax (substituting the correct numbers for your particular page):
 <nowiki><div class="figure" id="figure1">
 [[File:ProjectX_D1.1_FirstFigure.jpg]]
 Figure 1: Caption for the first figure in this document.</div></nowiki>
<div class="mbox">💡 This might appear needlessly complex. What is happening here is the following: both the image (<nowiki>inserted using the [[double brackets]]</nowiki>) and its caption (the text below) are put inside a so-called "division" element (<nowiki><div></div></nowiki>). That element is given two features: (i) a ''class'' (div class="figure") which is the same for ''all'' figures across the entire wiki. In other words, the formatting of all figures and captions can be changed easily. For more on this, see "Advanced tips" below. (ii) A unique ''id'' (eg. "figure1") which can be used to link directly to this particular figure from other webpages.</div>

To insert a '''table''' into a page, 1️⃣ use the following syntax:
 <nowiki>{| class="wikitable"</nowiki> ''← start of a table''
 <nowiki>! Header 1</nowiki> ''← column header''
 <nowiki>! Header 2</nowiki> 
 <nowiki>|-</nowiki> ''← new line''
 <nowiki>| Cell 1-L</nowiki> ''← first cell on new line''
 <nowiki>| Cell 1-R</nowiki> ''← second cell on new line''
 <nowiki>|-</nowiki>
 <nowiki>| Cell 2-L</nowiki>
 <nowiki>| Cell 2-R</nowiki>
 <nowiki>|}</nowiki> ''← end of the table''

2️⃣ Resulting in this:

{| class="wikitable"
! Header 1
! Header 2
|-
|Cell 1-L
|Cell 1-R
|-
|Cell 2-L
|Cell 2-R
|}

For a '''more detailed explanation''' of tables, see MediaWiki's manual [https://www.mediawiki.org/wiki/Help:Tables Help:Tables] or Wikipedia's even more extensive manual, [https://en.wikipedia.org/wiki/Help:Table Help:Table].

=🎨 Style guidelines=

Whether you're just editing existing pages or creating new ones, it's good to try and keep the style consistent across the wiki.

==✔️ Do's==

# '''Edit proactively!''' Your expertise and input is valuable for keeping the wiki relevant for the whole community.
# '''Refer to the wiki''' in your own communications, and encourage others to contribute as well.
# '''Keep it simple!''' Try to organise the content mainly using headings, links, and lists. Too much formatting makes the text very hard to follow.
# '''Aim for clarity...''' Optimally, a first-time reader should be able to figure out what it is they are looking at.

==❌ Don'ts==

# '''...but avoid repetition.''' Leave out generic background information, eg. concerning projects, which is available elsewhere on the wiki, and instead use links to point to that information!
# '''Avoid custom categories''' for collecting your own pages. Instead, try to fit your content into the existing content structure.
# '''Don't delete pages carelessly.''' If a page has become obsolete, consider instead adding some information explaining why (and where to get more up-to-date information).

=☝️ Tips for advanced users=

MediaWiki supports regular HTML and CSS markup, but use this sparingly! Avoid <span> tags and inline CSS, and instead familiarize yourself with the classes available in [[MediaWiki:Common.css]].

==🧩 Some common and useful CSS classes==

===mbox and mbox small===

<div class="mbox">💡 A simple, 100 % wide message box. Emojis are a useful addition to indicate the intent of the box. Mainly used to indicate temporary solutions or other things to notice on the page, so avoid mboxes as part of actual page content.</div>

<div class="mbox small">💡 Same as above, but only 50 % wide.</div>

===figure and tablecaption===

<div class="figure">
[[File:Black rectangle.png]]
Example 1: a live example of the "figure" class.</div>

<div class="tablecaption">Example 2: a live example of the "tablecaption" class.</div>
{| class="wikitable"
! Header 1
! Header 2
|-
|Cell 1-L
|Cell 1-R
|-
|Cell 2-L
|Cell 2-R
|}

See the previous section on figures and tables. Edit these to change the look of figures and tables across the wiki.

===navFrame and Infobox===

See the next section on templates. Edit these to change the look of navFrames and infoboxes across the wiki.

==🖇️ Understanding templates==

One of MediaWiki's most useful features is ''[https://www.mediawiki.org/wiki/Transclusion transclusion]'', ie. showing the contents of a page on another page. Generally this is done using '''templates'''. By creating a template with eg. information about a project, and using that template across the wiki, if there is a change in the original information we only need to change a single page – the template. The rest will transclude the new information automatically.

Templates are identified by the '''"Template:" prefix'''. They are transcluded by using a '''template call''' which is the name of the template inside curly braces, like so: <nowiki>{{Template:TemplateName}}</nowiki>.

Here's an example of a template in action:
* The top of the [[:Category:ENVRIplus]] page contains some general information about the ENVRIplus project.
* However, instead of having this information written directly on the page, the page simply contains two template calls to: [[Template:ENVRIplus/short]] and [[Template:ENVRIplus/summary]].
* Consequently, these contents are transcluded unto the category page. If the templates change, so does the information on [[:Category:ENVRIplus]].

Templates can also be called with '''parameters''', resulting in unique results on the page where they are called. Both of the two most common templates in use on the ENVRI wiki, namely [[Template:Infobox]] and [[Template:DocumentMetadata]], use parameters. (See the template pages for an explanation of their purpose and syntax.) In other words, changing the templates can change the look and behaviour of infoboxes and document metadata boxes across the entire wiki, but leave the specifics of each page (infobox titles, the metadata itself, etc.) untouched.

To list all templates on the wiki, you can do [[http://mediawiki.envri.eu/index.php?title=Special%3APrefixIndex&prefix=&namespace=10 a namespace search using Special:PrefixIndex]].

=📖 About this manual=

<div class="mbox">⚠️ Temporary section, likely to be deleted!</div>

Subpage structure:

* Help:Manual: Navigation, Constributing, Contact
** Help:Manual/lighthouses
** Help:Manual/templates
** Help:Manual/guidelines