Important les règles iGEM pour le wiki sont ici :Competition/Deliverables/Wiki

This page will help you edit and build your team wiki based on the default template given to your team. You will find code examples that you can simply copy and paste on your wiki to create tables, links and images to document your project.

Commencer chaque page par {{Aix-Marseille/top|title=TITRE DE LA PAGE}}

The template is composed of html, css and jquery, you can find the code here: Template:Aix-Marseille/top et l'original Template:Aix-Marseille

Templates are a very useful to avoid repeating the same code or text. The way they are used in the iGEM wiki is that they host the menu and the general css styling for a group of pages. Another good use is to have a banner on your template so it appears on every of your wiki pages

HTML et wikitext

Sur cette page est décrite la syntaxe wikitext principalement, qui permet d'écrire des pages wiki de façon simple !

Et il y a des fonctionnalités très utiles telles que notes de bas de page (pour citer les références!) et un sommaire automatique, je rajouterai un jour sur cette page comment utiliser ces fonctions, pour l'instant ça y est pas ... en attendant voir ici : [1] dans l'aide de wikipédia

Les pages de wikipédia par exemple sont écrites en wikitext, et l'aide de wikipédia pour écrire des pages est très utile, car elle s'applique à 90% pour le wiki iGEM : [2]

Le HTML ou Hypertext Markup Language, est le langage standard pour les pages Web, cette page est en HTML, et il est possible d'éditer le template pour régler la mise en page et l'apparence de façon avancée mais on évitera au plus possible d'utiliser du HTML directement

Colors

The colors used on your template are:


#484848	#635d5d	#928b8b	#c4baba	#ecb656	#f3bd5d	#f8b732	#7acbd8	#5bc7d8

Text

Pour écrire des paragraphes simplement écrire le texte

et sauter une ligne pour un différent paragraphe

en italique et en gras

Pour écrire des paragraphes simplement écrire le texte

et sauter une ligne pour un différent paragraphe

''en italique'' et '''en gras'''

Titles

Vous pouvez écrire des titres en mettant des = autour d'un texte, cela permet d'avoir le petit "edit" pour modifier directement la section, de le rajouter directement à la table des contenus, et de pouvoir faire un lien direct vers la section depuis une autre page (voir #Links)

Title one

Title two

Title three

Title four

Title five

Title six

= Title one =

== Title two ==

=== Title three ===

==== Title four ====

===== Title five =====

======Title six ======

Links

Voici un lien :

Team:Aix-Marseille/Template_Documentation

Avec un texte différent :

Project

Lien vers une sous-section :

Titles

Voici un lien :

[[ Team:Aix-Marseille/Project ]]

Avec un texte différent :

[[ Team:Aix-Marseille/Project | Project ]]

Lien vers une sous-section : [[ Team:Aix-Marseille/Template_Documentation#Titles | Titles ]]

Images

Pour mettre un image il faut d'abord l'envoyer sur les serveurs de l'iGEM ici : Special:Upload

Attention à la licence de l'image, elle doit être sous licence libre type Creative Commons Attribution éventuellement Partage à l'identique !

La syntaxe est identiques aux liens (avec le File: devant)

Voir pour des options pour aligner à gauche, droite, mettre un lien, etc. (attention mettre en anglais Fichier/File, vignette/thumb) ici :[ https://fr.wikipedia.org/wiki/Aide:Ins%C3%A9rer_une_image_(wikicode,_avanc%C3%A9) ]

[[File:T--Aix-Marseille--pcrfail.png]]

Unordered Lists

Use the following example to create a simple list.

Painting materials:

Brushes
Acrylic paint
Watercolors

'''Painting materials:'''

*Brushes

*Acrylic paint

*Watercolors

Numbered Lists

To create an ordered list, use:

Things to buy:

Milk
Eggs
Flour

'''Things to buy:'''

#Milk

#Eggs

#Flour

Nested Lists

Here is an example of a nested list.

Cold Colors
Warm Colors
- Red
- Orange
- Yellow

Here is an example of a nested list.

*Cold Colors

*Warm Colors

**Red

**Orange

**Yellow

Tables

Tables created within in a page already have styling and will display:

légende
Header 1	Header 2	Header 3
row 1, cell 1	row 1, cell 2	row 1, cell 3
row 2, cell 1	row 2, cell 2	row 2, cell 3

{| class="wikitable"

|+ légende

|-

! Header 1

! Header 2

! Header 3

|-

| row 1, cell 1

| row 1, cell 2

| row 1, cell 3

|-

| row 2, cell 1

| row 2, cell 2

| row 2, cell 3

|}

Layout classes

Columns

Layout classes will help structure your page. You will need to call it when you start your page to have the proper layout and make it responsive. There are three types of layout options having three, two or just one column. For one column call the class column full_size and for two columns call column two_thirds_size and for three columns third_size. Here are a few layout options.

Support Classes

Highlight

Highlight will need to be declared inside another layout box, this highlight class will make the background gray and the size will be slightly smaller.

Styling highlight class

There are ways to style the highlight class, you can add:

highlight decoration_background to add a gray background
highlight decoration_A_top to add a blue decorative line on top
highlight decoration_B_top to add a orange decorative line on top
highlight decoration_A_full to add a blue border around the div
highlight decoration_B_full to add a orange border around the div

These classes can be combined to create different effects, as seen in the next examples.

Button

You can use the button class to highlight a link in your wiki.

EXAMPLE BUTTON

<div class="button_link"> [[ #Button | EXAMPLE BUTTON ]] </div>

Clear

This class clears the content, it is basically the same as clicking "enter" when you are writing a text.
If you add the "extra_space" class, it will add extra vertical spacing between your divs.

Adding a direct menu item

To add another a direct (goes straight to the page rather than opening a submenu). Make sure you place the following code inside the class "igem_2018_team_menu". In this example we will link to "Test Direct".

<a href="https://2018.igem.org/Team:Example2/Test_Direct">
< div class="menu_item direct_link">
Test Direct
</div>
</a>

Adding a submenus

To add another menu item that opens up the submenu, use the following code. In this example we will create "Test Submenu" with the subpage "Test Subpage". Remember to make sure you place the your code inside the class "igem_2018_team_menu"

<div class="menu_item">
<div class="submenu_control_icon"> </div>
TEST SUBMENU
</div>

<div class="submenu">

<a href="https://2018.igem.org/Team:Example2/Test_subpage">
<div class="submenu_item">
Test subpage
</div>
</a>

</div>

CSS

CSS will provide styling for your HTML elements, the attributes are ordered alpahabetically in the template and each of them modifies the function and appareance of the class. Here is a list of the most common attributes used in the code.

Take a look at the code and see how each element is defined, if you want change a color for a particular thing, you can modify the hex code for that color or modify the size or anything you need!

size
- width
- height
layout
- position
- margin
- padding
- float
- display
color
- border
- background-color
font
- text-align
- font-weight
- text decoration
- color
other
- list-style-type
- cursor
- -transition

Creating a new class

In this example we are going to create a new class, it is best practice to name your classes with specific names so other code won't override them. The following code shows how to make a class that changes the color of text.

/* highlight with a full orange border decoration */
.igem_2018_team_content .igem_2018_team_column_wrapper .orange_text {
color: #f8b732;
}

<p class="orange_text"> Orange text </p>

Creating a new class under an existing one

In this example we are going to create a new class for an orange background under the highlight class. You will need to follow the precise naming of the classes in the code for it to work correclty when you call it in your html. First declare the two content wrappers: ".igem_2018_team_content .igem_2018_team_column_wrapper" and then specify the highlight class and the name of your new class: ".highlight.orange_background" Next you will find the necessary CSS code and then and example of how to call it on your html.

/* highlight with a full orange border decoration */
.igem_2018_team_content .igem_2018_team_column_wrapper .highlight.orange_background {
background-color: #f8b732;
}

<p class="orange_text"> Orange background </p>

Change the color of an element

This is very simple and easy thing to do. First, you will need to find which element or class you want to modify and then replace the hex code for the color. In the following example we change the color of h1 and h2 to orange.

/* styling for the titles h1 h2 */ .igem_2018_team_content .igem_2018_team_column_wrapper h1, .igem_2018_team_content .igem_2018_team_column_wrapper h2 {
padding:5px 15px;
border-bottom: 0px;
color: #fdeb39;
}

<span style="color:#f8b732;"> This is now orange </span>
<span style="color:red;"> This is now red </span>

This is now orange

This is now red

JQUERY

Jquery makes the menu and other interactive elements in the website work, for example the open and closing of the submenus along with the icon that reflects the state of said submenu. We will not go into depth to talk about the jquery, if you wish to learn more about this you can visit: [3]

@@ Line 5: / Line 5: @@
 This page will help you edit and build your team wiki based on the default template given to your team. You will find code examples that you can simply copy and paste on your wiki to create tables, links and  images to document your project.
+Commencer chaque page par <nowiki>{{Aix-Marseille/top|title=TITRE DE LA PAGE}}</nowiki>
 The template is composed of html, css and jquery,  you can find the code here: [[Template:Aix-Marseille/top]]
@@ Line 12: / Line 14: @@
 Templates are a very useful to avoid repeating the same code or text. The way they are used in the iGEM wiki is that they host the menu and the general css styling for a group of pages.
 Another good use is to have a banner on your template so it appears on every of your wiki pages
 </div>

Difference between revisions of "Team:Aix-Marseille/Template Documentation"

Latest revision as of 19:46, 27 June 2018

Template Documentation for Teams

Contents

HTML et wikitext

Colors

Text

Titles

Title one

Title two

Title three

Title four

Title five

Title six

Links

Images

Unordered Lists

Numbered Lists

Nested Lists

Tables

Layout classes

Columns

Support Classes

Highlight

Styling highlight class

Button

Clear

Adding items to your Menu

Adding a direct menu item

Adding a submenus

CSS

Creating a new class

Creating a new class under an existing one

Change the color of an element

JQUERY