This section is intended to host useful material on how to solve everyday problems when dealing with ITM tools both as a developer and as a user. The material is presented in an instructive way via tutorials, HowTo's, and user guides.
This is a fast manual on the steps needed to adapt the stand
alone version of a code to be used as an actor inside a KEPLER workflow .
Please do not get discouraged but rather contact
Denis Kalupin for help.
Your contribution to the ITM documentation websites is very welcome.
To be able to contribute to the ITM websites you must be a member of
the documentation project
doc_testunder Gforge on the ITM Gateway (see How to become a member of a Gforge project).
svn co https://gforge6.eufus.eu/svn/doc_test/trunk target_dirwhere target_dir is a directory name of your choice (it will be created by svn in your current directory)
- world - itm - isip - amns - edrg - imp12 - imp3 - imp4 - imp5Material in world will be visible on the web server to the whole world while access to the material in all other projects is limited to ITM members via login.
- private - publicMaterial placed into private will only be visible to members of the same project whereas material in public is visible to the entire ITM-TF.
- graphics - html - imports - pdf - xmlThe graphics directory is intended to host all graphics files whereas the imports directory shall host all other file types except for the xml and html files used for the generation of the ITM web pages. Those shall be placed into the xml and html directories. The pdf directory is used for processing only. Please do not place any files there.
- XML - HTMLThe recommended way of contributing is in the form of XML documents following the DocBook format. The ITM-TF currently uses a publishing tool created by John Storrs which allows the automatic conversion of DocBook like XML documents into HTML. This method has various advantages among which the most pronounced are that the contributor will not have to worry about the style and the overall structure of the web pages but rather contribute his/her material in the form of simple DocBook elements. The publication tools will then convert the existing material into a hierarchical and searchable structure of web pages with a single layout.
Writing your web pages in XML will allow them to be included in the automatic creation of hierarchical book-like pdf's of the web pages. |
All names of the files in the graphics/ and html/ directories must start with the name of the project plus an underscore, for instance "imp12_graphic.png" instead of "image.png". Furthermore, the Id names of the xml files which you find in the 'section class' element must likewise start with the name of the project plus underscore, for instance <section class="topic" id="itm_practicalxml"> . |
Automatic PDF Generation:
For web pages developed in XML, you have the option to automatically generate
a pdf version of your web page. The tools of PracticalXML will convert
the specified xml document into pdf and also decend into depending xml
documents. The result is an article like document with table of contents
and hyperlinks.
To tell the system to automatically generate a pdf version of a web page
you need to include the pdf attribute in the top section of your xml document.
Example:
<section class="topic" id="itm_howtos" pdf="itm_howtos">The value of the pdf tag has to be identical to the value of the id tag and the name of the xml file, in the example above: itm_howtos.xml.
<timestamp>version: $Id: itm_howtos.xml 2153 2019-01-31 09:23:43Z g2dpc $</timestamp>at the bottom of your xml document just before closing the last section tag. Furthermore, you have to set svn:keywords to Id. This can be done with
svn ps svn:keywords Id example.xmlassuming your xml is stored in "example.xml". With each commit, svn will automatically add the commit information between the two '$' which will be processed into the required update information by the system.
svn checkout https://gforge6.eufus.eu/svn/doc_test/branches target_dirThis will create a local copy of the software publishxml in your working copy and a binary version of tex2im which should run on all linux platforms.
setenv PATH {$PATH}:path_to_target_dir/tex2im-1.8or equivalent (depending on the shell) where path_to_target_dir is the path to your working copy.
svn checkout https://gforge6.eufus.eu/svn/doc_test/trunk/isip isipThis will strongly reduce the size of your working copy and allow you to edit you project's web pages without worrying about the rest of the website.
cd isip/public/xml edit xml files cd ../../ (i.e. inside isip/) svn commit -m "- made some changes" (just an example)
cd isip/public/xml ./makehtml.sh main.xmlThis will create the corresponding html files in isip/public/html/ and a symbolic link in isip/public/imports/.
./makehtml.sh <filename>where <filename> is the name of your xml document.
firefox isip/public/html/index.htmlThe layout is as it will appear on the server.
Please be aware that the test bed does NOT allow you to upload material to the web server yourself. This is done automatically by a CRON job. |
- perl - python - latex - pdflatex - convertAll these are needed to make the web pages.
Documents which are placed in the imports/ directories and
added via a <ulink> element can be categorized using a variety of
attributes for the <ulink> tag.
Categorized documents will appear ordered by category in the
ITM Document Catalog and
are therefore much easier to identify and to find than uncategorized
documents. The categorization has to be done by hand but is worth the
extra bit of effort.
Attributes for the categorization:
Besides the standard attribute $url, there are 10 optional
attributes for the <ulink> tag which are described in the following.
All 10 attributes have to present for the corresponding document to be
categorized. Documents which have been categorized at one location in the
XML tree of the ITM website do not need to be categorized again when linked
to the website at a different location.
Missing classification types may be added with the consent of the publication team.
Since this list is not exhaustive, you are welcome to add new topics as you wish. However, please keep in mind that a too granular categorization is of little use.
The order of the attributes is free. All values have to be enclosed in double quotes ("). Avoid leading or
trailing spaces.
An example for a categorized import (here edrg) is shown below:
<ulink url="../imports/meetings/2009/EDRG_kickoff/edrg_kick-off.ppt" title="Experimentalists and Diagnosticians Resource Group (EDRG) - Kick-off Meeting" type="presentation" project="edrg" author="Coelho" year="2009" month="01" topic="control" complexity="standard" addressee="public" size="15"> Overview of EDRG for 2009 (R.Coelho)</ulink>
To become a member of a Gforge project please login to the ITM Portal at
https://portal.eufus.eu |
GFORGE -> ProjectsNow find the project you would like to join on the list of projects.
extract_actor actor_name |
import_actor [path/]actor_name |
rmactor actor_name |
$ITMDOXYGENROOT/[GROUP]/[PROJECT]which can then be referenced by
<ulink url="https://portal.eufus.eu/documentation/ITM/doxygen/[GROUP]/[PROJECT]/"> SOME TEXT </ulink>in your xml (making the appropriate substitutions for [GROUP] and [PROJECT]). You will then need to copy the html generated by doxygen into the above directory.