FabWIKI quick start guide

This page is meant as a quick start guide for creating new WIKI pages (for documentation or tutorial making).

More help about working with WIKI can be found at | https://www.mediawiki.org/wiki/MediaWiki and you can look at the example Test_page in edit mode

Creating Account
1. To add new pages to the wiki you will need a account. Click on 'create account'.



2. This is the login page. Click on 'request one', and fill in the form.

When done, make sure you confirm the link in your email.



3. When the WIKI administrator confirmed you're request, you will receive a email.

4. First time you login on WIKI you will be requested to replace the standard password with you're own.

Creating a new wiki page
1. To create a new page, first go to the web address bar and change the name from whatever it is at the moment to

wiki.fablab.is/wiki/new_name_of_your_page (and hit enter).



2. If the name does not exist on the wiki, you can now create a new page by clicking on the create button (at the top right side of the screen).

Beware of typo's before committing to a new page.

And do check if the page you want to create doesn't already exist under a different spelling or language.

You can use the 'search' bar for checking that (top right of the screen).



3. After creating the page, you will be redirected to edit mode. Here you can type in the content of the new page.

Adding summary
Before you click on the 'save page' page button (at the bottom of the screen) it is important to fill in the summery.

Write a short one sentence text about what kind of changes you made to the page. So in this case you can write 'inserted tutorial inkscape' or something like that. This summary text will be added to the history documentation of this wiki page. You can view all the changes if you click on the 'view history' button at the top of the page.



Every time you edit and save the page, wiki will keep track of it in the history and show this on the main page of the WIKI.

So before saving first click on the show preview button to check for errors/typo's. When satisfied, than commit by hitting 'save'.

If you only have edited minor stuff (like typing mistakes), please also check mark the 'this is a minor edit' at the bottom of the page.

This helps us keeping the WIKI history records clean and organised.



How to edit a page
If you wish to edit a page, click on the edit button on the top right side of the screen.



Adding category
If you have written a tutorial, copy the tag  [ [ Category : Tutorials ] ]  into your page. Now your tutorial will automatically appear in the tutorial section of the wiki.

Adding multiple tags is possible. Example: make a second tag like  [ [ Category : Circuits ] ]  and it will also appear there.



Adding languages bar
When you have a page in edit mode always start by adding in the language bar.

This looks like: { { Languages | Pagename } }

Wiki assumes that you always start with creating a English wiki page.



If the English page with the language bar already exists and you want to add a translation: You click on the red colored link of the language bar and create a new page from there.



Styling you page
On the edit page there are a few buttons that are helpful when styling you're page. As you get more comfortable with the wiki editor, you can also type the style markers by hand.

Making text bold or cursive
Fist select the text, and then hit the button with the B symbol. There will appear some markers around the text (leave them be).

(To make the text cursive in stead of bold, hit the second button with the slated I.)

After saving the text (or hit the preview button) you will see in the end result with bold text.



Adding headlines
As you can see in many wiki pages, many chapters start with a headlined text.

First select you text, and then click on the big ABold text. Different markers will now appear around the already bold text.

The end result will give you a big bold header, with a nice grey underlining.



Adding a image
There are 2 ways to upload a file. There is the 'upload 1 file option' but you can also upload a batch (useful when making tutorials).

Beware that you don't upload large files (like more than 2MB and give your files good descriptive names.

Upload a single image
1. In the main menu on the left of the screen the is the option 'upload file'.



2. Then select the file you want to upload by clicking on the button.



3. Next is editing the destination file name. (how the file will be named on wiki)

Change it into something descriptive and unique. So don't go uploading stuff with names like img1.jpg or printsceen.jpg etc.

A good descriptive name is: your-page-name_content-img.jpg

example: inkscape-tutorial_prtscn_how-to-make-text-bold.jpg



4. And also add in further description in the summery if necessary. When ready hit the upload file button.



5. When it is done uploading copy your new file name from the address bar.



6. Then open up the page where you want to add the image and go to edit mode.

First move your type cursor to the where you want the new image and click once. Then click on the little picture button.



7. Now replace the standard text by your uploaded file name

In my case this is Example-image.png

(as mentioned earlier, your file name should be more descriptive them my example).



8. When done, hit the save button.

Upload a multiple images (batch)
You can also upload multiple photo's in one go (handy for making tutorials).

In the edit mode you can drag you files in the blue 'drop file here'. Then click link to confirm upload ('click here to upload this file')



After the images are uploaded you can click on the link 'insert on page' button.

Please do remember to use descriptive file names since with this method you can't edit the filename!

Styling image
In edit mode of your page you can extend the description of the file name. This way you can give the image style more options, like alignment or view size.

[ [ File : File.jpg ] ] to use the full version of the file

[ [ File : Example-image.png | 200px | thumb | left | look at this example image ] ]

to re scale your image to 200 pixels wide, in a box on the left side of the page, and with a small text beneath the image within the box.



Renaming your image
1. It can happen that you forget to name your images with a good descriptive name.

To view the recent uploaded images go to 'recent upload' in the menu at the left side of the screen.



2. click on the image you want to rename. Then click on the arrow at the right side of the screen and select 'move' from the dropdown menu.



3. Rename the file, submit a good reason and click on save.



Adding hyperlink
There are 2 way's to make a link.

Link to external website
1. Click on the little globe button.



2. Now replace the example text by text of your own.



Link to page within this WIKI (internal link)
Let say we want to make a link back to http://wiki.fablab.is/wiki/Fab_Lab_Reykjavik

You copy only the pagename: 'Fab_Lab_Reykjavik'

Click on the underlined A button and copy in the pagename between the double brackets.