Home
Categories
Dictionary
Download
Project Details
Changes Log
What Links Here
How To
Syntax
FAQ
License

Linking to local resources



It is possible to embark local images, files, or whole APIs in the wiki, and link to these resources. There are three kinds of resources:
  • Images.
  • Files
  • APIs

Image resources

Main Article: Image files

Image localizations are defined in image files which specify the URL of each image and the ID to use to refer to it in the img element. Note that the URL of each image is relative to the file.

For example:
  <images>
    <image id="image1" url="hand.png" />
    <image id="image2" url="crocodile.png" />
  </images>

File resources

Main Article: Resource files

These files can be any kind of files (XML, HTML, text files, etc...). There are two ways to refer to these resource files:
  • Relative to the resource element. In that case, the resource file is under the "doc-file" directory which is under the element article parent[1]
    This allows to use XML files as resources
    .
  • Through a resource definition File. In that case, resource files are under the "doc-file" directory which is under the resource definition file parent[1]
    This allows to use XML files as resources
    . This way allows to define the resource only once but use it in many articles in the wiki

Local APIs

Main Article: APIs property

APIs can be defined locally and embarked in the wiki. In that case, the API should be defined in a sub-directory under the wiki output directory.

Notes

  1. ^ [1] [2] This allows to use XML files as resources

Categories: structure

docJGenerator Copyright (c) 2016-2023 Herve Girod. All rights reserved.