Recent changes to Source

WikiPage Source modified by wauter

wauter — Wed, 04 Jan 2012 14:12:33 -0000

--- v7 
+++ v8 
@@ -1,26 +1,20 @@
-To get the sources, install [Bazaar](http://bazaar.canonical.com) first.
-
-Then, depending on which branch you need, do one or more of:
-
-~~~~~~~~~~~~~~~
-bzr branch lp:~codak/codak/codak-core codak-core
+As of January 4, 2012, the source repository has moved from Launchpad (bzr) to Sourceforge (git). To get the sources, navigate to the *code* menu and follow instructions.
+
+To get the sources, install [Bazaar](http://bazaar.canonical.com) first.
+
+Then, depending on which branch you need, do one or more of:
+
+bzr branch lp:~codak/codak/codak-core codak-core
 bzr branch lp:~codak/codak/codak-terms codak-terms
 bzr branch lp:~codak/codak/codak-mysql codak-mysql
-bzr branch lp:~codak/codak/codak-dist codak-dist
-~~~~~~~~~~~~~~~
+bzr branch lp:~codak/codak/codak-dist codak-dist
 
 Explanation of the branches:
 
 * [codak-core (source)]: all of codak-core: the web interface and basic infrastructure [browse](http://bazaar.launchpad.net/~codak/codak/codak-core/files)
 * [codak-terms (source)]: the term extraction and management extension [browse](http://bazaar.launchpad.net/~codak/codak/codak-terms/files)
 * [codak-mysql (source)]: an extension to MySQL which is required by codak-terms [browse](http://bazaar.launchpad.net/~codak/codak/codak-mysql/files)
 * [codak-dist](Repository Management): distribution repository management scripts (normally not needed) [browse](http://bazaar.launchpad.net/~codak/codak/codak-dist/files)
-
-If, at any later time, you want to update a local branch to the latest revision, *cd* to the branch directory and type:
-
-~~~~~~~~~~~~~~~
-bzr pull
-~~~~~~~~~~~~~~~
 
 Compiling sources
 -----------------

WikiPage Source modified by wauter

wauter — Tue, 06 Dec 2011 16:14:27 -0000

--- v6 
+++ v7 
@@ -11,10 +11,10 @@
 
 Explanation of the branches:
 
-* [codak-core (source)]: all of codak-core: the web interface and basic infrastructure
-* [codak-terms (source)]: the term extraction and management extension
-* [codak-mysql (source)]: an extension to MySQL which is required by codak-terms
-* [codak-dist](Repository Management): distribution repository management scripts (normally not needed) 
+* [codak-core (source)]: all of codak-core: the web interface and basic infrastructure [browse](http://bazaar.launchpad.net/~codak/codak/codak-core/files)
+* [codak-terms (source)]: the term extraction and management extension [browse](http://bazaar.launchpad.net/~codak/codak/codak-terms/files)
+* [codak-mysql (source)]: an extension to MySQL which is required by codak-terms [browse](http://bazaar.launchpad.net/~codak/codak/codak-mysql/files)
+* [codak-dist](Repository Management): distribution repository management scripts (normally not needed) [browse](http://bazaar.launchpad.net/~codak/codak/codak-dist/files)
 
 If, at any later time, you want to update a local branch to the latest revision, *cd* to the branch directory and type:

WikiPage Source modified by wauter

wauter — Tue, 22 Nov 2011 12:57:18 -0000

--- v5 
+++ v6 
@@ -41,3 +41,42 @@
 ~~~~~~~~~~~
 
 The first command is required only the first time. It tells Maven to install the parent package but any other package down the tree.
+
+Web application debugging
+-------------------------
+
+To run a web application directly from the source tree, cd to the package directory (e.g., codak-core/webif) and do:
+
+~~~~~~~~~~~
+mvn jetty:run
+~~~~~~~~~~~
+
+Optionally, specify a port number:
+
+~~~~~~~~~~~
+mvn jetty:run -Djetty.port=8181
+~~~~~~~~~~~
+
+Processing module debugging
+---------------------------
+
+To replace an already installed processing module, cd to the package directory (e.g., codak-core/sentencer) and do:
+
+~~~~~~~~~~~
+mvn package
+~~~~~~~~~~~
+
+to build the package, and then do:
+
+~~~~~~~~~~~
+sudo make install
+~~~~~~~~~~~
+
+to update the symbolic link of the previously installed package, which will now point to the freshly built package in the source tree. This means that you can rebuild the package without doing 'sudo make install' again. It also means that deleting the source tree without restoring the symbolic link will probably leave you with a broken CoDAK installation.
+
+After building the package, you also have to restart Jetty or PipeT (depending on how the module is served) to load the updated module.
+
+Extension debugging
+-------------------
+
+To replace an already installed extension, cd to the extension directory (e.g., codak-terms/termex-extension) and follow the instructions above for processing module debugging. Restart Jetty to load the updated extension.

WikiPage Source modified by wauter

wauter — Wed, 19 Oct 2011 12:29:49 -0000

--- v4 
+++ v5 
@@ -14,7 +14,7 @@
 * [codak-core (source)]: all of codak-core: the web interface and basic infrastructure
 * [codak-terms (source)]: the term extraction and management extension
 * [codak-mysql (source)]: an extension to MySQL which is required by codak-terms
-* [codak-dist]: distribution repository management scripts (normally not needed) 
+* [codak-dist](Repository Management): distribution repository management scripts (normally not needed) 
 
 If, at any later time, you want to update a local branch to the latest revision, *cd* to the branch directory and type:

WikiPage Source modified by wauter

wauter — Wed, 19 Oct 2011 12:28:08 -0000

--- v3 
+++ v4 
@@ -11,10 +11,10 @@
 
 Explanation of the branches:
 
-* codak-core: all of codak-core: the web interface and basic infrastructure
-* codak-terms: the term extraction and management extension
-* codak-mysql: an extension to MySQL which is required by codak-terms
-* codak-dist: distribution repository management scripts (normally not needed) 
+* [codak-core (source)]: all of codak-core: the web interface and basic infrastructure
+* [codak-terms (source)]: the term extraction and management extension
+* [codak-mysql (source)]: an extension to MySQL which is required by codak-terms
+* [codak-dist]: distribution repository management scripts (normally not needed) 
 
 If, at any later time, you want to update a local branch to the latest revision, *cd* to the branch directory and type:

WikiPage Source modified by wauter

wauter — Wed, 12 Oct 2011 15:33:36 -0000

--- v2 
+++ v3 
@@ -16,6 +16,12 @@
 * codak-mysql: an extension to MySQL which is required by codak-terms
 * codak-dist: distribution repository management scripts (normally not needed) 
 
+If, at any later time, you want to update a local branch to the latest revision, *cd* to the branch directory and type:
+
+~~~~~~~~~~~~~~~
+bzr pull
+~~~~~~~~~~~~~~~
+
 Compiling sources
 -----------------

WikiPage Source modified by wauter

wauter — Fri, 07 Oct 2011 14:51:02 -0000

--- v1 
+++ v2 
@@ -15,3 +15,23 @@
 * codak-terms: the term extraction and management extension
 * codak-mysql: an extension to MySQL which is required by codak-terms
 * codak-dist: distribution repository management scripts (normally not needed) 
+
+Compiling sources
+-----------------
+
+CoDAK uses [Maven](http://maven.apache.org/) to manage the build process. This includes getting all the dependencies, compiling sources, etc. Make sure you know the basics of Maven before continuing.
+    
+To build everything, go to the branch's root directory and type:
+
+~~~~~~~~~~~
+mvn install
+~~~~~~~~~~~
+
+To build only a specific package, go to the package's root directory and type:
+
+~~~~~~~~~~~
+mvn -N -f ../pom.xml install
+mvn install
+~~~~~~~~~~~
+
+The first command is required only the first time. It tells Maven to install the parent package but any other package down the tree.

WikiPage Source modified by wauter

wauter — Fri, 07 Oct 2011 14:37:10 -0000

To get the sources, install [Bazaar](http://bazaar.canonical.com) first. Then, depending on which branch you need, do one or more of: ~~~~~~~~~~~~~~~ bzr branch lp:~codak/codak/codak-core codak-core bzr branch lp:~codak/codak/codak-terms codak-terms bzr branch lp:~codak/codak/codak-mysql codak-mysql bzr branch lp:~codak/codak/codak-dist codak-dist ~~~~~~~~~~~~~~~ Explanation of the branches: * codak-core: all of codak-core: the web interface and basic infrastructure * codak-terms: the term extraction and management extension * codak-mysql: an extension to MySQL which is required by codak-terms * codak-dist: distribution repository management scripts (normally not needed)