Loading...
 
How to use Integrator

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 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:
    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 Pageindex.html (In case of remote files/scripts here should be file name with parameters: tiki-index.php?page=TikiIntegrator for example)
    • CSS Filedoxygen.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 :-)


doc.tiki.org


Bootstrap

AdminGuide

UserGuide

Keywords

Keywords serve as “hubs” for navigation within the Tiki documentation. They correspond to development keywords (bug reports and feature requests):

Accessibility (WAI and 508)
Accounting (7.x)
Articles and Submissions
Backlinks
Banners
Batch (6.x)
BigBlueButton audio/video/chat/screensharing (5.x)
Blog
Bookmark
Browser Compatibility
Link Cache
Calendar
Category
Chat
Clean URLs
Comments
Communication Center
Compression (gzip)
Contacts (Address Book)
Contact us
Content Templates
Contribution (2.x)
Cookie
Copyright
Credit (6.x)
Custom Home and Group Home Page
Date and Time
Debugger Console
Directory of hyperlinks
Documentation link from Tiki to doc.tiki.org (Help System)
Docs 8.x
Draw 7.x
Dynamic Content
Dynamic Variable
External Authentication
FAQ
Featured links
File Gallery
Forum
Friendship Network (Community)
Gmap Google maps
Groups
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
Kaltura video management (4.x)
Karma
Live Support
Login
Logs (system & action)
Look and Feel
Lost edit protection
Mail-in
Map with Mapserver
Menu
Meta Tags
Mobile Tiki and Voice Tiki
Mods
Module
MultiTiki
MyTiki
Newsletter
Notepad
Payment
Performance Speed / Load
Permissions
Platform independence (Linux-Apache, Windows/IIS, Mac, BSD)
Polls
Profiles
Profile Manager
Report
Toolbar
Quiz
Rating
Feeds
Score
Search engine optimization
Search
Search and Replace
Security
Semantic links (3.x)
Shadowbox
Shadow Layers
Share
Shopping cart
Shoutbox
Slideshow
Smiley
Social Networks
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Stats
Surveys
Tags (2.x)
Task
Tell a Friend, alert + Social Bookmarking
TikiTests (2.x)
Theme CSS & Smarty
Trackers
Transitions (5.x)
TRIM
User Administration including registration and banning
User Files
User Menu
Watch
WebHelp
WebDAV (5.x)
Webmail
Web Services
Wiki 3D
Wiki History, page rename, etc
Wiki Page Staging and Approval (2.x)
Wiki Plugin extends basic syntax
Wiki Syntax
Wiki structure (book and table of content)
Workspace
WSOD
WYSIWYCA
WYSIWYG (2.x)
XMLRPC


Tiki Newsletter

Delivered fresh to your email inbox!
Newsletter subscribe icon
Don't miss major announcements and other news!
Contribute to Tiki
Show php error messages