MetaXPWiki/DeveloperDocumentation/GettingStarted - Revision history

Admin: 8 revisions

2011-10-26T06:15:03Z

8 revisions

← Older revision	Revision as of 08:15, 26 October 2011
(No difference)

imported>VirginieMittard at 13:03, 30 August 2005

2005-08-30T13:03:30Z

← Older revision		Revision as of 15:03, 30 August 2005
Line 59:		Line 59:
	* use the specific documentation tools of the domain		* use the specific documentation tools of the domain
	* use POD for documenting Perl module		* use POD for documenting Perl module
	* use ~~permodule~~ Pod::Usage for documenting perl-scripts		* use perlmodule Pod::Usage for documenting perl-scripts
	* each script needs a usage ~~massage~~ (see above)		* each script needs a usage message (see above)
	* [[O2DBIWiki\|O2DBI]]-documentation (will create POD-doku for server classes)		* [[O2DBIWiki\|O2DBI]]-documentation (will create POD-doku for server classes)
	'''		'''

imported>KaiRunte at 09:46, 13 May 2005

2005-05-13T09:46:49Z

← Older revision		Revision as of 11:46, 13 May 2005
Line 19:		Line 19:

	<pre><nowiki>		<pre><nowiki>
	cvs checkout bioinfo/~~metaxp~~		cvs checkout bioinfo/<name of project>
	</nowiki></pre>		</nowiki></pre>

	~~you~~ need to checkout the following projects:		You need to checkout the following projects:
	* metaxp		* metaxp
	* projectmanagement		* projectmanagement
	* common		* common

			== API Documentation ==

			The API documentation of OntoDB is not checked in as this causes more
			trouble then it's worth. To generate your own copy of the API
			documentation, simply run the script

			<pre><nowiki>
			CVS/bioinfo/ontodb/bin/create_html_doc.sh
			</nowiki></pre>


	== Web-Server ==		== Web-Server ==

imported>KaiRunte at 09:45, 13 May 2005

2005-05-13T09:45:20Z

← Older revision		Revision as of 11:45, 13 May 2005
Line 6:		Line 6:
	== DB Access ==		== DB Access ==

	All MetaXP projects are backed by the projectmanagement system [[/GPMSWiki\|GPMS]].		All MetaXP projects are backed by the projectmanagement system [[GPMSWiki\| GPMS]].
	To be able to work with MetaXP you need an account.		To be able to work with MetaXP you need an account.

imported>KaiRunte at 09:44, 13 May 2005

2005-05-13T09:44:58Z

← Older revision		Revision as of 11:44, 13 May 2005
Line 2:		Line 2:
	= Getting Started =		= Getting Started =

	This HowTo ~~tries to eplain~~ how to get started with developing MetaXP.		This HowTo explains briefly how to get started with developing code for MetaXP project.

	== DB Access ==		== DB Access ==

imported>KaiRunte at 10:25, 21 April 2005

2005-04-21T10:25:41Z

← Older revision		Revision as of 12:25, 21 April 2005
Line 50:		Line 50:
	* use permodule Pod::Usage for documenting perl-scripts		* use permodule Pod::Usage for documenting perl-scripts
	* each script needs a usage massage (see above)		* each script needs a usage massage (see above)
	* [[/O2DBIWiki\|O2DBI]]-documentation (will create POD-doku for server classes)		* [[O2DBIWiki\|O2DBI]]-documentation (will create POD-doku for server classes)
	'''		'''
	----		----
	The other main source is the perldoc documentation. The generated [[/O2DBIWiki\|O2DBI]]-servermodules are pod documented. You can read them with:		The other main source is the perldoc documentation. The generated [[O2DBIWiki\|O2DBI]]-servermodules are pod documented. You can read them with:
	<pre><nowiki>		<pre><nowiki>
	perldoc module.pm		perldoc module.pm
Line 76:		Line 76:
	* `/share` contains the main application code		* `/share` contains the main application code
	** `/exec` executable scripts		** `/exec` executable scripts
	** `/perl` contains ~~the~~ perl code		** `/perl` contains perl code
	*** `/MetaXP` ~~same as above~~		*** `/MetaXP` contains perl code
	**** `/WWW/` modules specific to the web front-end of MetaXP		**** `/WWW/` modules specific to the web front-end of MetaXP
	**** `/DBmodules` modules accessing the backend, used by the www-modules		**** `/DBmodules` modules accessing the backend, used by the www-modules

imported>KaiRunte at 10:24, 21 April 2005

2005-04-21T10:24:11Z

← Older revision		Revision as of 12:24, 21 April 2005
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	~~Here comes a short~~ HowTo ~~about~~ how to get started with developing MetaXP		= Getting Started =

			This HowTo tries to eplain how to get started with developing MetaXP.

			== DB Access ==

			All MetaXP projects are backed by the projectmanagement system [[/GPMSWiki\|GPMS]].
			To be able to work with MetaXP you need an account.

			If you are a developer
			send an email to: [[MailTo(krunte DASH devel AT cebitec DOT uni DASH bielefeld DOT de)]] to get a
			developer account.

			== CVS ==

			* create a working direktory for CVS in your home named 'CVS'
			* cd to that directory and get the projects needed to run emma:

			<pre><nowiki>
			cvs checkout bioinfo/metaxp
			</nowiki></pre>

			you need to checkout the following projects:
			* metaxp
			* projectmanagement
			* common

			== Web-Server ==

			* goto CVS/bioinfo/metaxp/share/www
			* edit apache2.sh: change `PORT=XXXX` to any free port on the webserver, and set CVS= to your CVS-directory
			* login on a suitabel test-webserver using `qxterm` or `qrsh`
			* in that shell execute:

			<pre><nowiki>
			CVS/bioinfo/metaxp/share/www/apache2.sh start
			</nowiki></pre>

			* try to open `http://SERVER:PORT` with your browser
			* if nothing happens or you get an error message have a look at `CVS/bioinfo/metaxp/share/www/log/all.errors`

			== Documentation ==

			----
			'''As developers we are also responsible for ducumentation. Please let's try the following conventions:
			* document your code
			* use the specific documentation tools of the domain
			* use POD for documenting Perl module
			* use permodule Pod::Usage for documenting perl-scripts
			* each script needs a usage massage (see above)
			* [[/O2DBIWiki\|O2DBI]]-documentation (will create POD-doku for server classes)
			'''
			----
			The other main source is the perldoc documentation. The generated [[/O2DBIWiki\|O2DBI]]-servermodules are pod documented. You can read them with:
			<pre><nowiki>
			perldoc module.pm
			</nowiki></pre>

			Other modules may also have pod-documetation but this is not guaranteed. The documentation found can also be incomplete or rather outdated. If you wish to generate the documentation for all perl modules you can do so be executing the shell script:

			<pre><nowiki>
			CVS/bioinfo/metaxp/share/exec/create_html_docs.pl
			</nowiki></pre>

			It generates an HTML version of the perldoc documentation in the directory 'CVS/bioinfo/metaxp/share/doc/html'.

			Additional documentation can be found in CVS/bioinfo/metaxp/share/doc.

			== Directory Structure ==

			The directory `CVS/bioinfo/metaxp/` contains the specific components of the metaxp software:

			* `/bin` start wrapper(s) for executable scripts in `/share/exec`.
			To run a script in share exec type: `metaxp_start scriptname.pl -p project [options]`
			* `/share` contains the main application code
			** `/exec` executable scripts
			** `/perl` contains the perl code
			*** `/MetaXP` same as above
			**** `/WWW/` modules specific to the web front-end of MetaXP
			**** `/DBmodules` modules accessing the backend, used by the www-modules
			* `/www` contains web-server specific code and the document root
			** `/cgi-bin' contains the cgi-scripts
			*** `/templates' the HTML-templates for each page
			* `/htdocs' contains the static HTML pages for the web front-end
			** `/images' the images used for the web front-end
			* `/log' contains logging files of the apache web server
			* `/src` contains the database schema and code for generation of code and documentation

imported>KaiRunte at 10:05, 21 April 2005

2005-04-21T10:05:01Z

← Older revision		Revision as of 12:05, 21 April 2005
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	Here comes a short HowTo about how to get started with developing !MetaXP		Here comes a short HowTo about how to get started with developing MetaXP

Unknown user at 00:00, 1 January 1970

1970-01-01T00:00:00Z

New page

__NOTOC__
Here comes a short HowTo about how to get started with developing !MetaXP