Loading...
 

Introduction to Tiki Code Layout

The Tiki codebase is rather large so the following is a helpful introduction on what/where things are from a historical perspective.

tiki-*.php: These are the legacy traditional front-ends that users use to access all the various features. Increasingly though, they less used by end-users except by site administrators or content editors.

templates/tiki-*.tpl: The corresponding Smarty templates to the above.

tiki-index.php: This loads a wiki page. The most current approach in building UI for users is to use the wiki page as a kind of general purpose canvas to embed plugins, rather than to have users access the tiki-*.php for each of the different features.

lib/wiki-plugins/wikiplugin_*.php: Wiki plugins, that embed various functionality into wiki pages

templates/wiki-plugins/*.tpl: The corresponding Smarty templates to wiki plugins, if any for a particular wiki plugin.

lib/wiki-plugins/wikiplugin_list.php: The code for https://doc.tiki.org/PluginList, a general purpose query/templating engine to display data from Unified Search

lib/wiki-plugins/wikiplugin_customsearch.php: The code for https://doc.tiki.org/PluginCustomSearch, uses PluginList technology but provides an additional ability to create custom search/filtering interfaces

lib/*/*:php The traditional libs. These exist in subfolders for individual features.

lib/tikilib.php and lib/userlib.php: The oldest and most ancient libs in Tiki which still contain the most core functionality. In the early days of Tiki everything went here until more and more features were added (or refactored) into lib/* foders.

lib/core/*: This is where the new more OOP code goes. The class naming follows Zend folder structure convention.

lib/core/Services: This is where AJAX services go

templates/*/*.tpl (e.g. templates/files/*.tpl): These are the Smarty templates that correspond to the files AJAX service (lib/core/Services/File), for example.

templates/trackerinput/*.tpl and templates/trackeroutput/*.tpl, the tracker input and output templates for Tracker fields corresponding to lib/core/Tracker/Field/*.php

lib/core/Search: This is where all the Unified Search code goes, with the exception of lib/search/searchlib-unified.php and other features such as lib/search/*.php

lib/smarty_tiki/*.php: This is where all the Tiki specific Smarty modifiers, blocks and functions live.

lib/jquery_tiki/*.js: This is where most of the Jquery lives, esp. tiki-jquery.js

lib/tiki-js.js: This is where legacy non-jquery javascript lives, essentially what was introduced before jQuery was used in Tiki.

2 pages link to Introduction to Tiki Code Layout

Keywords

The following is a list of keywords that should serve as hubs for navigation within the Tiki development and should correspond to documentation keywords.

Each feature in Tiki has a wiki page which regroups all the bugs, requests for enhancements, etc. It is somewhat a form of wiki-based project management. You can also express your interest in a feature by adding it to your profile. You can also try out the Dynamic filter.

Accessibility (WAI & 508)
Accounting
Administration
Ajax
Articles & Submissions
Backlinks
Banner
Batch
BigBlueButton audio/video/chat/screensharing
Blog
Bookmark
Browser Compatibility
Calendar
Category
Chat
Comment
Communication Center
Consistency
Contacts Address book
Contact us
Content template
Contribution
Cookie
Copyright
Credits
Custom Home (and Group Home Page)
Database MySQL - MyISAM
Database MySQL - InnoDB
Date and Time
Debugger Console
Diagram
Directory (of hyperlinks)
Documentation link from Tiki to doc.tiki.org (Help System)
Docs
DogFood
Draw -superseded by Diagram
Dynamic Content
Preferences
Dynamic Variable
External Authentication
FAQ
Featured links
Feeds (RSS)
File Gallery
Forum
Friendship Network (Community)
Gantt
Group
Groupmail
Help
History
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
jQuery
Kaltura video management
Kanban
Karma
Live Support
Logs (system & action)
Lost edit protection
Mail-in
Map
Menu
Meta Tag
Missing features
Visual Mapping
Mobile
Mods
Modules
MultiTiki
MyTiki
Newsletter
Notepad
OS independence (Non-Linux, Windows/IIS, Mac, BSD)
Organic Groups (Self-managed Teams)
Packages
Payment
PDF
Performance Speed / Load / Compression / Cache
Permission
Poll
Profiles
Quiz
Rating
Realname
Report
Revision Approval
Scheduler
Score
Search engine optimization (SEO)
Search
Security
Semantic links
Share
Shopping Cart
Shoutbox
Site Identity
Slideshow
Smarty Template
Social Networking
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Staging and Approval
Stats
Survey
Syntax Highlighter (Codemirror)
Tablesorter
Tags
Task
Tell a Friend
Terms and Conditions
Theme
TikiTests
Federated Timesheets
Token Access
Toolbar (Quicktags)
Tours
Trackers
TRIM
User Administration
User Files
User Menu
Watch
Webmail and Groupmail
WebServices
Wiki History, page rename, etc
Wiki plugins extends basic syntax
Wiki syntax text area, parser, etc
Wiki structure (book and table of content)
Workspace and perspectives
WYSIWTSN
WYSIWYCA
WYSIWYG
XMLRPC
XMPP




Useful Tools