Difference between revisions of "Resources/Template Documentation"

 
Line 343: Line 343:
 
<div class="clear extra_space"></div>
 
<div class="clear extra_space"></div>
 
<div class="line_divider"></div>
 
<div class="line_divider"></div>
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space" id="HTML"></div>
  
 
<div class="column full_size">
 
<div class="column full_size">
−
<h2 id="HTML"> 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 voer the general tags used to create a standard wiki page</p>
 
</div>
 
</div>
  
  
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space" id="colors"></div>
  
 
<div class="column full_size">
 
<div class="column full_size">
−
<h3 id="colors"> Colors </h3>
+
<h3> Colors </h3>
 
<p> The colors used on your template are: </p>
 
<p> The colors used on your template are: </p>
  
Line 394: Line 394:
  
  
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space" id="text"></div>
  
  
  
−
<div class="column two_thirds_size" id="text">
+
<div class="column two_thirds_size">
 
<h3> Text </h3>
 
<h3> Text </h3>
 
<p> To write text use the < p > tag </p>  
 
<p> To write text use the < p > tag </p>  
Line 413: Line 413:
  
  
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space" id="titles"></div>
  
  
  
−
<div class="column two_thirds_size" id="titles">
+
<div class="column two_thirds_size">
 
<h3> Titles </h3>
 
<h3> Titles </h3>
 
<p> You can add title using the  h tag, here is how the different sizes look:</p>
 
<p> You can add title using the  h tag, here is how the different sizes look:</p>
Line 449: Line 449:
  
  
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space"  id="links"></div>
  
  
  
−
<div class="column two_thirds_size" id="links">
+
<div class="column two_thirds_size">
 
<h3> Links </h3>
 
<h3> Links </h3>
 
<p> When creating links use the < a > tag, links will display : <a href =" "> Example Link </a>  </p>
 
<p> When creating links use the < a > tag, links will display : <a href =" "> Example Link </a>  </p>
Line 469: Line 469:
  
  
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space" id="images"></div>
  
  
  
−
<div class="column two_thirds_size" id="images">
+
<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>
Line 490: Line 490:
  
  
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space" id="unordered_list"></div>
  
  
  
−
<div class="column two_thirds_size" id="unordered_list">
+
<div class="column two_thirds_size" >
 
<h3> Unordered Lists </h3>
 
<h3> Unordered Lists </h3>
 
<p>Use the following example to create a simple list.  <br> <b> Painting materials: </b></p>
 
<p>Use the following example to create a simple list.  <br> <b> Painting materials: </b></p>
Line 526: Line 526:
  
  
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space" id="ordered_list"></div>
  
  
  
−
<div class="column two_thirds_size" id="ordered_list">
+
<div class="column two_thirds_size" >
 
<h3> Numbered Lists </h3>
 
<h3> Numbered Lists </h3>
 
<p>To create an ordered list, use:  <br>  
 
<p>To create an ordered list, use:  <br>  
Line 562: Line 562:
  
  
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space"  id="nested_list"></div>
  
  
  
  
−
<div class="column two_thirds_size" id="nested_list">
+
<div class="column two_thirds_size">
 
<h3> Nested  Lists </h3>
 
<h3> Nested  Lists </h3>
 
<p> Here is an example of a nested list. </p>
 
<p> Here is an example of a nested list. </p>
Line 608: Line 608:
  
  
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space" id="table"></div>
  
  
Line 614: Line 614:
  
  
−
<div class="column two_thirds_size" id="table">
+
<div class="column two_thirds_size">
  
 
<h3> Tables</h3>
 
<h3> Tables</h3>
Line 665: Line 665:
 
<div class="clear extra_space"></div>
 
<div class="clear extra_space"></div>
 
<div class="line_divider"></div>
 
<div class="line_divider"></div>
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space" id="layout_classes"></div>
  
  
  
  
−
<div class="column full_size" id="layout_classes">
+
<div class="column full_size" >
 
<h2>Layout classes</h2>
 
<h2>Layout classes</h2>
 
</div>
 
</div>
−
 
+
<div class="clear" id="columns"></div>
−
<div class="column full_size" id="columns">
+
<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>. Here are a few layout options. </p>
Line 754: Line 754:
 
<div class="clear extra_space"></div>
 
<div class="clear extra_space"></div>
 
<div class="line_divider"></div>
 
<div class="line_divider"></div>
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space" id="support_classes"></div>
  
  
  
  
−
<div class="column full_size" id="support_classes">
+
<div class="column full_size">
 
<h2> Support Classes </h2>
 
<h2> Support Classes </h2>
 +
</div>
 +
<div class="clear"  id="highlight"></div>
  
−
 
+
<div class="column two_thirds_size" >
−
<div class="column two_thirds_size"  id="highlight">
+
 
<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 make the background gray and the size will be slightly smaller. </p>
Line 782: Line 783:
  
  
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space" id="styling_highlight"></div>
  
  
  
  
−
<div class="column full_size" id="styling_highlight">
+
<div class="column full_size" >
 
<h3> Styling highlight class</h3>
 
<h3> Styling highlight class</h3>
 
<p> There are ways to style  the highlight class, you can add:</p>
 
<p> There are ways to style  the highlight class, you can add:</p>
Line 853: Line 854:
 
<div class="clear extra_space"></div>
 
<div class="clear extra_space"></div>
 
<div class="line_divider"></div>
 
<div class="line_divider"></div>
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space"  id="button"></div>
  
  
Line 860: Line 861:
 
 
  
−
<div class="column two_thirds_size" id="button">
+
<div class="column two_thirds_size">
 
<h3>Button </h3>
 
<h3>Button </h3>
 
<p> You can use the button class to highlight a link in your wiki. </p>
 
<p> You can use the button class to highlight a link in your wiki. </p>
Line 882: Line 883:
  
  
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space"  id="clear"></div>
  
  
−
<div class="column two_thirds_size" id="clear">
+
<div class="column two_thirds_size">
 
<h3> Clear  </h3>
 
<h3> Clear  </h3>
 
<p> This class clears the content, it is basically the same as clicking "enter" when you are writing a text.  <br>
 
<p> This class clears the content, it is basically the same as clicking "enter" when you are writing a text.  <br>
Line 908: Line 909:
 
<div class="clear extra_space"></div>
 
<div class="clear extra_space"></div>
 
<div class="line_divider"></div>
 
<div class="line_divider"></div>
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space"  id="menu"></div>
  
  
  
 
 
−
<div class="column full_size" id="menu">
+
<div class="column full_size">
 
<h2> Adding items to your Menu </h2>
 
<h2> Adding items to your Menu </h2>
 
</div>
 
</div>
 +
<div class="clear" id="adding_submenu"></div>
  
−
 
+
<div class="column third_size" >
−
<div class="column third_size" id="adding_submenu">
+
 
<h3> Adding a direct menu item</h3>
 
<h3> Adding a direct menu item</h3>
 
<p> 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". </p>
 
<p> 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". </p>
Line 936: Line 937:
 
</div>
 
</div>
  
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space" id="adding_submenu_menu"></div>
  
  
Line 942: Line 943:
  
  
−
<div class="column third_size" id="adding_submenu_menu">
+
<div class="column third_size">
 
<h3> Adding a submenus </h3>
 
<h3> Adding a submenus </h3>
 
<p> 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"</p>
 
<p> 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"</p>
Line 1,032: Line 1,033:
  
 
<div class="clear extra_space"></div>
 
<div class="clear extra_space"></div>
−
<div class="line_divider"></div>
+
<div class="line_divider" id="new_class"></div>
 
<div class="clear extra_space"></div>
 
<div class="clear extra_space"></div>
  
Line 1,038: Line 1,039:
  
  
−
<div class="column third_size" id="new_class">
+
<div class="column third_size">
 
<h3> Creating a new class </h3>
 
<h3> Creating a new class </h3>
 
<p> 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.
 
<p> 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.
Line 1,071: Line 1,072:
  
  
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space" id="new_class_under"></div>
  
−
<div class="column third_size" id="new_class_under">
+
<div class="column third_size">
 
<h3> Creating a new class under an existing one </h3>
 
<h3> Creating a new class under an existing one </h3>
 
<p> 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"
 
<p> 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"
Line 1,105: Line 1,106:
  
  
−
<div class="clear extra_space"></div>
+
<div class="clear extra_space" id="changing_color"></div>
  
  
Line 1,111: Line 1,112:
  
  
−
<div class="column third_size" id="changing_color">
+
<div class="column third_size">
 
<h3> Change the color of an element </h3>
 
<h3> Change the color of an element </h3>
 
<p>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.
 
<p>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.

Revision as of 20:12, 8 January 2019

Loading...

Template Documentation for Teams

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.

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 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

On this page

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 voer the general tags used to create a standard wiki page

Colors

The colors used on your template are:

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

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. Here are a few layout options.

<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 make the background gray and the size will be slightly smaller.

<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: #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_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: #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_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: #fdeb39;
}

<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/