Team:ETH Zurich/Tools/Automated Wiki

From 2008.igem.org

(Difference between revisions)

Latest revision as of 05:39, 30 October 2008

Motivation

At the beginning of our project planning phase we were thinking about how to deal with 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 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. 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 has already happened 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 people responsible for this wiki are aware of the situation - embedding external content into a wiki page did not seem to work anymore.

While this solved the problem of missing content, it gave rise to 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 want 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 performs 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

Software / Progamming Language

The automated wiki is written in C# as a webapplication that needs an IIS server to run on.
As a database it uses Mysql.
The software can be divided into three major parts:

User Interface

Page editing with the automated wiki

The user interface uses the [http://www.fckeditor.net/demo FCKEditor Tool] as an input interface. You can test it [http://www.fckeditor.net/demo here] and see what it can do.

A short list of benefits compared to regular wiki editing:

regular users don't have to deal with any wiki syntax.
"What you see is what you get" editor.
- Drag and drop available
- Image editing in place (drag and drop or via properties dialog)
- Formating via pointing
Pasting and converting text from Word or HTML pages!

Selecting/uploading images with automated wiki

Drag and drop editing/resizing images with automated wiki

Parsing Sites

At this point we stopped developing the automated wiki. This part is mainly responsible for adding the layout to the text.
To achieve this, a layout consisting of a regular html page is read out of the database containing various parsing tags.
For every parsing tag the program then enters the correct page content.
That way, the menu or a layout image that is placed on every page can be edited in one place and then updated on every other page.

Our plan was to also parse the text for key words like e.g papers etc. and automatically create the correct links on the wiki.

Writing into MIT Wiki

Menu out of Mysql Database

Finally after all the pages are generated, those which have been changed get updated at the MIT wiki.

To do this the application simply mimics a regular user edit by logging in with a regular user account and editing page per page.

To see 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 comfortable with the idea that we need an extra tool for editing the wiki, because this also brings an additional source for errors/complications.
For some reason, the MIT wiki team decided to loosen up the allowed syntax again, so 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.

@@ 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 about how to deal with the wiki.
+At the beginning of our project planning phase we were thinking about how to deal with 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.<br>
-The problem is that large parts of the old wikis are stored on external servers- e.g. JavaScript menus that are 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 stored on students' private homepages.<br>
 A good example for this is last year's ETH team wiki:
@@ Line 19: / Line 19: @@
 As you can see, the .js file is stored on an external server. 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 has already happened 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- embedding 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 people responsible for this wiki are aware of the situation - embedding external content into a wiki page did not seem to work anymore.<br>
-While this solved the problem of missing content, it gave 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 want 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.
+While this solved the problem of missing content, it gave rise to 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 want 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: <br><br>
 <center>
@@ Line 36: / Line 36: @@
 === 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.
+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 performs 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 ==
 === Software / Progamming Language ===
-The Automated Wiki is written in C# as a Webapplication that needs an IIS Server to run on.<br>
+The automated wiki is written in C# as a webapplication that needs an IIS server to run on.<br>
-As Database it uses Mysql.<br>
+As a database it uses Mysql.<br>
-The Software can be split into 3 Major Parts:
+The software can be divided into three major parts:
 === User Interface ===
-[[Image:Auto wiki shot.png|left|thumb|250px|Page editing with the Automated Wiki]]The Userinterface uses the [http://www.fckeditor.net/demo FCKEditor Tool] as Input Interface. You can test it and see what it can do on [http://www.fckeditor.net/demo site].<br>
+[[Image:Auto wiki shot.png|left|thumb|250px|Page editing with the automated wiki]]The user interface uses the [http://www.fckeditor.net/demo FCKEditor Tool] as an input interface. You can test it [http://www.fckeditor.net/demo here] and see what it can do.<br>
-A short list of benifits compared to regular Wiki Editing:
+A short list of benefits compared to regular wiki editing:
-*regular users dont have to deal with any wiki syntax.
+*regular users don't have to deal with any wiki syntax.
 *"What you see is what you get" editor.
-** Drag and Drop aviable
+** Drag and drop available
-** Image editing in place (Drag and Drop or via Properties Dialog
+** Image editing in place (drag and drop or via properties dialog)
 ** Formating via pointing
-*Pasting and converting Text from Word or HTML Pages!
+*Pasting and converting text from Word or HTML pages!
 <br clear="all" />
-[[Image:Image_upload.PNG|left|thumb|250px|Selecting/Uploading Images with Automated Wiki]]
+[[Image:Image_upload.PNG|left|thumb|250px|Selecting/uploading images with automated wiki]]
-[[Image:Image_editing.PNG|left|thumb|250px|Drag and Drop editing/resizing Images with Automated Wiki]]
+[[Image:Image_editing.PNG|left|thumb|250px|Drag and drop editing/resizing images with automated wiki]]
 <br clear="all" />
 === Parsing Sites ===
-In the state we stopped developing the Automated Wiki, this part is mainly responsible to add the layout to the text.<br>
+At this point we stopped developing the automated wiki. This part is mainly responsible for adding the layout to the text.<br>
-To achive this a layout in form of a regular html page is read out of the database containing various parsing tags.<br>
+To achieve this, a layout consisting of a regular html page is read out of the database containing various parsing tags.<br>
-For every parsing tag the programm then enters the correct page content.<br>
+For every parsing tag the program then enters the correct page content.<br>
-Like this e.g. the menu or an layout image that is placed on every page can be edited in one place and then updated on every page containing it easily.<br>
+That way, the menu or a layout image that is placed on every page can be edited in one place and then updated on every other page.<br>
+Our plan was to also parse the text for key words like e.g papers etc. and automatically create the correct links on the wiki.
-The plan was also to parse the Text for Key Words like e.g Papers etc. and automaticly make the correct wiki links.
 === Writing into MIT Wiki ===
-[[Image:Menu_db.JPG|left|thumb|500px|Menu out of Mysql Database]]Finaly after all the Pages are generated, those which have been changed get updated at the MIT wiki.<br>
+[[Image:Menu_db.JPG|left|thumb|500px|Menu out of Mysql Database]]Finally after all the pages are generated, those which have been changed get updated at the MIT wiki.<br>
-To do this the Application simply mimics a regular user edit by login in with a regular User and Editing Page per Page.
+To do this the application simply mimics a regular user edit by logging in with a regular user account and editing page per page.
 To see an example of a page generated with the automated wiki, click [https://2008.igem.org/Team:ETH_Zurich/Wet_Lab/Protocoll here].
 <br clear="all" />
 == 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 for errors/complications.
+*Within the team not everyone felt comfortable with the idea that we need an extra tool for editing the wiki, because this also brings an additional source for errors/complications.
-*For some reason, the MIT wiki team decided to loosen up the allowed syntax again, so 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...
+*For some reason, the MIT wiki team decided to loosen up the allowed syntax again, so 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 ==