Skip to content

Source code

GrisouUQAM edited this page Aug 6, 2013 · 10 revisions

wikiContributions is hosted at GitHub and uses Git for source control. In order to obtain the source code, you must first install Git on your system. Instructions for installing and setting up Git can be found at http://help.github.com/set-up-git-redirect.

If you simply want to create a local copy of the source to play with, you can clone the main repository using this command:

git clone git://github.com/nikixiaoyou/wikiContributions.git

If you're planning on contributing to our wikiContributions project, then it's a good idea to fork the repository. You can find instructions for forking a repository at http://help.github.com/fork-a-repo/. After forking the wikiContributions repository, you'll want to create a local copy of your fork.

Directory structure

The wikiContributions directory and file structure is as follows:

  • google-diff and weha folders, both independant, autonomous versions of our web site.
  • source - contains the code that compares 2 revisions of an article and returns what kind of edits were made. This folder exists only in the WEHA version, since the Google-Diff version only contains one file for this code (diff_match_patch.php).
  • UI - contains the xhtml, css, js and php files that run the website. This folder exists in both the Google-Diff version of our site and the WEHA version, but the files it contains vary.
  • testPage.php - a simple file to test the code (see bottom of [Step 2] (https://github.com/nikixiaoyou/wikiContributions/wiki/Installation-Procedures) for more details). This file exists in both the Google-Diff version of our site and the WEHA version.

Clone this wiki locally