"
Wiki How-To
From 2014.igem.org
|
Wiki Freeze - October 17th (11:59 PM -EDT)
Your team's project must be documented on the iGEM 2014 wiki, the parts used in your project must be documented on the Registry of Standard Biological Parts. You have the freedom to be creative, but a few specific rules apply:
Wiki Dos and Don'ts
| Do | Don't | Why? |
|---|---|---|
| Make sure all wiki content, from pages to files, is hosted on 2014.igem.org | Don't host your wiki or parts of your wiki elsewhere | iGEM content is preserved on our servers so future teams can learn from what you've done. When content is stored on other sites/servers, links may become broken (example), sites may go down, and information will be lost. |
| Work on your wiki throughout the year and save small edits for last | Don't wait to add/edit large portions of wiki content the day of the Wiki Freeze | Just before the Wiki Freeze, iGEM websites experience increased traffic and server loads. This can be a difficult time to make larger changes or additions to your wiki. Don't wait till the last minute! |
| Name uploaded files clearly and uniquely (TeamName_Header.png) | Don't use generic names for you files (Header.png) | Using unique names makes searching/identification of uploaded files easier, and helps prevent files from being overwritten. |
Perspectives from an iGEM veteran
|
Hello iGEMers!
I was also part of an iGEM team! In 2011 and 2012 my role was to design and create our team’s wiki. So wiki freeze was my major deadline. I am by no means an expert but let me share with you some of the things I learned with two wiki freezes under my belt. 1.- Test your webpage layout: is information easy to find? I made the terrible mistake of not asking for a third party’s opinion about the layout of information on our site. It was obvious for me how things were laid out and organized. It wasn’t for the people evaluating us. 2.- Look at other teams’ code, see how they documented and what resources they used. It is always good to get inspiration from other iGEM teams. See what you liked that they did and strive to improve! 3.- Start working on your documentation early on. This was a good thing that we did; we created a common file that more than one person can edit at a time. Divide the documentation into smaller files and assign a team member to fully document that topic. In the end you will have a printable version of your project that you can share as a pdf file with other people! |
4.- Name your images according to the project and keep them all in a folder on your computer. Sometimes naming your gel image “gelthingy_whyiamworkingat3am” sounds perfect at 3AM but later it may not be easy to know what or when that photograph was taken or that image created. 5.- Do not leave everything to the last minute! Plan ahead. The last thing you want to be doing at 11:30PM the night of wiki freeze is uploading images. It is very stressful to be looking at the clock and hoping some kind of coding miracle helps you fix bugs faster. Plan to have everything online at least one week ahead so you can go enjoy a nice dinner with your team that night! I hope this helps and if you have any questions, feel free to email me or send me a tweet! ana at igem dot org@anita_sifuentes |
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 2014 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 2014.igem.org pages. It contains:
- wiki tools (edit, history, watch, etc.)
- login
No Adobe Flash
Flash is not permitted on the iGEM 2014 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 2014.igem.org server
All team pages, images, documents and code must be hosted on the 2014.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.
No iframes
iframes are not permitted to access content outside of 2014.igem.org. Remember, all iGEM content must be hosted on 2014.igem.org!
- an iframe that accesses content outside of 2014.igem.org
- would break when there was an issue with the outside server
- would allow a team to show change/add content after the wiki freeze
2014.igem.org/Team:Team_Name
All iGEM 2014 teams are given a namespace on the iGEM 2014 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 - October 17th
The wiki freeze for the 2014 Giant Jamboree is on October 17th, 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.
Wiki Templates
This year we have created a set of template pages that you may for your wiki!
Feel free to edit them as much as you want
