Team:ETH Zurich/Tools/Automated Wiki

From 2008.igem.org

(Difference between revisions)
Line 16: Line 16:
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>
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.
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 ===
+
=== This year's 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.<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 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.
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.
Line 36: Line 36:
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 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 maintaining wiki only syntax on the MIT wiki site.
-
== The Automated Wiki ==
+
== The automated wiki ==
[[Image:Menu_db.JPG|center|thumb|500px|Menu out of Mysql Database]]
[[Image:Menu_db.JPG|center|thumb|500px|Menu out of Mysql Database]]
[[Image:Auto wiki shot.png|center|thumb|500px|Page editing with the Automated Wiki]]
[[Image:Auto wiki shot.png|center|thumb|500px|Page editing with the Automated Wiki]]
For an example of a page generated with the automated wiki click [https://2008.igem.org/Team:ETH_Zurich/Wet_Lab/Protocoll here]
For an example of a page generated with the automated wiki click [https://2008.igem.org/Team:ETH_Zurich/Wet_Lab/Protocoll here]
-
== Why we didnt use it in the end ==
+
== Why we didn't use it in the end ==
There were two reasons why we didn't use the automated wiki in the end.
There were two reasons why we didn't 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.
*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.

Revision as of 00:10, 28 October 2008

Contents

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: Javascript.JPG 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 year's 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:

<!-- PUT THE PAGE CONTENT AFTER THIS LINE. THANKS :) -->
your text goes here
<!-- PUT THE PAGE CONTENT BEFORE THIS LINE. THANKS :) -->



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 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 a page generated with the automated wiki click here

Why we didn't use it in the end

There were two reasons why we didn't 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 html to javascript and also flash- is allowed. Along with these changes, also the main reason why we introduced the automated wiki in the first place was gone.

Download

Media:ETH Auto wiki.zip Keep in mind that the development of this tool stopped in the middle of the project. However, you might be able to use some ideas/parts of it.

Retrieved from "http://2008.igem.org/Team:ETH_Zurich/Tools/Automated_Wiki"