Project

General

Profile

« Previous | Next » 

Revision d2a09415

Added by Andreas Kohlbecker over 8 years ago

CRLF will be replaced by LF issues

View differences:

modules/cdm_dataportal/help/overview.html
1
<p>
2
    <a target="_blank" href="http://drupal.org" title="drupal">Drupal</a> is an open source
3
    <a target="_blank" href="http://en.wikipedia.org/wiki/Web_content_management_system" title="CMS">content managent system</a>
4
    which can be expanded, builded and custimized by developing modules and themes.
5
    <b>CDM Dataportal module</b> is a drupal module developed for supporting the front end or presentation layer of the
6
    <a target="_blank" href="http://wp5.e-taxonomy.eu/cdm-server/" title="EDIT CDM Server">EDIT CDM Server</a>.
7
    It allows taxonomist to look up for taxa, search taxa and other features. Besides
8
    the CDM Dataportal module there are several <b>drupal themes</b>
9
    which personalized the layout (colours, images and others) of the CDM Dataportal module results.
10
</p>
11

  
12
<p>
13
    On this basis, it can be possible, for example, to have two different taxonomy collections whith differents selected looks
14
    thanks to the different drupal themes (each one per collection). However both collections will have the same features (such
15
    taxa search) thanks to the CDM Dataportal module.
16
</p>
17

  
18
<p>
19
    More documentation about the CDM (Common Data Library) where the CDM dataportal belongs could be found at the following locations:
20
</p>
21
<ul>
22
    <li> <a target="_blank" href="http://wp5.e-taxonomy.eu/cdmlib/" title="CDM Library">CDM Library</a>
23
    </li>
24
    <li> <a target="_blank" href="http://wp5.e-taxonomy.eu/taxeditor/" title="Taxonomic Editor">Taxonomic Editor</a>
25
    </li>
26
    <li> <a target="_blank" href="http://wp5.e-taxonomy.eu/cdm-server/" title="CDM Server">CDM Server</a>
27
    </li>
28
    <li> <a target="_blank" href="http://wp5.e-taxonomy.eu/printpublisher/" title="Print Publisher">Print Publisher</a>
29
    </li>
30
    <li> <a target="_blank" href="http://wp5.e-taxonomy.eu/cdm-setups/" title="CDM Setups">CDM Setups</a>
31
    </li>
32
</ul>
33

  
34

  
35
<!-- module activation  -->
36
<h3>Drupal module and theme activation</h3>
37
<p>
38
    To activate the datataportal module go to
39
    <a target="_blank" href="./?q=admin/build/modules">Administer&#45;&#62;Site building&#45;&#62;Modules</a>
40
    and at the CDM section select the modules CDM API, CDM Dataportal and CDM Taxon Tree. The other two
41
    modules are optional.
42
</p>
43
    <p><strong>Note:</strong> If you downloaded Drupal from our download site, the module will be
44
    already enabled and ready for use.
45
    </p>
46
<p>
47
    To change your default theme just navigate to
48
    <a target="_blank" href="./?q=admin/build/themes">Administer&#45;&#62;Site building&#45;&#62;Themes</a>
49
    where you can select your default theme as well as configured it. 
50
</p>
51

  
52
<!-- CDM Dataportal Settings  -->
53
<h3>CDM Dataportal Settings</h3>
54

  
55
<p>
56
    If you are using the CDM Dataportal module, you will need to configure it. Here you will find how to
57
    explore and configure the module.
58
</p>
59

  
60
<p>
61
    First step to configure the module is making sure your user has access to the settings options of CDM Dataportal module.
62
    You can find the configurations options under <a target="_blank" href="./?q=admin/settings/cdm_dataportal">Administer&#45&#62Site Configuration&#45&#62CDM Dataportal</a>. Once you are in the
63
    configuration site you will see four different sections:
64
</p>
65

  
66
<ul>
67

  
68
<li><h4>General</h4>
69
    <p>
70
    Drupal's CDM Dataportal module dialogues with the <i>CDM Server</i> asking for taxa data
71
   	and classification of taxa. The first thing the <i>CDM Dataportal module</i> needs to know
72
   	is where is the CDM Server located in order to access it. Such parameters are configurable
73
    via the general tag of the settings.
74
    </p>
75
    <p>The <a target="_blank" href="./?q=admin/settings/cdm_dataportal/general">general settings</a> documentation explains itself.
76
	</p>
77
</li>
78
	
79
<li><h4>Geo &amp; Map</h4>
80
    <p>
81
    As with <i>CDM Server</i>, CDM Dataportal module also dialogues with a Map Server to
82
    generate all the maps displayed on your web site. Drupal needs to know where
83
    the map server is located and this parameter as well as others related with the maps
84
    appaerance like map legends, map size or map background are configurable via
85
    <a target="_blank" href="./?q=admin/settings/cdm_dataportal/geo" title="General">Geo &amp Map settings</a>.
86
    This configuration site explains itself.
87

  
88
   </p>
89
</li>
90
	 	
91
<li><h4>Layout</h4>
92
    <p>The Layout of <em>taxa pages</em>, <em>search results</em> and <em>media files</em>
93
    are configurable under
94
    <a target="_blank" href="./?q=admin/settings/cdm_dataportal/layout">Administer&#45;&#62;Site Configuration&#45;&#62;CDM Dataportal&#45&#62Layout</a>. 
95
    <em>Taxa pages</em> contains different sections which can be displayed as tabs or as single taxon page.
96
    This sections are <em>Taxon general information</em> (such descriptions or distribution),
97
    <em>taxon synonymy</em>, <em>taxon specimens</em> and <em>taxon media</em>.
98
    To configure the layout visit the layout settings site and read the documentation for more information.
99
    </p>
100
</li>
101
	
102
<li><h4>Cache</h4>
103
    <p>
104
    It is possible to increase the portal time response when serving taxa sites. The mechanism
105
    is quite simple. It works caching all taxa sites available in your portal in a way that when
106
    a user wants to visit new taxa, the module will not create the new taxon site from scratch.
107
    Instead of that the taxon site will be loaded from the cache and therefore will be no
108
    dialogue with the CDM Server.
109
    </p>
110
		 
111
    <p>Go to the
112
    <a target="_blank" href="./?q=admin/help/settings/cdm_dataportal/cachesite" title="Cache">cache settings site</a>
113
    to configure it or learn more about CDM Data Portal cache.
114
    </p>
115
</li>
116
</ul>
1
<p>
2
    <a target="_blank" href="http://drupal.org" title="drupal">Drupal</a> is an open source
3
    <a target="_blank" href="http://en.wikipedia.org/wiki/Web_content_management_system" title="CMS">content managent system</a>
4
    which can be expanded, builded and custimized by developing modules and themes.
5
    <b>CDM Dataportal module</b> is a drupal module developed for supporting the front end or presentation layer of the
6
    <a target="_blank" href="http://wp5.e-taxonomy.eu/cdm-server/" title="EDIT CDM Server">EDIT CDM Server</a>.
7
    It allows taxonomist to look up for taxa, search taxa and other features. Besides
8
    the CDM Dataportal module there are several <b>drupal themes</b>
9
    which personalized the layout (colours, images and others) of the CDM Dataportal module results.
10
</p>
11

  
12
<p>
13
    On this basis, it can be possible, for example, to have two different taxonomy collections whith differents selected looks
14
    thanks to the different drupal themes (each one per collection). However both collections will have the same features (such
15
    taxa search) thanks to the CDM Dataportal module.
16
</p>
17

  
18
<p>
19
    More documentation about the CDM (Common Data Library) where the CDM dataportal belongs could be found at the following locations:
20
</p>
21
<ul>
22
    <li> <a target="_blank" href="http://wp5.e-taxonomy.eu/cdmlib/" title="CDM Library">CDM Library</a>
23
    </li>
24
    <li> <a target="_blank" href="http://wp5.e-taxonomy.eu/taxeditor/" title="Taxonomic Editor">Taxonomic Editor</a>
25
    </li>
26
    <li> <a target="_blank" href="http://wp5.e-taxonomy.eu/cdm-server/" title="CDM Server">CDM Server</a>
27
    </li>
28
    <li> <a target="_blank" href="http://wp5.e-taxonomy.eu/printpublisher/" title="Print Publisher">Print Publisher</a>
29
    </li>
30
    <li> <a target="_blank" href="http://wp5.e-taxonomy.eu/cdm-setups/" title="CDM Setups">CDM Setups</a>
31
    </li>
32
</ul>
33

  
34

  
35
<!-- module activation  -->
36
<h3>Drupal module and theme activation</h3>
37
<p>
38
    To activate the datataportal module go to
39
    <a target="_blank" href="./?q=admin/build/modules">Administer&#45;&#62;Site building&#45;&#62;Modules</a>
40
    and at the CDM section select the modules CDM API, CDM Dataportal and CDM Taxon Tree. The other two
41
    modules are optional.
42
</p>
43
    <p><strong>Note:</strong> If you downloaded Drupal from our download site, the module will be
44
    already enabled and ready for use.
45
    </p>
46
<p>
47
    To change your default theme just navigate to
48
    <a target="_blank" href="./?q=admin/build/themes">Administer&#45;&#62;Site building&#45;&#62;Themes</a>
49
    where you can select your default theme as well as configured it. 
50
</p>
51

  
52
<!-- CDM Dataportal Settings  -->
53
<h3>CDM Dataportal Settings</h3>
54

  
55
<p>
56
    If you are using the CDM Dataportal module, you will need to configure it. Here you will find how to
57
    explore and configure the module.
58
</p>
59

  
60
<p>
61
    First step to configure the module is making sure your user has access to the settings options of CDM Dataportal module.
62
    You can find the configurations options under <a target="_blank" href="./?q=admin/settings/cdm_dataportal">Administer&#45&#62Site Configuration&#45&#62CDM Dataportal</a>. Once you are in the
63
    configuration site you will see four different sections:
64
</p>
65

  
66
<ul>
67

  
68
<li><h4>General</h4>
69
    <p>
70
    Drupal's CDM Dataportal module dialogues with the <i>CDM Server</i> asking for taxa data
71
   	and classification of taxa. The first thing the <i>CDM Dataportal module</i> needs to know
72
   	is where is the CDM Server located in order to access it. Such parameters are configurable
73
    via the general tag of the settings.
74
    </p>
75
    <p>The <a target="_blank" href="./?q=admin/settings/cdm_dataportal/general">general settings</a> documentation explains itself.
76
	</p>
77
</li>
78
	
79
<li><h4>Geo &amp; Map</h4>
80
    <p>
81
    As with <i>CDM Server</i>, CDM Dataportal module also dialogues with a Map Server to
82
    generate all the maps displayed on your web site. Drupal needs to know where
83
    the map server is located and this parameter as well as others related with the maps
84
    appaerance like map legends, map size or map background are configurable via
85
    <a target="_blank" href="./?q=admin/settings/cdm_dataportal/geo" title="General">Geo &amp Map settings</a>.
86
    This configuration site explains itself.
87

  
88
   </p>
89
</li>
90
	 	
91
<li><h4>Layout</h4>
92
    <p>The Layout of <em>taxa pages</em>, <em>search results</em> and <em>media files</em>
93
    are configurable under
94
    <a target="_blank" href="./?q=admin/settings/cdm_dataportal/layout">Administer&#45;&#62;Site Configuration&#45;&#62;CDM Dataportal&#45&#62Layout</a>. 
95
    <em>Taxa pages</em> contains different sections which can be displayed as tabs or as single taxon page.
96
    This sections are <em>Taxon general information</em> (such descriptions or distribution),
97
    <em>taxon synonymy</em>, <em>taxon specimens</em> and <em>taxon media</em>.
98
    To configure the layout visit the layout settings site and read the documentation for more information.
99
    </p>
100
</li>
101
	
102
<li><h4>Cache</h4>
103
    <p>
104
    It is possible to increase the portal time response when serving taxa sites. The mechanism
105
    is quite simple. It works caching all taxa sites available in your portal in a way that when
106
    a user wants to visit new taxa, the module will not create the new taxon site from scratch.
107
    Instead of that the taxon site will be loaded from the cache and therefore will be no
108
    dialogue with the CDM Server.
109
    </p>
110
		 
111
    <p>Go to the
112
    <a target="_blank" href="./?q=admin/help/settings/cdm_dataportal/cachesite" title="Cache">cache settings site</a>
113
    to configure it or learn more about CDM Data Portal cache.
114
    </p>
115
</li>
116
</ul>

Also available in: Unified diff