1. Admin CTIC
  2. parrot

Wiki

Clone wiki

parrot / How_to_use_Parrot

Web Browser

Using the web browser UI of Parrot, you can choose between 4 options to document RIF and OWL files:

  • by URI. Type the URI where the OWL/RIF document is located. Remember that you can add more than one URI using the button "add another URI".
  • by direct input. Copy the OWL/RIF document content in the text area. Remember that you can add more than one text using the button "add another text".
  • by file upload. Select the OWL/RIF files using the dialog. Remember that you can add more than one file using the button "add another file".
  • by previous report. Type the URI where the previous report is located.

images/Web-screenshot.png

You can try it in http://ontorule-project.eu/parrot

Web Service

All the details about how to use Parrot as a web service are described in the REST documentation.

Eclipse Plugin

To use Parrot to document OWL and RIF documents in Eclipse, you just need to select the documents to be documented, right-click and select "Generate documentation".

images/Eclipse-screenshot.png

NeOn Toolkit / Terminae Plugin

To use Parrot to document OWL and RIF documents in Neon Toolkit and Terminae, you just need to select the ontologies to be documented, right-click and select "Generate documentation".

images/Neon-screenshot.png

Remind that its necessary to be in the perspective "Neon Toolkit Conceptual Level (OWL)" to use Parrot.

images/Terminae-screenshot.png

Command Line Interface

usage: java -jar parrot.jar [-b <arg>] [-h] [-i <file>] [-l <arg>] [-o <arg>] [-p <arg>] [-s <arg>] [-t <arg>]
options
 -b,--base <arg>       URI base to resolve the external resources  (default: http://ontorule-project.eu/parrot/)
 -h,--help             print help
 -i,--input <file>     input document
 -l,--lang <arg>       language using language subtag registry from IANA (default: en)
 -o,--output <arg>     output file (default output: console)
 -p,--profile <arg>    profile ( valid values: 'technical' [default] or 'business')
 -s,--css <arg>        customize Cascading Style Sheet URL (default: none)
 -t,--template <arg>   template (default: classpath:html/template.vm)

Example of usage:

java -jar parrot.jar -i http://ontorule-project.eu/resources/m24dem/CAx_M24_ontology.owl -i http://ontorule-project.eu/resources/m24dem/CAx_M24_rules_parrot.rifps -o documentation-generated.html -s http://idi.fundacionctic.org/semantica/parrot/style.css -b http://ontorule-project.eu/parrot/

center

Advance users

How to customize a Parrot report adding a prologue and an appendix

Once the report is generated by Parrot, it can be saved as an HTML file.

This file can be edited, adding information in two place-holder sections: prologue and appendix.

Once the sections have been fulfilled, the report can be updated using the by existing report option. In order to use this option, the '''fulfilled''' report must be uploaded in a server in advance.

This feature is possible thanks to the RDFa content available in the Parrot report, that used the Parrot ontology.

Updated