Team:UCL/FAQ/WikiDesign
From 2014.igem.org
(42 intermediate revisions not shown) | |||
Line 5: | Line 5: | ||
<a data-tip="true" class="top large" data-tip-content="TOOLTIP TEXT" href="javascript:void(0)"><b>VISIBLE TEXT</b></a> | <a data-tip="true" class="top large" data-tip-content="TOOLTIP TEXT" href="javascript:void(0)"><b>VISIBLE TEXT</b></a> | ||
---> | ---> | ||
- | |||
<div id="bodyContent"> | <div id="bodyContent"> | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
<div id="TopGapO"></div> | <div id="TopGapO"></div> | ||
- | |||
<div id="BPimagewrapperHeader"> | <div id="BPimagewrapperHeader"> | ||
- | <img src="https://static.igem.org/mediawiki/2014/ | + | <img src="https://static.igem.org/mediawiki/2014/e/e2/UCLOwiki_how_to_Bannero-27.jpg" width="100%" height="100%" alt="About Our Project" /> |
</div> | </div> | ||
- | |||
<div class="textArena"> | <div class="textArena"> | ||
+ | <div class="SCJHIGHLIGHT" data-step="1" data-position='top' data-intro="Let's find out what this whole page is about!"> | ||
+ | <p><a data-tip="true" class="top large" data-tip-content="This is our web & communications team logo!" href="javascript:void(0)" style="width: 18%;float: right;margin-left:2%"><img src="https://static.igem.org/mediawiki/2014/6/6a/UCLTeam_Icons-05.png" style="max-width: 100%;"></a>Every iGEM team must produce a wiki to upload and present their work. When it comes to building your wiki, it helps to have some members with <a data-tip="true" class="top large" data-tip-content="Or at least members with an interest." href="javascript:void(0)"><b>experience</b></a> in <a data-tip="true" class="top large" data-tip-content="At least familiarity with HTML and CSS." href="javascript:void(0)"><b>web design</b></a>.<br><br>If you haven't had the chance to familiarise yourself with these basic aspects of web design, <a data-tip="true" class="top large" data-tip-content="Its worthwhile to start experimenting and learning the ropes." href="http://www.w3schools.com/"><b>w3schools</b></a> offers a good <a data-tip="true" class="top large" data-tip-content="Whilst they may not explain things in too much detail, its a healthy start for you to begin editing bits of code." href="javascript:void(0)"><b>beginners platform</b></a> to web design. Sooner or later, you'll be able to recognise whats going on.<br><br> | ||
+ | In the first section, I'll explain the basics of making a website. If you're looking to learn about wiki building approaches, read the second section. The third section explores the design process of our UCL iGEM 2014 wiki, and the fourth section explains a little about the basics of building your very own iGEM team wiki.</p> | ||
+ | </div> | ||
+ | <br> | ||
+ | <!-------- This is the beginning of the expanding box--------> | ||
+ | <div class="collapse-card" data-step="2" data-position='top' data-intro="I'm not a web design expert myself (I started learning web design whilst using Tumblr, back in 2009; I would experiment with the different themes and whatnot), so I'll explain it all in simple terms that I would have been able to understand back when I was learning."><div class="title"> | ||
+ | <i class="fa fa-question-circle fa-2x fa-fw"></i><strong> | ||
+ | <!--- Title start ---> | ||
+ | How can I make a website? | ||
+ | <!--- Title end ---> | ||
+ | </strong></div><div class="body"> | ||
+ | <!--- Content start---> | ||
+ | Firstly, the bread and butter: <a data-tip="true" class="top large" data-tip-content="These two languages work together to create the basic design of a website." href="javascript:void(0)"><b>HTML and CSS</b></a>. HTML is the backbone of your website, and CSS is the design and styling. | ||
+ | <br><br> | ||
+ | <div class="SCJHIGHLIGHT"><p> | ||
+ | Of course, I'm really really simplifying this; so if you really want to learn more, I suggest checking out mozilla developer, codecademy and w3schools. | ||
+ | <br><br> | ||
+ | I suggest you get on Tumblr and start playing around with the themes and learn the ropes there. In web design as a beginner, you just need to <a data-tip="true" class="top large" data-tip-content="Google how to do it, and follow the instructions." href="javascript:void(0)"><b>imagine what you want</b></a>. The community of web developers is perhaps one of the most helpful online communities out there, it's just a matter of trial and error. | ||
+ | </p></div><br> | ||
+ | Now, if you're familiar with HTML and CSS; let's delve a bit deeper into web design concepts. Javascript was something I stayed away from for a <a data-tip="true" class="top large" data-tip-content="Until I started editing this wiki!" href="javascript:void(0)"><b>long time</b></a>. Being able to simple incorporate javascript into your website makes it so much better. Over the course of the summer, I have learned to use and <a data-tip="true" class="top large" data-tip-content="To a very small degree..." href="javascript:void(0)"><b>manipulate</b></a> jQuery plugins. jQuery plugins offer a huge bunch of formatting and <a data-tip="true" class="top large" data-tip-content="From dropdown menus, tabs, galleries etc." href="javascript:void(0)"><b>styling oppotunities</b></a>. If you are looking for a bunch of jQuery plugins, have a look at <a data-tip="true" class="top large" data-tip-content="Unheap is a jQuery plugin repository, and they have all kinds of cool things!" href="javascript:void(0)"><b>unheap</b></a>! | ||
+ | <br><br> | ||
+ | <div class="SCJHIGHLIGHT"><p> | ||
+ | There are other web design languages and other aspects to Javascript as well, but my lack of experience with those means I won't be able to explain any further. When it comes to the basics of web design, the best thing to do is experiment. Download a text editor for coding, and experiment different things you come across. There are many <a data-tip="true" class="top large" data-tip-content="And free!" href="javascript:void(0)"><b>different</b></a> styles, plugins etc. out there; and whilst some may be a little difficult to work with, many are simple and elegant on a variety of web pages. | ||
+ | </p></div> | ||
+ | <!--- Content end---> | ||
+ | </div></div><br> | ||
+ | <!--------- This is the end of the expanding box--------> | ||
+ | <!-------- This is the beginning of the expanding box--------> | ||
+ | <div class="collapse-card" data-step="3" data-position='top' data-intro="So you're looking to build your wiki! Think about your layout, and how you want to present your work. I suggest looking at the wikis of past iGEM teams (especially those who won awards for their wiki). There are two things to think about when building your wiki: content and design."><div class="title"> | ||
+ | <i class="fa fa-clock-o fa-2x fa-fw"></i><strong> | ||
+ | <!--- Title start ---> | ||
+ | How will I get my wiki done on time? | ||
+ | <!--- Title end ---> | ||
+ | </strong></div><div class="body"> | ||
+ | <!--- Content start---> | ||
+ | Firstly, lets talk <a data-tip="true" class="top large" data-tip-content="You may be thinking that this is the easy part, but it really isn't. Getting all your content up before the wiki freeze is quite the unexpected challenge." href="javascript:void(0)"><b>content</b></a>. You want to be able to, in detail, explain your entire project on your wiki; and if you don't get your content together before the last few weeks, you'll probably find yourself scrambling to get something onto your wiki as the <a data-tip="true" class="top large" data-tip-content="Not a position you want to be in!" href="javascript:void(0)"><b>deadline approaches</b></a>. | ||
+ | <br> | ||
+ | <br> | ||
+ | Now, lets talk design. It's the most creative and fun part, but you'll have to work as a team to decide what sort of <a data-tip="true" class="top large" data-tip-content="If you want to find out more about web design concepts, try googling or have a look at your favourite websites and the approaches they have taken." href="javascript:void(0)"><b>design</b></a> you want. I suggest researching on good layouts and designs to base your wiki on; and remember, simple and functional beats problematic and complex. | ||
+ | <!--- Content end---> | ||
+ | </div></div><br> | ||
+ | <!--------- This is the end of the expanding box--------> | ||
<!-------- This is the beginning of the expanding box--------> | <!-------- This is the beginning of the expanding box--------> | ||
- | <div class="collapse-card"><div class="title"> | + | <div class="collapse-card" data-step="4" data-position='top' data-intro="I thought it best to approach this by breaking it down into sections based on what you see in front of you."><div class="title"> |
- | <i class="fa fa- | + | <i class="fa fa-book fa-2x fa-fw"></i><strong> |
<!--- Title start ---> | <!--- Title start ---> | ||
+ | UCL iGEM 2014: Our wiki story | ||
+ | <!--- Title end ---> | ||
+ | </strong></div><div class="body"> | ||
+ | <!--- Content start---> | ||
+ | First, the header. Lewis Iain was the source of inspiration for this, I think it caught his eye whilst he was browsing for different website design templates. He looked through a bunch of code and managed to pull it out of the bag, and even <a data-tip="true" class="top large" data-tip-content="If you view our site on a mobile device, or simple make your window smaller; there's a cool feature he managed to fix up." href="javascript:void(0)"><b>spice it up a little</b></a>. Our team then decided on our colour scheme and it was all set. We decided to go with a simplistic approach, breaking our content into <a data-tip="true" class="top large" data-tip-content="Project, Science and Humans." href="javascript:void(0)"><b>3 main categories</b></a>. It works well because it ensures we avoid having a menu full of clutter, and allows users to go through each aspect of our project step by step. | ||
+ | <br><br> | ||
+ | Next, the <a data-tip="true" class="top large" data-tip-content=" Initially, we used a bunch of photos that were all different sizes; but with a more consistent set of images, everything looks a little neater now." href="javascript:void(0)"><b>header images</b></a>. Oran Maguire, who contributed in UCL iGEM 2013 was happy to lend a hand in the graphics team this year. | ||
+ | <br><br> | ||
+ | We would like to thank Dr Darren Nesbeth, our supervisor, for his feedback in helping us convey our project efficiently. | ||
+ | <br><br> | ||
+ | Now, there are a few keen features you may have noticed on our pages. The tabs feature, the expanding box, the <a data-tip="true" class="top large" data-tip-content="Hey, that's me!." href="javascript:void(0)"><b>hover tooltip</b></a>, the carousel gallery, and the sticky note! That's all <a data-tip="true" class="top large" data-tip-content="On some of our pages, you may have come across the mini tutorial feature; that's yet another jQuery plugin." href="javascript:void(0)"><b>jQuery plugins</b></a>, something I had a real good bit of fun experimenting with. | ||
+ | <br><br> | ||
+ | Lastly, we have our footer, it's simple yet elegant. All the necessary info, and of course our Twitter feed! Be sure to follow UCL iGEM on Twitter, and keep up with our progress and of course keep up with the 2015 UCL iGEM team! | ||
+ | <!--- Content end---> | ||
+ | </div></div><br> | ||
+ | <!--------- This is the end of the expanding box--------> | ||
- | + | <!-------- This is the beginning of the expanding box--------> | |
- | + | <div class="collapse-card" data-step="5" data-position='top' data-intro="Over here, I'm just going to explain the following: inserting your javascript and css into a template, linking that template into your wiki page, and how to ensure members (who aren't as tech savvy as you are) can edit content on the page without having to read between a bunch of code they don't understand at all. The best way to do this is to use an example, so use this page as an example - open the source and have a look at how it's laid out."><div class="title"> | |
+ | <i class="fa fa-cubes fa-2x fa-fw"></i><strong> | ||
+ | <!--- Title start ---> | ||
+ | Wiki how-to: Basics | ||
<!--- Title end ---> | <!--- Title end ---> | ||
</strong></div><div class="body"> | </strong></div><div class="body"> | ||
<!--- Content start---> | <!--- Content start---> | ||
- | + | Firstly, lets talk about loading your js and css files onto your page. Firstly, you'll want to create a template (Team:Name/Template:TemplateName.<a data-tip="true" class="top large" data-tip-content="Where ### could be js or css depending on your file." href="javascript:void(0)"><b>###</b></a>). Create the template page and load your css and js files onto them. The next step is to create another template, to hold the links to all your js and css files, for example our styles pages (Team:UCL/Template:BioprocessStyles and Team:UCL/Template:WikiDesignStyles). It simply loads all the js and css templates, and it makes it a lot <a data-tip="true" class="top large" data-tip-content="It also makes all the clutter disappear!" href="javascript:void(0)"><b>easier</b></a> to insert onto your page. Once you've done that, load it onto your page, and voilà, it's all working! | |
- | + | <br><br> | |
- | + | What we've done to ensure all our members can easily edit the pages, is using comments in the source code. This allows our members to know <a data-tip="true" class="top large" data-tip-content="It really helps avoid someone coming along and breaking an entire page!" href="javascript:void(0)"><b>exactly</b></a> where to start typing and what they can touch. Now, you might be wondering if I'm going to explain about the nitty gritty coding that we've got going on. The good thing is, <a data-tip="true" class="top large" data-tip-content="Two birds with one stone!" href="javascript:void(0)"><b>I don't have to</b></a>! In the process of making all those comments for our own team members to understand the code, you can just as easily look at the source code and understand it yourself! | |
<!--- Content end---> | <!--- Content end---> | ||
- | </div></div> | + | </div></div><br> |
<!--------- This is the end of the expanding box--------> | <!--------- This is the end of the expanding box--------> | ||
- | |||
- | |||
- | |||
</div> | </div> | ||
Line 94: | Line 124: | ||
padding-top:50px; | padding-top:50px; | ||
display:inline-block; | display:inline-block; | ||
- | |||
- | |||
- | |||
} | } | ||
Line 102: | Line 129: | ||
.textArena { | .textArena { | ||
background-color:white; | background-color:white; | ||
- | padding: | + | padding: 5% 8% 5% 8%; |
font-size:90%; | font-size:90%; | ||
font-family: 'Open Sans', 'Helvetica Neue', Helvetica, Arial, sans-serif; | font-family: 'Open Sans', 'Helvetica Neue', Helvetica, Arial, sans-serif; | ||
- | + | text-align: justify; | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
} | } | ||
Line 179: | Line 165: | ||
} | } | ||
- | div. | + | div.SCJHIGHLIGHT p { |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
color: #fff; | color: #fff; | ||
- | border: solid 4px # | + | border: solid 4px #29AAE3; |
border-radius: 10px; | border-radius: 10px; | ||
background-color: #000; | background-color: #000; | ||
Line 215: | Line 175: | ||
box-shadow: 10px 10px 5px #888888; | box-shadow: 10px 10px 5px #888888; | ||
} | } | ||
- | div. | + | div.SCJHIGHLIGHT a { |
- | color: # | + | color: #29AAE3; |
} | } | ||
Latest revision as of 01:25, 17 October 2014
Every iGEM team must produce a wiki to upload and present their work. When it comes to building your wiki, it helps to have some members with experience in web design.
If you haven't had the chance to familiarise yourself with these basic aspects of web design, w3schools offers a good beginners platform to web design. Sooner or later, you'll be able to recognise whats going on.
In the first section, I'll explain the basics of making a website. If you're looking to learn about wiki building approaches, read the second section. The third section explores the design process of our UCL iGEM 2014 wiki, and the fourth section explains a little about the basics of building your very own iGEM team wiki.
Of course, I'm really really simplifying this; so if you really want to learn more, I suggest checking out mozilla developer, codecademy and w3schools.
I suggest you get on Tumblr and start playing around with the themes and learn the ropes there. In web design as a beginner, you just need to imagine what you want. The community of web developers is perhaps one of the most helpful online communities out there, it's just a matter of trial and error.
Now, if you're familiar with HTML and CSS; let's delve a bit deeper into web design concepts. Javascript was something I stayed away from for a long time. Being able to simple incorporate javascript into your website makes it so much better. Over the course of the summer, I have learned to use and manipulate jQuery plugins. jQuery plugins offer a huge bunch of formatting and styling oppotunities. If you are looking for a bunch of jQuery plugins, have a look at unheap!
There are other web design languages and other aspects to Javascript as well, but my lack of experience with those means I won't be able to explain any further. When it comes to the basics of web design, the best thing to do is experiment. Download a text editor for coding, and experiment different things you come across. There are many different styles, plugins etc. out there; and whilst some may be a little difficult to work with, many are simple and elegant on a variety of web pages.
Now, lets talk design. It's the most creative and fun part, but you'll have to work as a team to decide what sort of design you want. I suggest researching on good layouts and designs to base your wiki on; and remember, simple and functional beats problematic and complex.
Next, the header images. Oran Maguire, who contributed in UCL iGEM 2013 was happy to lend a hand in the graphics team this year.
We would like to thank Dr Darren Nesbeth, our supervisor, for his feedback in helping us convey our project efficiently.
Now, there are a few keen features you may have noticed on our pages. The tabs feature, the expanding box, the hover tooltip, the carousel gallery, and the sticky note! That's all jQuery plugins, something I had a real good bit of fun experimenting with.
Lastly, we have our footer, it's simple yet elegant. All the necessary info, and of course our Twitter feed! Be sure to follow UCL iGEM on Twitter, and keep up with our progress and of course keep up with the 2015 UCL iGEM team!
What we've done to ensure all our members can easily edit the pages, is using comments in the source code. This allows our members to know exactly where to start typing and what they can touch. Now, you might be wondering if I'm going to explain about the nitty gritty coding that we've got going on. The good thing is, I don't have to! In the process of making all those comments for our own team members to understand the code, you can just as easily look at the source code and understand it yourself!