Difference between revisions of "Team:UCL/Software"
Lewismoffat (Talk | contribs) |
Lewismoffat (Talk | contribs) |
||
| Line 380: | Line 380: | ||
<h2>Mind-the-Mark</h2> | <h2>Mind-the-Mark</h2> | ||
<br><br><span style="text-align: center; margin: 0 auto; display: block;"><img src="https://static.igem.org/mediawiki/2015/d/d6/UCL_Mind_the_Mark_icon_small.png"/></span><br> | <br><br><span style="text-align: center; margin: 0 auto; display: block;"><img src="https://static.igem.org/mediawiki/2015/d/d6/UCL_Mind_the_Mark_icon_small.png"/></span><br> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<h3>Summary</h3> | <h3>Summary</h3> | ||
<p> | <p> | ||
| Line 423: | Line 416: | ||
<p>For more information, the source code, and the extension go to <a href="https://github.com/ucligem2015/Mind-The-Mark" style="color:red;"> | <p>For more information, the source code, and the extension go to <a href="https://github.com/ucligem2015/Mind-The-Mark" style="color:red;"> | ||
Our Github Page</a>.</p> | Our Github Page</a>.</p> | ||
| − | + | <div class="editorGit"> | |
| + | <a href="https://github.com/ucligem2015/Mind-The-Mark"> | ||
| + | <span class="overlayx"></span> | ||
| + | <img src="https://static.igem.org/mediawiki/2015/3/32/UCLGitHubLogo.png" width="10%"/> | ||
| + | <div>GitHub Repository</div> | ||
| + | </a> | ||
| + | </div> | ||
<h3>Construction</h3> | <h3>Construction</h3> | ||
Revision as of 21:22, 9 September 2015
'
Mind-the-Mark
Summary
The Mind-the-Mark tool takes the bland and boring wiki input box and transforms it into a proper code editor with several interactive and assistive features. Having talked to several iGEM teams this year, and years past, one of the issues they lamented over was the issue of entering code into the wiki. The bland and simple text input on each page made developing interactive and pretty wikis a real hassle. Due to this many teams developed their code externally and then transfered it in, costing them time and effort. We have changed that.
Before |
After |
|
|
By taking advantage of Google's easy to use extension system for the Chrome Browser, we devised a powerful and lightweight extension that transforms the wiki editor on whatever page you choose to edit; be it in the future in 2020 or now in 2015. The extension is easily downloaded and then drag-and-dropped into the Chrome browser, to install. Then its working!
For more information, the source code, and the extension go to Our Github Page.
Construction
The spirit of the tool is to make editing and working on the iGEM wiki easier and more interactive for all. It was with this spirit that we built the tool. Although the code is part of chrome extension, it is really a lightweight javascript tool.
What is a Chrome Extension?
A chrome extension at its base is a .json file called the "Manifest" file that contains the file reference's and basic information about the tool. When used this tells the browser to load a piece of javascript or other files on to specified pages. These then interact with the DOM (Document Object Model) of the page.
Why use a Chrome Extension?
Chrome is one of the most modern and widely used browser on the internet and has an easy to use and develop extension system, on top of a very rich API. When loading files that interact with the DOM chrome extensions also make sure that there is no interaction with any of the loaded scripts of libraries from the page, protecting the user. To top it all off, the chrome extensions are very easy to install and distribute.
How did we Implement it?
Our tool uses the commonly implemented "Content_Scripts" method for loading our extension. This allows chrome to load specific js and css files whenever a URL, defined by a certain patern, is loaded. In our case we load both js and css whenever an iGEM edit page is loaded. The javascipt that is loaded is the background.js file which adds a script refecence to the page, loads the script, and then deletes it. In this instance the script in question is the script.js file. The extension also has the ability to access other js and css file which are referenced in the Manifest file. The reason the background.js file is used to then load the script file is that it allows for a cleaner separation of files as well as a faster loading solution when the scipt is large.
The script.js file contains the source code and several add-on pieces of code from a js library called CodeMirror. This provides the majority of functions that alter the page. It also contains the final function that runs when the Document OnLoad call is made. This final function finds the textarea tag by its ID and makes the call to CodeMirror to change the textarea into the new snazzy code editor. CodeMirror then alters the shape of the divs in the tag and applies the css. As well as defining and instigating a few other features, this performs the majority of the work
By packing the majority of the js into one file it reduces the overall space required and time neaded to load. That being said it is well commented and laid out so that it is easily editable in the future. The same runs true for the css.
Future Work
There are several features we would like to implement in the future to make this the best tool, and the only as far as we know, for editing the iGEM wiki. Javascipt, CSS, and HTML are all currently supported but providing syntax for SCSS and other CSS variants, as well as PHP would complete the language mark up types. Providing code suggestion as well as auto complete would make this a tool to rival the best code editors out there.
Another project we have begun work on is developing a larger tool coaltes our tool with other team's to create a complete IDE for developing iGEM wikis.
This tool will and can make a massive difference to teams current and futrue by making the process of creating a wiki infinitely more easy and enjoyable to do!