Loading...
 
Skip to main content

History: Integrator User

Source of version: 6 (current)

Copy to clipboard
            ! Integrator User
^Some ((screenshot))s would be very welcome here....^
!! How to use Integrator
As a little ((tutorial)), I'll teach you how to integrate [http://www.doxygen.org|doxygened] documentation.
# at first you need to produce it (:razz:) 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:{CODE()}
cd /var/www/html/mydoxydoc;
find . -name '*.png' -exec convert -transparent '#FFFFFF' '{}' '{}' ';'
{CODE}As you may noticed, [http://www.imagemagick.org/|ImageMagick] needs to be installed on your system.
# Next you need to define the ''repository'' using [tiki-admin_integrator.php|Admin tool|nocache]. 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
####+ $tiki_root/styles/$style_base
#### $tiki_root/styles/integrator
#### 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:
####+ ''matrix-doxygen.css''
#### ''matrix.doxygen.css''
#### ''matrix_doxygen.css''
#### ''doxygen-matrix.css''
#### ''doxygen.matrix.css''
#### ''doxygen_matrix.css''
#### ''doxygen.css''
** Check ''Visibility'' box
** Type something in ''Description'' -- for example ''Doxygened documentation for my MEGA-Project'' :)
** Press ''Save''
# OK your first repository has been created. Now it's time to define some __''integration rules''__. Click on your repository in the table below ...
# ... 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 :)
# 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 :)
# 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 :)