Loading...
 
Skip to main content
How to use Integrator
Page actions
PDF Print Get a short URL Open in WebDAV

Integrator User

Some screenshots would be very welcome here....

How to use Integrator

As a little tutorial, I'll teach you how to integrate doxygened documentation.

  1. at first you need to produce it 😛 and to put it into your document root... let it be /var/www/html/mydoxydoc. Also consider to fix background of generated pictures — to make it transparent (not all themes in Tiki have white background). 😊 You may do this by one simple command:
    Copy to clipboard
    cd /var/www/html/mydoxydoc;
find . -name '*.png' -exec convert -transparent '#FFFFFF' '{}' '{}' ';'
    As you may noticed, ImageMagick needs to be installed on your system.
  2. Next you need to define the repository using Admin tool. Specify the following
    [-]
    • Name — name of your repository. Type My Doxygened Documentation
    • Path — type /mydoxydoc
    • Start Page — index.html (In case of remote files/scripts here should be file name with parameters: tiki-index.php?page=TikiIntegrator for example)
    • CSS File — doxygen.css. Currently only Notheme series themes have redefined styles for doxygened docs. All others use little adopted default (got from doxygen) CSS. Tiki Integrator search CSSes in the following way:
      • directories to scan
        [-]
        1. $tiki_root/styles/$style_base
        2. $tiki_root/styles/integrator
        3. configured repository path
      • files to search for in every directory (for example assume that current theme is Matrix (matrix.css) and configured repository CSS file is doxygen.css:
        [-]
        1. matrix-doxygen.css
        2. matrix.doxygen.css
        3. matrix_doxygen.css
        4. doxygen-matrix.css
        5. doxygen.matrix.css
        6. doxygen_matrix.css
        7. doxygen.css
    • Check Visibility box
    • Type something in Description — for example Doxygened documentation for my MEGA-Project 😊
    • Press Save
  3. OK your first repository has been created. Now it's time to define some integration rules. Click on your repository in the table below ...
  4. ... and on the new page (Edit Rules for Repository) press copy rules link...
    [-]
    • Currently only 'Notheme' themes have rules copying dialog hidden by default, in other themes no need to press/click something here — dialog is already visible... but in author's plans it should be hidden 😊
  5. Choose Doxygened (1.3.4) Documentation and press the Copy button
    • here is a small cheat: by default (just after install) Tiki Integrator already has rules for doxygened repositories (as most usual type of programmer documentation)... in other cases you will need to make such rules for your repository by yourself... but fortunately it is easier than you may think 😊
  6. Press/click view repository and enjoy 😊
    • it's recommended to use one of the Notheme themes 😊
    • ... also you may ask the author of your preferred theme to provide doxygen.css file too 😊


History Source
Slideshow