Getting started with Wiki

From myViewBoard
This is the approved revision of this page, as well as being the most recent.
Jump to navigation Jump to search

Welcome to the help page of our myViewBoard Wiki. This How-to-get-started-guide aims at everyone who's willing to contribute to this Wiki without having any experience with MediaWiki.


Prerequisites to get started

There are two things we need to set up for you in order to get started:

  • User account
  • Two namespaces


User account

If you don't have a user account yet, we will create one and provide username and password for you. After you have logged in for the first time, you can change your password under:
Preferences > User Profile > Password: Change Password.


Two namespaces

Just like we set up your user account we'll also create the namespaces for you.

Each language on wiki requires two namespaces. You can consider a namespace as a folder for pages:

  • Namespace 1
    The main namespace for all your actual pages in your language.
  • Namespace 2
    That's the namespace for your templates. Click here to learn more about Templates.


To navigate to the list of all namespaces:

  1. Click Special pages from the side menu on the left.
  2. Locate the entry All pages.
  3. Under Namespace: click on the little arrow.
  4. A drop-down menu opens with a list of all available namespaces.




How-to-guides

To get the Wiki translated, you need to focus on two things:

  • Pages
  • Templates


Pages

Step 1 - Create a page

reFa8z6MBTU

Step 1 - Create a page


To be able to translate a page, you have to create it within your namespace first. Please follow the steps below to create a page:

  1. Make sure your language is set to English.
  2. Navigate to all pages.
    Special pages > All pages.
  3. Now you can see a list of all available pages in English.
    Don't pay attention to entries written in italics. These are redirects. For the sake of convenience we recommend you to check the Hide redirects checkbox.
  4. Choose page you want to translate and click on it.
    Tip: For the beginning it's easier to choose small pages like Redo, Undo or Title bar.
  5. Now you should see the English version of that page. Click ViewSorce.
  6. Select and copy the whole content to your clipboard.
    Tip: Use a keyboard shortcut: CTRL+A to select everything and CTRL+C to copy it to your clipboard.
  7. Use the language selector at the top the page and choose your language.
  8. Modify the URL: Change it from https://wiki.myviewboard.com/index.php?title=Test_and_Demo&action=edit to https://wiki.myviewboard.com/index.php?title=de:Test_and_Demo&action=edit and press Enter.
    Note: de: is the namespace for German pages. You have to use the namespace for your language!
  9. You should now see an large, empty text field.
  10. Insert the previously copied text.
    Tip: Use a keyboard shortcut: CTRL+V to insert.
  11. Click Save page at the bottom of the page.
    Note: The word Save page is displayed in your language.


Okay! Now you have your page inside of your namespace ready to translate.

Step 2 - Translate a page

Myokn6zqxd8

Step 2 - Translate a page


  1. Make sure your page has already been created.
  2. Make sure you have selected your language from the language selector.
  3. Navigate to all pages.
    Special pages > All pages.
  4. From the dropdown menu select your namespace and click Go.
  5. Select the page you want to edit.
  6. Click Edit.
    Note: The word Edit is displayed in your language.
  7. Start editing/translating. For more information about what you can translate and what better not, click here.
  8. Click Save changes at the bottom of the page.
    Note: The word Save changes is displayed in your language.

Templates

Templates are used to embed the same information in many pages. For example: Instead of typing the same sentence 50 times on 50 different pages, it's a way easier to write it down one-time in a template and embed this template on these 50 pages.

Furthermore, if you want to change this sentence one day, you won't need to touch 50 different page. Just change the sentence one single time in your template and then this new sentence will appear on all 50 pages automatically.


Step 1 - Create a template

Oc_O8LHoZ-M

Step 1 - Create a template


  1. Make sure your language is set to English.
  2. Navigate to all pages.
    Special pages > All pages.
  3. From the dropdown menu select Template and click Go.
  4. Now you can see a list of all available templates in English.
  5. Choose and click on a template you want to translate.
  6. Click View Sorce.
  7. Select and copy the whole content to your clipboard.
    Tip: Use a keyboard shortcut: CTRL+A to select everything and CTRL+C to copy it to your clipboard.
  8. Go back one page, by clicking the "Back-Button" of your browser.
    Now you should see again the English version and the URL should look like https://wiki.myviewboard.com/Template:NameNameName
  9. Modify the URL: Change it to https://wiki.myviewboard.com/det:NameNameName and press Enter.
    Note 1: det: is the namespace for German templates. You have to use the namespace for your language!
    Note 2: Don't change the "NameNameName" part.
  10. Click Create.
    You should now see an large, empty text field.
  11. Insert the previously copied text.
    Tip: Use a keyboard shortcut: CTRL+V to insert.
  12. Click Save page at the bottom of the page.

Step 2 - Translate a template

kxjE8FF8p_A

Step 2 - Translate a template


  1. Make sure your template has already been created.
  2. Make sure your language is set to English.
  3. Navigate to all pages.
    Special pages > All pages.
  4. From the dropdown menu select your template namespace and click Go.
  5. Select the template you want to edit.
  6. Click Edit.
  7. Start editing/translating. For more information about what you can translate and what better not, click here.
  8. Click Save changes at the bottom of the page.



The layout of our Wiki pages

We always aim to keep the myViewBoard Wiki in a consistent and clearly arranged layout. Therefore it's vitally important that you don't design your own layout for your pages in your language. Make sure you always adopt the layout of the particular English page you translate. The best way to ensure this, is to avoid touching anything that looks like HTML code to you. However, as is often the case, the exception proves the rule:

There are a few places you can tamper with:


  • Displaytitle
    At the bottom of every page you can find string called DISPLAYTITLE. It ensures, that the title of a page displays in your language.

    You have to change it as the following example:
    {{DISPLAYTITLE:English title}} change to {{DISPLAYTITLE:Appropriate title in your language}}


  • Linknames
    To link pages among each other, following brackets are used: [ [ and ] ].
    In Read-mode a link is usually displayed in a user-defined name for a better legibility.

    Please refer to the following example to change the displayed linkname:
    [[English_page_name|English]] change to [[de:English_page_name|Your language]]


Note: Don't forget to add your namespace to the new link.


  • Templates
    Many of our Wiki pages include a template. So you need to check every page, whether a template is included or not. In Edit mode scroll down to the bottom of the page and see if you can find something like this: {{Template:PrintTBinstructions}}


If it's on the page, you must update it:
{{Template:PrintTBinstructions}} change to {{det:PrintTBinstructions}}


Note: det is the namespace for German templates. You have to use the namespace for your language.


Another little thing you should keep an eye on is the capitalization of myViewBoard:

Wrong: MyViewBoard, MyViewboard, Myviewboard, myviewboard
Correct: myViewBoard



Special pages

To see summary of all special pages: Click Special pages from the side menu on the left.
A few remarkable special pages are:


Lists all pages available on the wiki created by and other users. To see your pages, select your namespace from the dropdown menu.


Combined display of all available logs of myViewBoard. You can narrow down the view by selecting a log type, the username (case-sensitive), or the affected page (also case-sensitive).


Here you can upload files such as screenshots, .gif files and videos.

YouTube Tutorials