Skip to content

Commit

Permalink
adding new flag to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dgarijo committed Apr 1, 2024
1 parent 286c13f commit 0110169
Showing 1 changed file with 25 additions and 22 deletions.
47 changes: 25 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,58 +132,61 @@ docker run -ti --rm \

### Options

`-ontFile PATH` [required (unless -ontURI is used)]: Load a local ontology file (from PATH) to document. This option is incompatible with -ontURI
`-analytics CODE`: Add a code snippet for Google analytics to track your HTML documentation. You need to add your CODE next to the flag. For example: UA-1234

`-ontURI URI` [required (unless -ontFile is used)]: Load an ontology to document from its URI. This option is incompatible with -ontFile
`-confFile PATH`: Load your own configuration file for the ontology metadata. Incompatible with -getOntologyMetadata. See [the configuration documentation](doc/configuration/configuration_doc.md) for more information about the accepted fields.

`-outFolder folderName`: Specifies the name of the folder where to save the documentation. By default is 'myDocumentation'
`-crossRef`: ONLY generate the overview and cross reference sections. The index document will NOT be generated. The htaccess, provenance page, etc., will not be generated unless requested by other flags. This flag is intended to be used only after a first version of the documentation exists.

`-confFile PATH`: Load your own configuration file for the ontology metadata. Incompatible with -getOntologyMetadata. See [the configuration documentation](doc/configuration/configuration_doc.md) for more information about the accepted fields.
`-displayDirectImportsOnly`: Only those imported ontologies that are directly imported in the ontology being documented.

`-getOntologyMetadata`: Extract ontology metadata from the given ontology
`-doNotDisplaySerializations`: The serializations of the ontology will not be displayed.

`-oops`: Create an html page with the evaluation from the OOPS service (http://oops.linkeddata.es/)
`-excludeIntroduction`: Skip the introduction section in the documentation.

`-rewriteAll`: Replace any existing files when documenting an ontology (e.g., from a previous execution)
`-getOntologyMetadata`: Extract ontology metadata from the given ontology

`-crossRef`: ONLY generate the overview and cross reference sections. The index document will NOT be generated. The htaccess, provenance page, etc., will not be generated unless requested by other flags. This flag is intended to be used only after a first version of the documentation exists.
`--help`: Shows a help message and exits.

`-saveConfig PATH`: Save a configuration file on PATH with the properties of a given ontology
`-htaccess`: Create a bundle for publication ready to be deployed on your Apache server.

`-useCustomStyle`: Export the documentation using alternate css files (by Daniel Vila).

`-lang LANG1-LANG2`: Generate documentation in multiple languages (separated by "-"). Note that if the language is not supported, the system will load the labels in english. For example: en-pt-es
`-ignoreIndividuals`: Individuals will not be included in the documentation.

`-includeAnnotationProperties`: Include annotation properties defined in your ontology in the documentation (by default they are not included)

`-includeImportedOntologies`: Indicates whether the terms of the imported ontologies of the current ontology should be documented as well or not.

`-htaccess`: Create a bundle for publication ready to be deployed on your Apache server.
`-import`: imports a local ontology (e.g., if you don't want to load an online ontology, you may load its local version)

`-webVowl`: Create a visualization based on WebVowl (http://vowl.visualdataweb.org/webvowl/index.html#) in the documentation.
`-lang LANG1-LANG2`: Generate documentation in multiple languages (separated by "-"). Note that if the language is not supported, the system will load the labels in english. For example: en-pt-es

`-licensius`: Use the Licensius web services (http://licensius.com/apidoc/index.html) to retrieve license metadata. Only works if the -getOntologyMetadata flag is enabled.

`-ignoreIndividuals`: Individuals will not be included in the documentation.
`-noPlaceHolderText`: Do not add any placeholder text (this will remove intro, abstract (if empty) and description sections).

`-includeAnnotationProperties`: Include annotation properties defined in your ontology in the documentation (by default they are not included)
`-ontFile PATH` [required (unless -ontURI is used)]: Load a local ontology file (from PATH) to document. This option is incompatible with -ontURI

`-analytics CODE`: Add a code snippet for Google analytics to track your HTML documentation. You need to add your CODE next to the flag. For example: UA-1234
`-outFolder folderName`: Specifies the name of the folder where to save the documentation. By default is 'myDocumentation'

`-doNotDisplaySerializations`: The serializations of the ontology will not be displayed.
`-ontURI URI` [required (unless -ontFile is used)]: Load an ontology to document from its URI. This option is incompatible with -ontFile

`-displayDirectImportsOnly`: Only those imported ontologies that are directly imported in the ontology being documented.
`-oops`: Create an html page with the evaluation from the OOPS service (http://oops.linkeddata.es/)

`-rewriteAll`: Replace any existing files when documenting an ontology (e.g., from a previous execution)

`-rewriteBase PATH`: Change the default rewrite base path. The default value is "/". This flag can only be used with the htaccess option.

`-excludeIntroduction`: Skip the introduction section in the documentation.
`-saveConfig PATH`: Save a configuration file on PATH with the properties of a given ontology

`-uniteSections`: Write all HTML sections into a single HTML document.

`-noPlaceHolderText`: Do not add any placeholder text (this will remove intro, abstract (if empty) and description sections).

`--help`: Shows a help message and exits.
`-useCustomStyle`: Export the documentation using alternate css files (by Daniel Vila).

`--version`: Shows the version of WIDOCO.

`-webVowl`: Create a visualization based on WebVowl (http://vowl.visualdataweb.org/webvowl/index.html#) in the documentation.


## How can I make WIDOCO automatically recognize my vocabulary annotations?
There are two alternative ways for making WIDOCO get your vocabulary metadata annotations and use them automatically to document the ontology.
Expand Down

0 comments on commit 0110169

Please sign in to comment.