Difference between revisions of "NaviKey sample data"

From Biowikifarm Metawiki
Jump to: navigation, search
(Notes)
 
(15 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
'''An interactive key using NaviKey.'''  
 
'''An interactive key using NaviKey.'''  
  
This test uses the DELTA example dataset delivered with [[NaviKey]]5. Ultimately, all files are directly editable inside the Wiki, no special upload functionality is necessary.
+
This test uses the DELTA example dataset delivered with [[NaviKey]]5. All files are directly editable inside the Wiki, no special upload functionality is necessary.
  
 
----
 
----
Line 9: Line 9:
 
<IdentificationTool>
 
<IdentificationTool>
 
   tool=NaviKey5
 
   tool=NaviKey5
   config=../../Portal/Wiki.jsp?page=NavikeySampleData_Config.xml&mode=raw
+
   config=../../metawiki/index.php?title=NaviKey_sample_data/NavikeyConfig.xml&action=raw
  DeltaChars=NameOfYourDeltaCharsPage
+
  DeltaItems=NameOfYourDeltaItemsPage
+
  DeltaSpecs=NameOfYourDeltaSpecsPage
+
  DeltaTImages=NameOfYourDeltaTaxonImagesPage
+
 
</IdentificationTool>
 
</IdentificationTool>
 
<span style="color:#999999; font-size:0.8em; text-align:right;">Powered by: <a href="http://www.navikey.net/" target="_blank">NaviKey</a></span>
 
  
 
----
 
----
Line 22: Line 16:
 
==Notes==
 
==Notes==
  
* Optional parameters are: height=600px, width=100%, align=center; the value shown will be used if the parameters are omitted.
+
* ''Optional parameters are:'' height=600px, width=100%, align=center; the value shown will be used if the parameters are omitted.
 +
* ''Future parameters  are:'' (in planning to avoid creating config.xml for each identification tool) are: DeltaChars=NameOfYourDeltaCharsPage, DeltaItems=NameOfYourDeltaItemsPage, DeltaSpecs=NameOfYourDeltaSpecsPage, DeltaTImages=NameOfYourDeltaTaxonImagesPage
  
* [NaviKey sample data/DeltaChars], [NaviKey sample data/DeltaItems], [NaviKey sample data/DeltaSpecs], [NaviKey sample data/DeltaTImages]
+
The key uses DELTA data which reside in the following wiki pages:
* [NaviKey sample data/NavikeyConfig.xml]
+
* [[NaviKey sample data/DeltaChars]], [[NaviKey sample data/DeltaItems]], [[NaviKey sample data/DeltaSpecs]], [[NaviKey sample data/DeltaTImages]]
 +
* [[NaviKey sample data/NavikeyConfig.xml]]
  
* FROM JSP WIKI testing: Using the links above you can edit the files (or update by simply overwrite with updated content using the clipboard). To access the files for direct content access (for the config-file), use http://www.phytopathology.net/Portal/Wiki.jsp?page=####&mode=raw, where #### is the page name. See the content of the config.xml for an example (note that the Navikey config is an xml file, so that the the "&"-character must be escaped as "&"!).
+
Using the links above you can edit the files (or update by simply overwrite with updated content using the clipboard).  
 +
 
 +
Technical notes: To access the content in raw data mode (e.g. for the config-file), use <code>../../MetaWiki/index.php?title=YOURPAGENAME&action=raw</code>, where YOURPAGENAME is the page name (you cannot use short-url-paths like <code>../../meta/YOURPAGENAME&action=raw</code>). See the content of the config.xml for an example (note that the Navikey config is an xml file, so that the the "&"-character must be escaped as "<nowiki>&amp;</nowiki>"!).
 +
 
 +
* For testing purposes, the key is also running in conventional Navikey mode (static file upload, without using the wiki) [http://www.phytopathology.net/Tools/Navikey/DeltaSampleData/index.html here].
 +
 
 +
 
 +
Usage note: In the right lower part ("Resulting Items"), a right-click on a name gives you a list of links e.g to a DELTA HTML page, Google Images, Wikimedia Commons etc. related to that name.
 +
 
 +
===Further simplification ideas===
 +
 
 +
1. Config parameter defaults to a data-independent standard config file, the DELTA data files can be passed directly in parameters:
 +
 
 +
<nowiki><IdentificationTool>
 +
  tool=NaviKey5
 +
  DeltaChars=NameOfYourDeltaCharsPage
 +
  DeltaItems=NameOfYourDeltaItemsPage
 +
  DeltaSpecs=NameOfYourDeltaSpecsPage
 +
  DeltaTImages=NameOfYourDeltaTaxonImagesPage
 +
</IdentificationTool></nowiki>
 +
 
 +
2. All DELTA directives can be passed in fewer files:
 +
 
 +
<nowiki><IdentificationTool>
 +
  tool=NaviKey5
 +
  Delta1=NameOfPageWithAllDeltaData
 +
</IdentificationTool></nowiki>
 +
 
 +
Optionally, multiple parts can be given, using parameters like "Delta2=NameOfSecondPart".
 +
 
 +
----
  
* For testing purposes, the key is also running in conventional Navikey mode (static file upload, without using the wiki) at [http://www.phytopathology.net/Tools/Navikey/DeltaSampleData/index.html].
+
See http://www.mediawiki.org/wiki/Manual:Parameters_to_index.php#Raw for more information on raw. Problem: the result is always considered a php file and titled "index.php". The extension http://www.mediawiki.org/wiki/Extension:RawFile adds the ability to download portions and give a different filename.

Latest revision as of 10:53, 31 August 2009

Test of NaviKey

An interactive key using NaviKey.

This test uses the DELTA example dataset delivered with NaviKey5. All files are directly editable inside the Wiki, no special upload functionality is necessary.



Powered by: NaviKey. Do you have problems viewing the key? Try This.


Notes

  • Optional parameters are: height=600px, width=100%, align=center; the value shown will be used if the parameters are omitted.
  • Future parameters are: (in planning to avoid creating config.xml for each identification tool) are: DeltaChars=NameOfYourDeltaCharsPage, DeltaItems=NameOfYourDeltaItemsPage, DeltaSpecs=NameOfYourDeltaSpecsPage, DeltaTImages=NameOfYourDeltaTaxonImagesPage

The key uses DELTA data which reside in the following wiki pages:

Using the links above you can edit the files (or update by simply overwrite with updated content using the clipboard).

Technical notes: To access the content in raw data mode (e.g. for the config-file), use ../../MetaWiki/index.php?title=YOURPAGENAME&action=raw, where YOURPAGENAME is the page name (you cannot use short-url-paths like ../../meta/YOURPAGENAME&action=raw). See the content of the config.xml for an example (note that the Navikey config is an xml file, so that the the "&"-character must be escaped as "&"!).

  • For testing purposes, the key is also running in conventional Navikey mode (static file upload, without using the wiki) here.


Usage note: In the right lower part ("Resulting Items"), a right-click on a name gives you a list of links e.g to a DELTA HTML page, Google Images, Wikimedia Commons etc. related to that name.

Further simplification ideas

1. Config parameter defaults to a data-independent standard config file, the DELTA data files can be passed directly in parameters:

<IdentificationTool> tool=NaviKey5 DeltaChars=NameOfYourDeltaCharsPage DeltaItems=NameOfYourDeltaItemsPage DeltaSpecs=NameOfYourDeltaSpecsPage DeltaTImages=NameOfYourDeltaTaxonImagesPage </IdentificationTool>

2. All DELTA directives can be passed in fewer files:

<IdentificationTool> tool=NaviKey5 Delta1=NameOfPageWithAllDeltaData </IdentificationTool>

Optionally, multiple parts can be given, using parameters like "Delta2=NameOfSecondPart".


See http://www.mediawiki.org/wiki/Manual:Parameters_to_index.php#Raw for more information on raw. Problem: the result is always considered a php file and titled "index.php". The extension http://www.mediawiki.org/wiki/Extension:RawFile adds the ability to download portions and give a different filename.