HTML service module

From WandoraWiki
(Difference between revisions)
Jump to: navigation, search
 
(11 intermediate revisions by one user not shown)
Line 1: Line 1:
−
This service provides a human friendly HTML access to the current topic map. HTML service name is '''topic'''. Service URL is
+
This service provides human friendly HTML access to the current topic map. The service's name is '''topic'''. To use the service module ensure the module is enabled in the configuration panel of [[Embedded HTTP server|embedded HTTP server]] and start the embedded HTTP server. The service URL is
  
 
  http://127.0.0.1:8898/topic  
 
  http://127.0.0.1:8898/topic  
  
−
This will open the same topic that is currently open in the Wandora application itself. To see other topics, use '''get''' parameter ''topic'' with the subject identifier of the topic you would like to see. For example  
+
This will open an HTML table visualization of the topic currently open in Wandora. Generated HTML pages contain links to all other related topics using this link format allowing very easy browsing of the topic map. To generate a visualization of any topic use the URL parameter ''topic'' with a value of a subject identifier of the topic. For example, you can generate an HTML view of the topic '''Schema type''' with a request
  
 
  http://127.0.0.1:8898/topic?topic=http%3A%2F%2Fwww.wandora.org%2Fcore%2Fschema-type
 
  http://127.0.0.1:8898/topic?topic=http%3A%2F%2Fwww.wandora.org%2Fcore%2Fschema-type
  
−
Generated HTML pages contains links to all other related topics using this link format allowing very easy browsing of the topic map. Image below shows '''Schema type''' topic served by the this service.
+
The HTML page service also accepts the URL parameters ''si'' and ''sl''. The former is used to address a topic with a subject identifier and latter a topic with it's subject locator. The screen captures below show examples of the HTML service's output.  
  
−
[[Image:Embedded_http_server_example.gif|center]]
 
  
−
This service uses [http://velocity.apache.org/ Apache velocity] to serve the pages. This means that it can also be used to server pages in other formats than HTML. The template used to build the pages can be changed in the service specific options. This template should be in the ''templates'' directory under the service specific directory. You can also place any static content needed for the pages in the ''static'' directory. You do not need to add the ''static'' in the path, just add the file name after the service name. For example <nowiki>http://localhost:8898/topic/wandora_logo.gif</nowiki> for the Wandora logo at the lower part of the page.
+
[[Image:service_topic_01.gif|center]]
  
−
This is also the default handler for services unless something else is specified in the service specific options.
+
 
 +
[[Image:service_topic_02.gif|center]]
 +
 
 +
This service uses the [http://velocity.apache.org/ Apache velocity] template engine to generate pages. The template files used are located in the ''templates'' directory. Other web resources such as images are located in the ''static'' folder. If you are familiar with Wandora's API and Velocity, it should be rather easy to modify the default template file.
  
 
== See also ==
 
== See also ==
  
 
* [[Embedded HTTP server]]
 
* [[Embedded HTTP server]]
 +
** [[Mobile HTML service module]]
 +
** [[RSS feed service module]]
 +
** [[SOAP web service module]]
 +
** [[Drupal service module]]
 +
** [[Firefox and Thunderbird plugin service module]]
 +
** [[XTM topic map service module]]
 +
** [[JTM topic map service module]]
 +
** [[RDF service module]]
 +
** [[GRAPHML service module]]
 +
** [[Screencast service module]]
 +
** [[Flash graph service module]]
 +
** [[Timeline service module]]
 +
** [[Google Maps service module]]
 +
** [[D3 graph service module]]

Latest revision as of 10:14, 8 August 2012

This service provides human friendly HTML access to the current topic map. The service's name is topic. To use the service module ensure the module is enabled in the configuration panel of embedded HTTP server and start the embedded HTTP server. The service URL is 

http://127.0.0.1:8898/topic

This will open an HTML table visualization of the topic currently open in Wandora. Generated HTML pages contain links to all other related topics using this link format allowing very easy browsing of the topic map. To generate a visualization of any topic use the URL parameter topic with a value of a subject identifier of the topic. For example, you can generate an HTML view of the topic Schema type with a request 

http://127.0.0.1:8898/topic?topic=http%3A%2F%2Fwww.wandora.org%2Fcore%2Fschema-type

The HTML page service also accepts the URL parameters si and sl. The former is used to address a topic with a subject identifier and latter a topic with it's subject locator. The screen captures below show examples of the HTML service's output.


Service topic 01.gif


Service topic 02.gif

This service uses the Apache velocity template engine to generate pages. The template files used are located in the templates directory. Other web resources such as images are located in the static folder. If you are familiar with Wandora's API and Velocity, it should be rather easy to modify the default template file.

[edit] See also

Retrieved from "http://wandora.org/w/index.php?title=HTML_service_module&oldid=10107"
Personal tools