Difference between revisions of "HQ:Code Documentation"

(Created page with "{{2016Demo}} <html> <style> pre {margin: -5px;} </style> <div class="oneColumn"> <h2> Styling </h2> </div> <div class="clear_id" id="Colors"></div> <div class="oneCol...")
(No difference)

Revision as of 18:08, 30 November 2015

Template:2016Demo

Styling

Color palette

Lime green
#e8edaa

Orange
#f27631

Turquoise
#5ba88a

Red
#e9232f

Navy
#4e606e

White
#ffffff

Light gray
#f2f2f2

Medium gray
#d3d3d3

Charcoal
#333333

Black
#000000

Text

To write text


<p> Text  </p>

Links

When creating links

Example


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

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> 

To create a numbered list, use the following example

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>

H titles

   <h2> Title </h2>

H1 Title

Used only on the first title of the page.

H4 Title

Used for red highlight text

H2 Title

Used for the main item titles of the page.

H5 Title

Highlighting text, similar to bold.

H3 Title

Used for subtitles

H6 Title

Not used

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> 

Images

You will need to call the "photo_container" class. Images width for the different layout classes are specified bellow.

 
<div class="twoColumns photo_container">

<img src= "URL" >

</div>

Full width

width = 950 px
height = 300 px (suggested)

Half width

width = 474 px
height = 300 px (suggested)

Third width

width = 315 px
height = 215 px (suggested)

Quarter width

width = 236 px
height = 156 px (suggested)

Classes

Button

When naming a button, please remember to use the style convention and write it in CAPS.

REGISTER NOW!


<a href="URL">
    <div class="button"> 	
        REGISTER NOW!
    </div>
</a>

Why ? pop up

The ? button is used to provide a more detailed explanation

The answer code must be written in: https://2015.igem.org/Why_demo
Make sure you follow the naming convention " why_NAME "
NAME being the title you chose for your ? and its corresponding answer.

Also make sure that "which_why" and div id are the same so the button calls the correct answer.


×

Title

Text



<span class="pop_why" onclick="which_why='why_NAME'">  
?  
</span> 






<div id="why_NAME"> 

<h3>Title </h3> 
<p>Text</p> 

</div> 

Expandable content

Title

Example content

Layout classes

Full width Column

Lorem ipsum dolor sit amet, ubique vivendo his at, eruditi officiis molestiae pro cu, ne per admodum recteque intellegat. Mea id inani nusquam tractatos, ea vei.

Half width Columns

Lorem ipsum dolor sit amet, ubique vivendo his at, eruditi officiis molestiae.

Third width Columns

Lorem ipsum dolor sit amet, ubique vivendo his

Quarter width Columns

Lorem ipsum dolor sit amet, ubique

Full width
<div class="oneColumn"> 
</div> 
Half width
<div class="twoColumns"> 
</div> 
Third width
<div class="threeColumns"> 
</div> 
Quarter width
<div class="fourColumns"> 
</div> 

Styling layout classes

Gray background

This can be used to highlight some text

Lorem ipsum dolor sit amet, duo labitur nostrum consulatu ex. Quo lorem periculis definitionem an, quo no labores definitionem.

 
<div class="threeColumns background_gray"> 

Solid Border

Lorem ipsum dolor sit amet, duo labitur nostrum consulatu ex. Quo lorem periculis definitionem an, quo no labores definitionem.

 
<div class="threeColumns full_border"> 

Dotted Border

Lorem ipsum dolor sit amet, duo labitur nostrum consulatu ex. Quo lorem periculis definitionem an, quo no labores definitionem.

 
<div class="threeColumns dot_border"> 

Alert box

Lorem ipsum dolor sit amet, duo labitur nostrum consulatu ex. Quo lorem periculis definitionem an, quo no labores definitionem.

<div class="twoColumns alert_box">

Highlight

Hover to see !
This can be used to make the whole div highlight and indicate that it is clickable

Lorem ipsum dolor sit amet, duo labitur nostrum consulatu ex. Quo lorem periculis definitionem an, quo no labores definitionem.

<div class="twoColumns  highlight"
onClick=" parent.location= ' URL '">  

Examples

Title

Per ut minim iriure aliquid, eam posse dicunt impetus id. Deleniti reprimique ut vel, consul ignota te eos, his facete equidem pertinacia et. Laoreet detracto scribentur has an, ad vis elitr vituperata. Nec at copiosae consectetuer, regione consulatu ius ne, nec laboramus consectetuer te. Ex homero labores adversarium pri, sanctus assentior vis ea. Postea convenire vituperata nam ne, ius vocibus phaedrum consequat in, scaevola honestatis nec id. Has te verterem constituam, sed omnes fuisset an.
Sea blandit sadipscing reprehendunt et.

Deadlines

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

Register

Per ut minim iriure aliquid, eam posse dicunt impetus id.



REGISTER

Image 1.1 - text

Title

Per ut minim iriure aliquid, ? eam posse dicunt impetus id. Deleniti reprimique ut vel, consul ignota te eos, his facete equidem pertinacia et. Laoreet detracto scribentur has an, ad vis elitr vituperata. Nec at copiosae consectetuer, regione consulatu ius ne, nec laboramus consectetuer te.

Title

Per ut minim iriure aliquid, eam posse dicunt impetus id. Deleniti reprimique ut vel, consul ignota te eos, his facete equidem pertinacia et. Laoreet detracto scribentur has an, ad vis elitr vituperata. Nec at copiosae consectetuer, regione consulatu ius ne, nec laboramus consectetuer te.

Menu

In this example the menu will be created for pages that have "Elements_of_Art" in their name space.

Placing your code

All the menus live in : https://2015.igem.org/Menu/DemoSafety Please be careful to not delete any of the other menus, look for the section where it says "PLACE YOUR MENU HERE" to make sure everything is properly wrapped.

Activating your hub menu

To enable the code to know that your menu exists, you will need to add to the array that holds the list of hub menus

Got to: https://2016.igem.org/HQ_Hub_List and add the following line


hub_list[#] ="Elements_of_Art";                                            (# stands for the next number in the list) 

Naming

All pages that have "Elements_of_Art" under their namespace will have the same menu.

    The name has to be exactly the same in three places:
  • Array with the list of hub menus
    hub_list[4] ="Elements_of_Art";
  • Menu code page
    div id="Elements_of_Art"
  • URLs
    https://2016.igem.org/Elements_of_Art

Addind Section Titles

The Section Title needs to be placed in the h4 tag.

Adding a Page

The first page under it is "Cold Colors".

Listing Page Sections


<div id="Elements_of_Art">  

<div> <a class="switch_Menus">◀</a> </div>  

<a href="URL"> 
<div class="sideMenuTitle">Elements of Art</div> 
</a> 

<div><a class="expand_subMenus"> + </a></div> 

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



<h4> Color</h4> 

<ul> 

<a href="URL"><li>Cold Colors</li></a>



<a href="URL"><li>Warm Colors</a>
<a class="subMenu_toggle">▼</a> 			
		
<div class="subMenu"> 

<ul> 			
<a href="URL"><li>Red</li></a> 
<a href="URL"><li>Orange</li></a> 
<a href="URL"><li>Yellow</li></a> 
</ul> 

</div> 

</li> 

</ul>
      
<div id="Elements_of_Art">  

 <div><a class="switch_Menus"> ◀ </a> </div>  

 <a href=" https://2016.igem.org/Elements_of_Art "> 
   <div class="sideMenuTitle">Elements of Art
   </div> 
 </a> 

 <div><a class="expand_subMenus"> + </a> </div> 

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

 <h4>Color</h4> 

  <ul> 

    <a href="https://2016.igem.org/Elements_of_Art/Color/Cold_Colors "><li>Warm Colors</a> 
     <a class="subMenu_toggle">▼</a> 			
      <div class="subMenu"> 
       <ul> 			
        <a href="https://2016.igem.org/Elements_of_Art/Color/Cold_Colors#Blue"><li>Blue</li></a> 
        <a href="https://2016.igem.org/Elements_of_Art/Color/Cold_Colors#Purple"><li>Purple</li></a> 
        <a href="https://2016.igem.org/Elements_of_Art/Color/Cold_Colors#Green"><li>Green</li></a> 
       </ul> 
      </div> 
    </li> 


    <a href="https://2016.igem.org/Elements_of_Art/Color/Warm_Colors "><li>Warm Colors</a> 
     <a class="subMenu_toggle">▼</a> 			
      <div class="subMenu"> 
       <ul> 			
        <a href="https://2016.igem.org/Elements_of_Art/Color/Warm_Colors#Red"><li>Red</li></a> 
        <a href="https://2016.igem.org/Elements_of_Art/Color/Warm_Colors#Orange"><li>Orange</li></a> 
        <a href="https://2016.igem.org/Elements_of_Art/Color/Warm_Colors#Yellow"><li>Yellow</li></a> 
       </ul> 
      </div> 
    </li> 

  </ul>


 <h4>Line</h4> 

  <ul> 

    <a href="https://2016.igem.org/Elements_of_Art/Line/Direction"><li>Direction</li></a>

    <a href="https://2016.igem.org/Elements_of_Art/Line/Width"><li>Width</li></a>

    <a href="https://2016.igem.org/Elements_of_Art/Line/Length"><li>Length</li></a>

  </ul> 


</div> 

Template:2016Demo bottom