Difference between revisions of "Resources/Template Documentation"

Line 269: Line 269:
 
<div class="column full_size">
 
<div class="column full_size">
 
<h1> Template Documentation for Teams </h1>
 
<h1> Template Documentation for Teams </h1>
−
 
−
<p> This page will help you edit and build your 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. </p>
 
−
 
−
<p> The template is composed of html, css and jquery,  you can find the original code here:
 
−
<a href="https://2019.igem.org/Template:Example2"> Template: Example 2 </a></p>
 
−
 
−
<p>
 
−
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, the general css styling and the javascript code 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 </p>
 
  
  
Line 310: Line 301:
 
<a href="https://2019.igem.org/Resources/Template_Documentation#JQUERY">JQUERY </a>
 
<a href="https://2019.igem.org/Resources/Template_Documentation#JQUERY">JQUERY </a>
 
</p>
 
</p>
−
</div>
 
  
 +
<p> This page will help you edit and build your 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. <br> You can also visit the <a href="https://2019.igem.org/Resources/Wiki_Editing_Help"> Wiki Editing Help</a> page ato find quick links and other resources to help you get started working on your wiki.</p>
  
 +
<p> The template is composed of html, css and jquery,  you can find the original code here:
 +
<a href="https://2019.igem.org/Template:Example2"> Template: Example 2 </a></p>
 +
 +
<p>
 +
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, the general css styling and the javascript code 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, ypu can take a look at previous teams to get some inspiration. </p>
 +
</div>
  
  
Line 323: Line 321:
 
<div class="column full_size">
 
<div class="column full_size">
 
<h2> HTML</h2>
 
<h2> HTML</h2>
−
<p> Hypertext Markup Language, or HTML, is a standardized system for tagging text to create font, color, graphic, and hyperlink styling on websites. Below we will go voer the general tags used to create a standard wiki page</p>
+
<p> Hypertext Markup Language, or HTML, is a standardized system for tagging text to create font, color, graphic, and hyperlink styling on websites. Below we will go over the general tags used to create a standard wiki page.</p>
 
</div>
 
</div>
  
Line 448: Line 446:
 
<div class="column two_thirds_size" >
 
<div class="column two_thirds_size" >
 
<h3> Images </h3>
 
<h3> Images </h3>
−
<p> You can add images to your website by using the img tag, remember all your images must be hosted on the iGEM server. </p>
+
<p> You can add images to your website by using the img tag, remember all your images must be hosted on the iGEM server.  
 +
 
 +
</p>
 
</div>
 
</div>
  
Line 649: Line 649:
 
<div class="column full_size" >
 
<div class="column full_size" >
 
<h3> Columns </h3>
 
<h3> Columns </h3>
−
<p> 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 <b>full_size</b> and for two columns call column <b>two_thirds_size</b> and for three columns <b>third_size</b>. Here are a few layout options. </p>
+
<p> 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 <b>full_size</b> and for two columns call column <b>two_thirds_size</b> and for three columns <b>third_size</b>. Below are a few layout options, we recommend adding a div with the clear class (<a href="https://2019.igem.org/Resources/Template_Documentation#clear">see below</a>) in between rows to ensure rows are separated. </p>
 
</div>
 
</div>
  
Line 739: Line 739:
 
<div class="column two_thirds_size" >
 
<div class="column two_thirds_size" >
 
<h3> Highlight  </h3>
 
<h3> Highlight  </h3>
−
<p> 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. </p>
+
<p> Highlight will need to be declared inside another layout box, this highlight class will add extra padding to the div and can be styled for different effects. </p>
 
</div>
 
</div>
  
Line 935: Line 935:
 
Test subpage<br>
 
Test subpage<br>
 
&#60;/div><br>
 
&#60;/div><br>
−
&#60;/a><br><br>
+
&#60;/a><br>
 
&#60;/div>
 
&#60;/div>
  
Line 1,025: Line 1,025:
 
<p> /* highlight with a full orange border decoration */ <br>
 
<p> /* highlight with a full orange border decoration */ <br>
 
.igem_2019_team_content .igem_2019_team_column_wrapper .orange_text { <br>
 
.igem_2019_team_content .igem_2019_team_column_wrapper .orange_text { <br>
−
     color: #f8b732; <br>
+
     color: #ffb819; <br>
 
}
 
}
 
</p>
 
</p>
Line 1,032: Line 1,032:
  
 
<div class="column third_size">
 
<div class="column third_size">
−
<div class="highlight" style="color:#f8b732;">
+
<div class="highlight" style="color:#ffb819;">
  
 
<p>
 
<p>
−
&#60;p class="orange_text"> Orange text &#60;/p>
+
&#60;p class="orange_text"> <span style="color:#ffb819;">Orange text</span> &#60;/p>
 
</p>
 
</p>
  
Line 1,059: Line 1,059:
 
<p> /* highlight with a full orange border decoration */ <br>
 
<p> /* highlight with a full orange border decoration */ <br>
 
.igem_2019_team_content .igem_2019_team_column_wrapper .highlight.orange_background { <br>
 
.igem_2019_team_content .igem_2019_team_column_wrapper .highlight.orange_background { <br>
−
     background-color: #f8b732; <br>
+
     background-color: #ffb819; <br>
 
}
 
}
 
</p>
 
</p>
Line 1,066: Line 1,066:
  
 
<div class="column third_size">
 
<div class="column third_size">
−
<div class="highlight">
+
<div class="highlight" style="background-color:#ffb819;">
  
 
<p>
 
<p>
−
&#60;p class="orange_text"> Orange background &#60;/p>
+
&#60;p class="orange_text"> Example of an orange background &#60;/p>
 
</p>
 
</p>
  
Line 1,098: Line 1,098:
 
padding:5px 15px; <br>
 
padding:5px 15px; <br>
 
border-bottom: 0px;  <br>
 
border-bottom: 0px;  <br>
−
color: #fdeb39;<br>
+
color: #ffb819;<br>
 
}
 
}
 
</p>
 
</p>
Line 1,116: Line 1,116:
  
  
−
<h1 style="color:#f8b732;"> This is now orange </h1>
+
<h1 style="color:#ffb819;"> This is now orange </h1>
  
−
<h2 style="color:#f8b732;"> This is now orange </h2>
+
<h2 style="color:#ffb819;"> This is now orange </h2>
  
 
</div>
 
</div>

Revision as of 15:29, 27 February 2019

Loading...

Template Documentation for Teams

On this page you will find:
HTML : Colors , Text , Titles , Links , Images , Unordered list , Ordered list , Nested list , and Tables .
Layout Classes , Support Classes : Highlight , Styling highlight class , Button , Clear .
Menu: Adding a menu item , Adding a submenu .
CSS : Creating a new class , Creating a new class under an existing one , Changing the color of an element .
JQUERY

This page will help you edit and build your 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.
You can also visit the Wiki Editing Help page ato find quick links and other resources to help you get started working on your wiki.

The template is composed of html, css and jquery, you can find the original code here: Template: Example 2

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, the general css styling and the javascript code 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, ypu can take a look at previous teams to get some inspiration.

HTML

Hypertext Markup Language, or HTML, is a standardized system for tagging text to create font, color, graphic, and hyperlink styling on websites. Below we will go over the general tags used to create a standard wiki page.

Colors

The colors used on your template are:

#635d5d #484848 #00a19b #085156 #cecece #ececec #ffb819

Text

To write text use the < p > tag

<p> Text </p>

Titles

You can add title using the h tag, here is how the different sizes look:

Title one

Title two

Title three

Title four

Title five
Title six

<h1>Title one </h1>
<h2>Title two </h2>
<h3>Title three </h3>
<h4>Title four </h4>
<h5>Title five </h5>
<h6>Title six </h6>

Links

When creating links use the < a > tag, links will display : Example Link

<a href="link url "> LINK </a>

Images

You can add images to your website by using the img tag, remember all your images must be hosted on the iGEM server.

<img src="image URL ">

Unordered Lists

Use the following example to create a simple list.
Painting materials:

  • Brushes
  • Acrylic paint
  • Watercolors

<b>Painting Materials</b>
<ul>
<li> Brushes </li>
<li> Acrylic paint </li>
<li> Watercolors </li>
</ul>

Numbered Lists

To create an ordered list, use:
Things to buy:

  1. Milk
  2. Eggs
  3. Flour

<b>Things to buy: </b>
<ol>
<li> Milk </li>
<li> Eggs </li>
<li> Flour </li>
</ol>

Nested Lists

Here is an example of a nested list.

  • Cold Colors
  • Warm Colors
    1. Red
    2. Orange
    3. Yellow

<ul>
<li> Cold Colors </li>
<li> Warm Colors
<ol>
<li> Red </li>
<li> Orange </li>
<li> Yellow </li>
</ol>
</li>
</ul>

Tables

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

Header 1 Header 2
Content A 1 Content B 1
Content A 2 Content B 2

<table>
<tr>
<th> Header 1 </th> <th> Header 2 </th>
</tr>
<tr>
<td> Content A 1 </td> <td> Content B 1 </td>
</tr>
<tr>
<td> Content A 2 </td> <td> Content B 2 </td>
</tr>
</table>

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. Below are a few layout options, we recommend adding a div with the clear class (see below) in between rows to ensure rows are separated.

<div class="column full_size" >
</div>

<div class="column two_thirds_size" >
</div>

<div class="column third_size" >
</div>

<div class="column third_size" >
</div>

<div class="column third_size" >
</div>

<div class="column third_size" >
</div>

Support Classes

Highlight

Highlight will need to be declared inside another layout box, this highlight class will add extra padding to the div and can be styled for different effects.

<div class="column half_size" >
<div class="highlight">

</div>
</div>

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.

<div class="column third_size" >
<div class="highlight decoration_background decoration_A_top">

</div>
</div>

<div class="column third_size" >
<div class="highlight decoration_B_full">

</div>
</div>

<div class="column third_size" >
<div class="highlight decoration_background decoration_A_full">

</div>
</div>

Button

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

EXAMPLE BUTTON

<div class="button_link"> <a href="URL"> EXAMPLE BUTTON </a> </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.

<div class="clear extra_space"> </div>

Adding items to your Menu

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_2019_team_menu". In this example we will link to "Test Direct".

<a href="https://2019.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_2019_team_menu"

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

<div class="submenu">
<a href="https://2019.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_2019_team_content .igem_2019_team_column_wrapper .orange_text {
color: #ffb819;
}

<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_2019_team_content .igem_2019_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_2019_team_content .igem_2019_team_column_wrapper .highlight.orange_background {
background-color: #ffb819;
}

<p class="orange_text"> Example of an 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_2019_team_content .igem_2019_team_column_wrapper h1, .igem_2019_team_content .igem_2019_team_column_wrapper h2 {
padding:5px 15px;
border-bottom: 0px;
color: #ffb819;
}

<h1> This is now orange </h1>
<h2> This is now orange </h2>

This is now orange

This is now orange

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: https://learn.jquery.com/