Team:ETH Zurich/Tools/Automated Wiki

From 2008.igem.org

(Difference between revisions)

Revision as of 00:04, 28 October 2008

Motivation

At the beginning of our project planning phase we were also thinking about how to manage the wiki. One major shortcoming showed up when we were browsing the wikis of previous iGEM competitions - a lot of them simply didn't work anymore.
The problem is that large parts of the old wikis are stored on external servers- e.g. JavaScript menus that are actully stored on students' private homepages.
A good example for this is last year's ETH team wiki: As you can see, the .js file is stored on an external server meaning that as soon as this file is gone, the whole wiki page won't work anymore, because the navigation is gone.
And if you browse through wikis of even earlier years, you can see that this is already happening to a lot of pages.

This years situation

When we then started to think of ways how to design the wiki, it turned out that the persons responsible for this wiki are aware of the situation, because embedding any external content into a wiki page did not seem to work anymore.
While this solves the problem of missing content, it gives rise a new problem. Wiki syntax is very simple and therefore easy to handle. While this appears as a benefit when editing pages, it goes along with a lack of flexibility concerning design- or a lot of work if you would like to have a nice design anyways. The wiki syntax makes it harder to separate design and content- like it is the case for our wiki page right now. Since we have a lot of people responsible for the content and only few work on the design, we agreed on editing pages like this:

your text goes here

How to overcome this situation

While the reasons why external content should not be allowed on the wiki were obvious, we still didn't want to settle with "just" using the regular wiki editing.
Therefore, we had the idea to use some kind of software to overcome the shortcomings listed above. We wanted to introduce a "middle man" who perforems editing tasks for the user and create a division of content and syntax while still maintaining wiki only syntax on the MIT wiki site.

The Automated Wiki

Menu out of Mysql Database

Page editing with the Automated Wiki

For an example of an Page generated with the Automated Wiki click here

Why we didnt use it in the end

There where two reasons why we didnt use the Automated Wiki in the end.

Within the team not everyone felt compfortable with the idea that we need an extra tool for editing the wiki, because this also brings an additional source of error/complication.
For some reason the MIT wiki team decided to loosen up the allowed syntax again and now we are back at the situation that everything from all the html over javascript, up to flash is allowed. And with that the main reason why we introduced the automated wiki in the first place is gone.

Download

Media:ETH Auto wiki.zip Keep in mind that the development of this Tool stopped in the middle. But maybe you can use some ideas/parts of it.

@@ Line 9: / Line 9: @@
 <!-- PUT THE PAGE CONTENT AFTER THIS LINE. THANKS :) -->
 == Motivation ==
-At the beginning of our project planning phase we were also thinking on how to manage the wiki.
+At the beginning of our project planning phase we were also thinking about how to manage the wiki.
-One major shortcoming showed up when we where browsing the wikis of previous Igem Competitions - a lot of them simply didnt work anymore.<br>
+One major shortcoming showed up when we were browsing the wikis of previous iGEM competitions - a lot of them simply didn't work anymore.<br>
-The problem that causes this is, that big parts of the old wikis are actully stored on external servers. E.g JavaScript Menus that are actully stored on Students private Homepages.<br>
+The problem is that large parts of the old wikis are stored on external servers- e.g. JavaScript menus that are actully stored on students' private homepages.<br>
-A good example for this is actully e.g the last years ETH Team wiki:
+A good example for this is last year's ETH team wiki:
 [[Image:Javascript.JPG]]
-As you can see, the .js file is stored at an external server, which means as soon as for any reason this file is gone the whole wiki page wont work anymore, because the navigation is gone.<br>
+As you can see, the .js file is stored on an external server meaning that as soon as this file is gone, the whole wiki page won't work anymore, because the navigation is gone.<br>
 And if you browse through wikis of even earlier years, you can see that this is already happening to a lot of pages.
 === This years situation ===
-When we then started to think of ways how to design the wiki it turned out that apparently the persons responsible for this wiki are aware of the situation, cause embedding any external content into a wiki page seemed not to work anymore.<br>
+When we then started to think of ways how to design the wiki, it turned out that the persons responsible for this wiki are aware of the situation, because embedding any external content into a wiki page did not seem to work anymore.<br>
-While this solves the problem of missing content, it arrises a new problem. Wiki Syntax is very simple so that it is easy to handle. While a benefit in first editing pages, it brings with it a big lack of flexibility in design and a lot of work if you would like to still have nice design.
+While this solves the problem of missing content, it gives rise a new problem. Wiki syntax is very simple and therefore easy to handle. While this appears as a benefit when editing pages, it goes along with a lack of flexibility concerning design- or a lot of work if you would like to have a nice design anyways.
-The wiki syntax makes it harder to devide design from content like for example it is the case with our wiki page now.
+The wiki syntax makes it harder to separate design and content- like it is the case for our wiki page right now.
-Since we have a lot of people beeing responsable for the content while only a few manage the design we agreed on editing pages like this: <br><br>
+Since we have a lot of people responsible for the content and only few work on the design, we agreed on editing pages like this: <br><br>
 <center>
 <nowiki>
@@ Line 33: / Line 33: @@
 </center><br><br>
 === How to overcome this situation ===
-While the reasons why external content shouldnt be allowed on the wiki where obvious, we still didnt want to settle with "just" doing it with regular wiki editing.<br>
+While the reasons why external content should not be allowed on the wiki were obvious, we still didn't want to settle with "just" using the regular wiki editing.<br>
-So the idea was born to use some kind of Software to overcome this shortcomings by introducing a middle man who overs easy editing for the user and a devision of content and syntax while still maintaining wiki only syntax on the MIT wiki site.
+Therefore, we had the idea to use some kind of software to overcome the shortcomings listed above. We wanted to introduce a "middle man" who perforems editing tasks for the user and create a division of content and syntax while still maintaining wiki only syntax on the MIT wiki site.
 == The Automated Wiki ==