Team:TU Munich/BeyondTheLab/WikiTutorial

From 2010.igem.org

Revision as of 02:51, 28 October 2010 by Hartlmueller (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Navigation:

Home →  Social Project

iGEM MainPage

Contents


One major task for every iGEM team is the creation of a wiki describing their project. For this reason the MIT is hosting a MediaWiki and every iGEM participant is allowed to create wiki pages on this server. The great advantage of this setup is that no team has to run their own server for hosting their wiki. On the other hand, team members are not allowed to change any MediaWiki settings, such as changing the skin of the wiki or installing extensions. As a part of your "Beyond the Lab" project we want to help other team getting started on their wiki. Therefore we will show how to create a team wiki that is easy to use and can still be customized as desired. Furthermore, we will also explain how to use this wiki even if somebody else of your team created the wiki. After running through this tutorial, you will have a basic framework that can be extended and enhanced later on.
The tutorial will be divided into two parts:

  • Part I describes how to create and setup a team wiki at the first place. This part should be read by members in charge of the layout and design of the wiki and will require basic computer skills. An understanding of HTML and CSS will also be very helpful.
  • Part II focuses on the everyday usage of the wiki create in part I and gibes some general advice how to use the iGEM MediaWiki. All team member that want to contribute to their wiki should read this part.

So the goal of your social project is to give every teams an easier access to the iGEM wiki: Because a wiki should simplify your life and not make you struggle!

Part I: Setup your Wiki

Before creating your own wiki, you should be aware of some aspects that you have to deal with when you create your team wiki. The intention of a wiki is to provide an easy-to-use platform where team member can enter information without having to know any HTML, CSS, etc. Secondly, most teams want to add their own style and design to their wiki. The normal way to customize MediaWiki is by using skins and extensions. As all iGEM teams share you common wiki, this is not possible. Changes done by one team would screw up the wiki of some another team. Summing up, the following text has to goals: Create a wiki that every team member can easily edit. Demonstrate how to customize the look of your wiki.

Create an easy-to-use Wiki

Although team wikis tend to vary, most of them contain two areas. A navigation area is always found as well as a content section. These two sections are the most relevant parts of your wiki since every team member should be capable of adding information or arranging your wiki pages. In this tutorial we will use a straight forward, table-based layout that will be put into practice using an invisible HTML table (see figure). Please note that HTML code within a wiki page has to be marked as such, by surrounding it with an opening "<html>" and a closing "</html>". For a very short introduction on HTML open the up the following "Read more" section.

Read more

HTML (Hypertext Markup Language) is a computer language that tells a browser (e.g. Firefox, Internet Explorer, …) what a webpage is supposed to looks like. In fact, a HTML file comprises plain text and holds instructions, so-called tags, for the browser. Every tag is marked with brackets and has a name that specifies the tag type. The beginning of a tag always contains an opening an a closing bracket (<...>) and the ending of a tag additionally has a forward slash / (</...>). For example, and
tell the browser that there will be a table, whereas all text between

and

will be in one paragraph. Consequently, a complete webpage is build by just stringing together several tags.

It should be noted that every webpage is to be placed between a and a tag. Within this html-tag, there has to be one <head> … </head> that holds some invisible information about the webpage (e.g. the title of the page, the author, fonts and font-sizes, information for search robots such as Google, …). After the head-section, the body-section is declared (<body> … </body>). This is where all visible content of the page is specified (e.g. tables, paragraphs and text, images, flash content, …).

Another important aspect concerning tags are so-called attributes. Attributes represent options that can be applied to certain tags. Attributes are places inside the opening brackets of a tag. For example, ...
set the width of the border of this table to 1 pixel.

In order to learn more about HTML or to just look up some tags or attributes, many tutorials exist on the web. A small collection is available in the [http://en.wikipedia.org/wiki/HTML#External_links Wikipedia reference list].

Close

A The top of the page will contain a header showing a banner representing your team. Underneath will be a horizontal navigation area. Below this area on the left, the large content area will be positioned. To the right of the content will be a narrow vertical range, where you can add optional extras, such as a countdown to the jamboree, a visitor counter or some art work etc.
B HTML code for this table

Another important aspect is how to apply this table layout to the wiki page. In general, a wiki software allows the user to create different pages and to add content to these pages. To view such a wiki page using a browser, the MediaWiki software has to generates the corresponding HTML page every time a page is requested. For this purpose, the MediaWiki software is supplied with a HTML framework holding the typical wiki interface and places the content of the requested page into a container within the HTML framework. So when a wiki page is edited, the only part that is actually changed lies within the container of this HTML framework. It is important to note, that in the case of the iGEM wiki this HTML framework cannot be modified. In other words, the layout and design has to be entered into the textbox on every edit page.
But as the layout and navigation bar is identical for every page, it is useful to have these elements at one central place, rather than copying the same information on every single wiki page. For this purpose MediaWiki can handle so-called templates. These templates are wiki pages themselves and can be included into other wiki page. The import of a template into another wiki page is accomplished by placing the name of the template between and opening "{{:" and a closing "}}", for example {{:Team:xyz/Templates/Layout}} will import the wiki page "Team:xyz/Templates/Layout". When this page is requested by a browser, the MediaWiki software will replace {{:Team:xyz/Templates/Layout}} with the content of the page Team:xyz/Templates/Layout (Please note, that MediaWiki always treats names in a case-sensitive manner). Another handy aspect about templates are so-called parameters that can serve as a placeholder for content. The great advantage araises from the fact, that you can import one template several times but each time you tell MediaWiki to replace the placeholder with another content. A placeholder or parameter is inserted by using "{{{" and "}}}" with the name of the placeholder inbetween. For example, the template page "Team:xyz/Templates/Layout" containing the placeholder "{{{text}}}" can be imported using {{:Team:xyz/Templates/Layout | text=This will be put into the template}}, where the {{{text}}} will be replaced by "This will be put into the template".

By now we already have enough knowledge to implement the basic layout of the wiki. We will use the table layout described above and, to provide an easy-to-use wiki, we will split this table into different template page. The figure summaries the basic structure of the wiki:

Figure illustrating the basic structure of the wiki.
Every box represents a wiki page, whereas the top left page is the main wiki page that holds the content. All other boxes represent template pages, that will imported into each other as indicated. For details see the following text.

Every wiki page first includes the template ".../Templates/Header" which holds the first part of the HTML table. The bottom part of the table is include at the very last line in every wiki page (".../Templates/Footer"). Furthermore the template ".../Templates/Header" includes another template ".../Templates/Navigation" containing the navigation. The navigation itself is build by include multiple times the same template called ".../Templates/Button" where a two parameters are set each time. Looking at the template ".../Templates/Button", it can be seen that the text-parameter will eventually be the text of the link, where as the link-parameter will complete the URL "https://2010.igem.org/Team:xyz" with the page name (e.g. "https://2010.igem.org/Team:xyz" and "/Project" will be merged to "https://2010.igem.org/Team:xyz/Project").

To see what the wiki actually looks like, take a look at this Team:TU_Munich/Social_Project/Demonstration. Please note, that for better visualization the table cells were colored using the bgcolor attribute in the td-tags. Also, the height was adjusted using the height-attribute.

More details about the demonstration

This a list of all page used for the demonstration:

Close



The great advantage that comes with these template pages is that it is much easier to maintain the wiki afterwards. Any member of your team can edit the wiki page without bothering about HTML and the layout of the page. Just let your team members know, that they always have to leave the first and the last line of code on every wiki page since these lines import the templates. Furthermore, with very little effort, the navigation can be changed by editing the page ".../Templates/Navigation".
The extensive use of templates is not only an advangtage to the every day usage, but also in the process of building the wiki. For example, if you want to add a new banner, you just have insert an <img src="..."> tag in the corresponding template and after saving the templates all your wiki pages will contain this new banner.




Another application for templates is the easy integration of special elements such as a "Read more" section. On our wiki we use this technique to give the user a better overview of the page and to find the desired content faster. These toggle boxes use javascript and make use of the external javascript library [http://jquery.com "jQuerry"].

More information about "Read more" sections

The "Read more" boxes are based on displaying and hiding a <div> … </div>. Therefore overtime a box is used, you have to import a template page before and after the text that is supposed to be inside the box.
To setup "Read more" boxes you have to do following steps:

  • Include the following javascript into a template page (e.g. .../Templates/Header): 
<script type="text/javascript" src="http://code.jquery.com/jquery-latest.js"></script>
<script type="text/javascript">
$(document).ready(function(){
	//Hide (Collapse) the toggle containers on load
	$(".toggle_container").hide(); 
	//Switch the "Open" and "Close" state per click then slide up/down (depending on open/close state)
	$("p.trigger").click(function(){
		$(this).toggleClass("activeToggle");
		var nextElem = $(this).next();
		while(nextElem!= null) {
			if(!nextElem.is(".toggle_container")) {
				nextElem = nextElem.next();
			}
			else {
				break;
			}
		}
		if(nextElem.is(".toggle_container")) {
			nextElem.slideToggle("slow");
		}
		return false; //Prevent the browser jump to the link anchor
	});
	$("a.toggle_close").click(function(){
		var nextParent = $(this).parent();
		while(nextParent!= null) {
			if(!nextParent.is(".toggle_container")) {
				nextParent = nextParent.parent();
			}
			else {
				break;
			}
		}
		if(nextParent.is(".toggle_container")) {
			nextParent.slideToggle("slow");
			var prevElem = nextParent.prev();
			while(prevElem!= null) {
				if(!prevElem.is("p.trigger")) {
					prevElem = prevElem.prev();
				}
				else {
					break;
				}
			}
			if(prevElem.is("p.trigger")) {
				prevElem.toggleClass("activeToggle");
			}
		}
		return false; //Prevent the browser jump to the link anchor
	});
 });
</script>
  • Create a template page (e.g. Team:xyz/Templates/ToggleBoxStart) and insert the following code: 
<html>
<p class="trigger"><a class="toggle_text" href="#" style="font-size: 12px; color: #4e9d20">{{{text}}}</a></p>
<div></div>
<div class="toggle_container">
	<div class="block"> <p align="justified">
</html>
  • Create a template page (e.g. Team:xyz/Templates/ToggleBoxEnd) and insert the following code: 
<html></p><a class="toggle_close" href="#" style="font-size: 12px; color: #4e9d20" align="left">Close</a>
	</div>
</div>
<br>
</html>
  • To style your "Read more" sections you can use optional CSS code, that you can include in the CSS section in (.../Templates/Header). To give you an example, this is the CSS code we used to style your toggle boxes: 
p.activeToggle
{
    padding-left: 17px;
    background-image: url('https://static.igem.org/mediawiki/2010/5/56/Team_TU_Munich2010_Images_Arrow_close_small.jpg');
    background-repeat: no-repeat;
    background-position: center left;
}
a.toggle_close
{
    padding-left: 17px;
    background-image: url('https://static.igem.org/mediawiki/2010/5/5d/Team_TU_Munich2010_Images_Cross_small.jpg');
    background-repeat: no-repeat;
    background-position: center left;
    float: left;
    text-align: left;
}
div.toggle_container
{
    border-left: 1px solid #4E9D20;
    padding-left: 7px;
    margin-left: 5px;
    margin-bottom: 25px;
}
Please note, that "a.toggle_close" refers to the close-Button displayed at the bottom of every "Read more" section, "div.toggle_container" refers to the box surrounding the content and "p.activeToggle" contains style instruction that only apply to the text of an open "Read more" section.

The only information that your team mates will need to create a toggle box are the names of the two templates that have to be put before and after the text. A simple toggle could look like this: 

{{:Team:xyz/Templates/ToggleBoxStart | text=Read more}}
This is text will be hidden at the beginning, but can be read if the box is open.
{{:Team:xyz/Templates/ToggleBoxEnd}}

Your wiki is now ready and offers say-so-use "Read more" sections.

Close


Customize and style your wiki

So far be we created the backbone of your wiki by using templates and a table layout. Besides, every teams wants to have their only style. However, in the case of an iGEM team wiki, the normal way of change the look and feel of a wiki does not work. This is due to the fact, that all teams share one big wiki and changes done to the layout will change all other team wikis as well.
The best way of styling your wiki anyway is by using CSS (Cascading Style Sheets). To read more about CSS read the following section.

Read more

CSS ([http://en.wikipedia.org/wiki/Css Cascading Style Sheets]) is a language that is used to describe what elements on a web page are supposed to look like. So a webpage is created using HTML code and can be styled using CSS. The CSS instruction are to be placed between an opening "<style>" and a closing "</style>" in the header of a HTML page or can be directly included in HTML tags using the "style" attribute: 

<html>
   <head>
      <title>CSS example</title>
      ...
      <style type="text/css">
         a {
            color: green;
         }
         a.external {
            color: red;
         }
         #bestImage {
            border: 1px solid green;
            width: 500px;
         }
         .red {
            color: red;
         }
         ...
      </style>
   </head>
   <body>
      <p '''style="color: red;">Just some text</p>
   </body>
</html>

If the style-attribute is used, the CSS instruction will only affect this tag and all its child-tags. In case of the "<style>" block in the header section, two types of information have to be provided: What is to be styled and how is it to be styled.
The first information is provided by so-called selectors. A selector can select an element of the page in many different ways. A selector can generally select all tags of a certain kind (e.g. all <p>-tags). Secondly, a selecotr can select an element that has a certain identifier. An identifier is a unique ID for an element within the webpage and is specified by the attibute "id" (e.g. <img id="bestImage"><nowiki>). Thirdly, a selector can select a subgroup of elements, called class. HTML elements can be grouped into a classes by using the attribute "class" (e.g. <nowiki><img class="goodImages">).
A selector is always placed before the opening bracket "{". In the example above all three types have been used: "a" is a selector that selects all link elements (<a>-tags). "a.external" addresses all links that have been assigned to the group "external" (<a class="external">-tags). "#bestImage" refers to the element that has the ID "bestImage" (e.g. <img id="bestImage">-tag). And finally ".red" selects all tags within the class "red" (e.g. <a class="red">, <p class="red">, <table class="red">).
All style instruction are place inside brakets "{ ... }". They all share a common syntax. and the left side of a colon is a keyword that specifies what property is to be changed, and on the right side is the new value that will be set. An instruction is terminated by a semicolon. There are many different keywords that can set all kinds of properties (colors, borders, dimensions, visibility, text-decoration, etc.). Once you learn more about CSS, you will get to know the most important ones.
Again, there many tutorials about CSS on the web that go far beyond this short introduction. If you want to create a sophisticated wiki, you will definitely have to deal with CSS.

Close

Once you are familiar with CSS, changing the appearance of the wiki is very straight forward. The nice thing about MediaWiki is that nearly every element in the wiki framework (the big banner on the top of the page, the table of content, the title of the page, etc.) has a unique identifier or belongs to a certain class. An identifier is specified using the HTML tag id, whereas an element can be assigned to a class called "title" by using class="title". Consequently, to change the look of a certain element, you have to first get to know the name of the class or the identifier and then use this name to change the appearance using CSS.
To find out the name of the identifier or the class, you can either take a direct look at the source of the page, or you can use a very powerful Firefox extension to easily extract this information. Take a look at the following "read more" section for details about this.

Read more

To use Firebug you have to install the plug-in first. Open up FireFox, go to the Mozilla plug-in webpage, install the plug-in and restart FireFox. As soon as you start FireFox you will notice an icon with a small bug on the very bottom of the FireFox window. Clicking on it will open and close the FireBug screen.
To find out the id or the class of a specific element on the webpage, just right-click on it and in the menu you can choose to inspect this element. The firebug screen will now show the HTML code of this element. Now, you can either look for "id=" or "name=" which will give you a name you can address this element using CSS selectors (see also the following figure).

A typical FireBig screen
After right-clicking on the heading, it can be seen that this heading is assigned to the class "firstHeading" and can thus be styled using an appropriate selector

Close

Once you found out the name, you have to get into CSS. Since the appearance of your wiki is very likely to be the same for all pages, we can make use of our template structure that we created before. As the template ".../Templates/Header" is imported into every wiki page, putting your CSS styling in this template will affect all pages. Just edit the .../Templates/Header page and insert your CSS code: 

<style type="text/css">
    body {
         background-color: white; /* defines the default background color of the document*/
         color: black; /* defines the default font-color of the document*/
    }
    a {
         color: black; /* defines the default color of links */
    }
    a:hover {
         color: gray; /* defines the default color of links hovered by the cursor */
    }
    a {
         color: black; /* defines the default color of links */
    }
    .firstHeading
    {
         display: none; /* hides the default heading */
    }
...
</style>

You can not only modify the framework of MediaWiki, but you can also define classes in your templates and modify them in your global css section. For example, in the button template the link is assigned to the class "button", allowing the modification of all assigned links in your global CSS section. Now, you can also change all the default elements of the iGEM wiki. But please note that changing to much might can also confuse the user. For example, you should leave default buttons such as "Login, search, …". It is also appreciated to provide a link to the iGEM mainpage (http://20xx.igem.org/) in your header section. CSS is a very powerful technique that cannot be explained in this tutorial completely. Learning more about CSS can save a lot of time when customizing your wiki. You might also want to take a look at this page from this year's TU Delft team, where some more iGEM-specific CSS styling is listed. You will also find many tutorials or look-up pages about CSS on the web. And don't forget to take a look at previous teams, they might inspire you or have that piece of code you where looking for...

Congratulations! You made it through the tutorial. Now you are ready to play around with CSS and add some more eye candy in your templates to produce a nice looking wiki. Have fun and don't hesitate to try new things, you can always go back using the MediaWiki history!

Part II: How to use the iGEM MediaWiki

This part will give you a short introduction, how to use the iGEM wiki and will gibe you some advice that will save your time and your nervs. Furthermore it will give some hints, specific to a wiki created according to the above tutorial.

Login in

First of all, you always have to be login into the iGEM wiki before you can change your page. Just click the log in button on the top of this page or any other iGEM page and make sure you have your account set up.

Creating a new wiki page

There are several ways of creating a new page. The easiest way is to type the name of the new page into your browser, for example http://20xx.igem.org/Team:xxx/bane of the page you want to create.. Please note, that all names are treated in a case sensitive manner! After typing in the name, just click "Create" or "Edit" and you can add content to your newly created page. Hit "Save" to save the new page.
Since all iGEM teams share one common wiki, it is important that every page you create is in your namespace. In other words, all pages you create have to have your team name as a prefix. For instance, all page of our wiki are in the namespace "Team:TU_Munich".
One other important aspect is, that at the beginning and at the end of every wiki page, your have to link to so-called template pages that contain all your styling and layout of your wiki. Please ask your team member in charge of the wiki to add these lines to your new page, or take a look at an existing page.

Adding content to a wiki page

Before you start adding a lot of text into the wiki page please make yourself familiar with the Markup language of MediaWiki. MediaWiki offers a very intuitive way to mark headings, pictures, etc. As the Wikipedia is also based on MediaWiki, might already be familiar with these commands. However, you still want to take a look at the [http://en.wikipedia.org/wiki/Help:Wiki_markup Wikipedia help page] or the [http://www.mediawiki.org/wiki/Help:Contents MediaWiki documentation].
MediaWiki features a powerful history. You can undo any changed to a page or any replacement of a file. Make sure you are familiar with this feature.

Uploading files

In case you have to upload a picture or any other file you should be aware of some aspects. To upload a file you can scroll down on any wiki page and click on "upload file". Alternatively you can link to a picture on your page before you even uploaded it. MediaWiki will no show a red link at the corresponding page. Clicking on it will also get you to the upload page.
For security reasons, the iGEM wiki does not accept any type of file. Refer to the upload page to see a list of allowed file extensions. Make sure whether you can upload a file in advance, before you spend time generating files that you cannot send to the iGEM server.
Another iGEM-specific aspect, is that all teams share one common pool to upload pictures and other files. Your team should agree on a prefix that you add to all your filenames. In case you upload a picture named "team.jpg", chances a high that by accident another team will replace your file. Use "OUR_COLLEGE_20xx_team.jpg" instead!

Editing your navigation bar

As the navigation section is the same for all wiki pages, it can be stored at one central page. In case your wiki was created according to this tutorial, the computer expert in your team can give the name of the corresponding page where you can edit the navigation. In this page you will find entries similar to "{{:Team:xxx/Templates/Button | text=Home | link=/}}". Each entry resembles one button or link to a page. Please note, that your team members might have changed the exact spelling. In the above example, you can just add a new button to your navigation by copying a new entry "{{:Team:xxx/Templates/Button | text=Home | link=/}}". Now replace "Home" by the text you want to appear in the button. The target of your button will be specified by "link=". Change "/" to "/Modeling" to link to the page "Modeling" in our namespace.

Using "Read more" sections

With the help of "Read more" sections you can give the user a better overview of the page. Your team member in charge of the wiki can tell you more details. In general, you only have to add two lines to your page to create a "Read more" box:

  • Place "{{:Team:xyz/Templates/ToggleBoxStart | text=Read more}} before the content you want to be inside the box. Note that you can change the text "Read more" to some custom words by change the text after text=
  • Place "{{:Team:xyz/Templates/ToggleBoxEnd}} behind the text that you want to be within the box.

To give you an example, a simple toggle could look something like this: 

{{:Team:xyz/Templates/ToggleBoxStart | text=Read more}}
This is text will be hidden at the beginning, but can be read if the box is open.
{{:Team:xyz/Templates/ToggleBoxEnd}}

Your wiki is now ready and offers say-so-use "Read more" sections.

Close


Retrieved from "http://2010.igem.org/Team:TU_Munich/BeyondTheLab/WikiTutorial"