Difference between revisions of "Wiki How-To"
Line 14: | Line 14: | ||
<div id="leftColumn"> | <div id="leftColumn"> | ||
<ul> | <ul> | ||
− | <li><a href= "#requirements>Wiki Requirements</a> </li> | + | <li><a href= "#requirements>Wiki Requirements</a></li> |
− | <li><a href= "#editing">Wiki Editing </a></li> | + | <li><a href= "#editing">Wiki Editing </a> </li> |
</ul> | </ul> | ||
</div> | </div> |
Revision as of 18:24, 28 January 2015
Please note that all information on this page is in a draft version.
Please check back often for details.
Wiki Requirements
iGEM Logo
All iGEM Team Wikis must include the iGEM logo at the top of the page and a visible link back to the iGEM 2015 Wiki Main Page in the header (or at the top of the page). All wiki pages must preserve the user editing menu (notifications, username, messages, history, edit). In the case where the user heading is not visible, an automatic heading will be overlaid on top of the wiki page(s) where the heading is missing.
The iGEM Login Bar
The iGEM Login Bar is a 20 pixel high, full-width menu bar that exists on all 2015.igem.org pages. It contains:
- wiki tools (edit, history, watch, etc.)
- login
No Adobe Flash
Flash is not permitted on the iGEM 2015 wiki. Adobe flash is 100% proprietary and you cannot view the source like you can with our wiki. We chose wikis for teams to build their projects so the source code would be available for future teams, to build on the concept of open source. Flash can also be hosted on external sites and we want 100% of the content of our wikis to be on our wikis.
Upload to 2015.igem.org server
All team pages, images, documents and code must be hosted on the 2015.igem.org server. We preserve all iGEM content on our own servers so future teams can learn from what you have done. When you store content on your own sites or servers, after time, links might become broken, sites might go down, and information will be lost.
Additionally, hosting content outside of 2015.iGEM.org allows teams to change/add information to their wiki after the wiki freeze. Please note, that altering content after the wiki freeze is a form of cheating.
Load your CSS and Javascript into the wiki, either directly into your page or using templates.
No iframes
iframes are not permitted on the iGEM wiki. If an iframe was used to access content outside of 2015.igem.org...
- it would break when there was an issue with the outside server
- it would allow a team to show change/add content after the wiki freeze. Please note, that altering content after the wiki freeze is a form of cheating
2015.igem.org/Team:Team_Name
All iGEM 2015 teams are given a namespace on the iGEM 2015 wiki with their team name. Teams are allowed to create and edit pages within their respective team namespace. Teams are not allowed to create or edit pages belonging to another team's namespace.
Wiki Freeze -September 18
The wiki freeze for the 2015 Giant Jamboree is on September 18, along with other deadlines. iGEM experiences higher than normal traffic on this day which can lead to strain on our servers and sessions timing out for users. iGEM HQ recommends that users do not wait till the last day to work/finish their wikis. Once the wikis are frozen, users can no longer make any changes until they are unfrozen after the Jamboree.
Other deadlines
The team's project description must be documented on their iGEM Team Wiki by the deadline. The project description should be 1-3 paragraphs and only needs to include an up-to-date explanation of the project.
The team's wiki must include an attributions section.
Creative Commons
All content on this wiki is available under the Creative Commons Attribution 4.0 license (or any later version).
Wiki Editing
Add a wiki page, change a wiki page, delete a wiki page, etc.
All iGEM wiki sites are powered by Mediawiki. See the Mediawiki Help page for details on how to edit wiki pages and more.
Using/editing the wiki is a trial-and-error process. Editing the wiki is a simple, fun thing to do and you definitely get better the more you play around with it. The key is to take a look at other wiki pages and see what you like. Then all you have to do is go to the source (either view source if you're not logged in, or edit if you are logged in), copy it, and modify it to fit your needs. It doesn't have to be perfect before you can take a look at what it looks like. Try things out and see what results they yield.
Adding a page to your team's namespace?
You must keep your team's pages in your team namespace. For example, take a look at 2015.igem.org/Team:Example
Specifically, when you create a new page, you just have to name it Team:OFFICIAL team name/PageName. For example, if you were on Team Example and wanted to create a Biosensor project page you would name it Team:Example/Biosensor_project.
Using html in wiki pages
Instead of using wiki markup, you can use html in the wiki editor. Just put your html code in between <html></html>
Using CSS and/or Javascript
You can also use CSS and Javascript on the wiki by adding your <style> and <script> tags into your <html> code.
If you want to use a CSS stylesheet or Javascript on multiple pages, you can create a wiki template page.
Using Wiki Templates
If there is standard text/code that you want to add to more than one page, like a CSS style or script, then you can use MediaWiki templates
You can create a wiki template page to house your HTML/CSS/Javascript, by entering {{Team:YourTeamName/CSS}} into your wiki markup. Saving the page will create a link for a new template page, which you can edit and enter all of your CSS code. You can then call {{Team:YourTeamName/CSS}} on other pages.
Take a look at a few 2013 team wikis to see how other teams setup the styling. You can do this by going to a wiki, and looking for view source in the default wiki links at the top of the page. See MIT's and TU-Munich's for examples.
Uploading videos and using HTML 5 to display them
You can upload videos (ogg, mov) to the 2015 wiki by using Mediawiki's Upload tool.
You can display videos by using the HTML 5 <video> tag, along with <source src="file_url" type="video/mov" />.
Take a look at the 2013 Leed's team wiki to see how they displayed their video. You can do this by going to their wiki, and looking for view source in the default wiki links at the top of the page.