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/site/apt/configuration.apt
1

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

  
11

  
12

  
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

  
17

  
18

  
19
    More documentation about the CDM (Common Data Library) where the CDM dataportal belongs could be found at the following locations:
20

  
21
    * {{{http://wp5.e-taxonomy.eu/cdmlib/}CDM Library}}
22
    
23
    * {{{http://wp5.e-taxonomy.eu/taxeditor/}Taxonomic Editor}}
24
    
25
    * {{{http://wp5.e-taxonomy.eu/cdm-server/}CDM Server}}
26
    
27
    * {{{http://wp5.e-taxonomy.eu/printpublisher/}Print Publisher}}
28
    
29
    * {{{http://wp5.e-taxonomy.eu/cdm-setups/}CDM Setups}}
30
    
31

  
32

  
33

  
34

  
35
Drupal module and theme activation
36

  
37
    To activate the datataportal module go to 
38
    <Administer-\>Site building-\>Modules>
39
    and at the CDM section select the modules CDM API, CDM Dataportal and CDM Taxon Tree. The other two 
40
    modules are optional.
41
    
42

  
43
    To change your default theme just navigate to      
44
    <Administer-\>Site building-\>Themes>
45
    where you can select your default theme as well as configured it. 
46

  
47

  
48

  
49
CDM Dataportal Settings
50

  
51

  
52
    If you are using the CDM Dataportal module, you will need to configure it in order to make it run. Here you will find how to
53
    explore and configure the module.
54

  
55

  
56

  
57
    First step to configure the module is making sure your user has access to the settings options of CDM Dataportal module.
58
    You can find the configurations options under <Administer-\>Site Configuration-\>CDM Dataportal>. Once you are in the
59
    configuration site you will see four different sections:
60

  
61

  
62

  
63

  
64
*General
65
    
66
    Drupal's CDM Dataportal module dialogues with the <CDM Server> asking for taxa data 
67
   	and classification of taxa. The first thing the <CDM Dataportal module> needs to know
68
   	is where is the CDM Server located in order to access it. Such parameters are configurable
69
    via the general tag of the settings.
70
    
71
    The general settings has enough documentation that explains itself. However the same
72
    documentation with some extra details is avaible
73
    <a href="./?q=admin/help/cdm_dataportal_general" title="General">here</a>
74
    as one html site. If you prefer to go directly to the general settings just click 
75
    <Administer-\>Site Configuration-\>CDM Dataportal>
76
    to start the configuration click here. 
77
	
78

  
79
	
80
*Geo & Map
81
    
82
    As with <CDM Server>, CDM Dataportal module also dialogues with a Map Server to 
83
    generate all the maps displayed on your web site. Again the module needs to know where
84
    the map server is located and this parameter as well as others related with the maps
85
    appaerance like map legends, map size, map background ... are configurable via
86
    {{{./?q=admin/settings/cdm_dataportal/geo}Geo & Map settings}}.
87
    This configuration site also explain all the configurable options itself. Same documentation with some extra details is avaible
88
    <a href="./?q=admin/help/cdm_dataportal_geo" title="Geo & Map">here</a> as one html site.
89
   	 	
90

  
91
	 	
92
*Layout		
93
    
94
    <a target="_blank" href="./?q=admin/settings/cdm_dataportal/layout" >Here</a> 
95
    you will find the settings for configuring the layout issues such pictures size or
96
    number of search results to show. Layout section itself contains three subsections; 
97
    <a target="_blank" href="./?q=admin/settings/cdm_dataportal/layout/taxon">Taxon Layout Settings</a>,
98
    <Administer-\>Site Configuration-\>CDM Dataportal-\>Layout-\>Search> and
99
    <Administer-\>Site Configuration-\>CDM Dataportal-\>Layout-\>Media>. 
100
    Each one of the listed links forward you to the settings configuration site where each site explains 
101
    itself the different options.
102
	
103
	
104
    
105
	A html site with more level of details is available 
106
	<a target="_blank" href="./?q=admin/settings/cdm_dataportal_layout">here</a>.
107
    
108

  
109
	
110
*Cache
111
    
112
    It is possible to increase the portal time response when serving taxa sites. The mechanism 
113
    is quite simple. It works caching all taxa sites available in your portal in a way that when
114
    a user wants to visit new taxa, the module will not create the new taxon site from scratch.
115
    Instead of that the taxon site will be loaded from the cache and therefore will be no
116
    dialogue with the CDM Server. 		 
117
    
118
		 
119
    
120
    <a href="./?q=admin/help/cdm_dataportal_cache.html" title="Cache">Here</a>
121
    you can read the cache configuration help or much better go directly to the
122
    {{{./?q=admin/help/settings/cdm_dataportal/cachesite}cache settings site}}.
123
    
124

  
125

  
1

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

  
11

  
12

  
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

  
17

  
18

  
19
    More documentation about the CDM (Common Data Library) where the CDM dataportal belongs could be found at the following locations:
20

  
21
    * {{{http://wp5.e-taxonomy.eu/cdmlib/}CDM Library}}
22
    
23
    * {{{http://wp5.e-taxonomy.eu/taxeditor/}Taxonomic Editor}}
24
    
25
    * {{{http://wp5.e-taxonomy.eu/cdm-server/}CDM Server}}
26
    
27
    * {{{http://wp5.e-taxonomy.eu/printpublisher/}Print Publisher}}
28
    
29
    * {{{http://wp5.e-taxonomy.eu/cdm-setups/}CDM Setups}}
30
    
31

  
32

  
33

  
34

  
35
Drupal module and theme activation
36

  
37
    To activate the datataportal module go to 
38
    <Administer-\>Site building-\>Modules>
39
    and at the CDM section select the modules CDM API, CDM Dataportal and CDM Taxon Tree. The other two 
40
    modules are optional.
41
    
42

  
43
    To change your default theme just navigate to      
44
    <Administer-\>Site building-\>Themes>
45
    where you can select your default theme as well as configured it. 
46

  
47

  
48

  
49
CDM Dataportal Settings
50

  
51

  
52
    If you are using the CDM Dataportal module, you will need to configure it in order to make it run. Here you will find how to
53
    explore and configure the module.
54

  
55

  
56

  
57
    First step to configure the module is making sure your user has access to the settings options of CDM Dataportal module.
58
    You can find the configurations options under <Administer-\>Site Configuration-\>CDM Dataportal>. Once you are in the
59
    configuration site you will see four different sections:
60

  
61

  
62

  
63

  
64
*General
65
    
66
    Drupal's CDM Dataportal module dialogues with the <CDM Server> asking for taxa data 
67
   	and classification of taxa. The first thing the <CDM Dataportal module> needs to know
68
   	is where is the CDM Server located in order to access it. Such parameters are configurable
69
    via the general tag of the settings.
70
    
71
    The general settings has enough documentation that explains itself. However the same
72
    documentation with some extra details is avaible
73
    <a href="./?q=admin/help/cdm_dataportal_general" title="General">here</a>
74
    as one html site. If you prefer to go directly to the general settings just click 
75
    <Administer-\>Site Configuration-\>CDM Dataportal>
76
    to start the configuration click here. 
77
	
78

  
79
	
80
*Geo & Map
81
    
82
    As with <CDM Server>, CDM Dataportal module also dialogues with a Map Server to 
83
    generate all the maps displayed on your web site. Again the module needs to know where
84
    the map server is located and this parameter as well as others related with the maps
85
    appaerance like map legends, map size, map background ... are configurable via
86
    {{{./?q=admin/settings/cdm_dataportal/geo}Geo & Map settings}}.
87
    This configuration site also explain all the configurable options itself. Same documentation with some extra details is avaible
88
    <a href="./?q=admin/help/cdm_dataportal_geo" title="Geo & Map">here</a> as one html site.
89
   	 	
90

  
91
	 	
92
*Layout		
93
    
94
    <a target="_blank" href="./?q=admin/settings/cdm_dataportal/layout" >Here</a> 
95
    you will find the settings for configuring the layout issues such pictures size or
96
    number of search results to show. Layout section itself contains three subsections; 
97
    <a target="_blank" href="./?q=admin/settings/cdm_dataportal/layout/taxon">Taxon Layout Settings</a>,
98
    <Administer-\>Site Configuration-\>CDM Dataportal-\>Layout-\>Search> and
99
    <Administer-\>Site Configuration-\>CDM Dataportal-\>Layout-\>Media>. 
100
    Each one of the listed links forward you to the settings configuration site where each site explains 
101
    itself the different options.
102
	
103
	
104
    
105
	A html site with more level of details is available 
106
	<a target="_blank" href="./?q=admin/settings/cdm_dataportal_layout">here</a>.
107
    
108

  
109
	
110
*Cache
111
    
112
    It is possible to increase the portal time response when serving taxa sites. The mechanism 
113
    is quite simple. It works caching all taxa sites available in your portal in a way that when
114
    a user wants to visit new taxa, the module will not create the new taxon site from scratch.
115
    Instead of that the taxon site will be loaded from the cache and therefore will be no
116
    dialogue with the CDM Server. 		 
117
    
118
		 
119
    
120
    <a href="./?q=admin/help/cdm_dataportal_cache.html" title="Cache">Here</a>
121
    you can read the cache configuration help or much better go directly to the
122
    {{{./?q=admin/help/settings/cdm_dataportal/cachesite}cache settings site}}.
123
    
124

  
125

  

Also available in: Unified diff