Professional Documents
Culture Documents
Tiki Essentials
What all Smarties need to know about Tiki Wiki CMS Groupware
Tiki Essentials (http://twessentials.tikiforsmarties.com) is by Rick Sapir (based on content originally published by KeyContent.org( and licensed under a Creative Commons Attribution-Share Alike 3.0 United States License. Some rights reserved. Permissions beyond the scope of this license may be available at http://twessentials.tikiforsmarties.com/Copyright+Information. The complete guide, in additional languages and covering multiple versions of Tiki Wiki CMS Groupware is available online at http://twessentials.tikiforsmarties.com. This guide is designed to be an easy-to-read book that will get new Tiki administrators up and running. For complete information about Tiki Wiki CMS Groupware, please visit http://tiki.org. For the official Tiki documentation, please visit http://doc.tiki.org. For a beginner's guide, try Tiki for Dummies Smarties, http://tikiforsmarties.com.
Tiki Essentials is a collaboratively written guide. You are encouraged to contribute. Please see http://twessentials.tikiforsmarties.com/Contributors for more information.
This edition was automatically generated from the Tiki Essentials web site on Mar 2, 2012. Be aware that there may be formatting errors or inconsistencies with this automatically generated documentation. To purchase the complete Tiki Essentials as a paperback or ebook, please visit http://tikiformsarties.com/Books.
Page 1
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Tiki Essentials
What all Smarties need to know about Tiki Wiki CMS Groupware Be sure to review the Essential Questions (FAQs) for answers to common questions about this guide.
Table of Contents
Tiki Essentials...........................................................................................................1 1 Welcome to Tiki Essentials.....................................................................................7 In this section....................................................................................................................................7 1.1 About this Guide..............................................................................................................................8 In this section....................................................................................................................................8 Disclaimers.......................................................................................................................................8 About this Site..................................................................................................................................9 1.1.1 Using this Guide......................................................................................................................9 In this section..................................................................................................................................10 1.1.2 Copyright Information...........................................................................................................18 1.2 About the Author...........................................................................................................................19 2 Getting Started with Tiki......................................................................................20 In this section..................................................................................................................................20 2.1 Upgrading Your Tiki......................................................................................................................20 2.1.1 Upgrading to the Current Release..........................................................................................21 2.1.2 Getting the Latest Code.........................................................................................................26 2.2 Essential Installation Tips..............................................................................................................28 Performing a Manual Installation...................................................................................................29 Creating the Database.....................................................................................................................30 2.2.1 What to Backup.....................................................................................................................32 2.2.2 Backing up the Database.......................................................................................................37 2.3 Tiki Install Directory.....................................................................................................................41 Files................................................................................................................................................42 Directories/folders..........................................................................................................................42 3 Customizing Tiki Themes.....................................................................................44 In this section..................................................................................................................................44 3.1 Using the CSS Assistant................................................................................................................45 3.2 Using the Look and Feel...............................................................................................................47 3.2.1 Adding Custom CSS Styles...................................................................................................48 3.2.2 Which CSS Style to Edit........................................................................................................53
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 2 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
3.3 Using the Theme Generator...........................................................................................................55 3.4 Modifying Templates.....................................................................................................................56 Finding the Right Template............................................................................................................58 Including Wiki Syntax....................................................................................................................61 3.5 Template Map................................................................................................................................63 Wiki Pages......................................................................................................................................64 Articles............................................................................................................................................65 Forums............................................................................................................................................65 Blogs...............................................................................................................................................66 3.6 Other Customizations....................................................................................................................67 3.6.1 Customizing Per Page............................................................................................................67 3.6.2 Customizing by Category......................................................................................................69 4 Adding Web Content to Tiki.................................................................................71 In this section..................................................................................................................................71 4.1 Editing Pages.................................................................................................................................71 Copying and Pasting.......................................................................................................................73 Inserting Special Characters...........................................................................................................75 Using the Code Highlighter............................................................................................................76 4.2 Adding Widgets and Scripts..........................................................................................................78 4.2.1 Using the HTML Plugin........................................................................................................78 4.2.2 Using the JS Plugin................................................................................................................85 4.2.3 Allowing HTML in Pages......................................................................................................92 4.3 Using Modules..............................................................................................................................94 4.3.1 Creating User Modules..........................................................................................................94 4.3.2 Assigning Modules................................................................................................................98 4.3.3 Understanding Module Parameters......................................................................................103 5 Using Trackers...................................................................................................111 In this section................................................................................................................................111 5.1 Building Forms............................................................................................................................111 5.1.1 Creating a Tracker................................................................................................................112 5.1.2 Entering Tracker Data..........................................................................................................120 5.1.3 Displaying Tracker Data......................................................................................................123 5.2 Using Dynamic Lists...................................................................................................................126 5.2.1 Building the Internal Tracker...............................................................................................126 5.2.2 Adding the Dynamic List.....................................................................................................130 5.3 Creating Pretty Trackers..............................................................................................................134 5.3.1 Building a Template.............................................................................................................135 5.3.2 Displaying the Pretty Tracker..............................................................................................137 6 Writing Plugins...................................................................................................139 In this section................................................................................................................................139
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 3 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
When to Use a Plugin........................................................................................................................141 Writing a Simple Plugin....................................................................................................................142 6.1 Inputting Variables.......................................................................................................................143 Defining the Function...................................................................................................................145 Reading the Variables and Setting Defaults..................................................................................146 6.2 Adding Security and Help...........................................................................................................148 6.3 Displaying the Output.................................................................................................................150 Using the Plugin...........................................................................................................................151 7 Using Profiles.....................................................................................................155 In this section................................................................................................................................155 7.1 Using Profile Repositories...........................................................................................................158 Accessing the Tiki Repository......................................................................................................160 Creating your own Repository......................................................................................................162 7.2 Creating Profiles..........................................................................................................................163 Creating a Profile from a Site.......................................................................................................165 Writing a new Profile....................................................................................................................167 7.3 Applying Profiles.........................................................................................................................167 8 Performing Database Magic................................................................................173 In this section................................................................................................................................173 8.1 Adding and Overriding Programaticlly.......................................................................................173 Writing a Simple SQL Query.......................................................................................................176 8.2 Accessing Data from Wiki Pages................................................................................................176 Creating a DSN.............................................................................................................................178 Using the SQL Plugin...................................................................................................................180 Using the DBReport Plugin..........................................................................................................181 8.3 Updating Tiki Preferences...........................................................................................................182 Changing Preferences...................................................................................................................185 Fixing Modules.............................................................................................................................186 Editing Custom Code....................................................................................................................188 9 Joining the Tiki Community................................................................................190 In this section................................................................................................................................190 About the Tiki Websites....................................................................................................................190 Connecting to the Tiki Directory.......................................................................................................191 9.1 Tiki Registration..........................................................................................................................194 9.2 Social Networking.......................................................................................................................198 9.3 Getting Help................................................................................................................................199 9.3.1 Using the Forums.................................................................................................................199 9.3.2 Chatting on IRC...................................................................................................................204 9.3.3 Mailing Lists........................................................................................................................208 9.4 Contributing to Tiki.....................................................................................................................209
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 4 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
9.4.1 Getting Committed..............................................................................................................210 9.4.2 Sharing what you Know......................................................................................................214 10 Exploring the Possibilities................................................................................216 or, 1015 Uses for Tiki Wiki CMS Groupware..............................................................................216 In this section................................................................................................................................216 10.1 Blog...........................................................................................................................................217 Features & Examples....................................................................................................................217 Example Profile............................................................................................................................218 YAML Profile...............................................................................................................................219 10.2 News Portal...............................................................................................................................220 Example Profile............................................................................................................................221 10.3 Corporate Web Site....................................................................................................................221 Features & Examples....................................................................................................................221 Example Profile............................................................................................................................221 10.4 Club or Association...................................................................................................................222 Features & Examples....................................................................................................................222 Example Profile............................................................................................................................222 10.5 Online Book..............................................................................................................................222 Features & Examples....................................................................................................................222 Example Profile............................................................................................................................222 10.6 Issue Tracker..............................................................................................................................223 Features & Examples....................................................................................................................223 Example Profile............................................................................................................................223 10.7 Collaborative Website................................................................................................................223 Features & Examples....................................................................................................................223 Example Profile............................................................................................................................223 10.8 Technical Documentation..........................................................................................................223 Features & Examples....................................................................................................................224 Example Profile............................................................................................................................224 10.9 Translation Management System..............................................................................................224 Features & Examples....................................................................................................................224 Example Profile............................................................................................................................224 10.10 Collaborative Website..............................................................................................................224 Features & Examples....................................................................................................................224 Example Profile............................................................................................................................225 11 Epilogue...........................................................................................................226 Colophon...........................................................................................................................................226
Page 5
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Page 6
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
About this Guide Using this Guide Copyright Information About the Author
Page 7
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Using this Guide Copyright Information
Disclaimers
This guide is not a replacement for the official Tiki Documentation . Instead this guide will expand your knowledge of a few key features. Remember, Tiki has over one thousand options and configurations (more than other CMS applications). You should explore the documentation and community portal for complete information on everything that Tiki has to offer. The author and other contributors make no guarantees as to the accuracy or completeness of any information in this guide. By using this guide, you agree to do
Page 8
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
so at your own risk. You further agree not hold the author or any contributors liable for any results that may occur from the use of the product mentioned in this guide.
VALID MARKUP
ACCESSIBILITY FEATURES
This site uses the following access keys: L Log in/Log out S Search 1 Home 2 About 3 Contact 4 What's new 5 Contributors
PRIVACY POLICY
The privacy policy for Tiki Essentials (this site) is located at: http://twessentials.keycontent.org/Privacy+Policy.
COPYRIGHT INFORMATION
The copyright information for Tiki Essentials (this site) is located at: http://twessentials.keycontent.org/Copyright+Information.
Page 9
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
in this guide, are actually implemented on this site. In order to get the most out of this guide, you should read this section first because it explains how to find the information that you may be looking for. This guide is written by a Windows user, and this is reflected in the terminology and screen shots. But because Tiki is a browser-based, web application, you should be able to transfer this information to your operating system.
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud
NAVIGATION
There are four primary ways to navigate through the content in this guide: The Contents menu provides direct links to the primary sections of the guide. Think of this as a book's table of contents. The menu is always available, on the left side of every page.
Page 10
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The Contents menu is a simplified table of contents. There is also an additional menu at the top of the page that includes links for general information about this site (including how to register and contribute). The Search bar, located at the top of the screen, provides a full-text search of all the pages in this guide. For best results, try searching for only one or two words instead of a full sentence or phrase.
The Structure bar, located above the content area provides an easy way to "page" through each section. This is sometimes also called "bread crumbs" because it shows a trail of links like bread crumbs to show how you got to this page.
At the top and bottom of each page are links to to go the Next ( )and Previous ( ) pages, as well as the beginning of the current section ( ). The Related Topics links, when available, provides direct access to related (or similar topics). Using these links makes it easy to move through different
Page 11
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
(but related) sections in the guide. Figure: Use the Related Topics list to quickly jump to similar pages.
CONVENTIONS
Throughout this guide, you will find tips, notes, and warnings: Warning: This is how a warning appears. Pay close attention to each warning. There aren't many, but they are important. You could crash your Tiki or corrupt the database, making your site inaccessible. Tip: This is how a tip appears. Tips are helpful hints that will make your Tiki experience easier, such as providing alternate ways of accomplishing a task. Note: This is how a note appears. Notes are secondary information that you may (or may not) need.
LINKS
There are two types of links used in this guide: Internal links (that is, links to other sections of this guide) are simply underlined. External links (that is, links to other websites) include the external link icon ( ). External links to the official Tiki websites are identified with the Tiki icon ( ). These links contain detailed information and are highly recommended.
IMAGES
The images and screenshots included in this guide have been reduced to better fit the screen. You can enlarge any image to its full size simply by clicking the image.
Page 12
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Click to the image to enlarge it. This will make the screens and graphics much easier to read.
PRINTING
To print a single page from Tiki Essentials, simply click the Print icon of the page.
at the top
To print multiple pages, or the entire guide at once, click the Print multiple pages icon icon. From the Print Multiple Pages page, you can select which pages to print. Select Structure to print the entire guide.
Page 13
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Page 14
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
You can also purchase the complete, soft-cover edition of Tiki Essentials: Tiki Essentials is available for purchase through Amazon, LuLu, and others. See Buy the Book for details.
CONVERTING TO PDF
To convert a single page from Tiki Essentials to PDF format, simply click the PDF icon at the top of the page. I use the free, hosted, HTMLtoPDF service provided by pdf2me.com. It may take several seconds to produce the PDF, so please be patient! I also provide periodic "snapshots" of Tiki Essentials (in PDF and TXT formats) on Scribd , if you want the complete guide.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
TRANSLATIONS
Tiki (and this guide) uses powerful multilingual tools. Use the page-specific language option at the top-right of each page to translate the current page. Note: Changing a page translation will also change the site language.
Page 15
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Translating a page. This includes: Human Translations Contributors, just like you, have helped translate Tiki Essentials into multiple languages. You can help... Machine Translations Automated translations for pages are provided by Google Translate .
TAGS
A tag is a keyword term that identifies a piece of information. Pages in Essentials are "tagged" with terms to help you know what the page is about. You can click a page's tag to find similar pages that are tagged with the same term.
Page 16
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Tags for a page. You can help tag this guide! All tags should be in lowercase. Separate multiple tags with a blank space. Enclose multi-word tags in quotes. To reduce spam, you must enter a CAPTCHA to add tags to a page. There is no CAPTCHA for contributors who are logged in.
TAG CLOUD
The tag cloud is a visual representation of the popularity of all the tags. The more popular a tag, the larger it appears in the cloud. Simply click a tag in the cloud to display all the tagged pages.
Page 17
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Please read Credits and Acknowledgments for full list of contributors to this project.
IMAGES
The screen images are from Tiki Wiki CMS Groupware Version 6, and are made available under the GNU Lesser General Public License, Version 2.1 (LGPL). Some pictures and images are from stock.xchng and are subject to the SXC Image License Agreement . Title image by Flavio Takemoto , used with permission.
TRADEMARKS
Tiki, Tiki Wiki CMS Groupware, and the Tiki logo are trademarks of the Tiki Software Community Association , used with permission. KeyContent.org and Tiki Essentials are unaffiliated with the Tiki Software Community Association.
Page 18
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
PRIVACY
Please see Privacy Policy for information on how your personal information is treated when you access Tiki Essentials.
Page 19
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Upgrading Your Tiki Upgrading to the Current Release Getting the Latest Code Essential Installation Tips What to Backup Saving your Theme Backing up Other Customizations Backing up the Database Tiki Install Directory
Page 20
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
IN THIS SECTION
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions
Page 21
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Warning: Always back up your Tiki files and database before upgrading.
USING A PATCHSET
For incremental releases (such as from 4.2 to 4.3), you can download a patchset that contains only the files and database definitions that have been changed.
Page 22
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The 4.2to4.3 patch set contains only the required changes to move from Tiki 4.2 to 4.3. To install the patchset: Warning: Be sure to back up your customizations 'before'' running the Tiki Installer. 1. Download the patchset from SourceForge.net . 2. Unpack the archive into your Tiki directory. The new files will automatically overwrite the existing files. 3. Locate the version-specific .sql file in the ../db/ folder and execute it against your database. Note: Not all patchsets will contain database updates. 4. Use the Tiki Installer and select the Upgrade option, as shown here.
Page 23
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
You can also upgrade your Tiki by installing the latest, full version. Warning: Be sure to back up your customizations before running the Tiki Installer. 1. Download the Tiki release from http://tikiwiki.org on your host. 2. Run the Tiki installer by opening your browser to http://YOUR_DOMAIN/tiki-install.php. and expand the archive
Tip: Refer to the Installation Instructions in Tiki for Dummies Smarties for complete details, including how to "unlock" your site and how to complete the Security Precaution page. 3. Tiki should automatically detect that you are upgrading an existing site. Click the link to go directly to the Install/Upgrade step.
Tiki automatically detects that you are running an upgrade. Note: If the Tiki installer does not display the Upgrade link, confirm that the database information in your ...db/local.php file is correct. 4. On the Install & Upgrade page, click Upgrade to upgrade your Tiki database
Page 24
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Upgrading your database. Tip: In some cases, when a Tiki feature is deprecated or removed, there may be "extra" database tables that remain, after the upgrade. If you do not have any data these tables, you may safely remove them from the database. See http://doc.tiki.org/Upgrade for details of tables can be removed. 5. After upgrading the database, confirm that all queries were successful and click Continue.
Page 25
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Completing the Installer upgrade. 6. Complete the remaining pages of the Tiki Installer, as needed, then enter your Tiki. Be sure to read the Release Notes release. for each to understand the changes in the new
After completing your upgrade, you must restore any of the customizations that you previously backed up. This includes: Templates and stylesheets File galleries Attachments Language files Plugins and modules
Note: If you customized any PHP files that were part of the upgrade, you will have to manually copy your customizations to the new version files. To avoid this issue, consider joining the Tiki Community and contributing your customizations to the Tiki code repository.
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy
Page 26
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives
You can check out Tiki code with Anonymous access. For example, to check out a specific version use:
svn co https://tikiwiki.svn.sourceforge.net/svnroot/tikiwiki/branches/X.x
Where X.X is the version number to check out (such as 6.x). To check out the current development branch use:
svn co https://tikiwiki.svn.sourceforge.net/svnroot/tikiwiki/trunk
If you prefer a GUI SVN client, you can use an application such as Tortoise SVN
Page 27
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
(http://tortoisesvn.net/ ) to check out Tiki code from SVN. Note: Refer to SVN Tips on the Tiki Developer's site for additional information.
BECOMING A DEVELOPER
To check files into the repository, you'll need to join the Tiki community and get committer access. It is quick and easy, and allows you to directly impact the growth of Tiki Wiki CMS Groupware.
Every six hours, Tiki automatically creates an archive (TAR and ZIP) from the latest code. As an alternative to using SVN, you can download these archives to test or tryout the latest, pre-release code. You can obtain these daily builds from the Tiki Developer site : http://dev.tikiwiki.org/Daily+Build . Warning: These archives include pre-released code. You should not use the code for a live, inproduction site.
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 28 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database
Page 29
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
local.php
<?php $db_tiki='mysqli'; $dbversion_tiki='8.0'; $host_tiki='localhost'; $user_tiki='NAME OF YOUR DATABASE USER'; $pass_tiki='PASSWORD FOR YOUR DATABASE USER'; $dbs_tiki='NAME OF YOUR DATABASE'; $client_charset='utf8';
Note: If the database is on a different machine then the webserver, replace localhost with the URL location of the database. By default, Tiki uses UTF-8 for your database encoding. If you select a different encoding method, you must change the $client_charset setting to match your database. See Creating the Database, below, for more information. You should now be able to access your site and log in. Tip: See http://doc.tikiwiki.org/Manual+Installation manual installation. for additional details on performing a
Page 30
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Creating a new database with UTF-8 collation. Note: In some hosted environments, you may not be able to specify the collation. In that case, contact your webhost for details on selecting the correct collation type. If Tiki detects that your database does not use the correct encoding, you can attempt to convert it to use UTF-8 encoding.
Tiki can attempt to fix your database. Warning: Be sure to backup your database before attempting the conversion.
Page 31
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
If you have customized the theme (i.e., the skin) of your Tiki, you'll want to make sure that you back up all the necessary images and stylesheets. Your stylesheet is located in TIKI_HOME/styles/YOUR_THEME.css. Graphics and additional files are located in TIKI_HOME/styles/YOUR_THEME/.... If you customized any Smarty template TPL files, be sure to back them up as well. Your customized templates are located in TIKI_HOME/templates/styles/YOUR_THEME/.... Tip: When possible, avoid using custom template (TPL) files, as doing so will complicate your upgrade process.
In addition to the mySQL database and theme-specific files, there are additional files that you should backup. in this section
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 32 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else
FILE GALLERIES
When configuring the Tiki File Gallery, you can specify if Tiki stores files in the Database or in a Directory.
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 33 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Configuring File Gallery storage location. If you store files in a directory, you must back up the specific directory. Tip: Files stored the database are automatically included when you backup the database. Note: If you use Tiki Image Galleries (which were deprecated in Tiki 4) and store the images in a directory, you must back up the specific directory, too.
When configuring the Tiki wiki features, if you use Attachments you can specify if Tiki stores the attachments in the Database or in a Directory. If you store files in a directory, you must backup the specific directory. Tip: Files stored the database are automatically included when you backup the database. If you do not use File Galleries to store wiki images, you must also back up the ../img/wiki_up/.. directory. This is where Tiki stores your uploaded wiki images.
Page 34
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Configuring Wiki file locations. Tip: Starting in Tiki 8.0, use the Move images from wiki_up to the home file gallery to automatically move all images and files from the ../img/wiki_up/.. directory to the default File Gallery.
TRACKER ATTACHMENTS
When configuring Tiki trackers, you can specify if Tiki stores the attachments in the Database or in a Directory. If you store files in a directory, you must backup the specific directory. Tip: Files stored the database are automatically included when you backup the database.
Page 35
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The PHP files that control the main interface language for Tiki are located in the TIKI_HOME\lang\LANGUAGE_ABBREVIATION\*.php. Instead of customizing the main language file, you can create a custom.php file for each language that contains any customized, translated strings. If you created this custom.php file you'll need to back it up, too. Note: See the Tiki Documentation files. for details on customizing the Tiki language
Tip: You do not need to perform any special handling to backup the translations of specific wiki pages or articles. These will be included in the database backup.
If you created any custom Wiki Plugins or Modules (or modified exiting items). You will need to back up those files, too. If you have made updates, fixes, or enhancements to Tiki Plugins and Modules, please consider sharing your work back with the Tiki Community. It is easy to contribute your work. Plugins Normally, there are 2 files for each plugin that you will need to back up: A PHP file, located in ../lib/wiki-plugins/*.php
Page 36
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Modules Normally, there are 2 files for each plugin that you will need to back up: A PHP file, located in ../modules/*.php A TPL file, located in ../templates/modules/*.tpl Tip: You can include customized module templates files as part of your own template customizations. If so, they will be backed up as part of Saving your Theme.
ANYTHING ELSE
Normally, you should not need to edit or modify any PHP files. If you have customized any of the Tiki application libraries or files, you'll need to back them up as well. If you made improvements or fixed issues with your changes, please consider contributing your changes to the Tiki source code. It is quick and easy, and helps you to avoid having a "forked" version that will be difficult to maintain and upgrade. This is also good for the Tiki community, since it accelerates Tiki's progress and overall development.
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information
Page 37
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line
Tip: Check with your webhost provider for specific backup instructions.
Page 38
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware USING PHPMYADMIN
If you use phpMyAdmin, the easiest way to back up your database is to use the Export feature in phpMyAdmin.
Exporting the database. The resulting .sql file (or archived format, if you selected zip or gzip format) contains the complete database. With it, you can restore the database.... and your entire Tiki. Tip: For detailed information on using phpMyAdmin, refer to http://www.phpmyadmin.net .
You can also back up your database from a command line by creating. Use the following command to create a dump of the database: mysqldump DATABSE_NAME > DUMP_FILE Tip: For detailed information on using mySQL, refer to http://www.mysql.com .
Page 39
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
To restore a backup, you simply import the dump file into your database. The dump file contains the necessary SQL commands to create the database and populate it. Note: Depending on the size of your database, the SQL transaction may exceed your host's maximum allowed value. You may need to increase the max_execution_time and max_input_time variables in your php.ini file. Tip: If your host has imposed a runtime limit, you may not be able to import your dump file successfully. You can use BigDump to perform a staggered import in order to restore your database
USING PHPMYADMIN
With phpMyAdmin, you can easily restore a database by using the Import feature to import the dump file.
Importing a previously created backup file. Simply select the backup dump file that you create previously.
To restore a database from a dump file from the command line, use the following command: mysql.exe -u DATABASE_USERNAME -p DATABASE_NAME <
Page 40
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
SQL_BACKUP_FILE
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images
Page 41
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders
Files
In the root of the Tiki install directory are the core *.php files used by Tiki Wiki CMS Groupware. In addition, there are several other files that you should be aware of: _htaccess Rename to .htaccess to use the Search Engine Friendly URLs (SEFURL) feature. You can also use the htaccess.sh script to accomplish this within a CRON job. See "Clean URLs" in the Tiki documentation for more information. changelog.txt Lists details of each code change made in the Tiki code repository. setup.sh Use to automatically set the correct file directory permissions. See "Setting Directory Permissions" in Tiki for Dummies Smarties for more information. copyright.txt and license.txt The Tiki copyright statement and LGPL license. robots.txt Use to control how search engines and bots "crawl" your Tiki site. web_config Used for configuration with Windows IIs servers ( web.config ).
Directories/folders
The Tiki install directory also contains the following directories/folders: admin: Contains the *.php files use for the administration pages and
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 42 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
functions. backups css: Contains the base CSS stylesheets used for the standard Tiki features and functions. The theme-specific CSS files are located in the styles folder. db: Contains the *.sql files for creating and updating your MySQL database and the local.php file that contains your database connection information. Note: If you lock the installer, Tiki adds a lock file to this directory. You must manually remove this file to re-run the installer. doc devtools dump files templates listpages images img: Contains many of the default icons and images. + Note: If you do not store uploaded files and images in the File Gallery, Tiki uses the ../img/wiki_up/ directory. installer: Contains the PHP files and SQL scripts used during the installation and upgrade procedures. lang: Contains a directory for each supported language translation. lib: Contains a directory for each library included and used by Tiki. maps modules pics: Contains many of the default Tiki icons and images. styles: Contains a *.css file (and optional directory) for each installed theme. See Customizing Tiki Themes for more information. temp: Contains directories for temporary and cache storage. templates templates_c: Contains cached versions of templates. tiki_tests whelp: Contains the HTML web help files when generating web help from a Tiki structure. See Create Webhelp from Structure for more information.
Page 43
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Tiki Themes is your headquarters for fabulous looking themes. The Tiki Themes site has an extensive list of Template Tricks that can help you customize your theme. See http://themes.tiki.org/Template+Tricks for details. This section describes several ways that you can customize your Tiki site.
In this section
Using the CSS Assistant Using the Look and Feel Adding Custom CSS Styles Which CSS Style to Edit Using the Theme Generator Modifying Templates Template Map Other Customizations Customizing Per Page Customizing by Category
Page 44
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Enabling the CSS Assistant 2. Tiki displays the CSS Selection window.
Page 45
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The CSS Selection window Note: You can click-and-drag the frame to move the CSS Selection window anywhere on the screen. 3. Click an element on the Tiki page. In this example, we will customize the title for modules.
Selecting the module title. 4. Tiki automatically adds the correct CSS element in the Selector field: #module_1 h3.box-title .moduletitle 5. In the CSS Styles area, type:
font-style:italic; font-family:serif; background:yellow;
Tiki immediately changes the format of the module title to match the custom CSS
The new style Note: If Tiki does not display the new formatting, verify that you have entered valid CSS coding. 6. If you are finished modifying the CSS, click the Copy to Custom CSS button in the CSS Selection window. Tiki automatically adds (copies) the customized CSS to the Custom CSS area on the Look & Feel page.
Page 46
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Quick Admin links This is especially helpful in "future proofing" your site. Since your changes are maintained within the database, you will not have to duplicate your custom edits each time you upgrade.
IN THIS SECTION
Page 47
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Note: Starting in Tiki 7, most layout customization is accomplished by creating modules and add them to different areas of the layout.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles
Later, you'll see how to add these styles on a per-page basis. Tip: Use the Tiki Theme Generator to customize your site's theme without having to modify CSS files! Note: For complete information on using CSS, see http://www.w3.org/Style/CSS/ .
If you already have custom styles in a CSS style sheet, you can easily add the CSS file to your Tiki. No Tabs 8.x & 7.x6.x 1. Copy your .css to your webserver. You could FTP the file, or even use Tiki's file gallery to store the file. Note: Depending on your server configuration, storing CSS files in the Tiki file gallery may cause performance issues. 2. On the Customization tab of the Admin: Look & Feel page, add the following to the Custom HTML Content area:
Page 49
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
3. Click Apply. 4. Clear the Tiki caches. 1. Copy your .css to your webserver. You could FTP the file, or even use Tiki's file gallery to store the file. Note: Depending on your server configuration, storing CSS files in the Tiki file gallery may cause performance issues. 2. On the General Layout Options tab of the Admin: Look & Feel page, add the following to the Custom HTML Content area:
Page 50
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
You can now use any of the styles from your custom .css file in a Tiki wiki page. For example, you could use the DIV plugin: Using a custom CSS style
{DIV(class="CUSTOM_CSS_CLASS")} This text will be styled with the CUSTOM_CSS_CLASS. {DIV}
If you do not have a completed CSS file, you can create custom CSS styles in Tiki. No Tabs 8.x & 7.x6.x
Page 51
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
1. From the Admin: Look & Feel page, click the Customization tab. 2. On the Customization tab, type your CSS style definitions in the Custom CSS field.
3. Click Apply. 4. Clear all Tiki caches. 1. From the Admin: Look & Feel page, click the Custom CSS tab. 2. In the Custom Code area, type your CSS style definitions in the Custom CSS field.
Page 52
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware .CUSTOM_CSS_CLASS {padding:1em, font-size:2.0em; font-weight:bold}
You can now use your custom style in a Tiki wiki page. For example, you could use the DIV plugin: Using a custom CSS style
{DIV(class="CUSTOM_CSS_CLASS")} This text will be styled with the CUSTOM_CSS_CLASS. {DIV}
Now that you know how to customize specific CSS styles, how can you determine which CSS style to edit?
Page 53
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The default H2 heading. 1. Using Firebug for FireFox (or the Developer Tools for Internet Explorer), select the element on the page that you want to customize. In this example, we'll select the heading text Congratulations. 2. When you select the item in your browser, the Firebug console displays the HTML element information for the selected item, including its styles. Notice that the Congratulations text is defined by the h2 element.
The Firebug console displays the selected item's element and attributes. Notice, too, that the element gets some attributes from the fivealive.css stylesheet and others from the lite.css stylesheet. 3. Using one of the methods described previously, create a new definition for the h2 element: Customizing the H2 element
h2 { font-size:3.0em; color:#ffff00; font-family: serif; }
Page 54
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
4. Reload the HomePage of your Tiki. The headings are now larger, yellow, and in a serif font.
Your new, customized heading. Note: You may need to clear the Tiki cache and your browser's cache in order to see the new style.
Page 55
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Note: Do not confuse these Smarty (TPL) template files with the Tiki content templates. Tip: For complete information on using Smarty, see http://www.smarty.net/ .
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud
Page 56
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins
Any template files that you modify should be placed in a custom theme folder do not modify the template files in the ../templates/*.tpl folder. See Saving Your Theme for more information. Note: Creating modified template files as part of your custom theme may make it more difficult to upgrade your Tiki. You will need to re-apply your customizations to the new set of templates each time you upgrade.
Page 57
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
One template per page. For other pages it is not nearly that easy. Some pages, such as the event calendar (tiki-calendar.php) are actually made up of five (or more!) different templates. Luckily, there is an option to help you find which templates are used. No Tabs 7.x6.x When you enable the Smarty template usage indicator option on the Miscellaneous tab of the Admin: Look & Feel page, Tiki will add comments to the generated HTML files that identify the beginning and ending of each template (TPL) file.
Page 58
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
When you enable the Smarty template usage indicator option on the Theme tab of the Admin: Look & Feel page, Tiki will add comments to the generated HTML files that identify the beginning and ending of each template (TPL) file.
Page 59
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
By viewing the HTML source of a generated Tiki page, you can determine which template (TPL) is responsible for what content, as shown below:
Page 60
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Enabling the template indicator Warning: Do not use the Smarty Template usage indicator on a "live" site. Tiki will include the template comments in all generated content, including messages and email, and these comments will be visible to all site users.
not:
__text__
Page 61
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
However, there may be places that you need to use some wiki syntax. For example, you may want to include a wiki heading in template, use:
{wiki} !Level 1 Heading ... {/wiki}
To include a Tiki module or plugin in a Smarty template (TPL) file, you must use the {literal} tag, in addition to the {wiki} tag, as shown previously. For example, if you wanted to include the Tiki search module at the bottom of every web page on your Tiki site, you could add the following to the footer.tpl template: Adding the Search module to a template
{wiki} {literal} {MODULE(module=>search, show_object_filter=y, advanced_search=y) /} {/literal} {/wiki}
Tip: You could also use the simplified version of the module: {module module=search show_object_filter=y advanced_search=y} See Using Modules for additional information about Tiki modules. When adding plugins, you can use the {wikiplugin} tag to avoid having to use the {wiki} and {literal} tags: Adding a wiki plugin to a template
{wikiplugin _name="NAME OF PLUGIN" PARAMTER="VALUE" PARAMTER="VALUE"}{/wikiplugin}
Page 62
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Top
header.tpl ..header.tpl ....tiki-site_header.tpl ......tiki-site_header_top.tpl ......tiki-site_header_top_begin.tpl ......tiki-secondary_sitemenu.tpl ......tiki-site_header_options.tpl ......tiki-site_header_login_popup.tpl ......tiki-site_header_top_end.tpl ....tiki-top_bar.tpl ......tiki-top_bar_begin.tpl ......tiki-sitesearchbar.tpl ........tiki-searchresults.tpl ......tiki-sitemenu.tpl ......tiki-sitelocbar.tpl
Page 63
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware ......tiki-top_bar_end.tpl ....tiki-top_bar_custom_code.tpl
Col1 (center) Varies, depending on feature: Wiki Pages Articles Forums Blogs
Bottom
<br /> ....tiki-bot_bar.tpl<br /> ......credits.tpl<br /> ....footer.tpl <br />
Wiki Pages
tiki-show_page.tpl ..freetag-list ..tiki-wiki_topline.tpl ..rating.tpl ..wiki_authors.tpl ..show_copyright.tpl ..tiki-page_bar.tpl ....comments_button.tpl
Page 64
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware ....attachments.tpl ....comments.tpl ......tiki-edit_help.tpl ......tiki-edit_help_plugins.tpl ......antibot.tpl tiki-show_help.tpl ..For each active plugin: ..tiki-plugin_help.tpl
Articles
Read article:
tiki-read_article.tpl ..freetag_list.tpl ..article_trailer.tpl ..show_copyright.tpl
View article:
tiki-view_articles.tpl
Forums
tiki-forums.tpl
FORUM LIST
Page 65
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware FORUM THREAD tiki-view_forum_thread.tpl ..comment.tpl ....comment-header.tpl ....comment-body.tpl ....comment-footer.tpl ..comments.tpl ....tiki-edit_help.tpl ....tiki-edit_help_plugins.tpl ....antibot.tpl
Blogs
VIEW BLOG tiki-view_blog.tpl ..blog_wrapper.tpl ....blog_post_postbody_title.tpl ......freetag_list.tpl ....blog_post_author_info.tpl ....blog_post_postbody_content.tpl ......show_copyright.tpl ....blog_post_author_actions.tpl ....blog_post_actions.tpl ....blog_post_status.tpl ....blog_post_navigation.tpl
VIEW BLOG POST tiki-view_blog_post.tpl ..blog_wrapper.tpl ....blog_post_postbody_title.tpl ......freetag_list.tpl ....blog_post_author_info.tpl ....blog_post_postbody_content.tpl ......show_copyright.tpl ....blog_post_author_actions.tpl ....blog_post_actions.tpl ....blog_post_status.tpl ....blog_post_navigation.tpl
Page 66
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Customizing Per Page Customizing by Category Tip: You can also use Modules on a per-page or per-category basis. See Using Modules for more information.
Page 67
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
If you included a custom CSS file in the Custom HTML Content area on the General Layout Options tab of the Admin: Look and Feel page, you can tell Tiki to only load the file for a specific page:
Page 68
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Note: The {if} notation is an example of using Smarty and PHP syntax. See Modifying Templates for more information. Likewise, if you use the Custom CSS tab to include inline styles you can also make those styles conditional: Including a CSS file
{if $page eq 'WIKI_PAGE_NAME'} ... {/if}
To allow Tiki to use category information and IDs in templates and styles, you must first enable the Categories used in templates option on the Admin: Categories page:
Page 69
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Enabling the use of Category IDs in templates. Using the same process as before, you can create an {if} statement to check for a specific category ID. For example, to check if the current object is in category 2, you could use:
{if in_array(2, $objectCategoryIds)} ... {/if}
Page 70
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
In this section
Editing Pages Adding Widgets and Scripts Using the HTML Plugin Using the JS Plugin Allowing HTML in Pages Using Modules Creating User Modules Assigning Modules Understanding Module Parameters
IN THIS SECTION
Page 71
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 72 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums Forum List Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button Using the Code Highlighter
Tip: For basic information on using wiki pages, see TikiWiki for Dummies Smarties .
When pasting text into the wiki editor, Tiki will attempt to preserve the formatting, if possible. Additionally, any images that appeared in the original source will be included (via reference). Note: See the Tiki Documentation for complete information on the WYSIWYG editor.
Page 73
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Copying text into the WYSIWYG editor will preserve most formatting. Note: When pasting items into the Tiki WYSIWYG editor, some browsers may display a security message. You can safely disregard tit.
When pasting text into the wiki editor, Tiki will usually strip out any formatting and special characters. For best results, use the Paste... as Plain Text or Paste... Special options, if supported by your system's clipboard application.
Copying text into the wiki editor will strip all formatting. This will preserve line and paragraph breaks, but you will need to re-apply the necessary text formatting and import any images.
Page 74
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The ISO 8859-1 specification is a commonly used character encoding scheme for characters and symbols from the Latin alphabet. You can include any character in a wiki page by using its entity value. For example, the entity value for the copyright symbol ( ) is 169. To include this symbol in a Tiki wiki page, use: ~169~ . Note: For full details on HTML entities, see http://www.w3.org/TR/REC-html40/sgml/entities.html .
To insert a special character while editing a page: 1. Click the Special Character window appears. button. The Select Special Character
Note: This button is available in both the WYSIWYG and Wiki editors.
Page 75
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Selecting special characters (WYSIWYG). 2. Click the character to insert. Tiki inserts the character.
Page 76
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Changing the highlighter Note: For complete details on Tiki's code highlighter, see Tiki Documentation . When using the code highlighter, Tiki will highlight the wiki syntax and display the resulting code in the edit window:
Page 77
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Using the HTML Plugin Using the JS Plugin Allowing HTML in Pages Tip: You can also create a custom plugin or user module in order to add special content.
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images
Page 78
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums Forum List
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 79 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button Using the Code Highlighter Creating the HTML Plugin Plugin Parameters Enabling the HTML Plugin Approving the HTML Plugin Displaying all Pending Plugins
in a wiki page:
Page 80
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Object 1
If you attempt to simply copy and paste this code into a wiki page, Tiki will sanitize the script elements. Instead, use the HTML plugin: HTML Plugin
{HTML()} <object width="580" height="360"> <param name="movie" value="http://www.youtube.com/v/KBewVCducWw&hl=en_US&fs=1&color1=0x3a3a3a&color2=0x 999999&border=1"></param>
Page 81
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware <param name="allowFullScreen" value="true"></param><param name="allowscriptaccess" value="always"></param> <embed src="http://www.youtube.com/v/KBewVCducWw&hl=en_US&fs=1&color1=0x3a3a3a&color2=0x99 9999&border=1" type="application/x-shockwave-flash" allowscriptaccess="always" allowfullscreen="true" width="580" height="360"></embed> </object> {HTML}
Note: For complete details on the HTML plugin, see the Tiki Documentation . Tiki also includes a number of feature-specific plugin that can be used an an alternative to the HTML plugin. See Tiki Documentation for details. Warning: The HTML plugin will allow you (or anyone with permission) to add any HTML coding to the page; this includes potentially malicious code. Be sure to allow only trusted editors to use this plugin.
PLUGIN PARAMETERS
The HTML plugin contains one optional parameter: Wiki syntax. Use this parameter to instruct Tiki to parse any wiki syntax. For example: HTML Plugin without wiki syntax parsing
{HTML()} This link uses an __onclick__ event to produce a popup window: <a href="#" onClick="alert( 'This message is __bold__.' )"> Click Here </a> {HTML}
will produce: This link uses an __onclick__ event to produce a popup window: Click Here Notice that the text "onclick" and "bold" are not bold. By default, Tiki will not parse wiki syntax in the HTML plugin. Use the Wiki syntax parameter to tell Tiki to parse the syntax. For example: HTML Plugin with wiki syntax parsing
{HTML(wiki=1)} This link uses an __onclick__ event to produce a popup window:
Page 82
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware <a href="#" onClick="alert( 'This message is __bold__.' )"> Click Here </a> {HTML}
will produce: This link uses an onclick event to produce a popup window: Click Here
Plugins must be enabled before they can be used in wiki page. If you attempt to use a disabled plugin, Tiki displays the following message:
Some plugins require approval before they become "live," especially those, such as the HTML plugin, that allow users to embed specific coding. Only users with the necessary permission can approve pending plugins. Tip: To avoid requiring approval, Tiki provides specialized plugins for specific purposes. See Tiki documentation for a list of available plugins. To approve the pending HTML plugin: 1. Click View Details. Tiki displays the details of the HTML plugin.
Page 83
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Details of the HTML plugin. 2. Select one of the following options: Click Preview to execute the plugin once. Tiki reloads the page, executing the plugin. But for subsequent page visits, the plugin will not execute. Click Approve make the plugin "live." Tiki reloads the page, fully executing the plugin code. Click Reject to disapprove the plugin and deny its execution. Tiki displays the following message:
You should edit the page and remove the denied plugin code.
Use the Plugin Approval page to display all plugins that are pending approval. For each pending plugin, Tiki will display The plugin and its unique, security ID The location of the page (for plugins include on wiki pages) The user who added the plugin or last visited the page
Page 84
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Approving the pending plugins. You can approve or deny specific plugins.
Object 2
Object 3
Page 85
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Get the RSS Widget widget and many other great free widgets at Widgetbox! Not seeing a widget? (More info) Widgetbox generates the following code: Widgetbox script
<script type="text/javascript" src="http://cdn.widgetserver.com/syndication/subscriber/InsertWidget.js"></script> <script type="text/javascript"> if (WIDGETBOX) WIDGETBOX.renderWidget('5916c179-aace-43f5-b07a-3ac0df9d8546'); </script>
If you attempt to simply copy and paste this code into a wiki page, Tiki will sanitize the script elements. Instead, use the JS plugin: Using JS plugin
{JS(file="http://cdn.widgetserver.com/syndication/subscriber/InsertWidget.js") /} {JS()}if (WIDGETBOX) WIDGETBOX.renderWidget('5916c179-aace-43f5-b07a-3ac0df9d8546'); {JS}
Notice that we've use two instances of the JS plugin: The first references a hosted JavaScript file The second includes actual JavaScript code that must be added to the page. Note: You can use the JS plugin to both add a JavaScript file and include JavaScript code. Tip: If you need to add a script that should appear on every page of your Tiki (for example, the Google Analytics script , use the Customization tab of the Admin: Look & Feel page instead of the JS Plugin.
IN THIS SECTION
Disclaimers
Page 86
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 87 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums Forum List Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button Using the Code Highlighter Creating the HTML Plugin Plugin Parameters Enabling the HTML Plugin Approving the HTML Plugin Displaying all Pending Plugins Enabling the JS Plugin Approving the JS Plugin Enabling the JS Plugin Approving the JS Plugin
In the same way that you had to enable the HTML plugin, you must enable the JS plugin in order to use it in a wiki page. If you attempt to use a disabled plugin, Tiki displays the following message:
Page 88
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Some plugins, especially those that allow users to embed specific coding such as the JS plugin, require approval before they become "live." Only users with then necessary permissions can approve a plugin. Using JS plugin
{JS(file="http://cdn.widgetserver.com/syndication/subscriber/InsertWidget.js") /} {JS()}if (WIDGETBOX) WIDGETBOX.renderWidget('5916c179-aace-43f5-b07a-3ac0df9d8546'); {JS}
Notice that we've use two instances of the JS plugin: The first references a hosted Javascript file The second includes actual Javascript code that must be added to the page. Note: You can use the JS plugin to both add a JS file and include JS code.
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation
Page 89
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages
Page 90 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Articles Forums Forum List Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button Using the Code Highlighter Creating the HTML Plugin Plugin Parameters Enabling the HTML Plugin Approving the HTML Plugin Displaying all Pending Plugins Enabling the JS Plugin Approving the JS Plugin Enabling the JS Plugin Approving the JS Plugin
In the same way that you had to enable the HTML plugin, you must enable the JS plugin in order to use it in a wiki page. If you attempt to use a disabled plugin, Tiki displays the following message:
Page 91
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
In the same way that you had to approve the HTML plugin, you must approve the JS plugin. To approve the pending JS plugin: 1. Click View Details. Tiki displays the details of the JS plugin.
Details of the JS plugin. 2. Select one of the following options: Click Preview to execute the plugin once. Tiki reloads the page, executing the plugin. But for subsequent page visits, the plugin will not execute. Click Approve make the plugin "live." Tiki reloads the page, fully executing the plugin code. Click Reject to disapprove the plugin and deny its execution. Tiki displays the following message:
You should edit the page and remove the denied plugin code.
Page 92
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Enabling the Allow HTML option. You can include most HTML elements instead of (or in place of) wiki syntax to format pages. Note: Tiki will automatically sanitize any potentially unsafe HTML coding. This includes SCRIPT and EMBED elements.
Page 93
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Including HTML in wiki pages. Tip: Tiki generates all pages using XHTML. Be sure that any code you include validates properly as XHTML. See http://www.w3.org for the complete XHTML specification.
IN THIS SECTION
Page 94
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Note: You can also create a custom module by writing the necessary PHP file and its associated TPL template. If you create this type of custom module, please consider contributing your custom module to the Tiki code base. To create a user module: 1. From the Admin: Modules page, click the User Modules tab.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The User Modules area lists your existing user modules. Tip: By default, a new Tiki installation contains a single user module the Application Menu. 2. Use the Create New User Module area to create your user module. Note: To use Tiki wiki syntax in your module (including embedding modules and plugins) you must enable the Must be wiki parsed option.
3. In the Data field, enter the content to appear in the module. This could be text, images, a widget, or anything you want. For example, to add this weather widget (from weather.com): Washington, DC Get the 10 day forecast
53F Cloudy Feels Like: 53F Humidity: 52% Wind: SE at 13 mph Severe Weather Special Events Sporting
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 96 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Note: Notice we're using the JS Plugin to embed the script. 4. You can add addition text in the module, as needed. Your user module
Here's the weather where __I__ live. {JS(file="http://voap.weather.com/weather/oap/USDC0001? template=EVNTV&par=3000000007&unit=0&key=twciweatherwidget") /} [http://www.weather.com/|Click here] to find ''your'' local weather report.
Tip: Use the Objects That Can Be Included area to easily add other Tiki content (such as polls or menus) to the module. Simply select the item to add and click . 5. Save the module.
To include Smarty syntax or code in a module, you must use the {literal}. For example, you could edit the user module you created to include a personal message
Page 97
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
You will also need the {literal}to safely use any HTML tags that would otherwise be sanitized by Tiki. Tip: You could also use the HTML Plugin include scripts and embedded HTML tags in your module.
Tiki
No Tabs 7.x6.x pending Starting in Tiki 7.0, you can use the new drag-and-drop feature to add, move, or remove modules from: Left and right columns
Page 98
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Top and bottom bars Page top and bottom areas 1. From the Admin: Modules page, click the All Modules tab. IMAGE 2. Click and drag the module to add to a column (or top/bottom areas). Tip: Use the Filter field to quickly find a specific module: IMAGE IMAGE 3. When you place the module in the selected area, Tiki displays the Edit Module window to modify the module's parameters. IMAGE The "standard" options that are available to all modules include: Position: Left or right column. Note: Use the Module wiki plugin to add a module to a wiki content page. Order: The display order for the modules in the column (1 = top of column). Cache time: Number of seconds for which Tiki cache the module contents. Leave blank to never cache the module. Rows: Number of items to display in the module. The option applies only when listing specific Tiki objects, such as with the Newest Blog Post module. Parameters: Allows for the inclusion of additional module parameters. Tip: See Understanding Module Parameters for information on additional parameters. Groups: Select the groups for which this module is visible. Tip: Use Ctrl+Click to select multiple groups. pending For example, to add the module that you created earlier: 1. From the Admin: Modules page, click the User Modules tab.
Page 99
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Displaying the available User modules. 2. Click Add ( ) for the module to add to a column.
Adding a user module. 3. On the Assign/Edit Modules tab, in the Assign New Module area, click Module Options.
Page 100
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Assigning the module. 4. In the Edit This Assigned Module area, Tiki: Displays a preview of the module. Displays the "standard" module parameters.
Page 101
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Setting the module options. The "standard" options that are available to all modules include: Position: Left or right column. Note: Use the Module wiki plugin to add a module to a wiki content page. Order: The display order for the modules in the column (1 = top of column). Cache time: Number of seconds for which Tiki cache the module contents. Leave blank to never cache the module. Rows: Number of items to display in the module. The option applies only when listing specific Tiki objects, such as with the Newest Blog
Page 102
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Post module. Parameters: Allows for the inclusion of additional module parameters. Tip: See Understanding Module Parameters for information on additional parameters. Groups: Select the groups for which this module is visible. Tip: Use Ctrl+Click to select multiple groups. 5. You can Preview or Assign the module. If your module includes the HTML or JS plugin, you will need to approve the content. See Adding Widgets and Scripts for more information.
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud
Page 103
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums Forum List Forum View Forum Thread Blogs View Blog View Blog Post
Page 104 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button Using the Code Highlighter Creating the HTML Plugin Plugin Parameters Enabling the HTML Plugin Approving the HTML Plugin Displaying all Pending Plugins Enabling the JS Plugin Approving the JS Plugin Enabling the JS Plugin Approving the JS Plugin Adding {literal} Tags Adding Parameters to User Modules Using Module-Specific Parameters
When using user modules use the Parameters field (when assigning the modules ) to apply parameters to the module. No Tabs 7.x6.x
Page 105
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Page 106
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Separate multiple parameters with & (ampersand). For example, to specify the the following parameters: Flip = y Nopage = HomePage use:
flip=y&nopage=HomePage
Each Tiki module may contain parameters specific to that module. For example, the Categories module contains a parameter to specify which category IDs to display in the module. No Tabs 7.x6.x
Page 107
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Page 108
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Page 109
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Page 110
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
5 Using Trackers
A Tiki tracker is a way to collect, store, and organize data. You might think of trackers as a mini database or spreadsheet that runs inside your Tiki site. Trackers are also especially useful for creating forms that your site's visitors can complete. By using trackers, Tiki will create the necessary HTML form elements and record the results. Tip: For basic information on using trackers, see Using Trackers Smarties.
IN THIS SECTION
Building Forms Creating a Tracker Entering Tracker Data Displaying Tracker Data Using Dynamic Lists Building the Internal Tracker Adding the Dynamic List Creating Pretty Trackers Building a Template Displaying the Pretty Tracker
Page 111
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The tracker that you create in this section is also used in the Using Dynamic Lists and Creating Pretty Trackers sections.
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images
Page 112
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums Forum List
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 113 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button Using the Code Highlighter Creating the HTML Plugin Plugin Parameters Enabling the HTML Plugin Approving the HTML Plugin Displaying all Pending Plugins Enabling the JS Plugin Approving the JS Plugin Enabling the JS Plugin Approving the JS Plugin Adding {literal} Tags Adding Parameters to User Modules Using Module-Specific Parameters Creating a Tracker Creating Tracker Fields Finalizing the Tracker
CREATING A TRACKER
To create a new tracker: 1. From the Admin menu, select Trackers > Admin Trackers. 2. Click the Create Tracker tab.
Page 114
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Page 115
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Creating a tracker to maintain visitor information. 3. On the Create/Edit Tracker page, complete the following fields: Name: Name of the tracker. Description: Enter a brief description of the tracker. Enable the Description text is wiki-parsed option to format the description with wiki syntax. Show status: Specify if the tracker shows (or uses) a status field. For example, if you are using a Tracker for a bug reporting system, you may need to set the status of each bug. You can also specify if items of a particular status are shown when listing a tracker, if the status is visible to the Admin only, and the default status of newly created items. Note: There is a difference between listing and viewing trackers: When listing,Tiki displays the tracker items in a table; when viewing, Tiki displays each tracker item on a separate page:
The difference between Listing and Viewing tracker items. Send copies of all activity...: Enter email addresses to receive notification of all activity (creating new items, editing or deleting items, changing status, etc.) for this tracker. You can also specify if the email is is sent in a simplified format. By default the the notification message message will not include an tracker details. You can override this by enabling the Use simplified e-mail format field. You will need to create a field named Subject. Show date... fields: You can specify if the creation and last modified dates are shown when listing and viewing the tracker. You can also override the site's default date and time formats. Default sort... fields: Select the field to use as the default sort field (and its order) when listing tracker items. Since you have not added any tracker fields yet, you can only select the creation and last
Page 116
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
modified dates. 4. Click Save. Tiki saves the tracker. 5. Click the Trackers tab to display the newly created tracker.
Now that you have an "empty" tracker, you need to create fields for the tracker. These fields represent the form fields that visitors will complete. 1. From the Admin: Trackers page, click Fields ( created. ) for the tracker you
Adding fields to a tracker. 2. On the Admin: Tracker page, click the New Tracker Field tab.
Page 117
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Adding a tracker field. 3. Enter the following information in each field on the page: Name: Your name (this is the label for the field, as it will appear on the form). Type: textfield Function: ,80 Field is mandatory?: Select this field. Description: Please enter your full name.
Page 118
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Leave the other fields as their defaults. 4. Click Save. Tiki adds the field to the tracker. Repeat this procedure to add the following additional tracker fields: Field Type Options Email email Mandatory Address textarea ,60,5 City textfield ,80 State/Province textfield ,80 Country country selector Mandatory About text area ,60,5 textfield Subject1
1. If you selected the Use simplified email format option, you must create this Subject field.
Now that all the fields have been added to the tracker, we can complete the
Page 119
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
remaining options for the tracker. 1. Click the Edit this Tracker button.
Updating the tracker. What field is used for default sort?: Select Your name. Show these fields in a popup...: Enter the field ID that corresponds to the About field. 3. Click Save.
Page 120
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
One advantage of using the Tracker plugin, it allows you to add the form to any wiki page, thereby giving you more control over the display of the form. To create a form: 1. Create a new wiki page. 2. In the wiki page, enter the following:
{TRACKER(trackerId="1", fields="1:2:3:4:5:6:8", showtitle="n", showdesc="y", showmandatory="y", reset="Clear", submit="Send")} Thank you {TRACKER}
where: TRACKER_ID = The ID of the tracker that you created. FIELD = The ID numbers of each of the tracker fields that you created. Note: The other parameters tell Tiki: Not to display the title (name) of the tracker To display the description of the tracker To indicate which fields must be completed To include a reset button (that will erase the form) labeled "Clear" To include a submit button (that will send the form) labeled "Send"
Page 121
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Note: Be sure to use the tracker field ID and not the order. The actual order in which you include the fields in the TRACKER plugin is unimportant. Tiki uses the order field that you specified when creating the tracker fields. Alternatively, you can use the Plugin Helper to add the necessary information to the wiki page.
Using the Plugin Help to add the necessary parameters. 1. Save the wiki page.
Page 122
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The Tracker plugin displays the tracker as a web form. You can now use the form to enter tracker items. Add several items, using the newly created form.
where:
Page 123
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
TRACKER_ID = The ID of the tracker that you created. FIELD = The ID numbers of each of the tracker fields that you created.
Adding the Tracker List plugin to a wiki page. Note: Be sure to use the tracker field ID and not the order. Alternatively, you can use the Plugin Helper to add the necessary information to the wiki page.
Page 124
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Using the Plugin Help to add the necessary parameters. Tip: Refer to the Tiki Documentation pluging parameters. 3. Save the wiki page.
Tiki displays the tracker items in a table. Tiki displays the items in the tracker in a table.
Page 125
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
To accomplish this, we'll create a separate tracker to maintain the operating system values. We'll refer to this tracker as the Internal tracker. We'll refer to the tracker that users will directly interact with as the External tracker. In this section we'll create the "Internal" tracker and then link it to the "External" tracker.
IN THIS SECTION
Page 126
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Page 127
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The internal tracker used to select the Operating System. 2. Save the "Internal" tracker. 3. Create two fields for the tracker: Field Type Options OS dropdown Windows,Solaris Version textfield Again, you can leave the other options for each field as their defaults.
Be sure to record: The Tracker ID for this "Internal" tracker You'll need this ID in order to add the dynamic list to the "External" tacker. The ID of the dropdown field and the textfield field. You'll need both IDs in order to identify which is the selection field (the dropdown) and which is the dynamic field (the textfield).
Right now, the "Internal" tracker is empty there are no items from which a user can select their operating system and version. Let's populate the tracker with the necessary options. 1. Using the Tracker interface pages, enter an item for the "Internal" tracker: OS: Windows Version: Vista
Page 128
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Adding the first option (tracker item) to the Internal tracker. Note: You could create a custom form for entering the operating system options, but in this instance it is easier to use the Tiki Tracker interface. This represents one OS/Version combination that users can select. 2. Add additional items to the "Internal" tracker; several for each operating system and version combination. Operating System Version Windows XP Windows 95 Solaris 2.8 Solaris 2.9 Solaris 2.10 3. Your "Internal" tracker should now have six items:
Page 129
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The completed internal tracker. The "Internal" tracker is now complete. Users will select one of these possible OS/Version combinations. The Version will be dynamically displayed, based on the OS. Now let's finish the external tracker...
Page 130
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The relationship between the Internal tracker and the fields in the External tracker. Add the following fields to the "External" tracker: Field Type Options Operating System item link 2,102 Version dynamic items list 2,10,12,113
1. If you selected the Use simplified email format option, you must create this Subject field. 2. Where: 2 = ID of the Internal Tracker, 10 = Field ID of the primary selection (drop down list) 3. Where: 2 = ID of the Internal Tracker, 10 = Field ID of the primary selection (drop down list), 12 = ID of the item link of the External tracker, 11 = ID of the text field of the Internal tracker Your "External" tracker should appear similar to this:
Page 131
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The completed External tracker with the dynamic list from the Internal tracker.
Page 132
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware USING THE TRACKER
Now that the "External" tracker includes the dynamic fields, the final step is to update the form we built previously to include these new fields. 1. Update the TRACKER plugin to include the new fields
{TRACKER(trackerId="1", fields="1:2:3:4:5:6:8:12:13", showtitle="n", showdesc="y", showmandatory="y", reset="Clear", submit="Send")} Thank you {TRACKER}
The user information form with the new operating system fields. 3. When you select a specific option for the Operating System, its available Version options appear. You can also update the Trackerlist plugin to display the new fields:
Page 133
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Tiki displays the tracker items in a table. You can display each tracker item on a formatted wiki page:
Page 134
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Displaying the tracker items using a Pretty Tracker template. Building a Pretty Tracker requires: Creating a Tracker (this is no different then creating any other tracker) Building a Template Displaying the Pretty Tracker Let's update the tracker you've built to use a Pretty Tracker for display...
To include the data from a tracker field in the template, including the following code in the wiki page:
{$f_XX}
Page 135
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The ID for the Your Name field is 1. For example, to display the user's name, you would use {$f_1}.
CREATE THE TEMPLATE
The "template" for the pretty tracker is simply a new wiki page. 1. Create a new wiki page.
Wiki page to serve as the template for the pretty tracker. 2. Edit the page and include the following code: Pretty tracker template
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 136 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware {DIV(float=left,width="75px")}{img src="pics/large/users48x48.png" alt="{$f_1}" desc="{$f_1}"}{DIV} __{$f_1}__ from {$f_6} uses {$f_12} {$f_13}. A little about {$f_1}... {$f_8} {DIV(class="clearfix") /} For more information, contact {$f_1}: *Email: [{$f_2}] *Postal: +{$f_3} +{$f_4}, {$f_5} {$f_6}
Note: This will create a template that will display each tracker item as:
3. Save the wiki page. Be sure to record the name of the page... you'll need it in a moment!
Page 137
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
where: TRACKER_ID = The ID of the tracker that you created. FIELD = The ID numbers of each of the tracker fields that you created. For the pretty tracker, we'll use all the fields. WIKITEMPLATE = The wiki template page that you created. 3. Save the page. Tiki displays the tracker information, using the wiki page as the template:
Page 138
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
6 Writing Plugins
Plugins are the way to extend Tiki's wiki functionality to do anything (and everything) that you want. Although Tiki includes over 100 plugins, you may find it necessary to create your own plugin that meets your specific needs. This section will show you how. Note: This section is not a guide to PHP programming. For details on PHP, see http://www.php.net .
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation
Page 139
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums Forum List Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button Using the Code Highlighter Creating the HTML Plugin Plugin Parameters Enabling the HTML Plugin
Page 140 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Approving the HTML Plugin Displaying all Pending Plugins Enabling the JS Plugin Approving the JS Plugin Enabling the JS Plugin Approving the JS Plugin Adding {literal} Tags Adding Parameters to User Modules Using Module-Specific Parameters Creating a Tracker Creating Tracker Fields Finalizing the Tracker Populate the "Internal" Tracker Using the Tracker Create the Template When to Use a Plugin Writing a Simple Plugin Tip: If you are new to Tiki, start with Using Plugins in Tiki for Dummies Smarties . For complete information on Tiki plugins, refer to the Tiki Documentation .
Page 141
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Note: See Adding Widgets and Scripts for additional examples of plugins.
1. If you selected the Use simplified email format option, you must create this Subject field. 2. Where: 2 = ID of the Internal Tracker, 10 = Field ID of the primary selection (drop down list) 3. Where: 2 = ID of the Internal Tracker, 10 = Field ID of the primary selection (drop down list), 12 = ID of the item link of the External tracker, 11 = ID of the text field of the Internal tracker 4. A pull quote (also known as a lift-out quote or a call-out) is a quotation or edited excerpt typically placed in a larger typeface on the same page. http://en.wikipedia.org/wiki/Pull_quote
Page 142
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 143 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums Forum List Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button Using the Code Highlighter Creating the HTML Plugin Plugin Parameters Enabling the HTML Plugin
Page 144 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Approving the HTML Plugin Displaying all Pending Plugins Enabling the JS Plugin Approving the JS Plugin Enabling the JS Plugin Approving the JS Plugin Adding {literal} Tags Adding Parameters to User Modules Using Module-Specific Parameters Creating a Tracker Creating Tracker Fields Finalizing the Tracker Populate the "Internal" Tracker Using the Tracker Create the Template When to Use a Plugin Writing a Simple Plugin Defining the Function Reading the Variables and Setting Defaults Error Handling
The name of the function must be in the format wikiplugin_NAME OF YOUR PLUGIN. You can name your plugin anything you want but do not include any spaces. The name that you use here, is the name of the plugin that users editing the wiki will use. In this example, the plugin will be named pullquote. Therefore, the syntax to use it
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 145 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
in a wiki page is: {PULLQUOTE()}...{PULLQUOTE} The second line ($quote = '';) tells Tiki to set the quote (defined by the $quote variable) empty. This ensures that we start with an empty variable.
Notice that first we check to see if there is a color. Remember, the color is optional so it may not be included. If the user did not include a color code, the plugin defaults to #000000 (black text). Notice too that we added a hash ( # ) to the beginning of the color code. This is important because HTML hex colors codes must start with a # sign. We'll need to make sure that in the help we tell users not to include the # sign! We can use similar code for the width: Inputting width
if (!isset($width)) { // Set default width $w= '250px'; } else { $w = $width . 'px'; }
Page 146
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Here, we add px to the end of the width. Again, we'll need to make sure that in the help we tell users not to include the px with the width. If the user did not include a width, the plugin defaults to 250px.
ERROR HANDLING
The third option, float (the position: left or right), is required. We can add logic to the plugin to confirm that the user has added a position. Checking for the position
if (!isset($float)) { // No position, tell the user $msg = 'Please select a position: left or right.'; return $msg; die; } else { // Set the position $f = $float; }
Now, if the user forgets to enter a position, they'll be reminded. Finally, we'll confirm that there is actual text to use as the pull quote. Checking for text
if ($data eq '') { // No text, tell user $msg = 'Please include text for the pull quote.'; return $msg; die; }
Now, if a user tries to use the plugin without any text (such as {PULLQUOTE()} {PULLQUOTE} or {PULLQUOTE() /} ) they'll get an error message.
Page 147
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Now we'll add detailed help information for the Tiki inline plugin help (when users add the plugin through the Tiki help interface.
Page 148
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The detailed help explains the valid values for each option. Plugin information and security
function wikiplugin_pullquote_info() { return array( 'name' => tra('PULLQUOTE'), 'description' => tra('Create a literary pullquote in a wiki page.'), 'validate' => 'all', 'params' => array( 'color' => array( 'required' => false, 'name' => tra(Color of the pullquote'), 'description' => tra('Numeric hex color code (default=000000). Do *NOT* include #.'), 'filter' => 'int', ), 'width' => array( 'required' => false, 'name' => tra('Width of the pullquote'), 'description' => tra('Numeric width in pixels (default=250). Do *NOT* include px.'), 'filter' => 'int', ), 'float' => array( 'required' => true, 'name' => tra('Specify location of the pull quote.'), 'description' => tra('left | right (default=left)'), 'filter' => 'alpha', ), ), } );
Page 149
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Notice the lines highlighted in the sample code, above. 'validate' => 'all': This tells Tiki that a trusted site editor (with the necessary permissions) must validate (that is, approve) the plugin before it becomes active on the page. 'required' => true: The float parameter is required; users must select a position (left or right). Tiki will not allow users to add the plugin to a wiki page without entering this parameter. Note: Learn more about all the possible plugin variables on the Tiki Developer website .
The $data variable represents the actual quote text. Remember the error checking from before, to ensure that the text isn't empty? The $f represents the position. The $w represents the width. The $c represents the color. Tip: Notice that the text of the pull quote is enclosed in a named <div> element. This allows you to customize the styling by Adding Custom CSS Styles. For example, you could style the quote with: Sample CSS
.pullquote { font-family:Times,serif;
Page 150
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware font-size:1.6em; font-style:italic; font-weight:bold; line-height:1em; margin:10px; padding:20px 10px; }
function wikiplugin_pullquote_help() { return tra("Create a literary pullquote").":<br /> ~np~{pullquote(width=###|color=######, float=left| right)}".tra("text")."{pullquote}~/np~ "; } function wikiplugin_pullquote_info() { return array( 'name' => tra('pullquote'), 'description' => tra('Create a literary pullquote in a wiki page.'), 'validate' => 'all', 'params' => array( 'color' => array( 'required' => false, 'name' => tra('Code of the pullquote'), 'description' => tra('Numeric hex color code (default=000000). Do *NOT* include #.'), 'filter' => 'int', ), 'width' => array( 'required' => false, 'name' => tra('Width of the pullquote'), 'description' => tra('Numeric width in pixels (default=250). Do *NOT* include px.'),
Page 151
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware 'filter' => 'int', ), 'float' => array( 'required' => true, 'name' => tra('Specify location of the pull quote.'), 'description' => tra('left | right (default=left)'), 'filter' => 'alpha', ), ), } );
function wikiplugin_pullquote($data, $params) { // Always include this line to read the data and parameters. extract ($params,EXTR_SKIP); $quote =''; // Check for color if (!isset($color)) { // Set default color $c = '#000000'; } else { $c = '#'.$color; } // Check for width if (!isset($width)) { // Set default width $w= '250px'; } else { $w = $width . 'px'; } // Check for position if (!isset($float)) { // No position, tell the user $msg = 'Please select a position: left or right.'; return $msg; die; } else { // Set the position $f = $float; } //Build the output $quote .= "<div style='float:".$f.";width:".$w."'>";
Page 152
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware $quote .= "<div class='pullquote'><div class='content' style='color:". $c.";'>"; $quote .= $data; $quote .= "</div></div></div>"; return $quote; } ?>
2. In Tiki, use the Admin: Text Area page to enable the plugin. Tip: If you don't see the plugin, be sure to clear your Tiki cache. 3. Add your newly created plugin to a wiki page.
Adding the PULLQUOTE plugin to a wiki page. 4. If the plugin requires approval (if you specified the security), use the Plugin Approval page to approve it.
Page 153
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Approving the PULLQUOTE plugin. If you create useful plugins, please consider contributing them back to the Tiki community. It is quick and easy. Here's how...
Page 154
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
7 Using Profiles
A Tiki profile is a set of configurations that can be applied to your site. Since Tiki contains hundreds of features, preferences, modules, and permissions, using a profile is an easy way to configure multiple features in a single process.
Applying a profile to your site does not erase your data. This means you can apply profiles to your site at any time. Profiles can even be installed "on top of" one another. You can even create your own profile!
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 155 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums Forum List Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 156 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Using the Code Highlighter Creating the HTML Plugin Plugin Parameters Enabling the HTML Plugin Approving the HTML Plugin Displaying all Pending Plugins Enabling the JS Plugin Approving the JS Plugin Enabling the JS Plugin Approving the JS Plugin Adding {literal} Tags Adding Parameters to User Modules Using Module-Specific Parameters Creating a Tracker Creating Tracker Fields Finalizing the Tracker Populate the "Internal" Tracker Using the Tracker Create the Template When to Use a Plugin Writing a Simple Plugin Defining the Function Reading the Variables and Setting Defaults Error Handling Using the Plugin Using Profile Repositories Creating Profiles Applying Profiles Tip: To learn more about Profiles, start with "Using Profiles " in Tiki for Dummies Smarties the Tiki Profiles Repository .
or
Page 157
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins
Page 158
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums Forum List Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button Using the Code Highlighter Creating the HTML Plugin Plugin Parameters Enabling the HTML Plugin Approving the HTML Plugin Displaying all Pending Plugins Enabling the JS Plugin Approving the JS Plugin Enabling the JS Plugin Approving the JS Plugin Adding {literal} Tags
Page 159 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Adding Parameters to User Modules Using Module-Specific Parameters Creating a Tracker Creating Tracker Fields Finalizing the Tracker Populate the "Internal" Tracker Using the Tracker Create the Template When to Use a Plugin Writing a Simple Plugin Defining the Function Reading the Variables and Setting Defaults Error Handling Using the Plugin Accessing the Tiki Repository Creating your own Repository
Page 160
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Adding the Tiki Profile repository. Note: If your site requires a proxy to access the internet, confirm that the settings are correct on the Admin: General page. 2. Click Save. To confirm that Tiki can access the Tiki repository: 1. Review the Status area of the Apply Profiles tab.
Page 161
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Confirm that your Tiki can contact the repository. 2. Click Refresh . 3. Verify that the repository Status is (connected). You can now apply profiles from that repository
in Tiki for
Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Dummies Smarties. 3. Assign the profiles to the category you created in step 1. Now the site can be used as a Profiles Repository for other sites. See the Tiki Profiles site Tip: You can use the Repository Profile repository. for additional information. to easily turn your Tiki into a
There are two methods to create a new profile: Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset
Page 163
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums Forum List Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 164 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Using Entity Values Using the Special Characters button Using the Code Highlighter Creating the HTML Plugin Plugin Parameters Enabling the HTML Plugin Approving the HTML Plugin Displaying all Pending Plugins Enabling the JS Plugin Approving the JS Plugin Enabling the JS Plugin Approving the JS Plugin Adding {literal} Tags Adding Parameters to User Modules Using Module-Specific Parameters Creating a Tracker Creating Tracker Fields Finalizing the Tracker Populate the "Internal" Tracker Using the Tracker Create the Template When to Use a Plugin Writing a Simple Plugin Defining the Function Reading the Variables and Setting Defaults Error Handling Using the Plugin Accessing the Tiki Repository Creating your own Repository Creating a Profile from a Site Writing a new Profile
.
Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Exporting to a new profile Use the Object type option to select which objects (such as permissions) to export to YAML. Use the Export modified preferences as YAML area to select specific preferences. 3. Click Export. Tiki creates the necessary YAML. Exported YAML
{CODE(caption=>YAML,wrap=>0)} preferences: browsertitle: My Tiki error_reporting_adminonly: n error_reporting_level: 0 feature_edit_templates: y feature_editcss: y feature_freetags: y feature_right_column: fixed
Page 166
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware feature_show_stay_in_ssl_mode: n feature_view_tpl: y feature_wysiwyg: y freetags_3d_autoload: n gal_use_lib: gd header_custom_css: | #role_main .HomePage .module {max-width:99%} .HomePageHeading {font-family:serif;font-style:italic;fontweight:bold;text-align:center;margin:0 10%;font-size:18pt;} .HomePage .tabmark a {font-size: 1.1em;font-weight: bold;} .HomePage .tabmark {padding:5px 0} .HomePage .tabstoggle {display:none;} .HomePage .tabcontent {padding:4px 1em;} .HomePage .box-freetags_most_popular h3.box-title {display:none;} https_login: disabled https_port: layout_fixed_width: style_option: themegenerator_feature: y {CODE}
Page 167
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Selecting a profile to apply. Tip: Use the Advanced tab to configure additional profile repositories and data channels. 3. Click Featured Profiles to display a list of the top profiles. Tiki offers additional lists of profiles (Full, Mini, and Learning) as well as customizable filters to help you select a profile. 4. Tiki contacts the profiles repository and displays a list of profiles that match your filters. If Tiki is unable to contact the repository: Test your connection. In the Status ara, click Refresh ( ) and Tiki will attempt to contact the repository.
Check the Repository URL. On the Advanced tab, confirm that the Repository URL is correct.
Page 168
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Displaying the available profiles, based on selected filters. 5. Click a profile name. Tiki displays the release information for the selected profile.
Page 169
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Page 170
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Customizing and applying the profile. Some profiles allow you to customize the installation. For example, you can configure the Name or Title of your site. 6. Read the profile information then click Apply Now to apply the profile to your site. 7. Tiki prompts for confirmation before installing the profile. Click OK. After installing the profile, Tiki displays a list of all configuration changes that have been made.
Tiki shows the changes made by the profile. You can now explore your new site. Depending on the profile you selected, you may notice: A different theme New menus, modules, and pages Additional features
Page 171
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Note: You may need to log out or clear the cache before the changes take affect.
Page 172
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
In this section
Adding and Overriding Programaticlly Accessing Data from Wiki Pages Updating Tiki Preferences The MySQL database powers your Tiki.
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 173 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 174 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Forum List Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button Using the Code Highlighter Creating the HTML Plugin Plugin Parameters Enabling the HTML Plugin Approving the HTML Plugin Displaying all Pending Plugins Enabling the JS Plugin Approving the JS Plugin Enabling the JS Plugin Approving the JS Plugin Adding {literal} Tags Adding Parameters to User Modules Using Module-Specific Parameters Creating a Tracker Creating Tracker Fields Finalizing the Tracker Populate the "Internal" Tracker Using the Tracker Create the Template When to Use a Plugin Writing a Simple Plugin Defining the Function Reading the Variables and Setting Defaults Error Handling Using the Plugin Accessing the Tiki Repository Creating your own Repository Creating a Profile from a Site
Page 175 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer
Page 176
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums Forum List Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button Using the Code Highlighter Creating the HTML Plugin
Page 177 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Plugin Parameters Enabling the HTML Plugin Approving the HTML Plugin Displaying all Pending Plugins Enabling the JS Plugin Approving the JS Plugin Enabling the JS Plugin Approving the JS Plugin Adding {literal} Tags Adding Parameters to User Modules Using Module-Specific Parameters Creating a Tracker Creating Tracker Fields Finalizing the Tracker Populate the "Internal" Tracker Using the Tracker Create the Template When to Use a Plugin Writing a Simple Plugin Defining the Function Reading the Variables and Setting Defaults Error Handling Using the Plugin Accessing the Tiki Repository Creating your own Repository Creating a Profile from a Site Writing a new Profile Writing a Simple SQL Query Creating a DSN Using the SQL Plugin Using the DBReport Plugin
Creating a DSN
In order to arbitrarily access your Tiki data from a page, you must first create a Database Source Name (DSN). This is how Tiki will direct your queries to a specific database connection. 1. At the bottom of the Administration page, in the Crosslinks area, click DSN.
Page 178
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Accessing the Admin: DSN page. 2. On the Admin: DSN page, use the Create/Edit area to create a new DSN for your Tiki.
Creating a new DSN connection. 3. Enter the following information in each field: Name: The name of the DSN. You will use this name when accessing the database from the wiki page. DSN:The location and name of the database in the following format:
database-type://user:password@host/database-name
Where: database-type = mysql user = The database user with access to the database password = The password of the database user database-name = The name of the database 4. Click Save. Tiki adds your new DSN. Now you must specify which of your Tiki groups can use the DSN. 5. Click the Perms icon ( ) for the newly created DSN.
Page 179
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The available DSN connections. 6. On the Assign permissions to this object page, select which groups should be able to execute queries on the DSN, and click Assign.
Assigning permissions to the DSN. If you want all visitors to have access to the queries on this connection, select the Anonymous group. Now that your DSN is fully configured, you can use the SQL plugin to execute queries against the database. Note: For complete information about the Tiki DSN, refer to the Tiki Documentation .
Page 180
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Warning: Using the SQL plugin presents a potential security hazard, as your are allowing users to directly access the database. You should lock the page to avoid allowing users to see the page source (which would also expose the SQL code). Use the SQL Plugin to query the database: Sample SQL plugin
{SQL(db=>"DSN_NAME'')} ... {SQL}
For example, to execute a query that will display the number of objects in a specific Tiki category, you might use: Finding the number of objects in category #5
{SQL(db="DSN_NAME")} SELECT count(*) FROM `tiki_category_objects` WHERE `categId`=5 {SQL}
Note:
Page 181
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations
Page 182
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums Forum List Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 183 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Using the Code Highlighter Creating the HTML Plugin Plugin Parameters Enabling the HTML Plugin Approving the HTML Plugin Displaying all Pending Plugins Enabling the JS Plugin Approving the JS Plugin Enabling the JS Plugin Approving the JS Plugin Adding {literal} Tags Adding Parameters to User Modules Using Module-Specific Parameters Creating a Tracker Creating Tracker Fields Finalizing the Tracker Populate the "Internal" Tracker Using the Tracker Create the Template When to Use a Plugin Writing a Simple Plugin Defining the Function Reading the Variables and Setting Defaults Error Handling Using the Plugin Accessing the Tiki Repository Creating your own Repository Creating a Profile from a Site Writing a new Profile Writing a Simple SQL Query Creating a DSN Using the SQL Plugin Using the DBReport Plugin Changing Preferences Fixing Modules Editing Custom Code
Page 184
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Changing Preferences
Nearly all of the settings and preferences that control your Tiki site are defined in the tiki_preferences table in the database.
The tiki_preferences table. By simply changing the a setting from y to n (or vice-versa), you can usually undo any inadvertent damage and regain control of your site. For example, if you accidentally enable the Use HTTPS login option on a site without SSL, you'll find yourself unable to log in (even as the Admin, since Tiki would be looking for a non-resistant HTTPS port. To "reset" the HTTPS option to disabled you can edit the https_login in the tiki_preferences table:
Page 185
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The relationship between the Admin option and the database field. In this example, you would change the field to disabled in order to "turn off" the Use HTTPS login option. Other common options, that if inappropriately enabled, could "lock" your Tiki include: Authentication method (auth_method) SSL options Intertiki options Invalid syntax in custom code Invalid syntax in custom modules
Fixing Modules
When creating a custom user module, Tiki allows you to include custom code, including PHP and Smarty syntax. In some instances, if you add invalid code (such as an improperly formed Smarty expression) your Tiki may display a blank screen. In this case, you can edit your database (as explained previously) to temporarily deactivate the offending module. This will allow you access your Tiki and edit or correct the code in the module.
Page 186
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The tiki_modules table. 2. phpMyAdmin lists the currently active modules. Simply click Remove ( for the module to deactivate.
Deactivating a module. Tip: This does not delete the module Tiki simply deactivates it. 3. Reload your Tiki website. 4. On the Admin: Modules page, edit the user module to correct the custom code.
Page 187
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Page 188
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
screen. In this case, you can edit your database (as explained previously) to remove or correct the offending code. The following table identifies the appropriate database field in the tiki_preferences table for each custom code area on the Look and Feel page: Look and Feel field tiki_preferences field Custom HTML Content feature_custom_html_head_content Secondary site menu custom code feature_secondary_sitemenu_custom_code Custom Site Header sitemycode Top Bar, Custom code feature_topbar_custom_code Custom Center Column Header feature_custom_center_column_header Custom Site Footer bot_logo_code Custom End of Code feature_endbody_code
Page 189
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The Tiki community consists of all the developers, consultants, and end-users (just like you!). By joining the community, you help Tiki to grow. Not only will you be able to find answers to your questions, but you can even become an integral member of the community (if you desire) and help chart the course for Tiki in the future.
In this section
Tiki Registration Social Networking Getting Help Using the Forums Chatting on IRC Mailing Lists Contributing to Tiki Getting Committed Sharing what you Know
Page 190
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
You can see how "up-to-date" a particular *.t.o site is, by reviewing the footer information on each page.
Page 191
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Page 192
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Note: You can also use the Admin: Connect page to submit a bug report or feature request to the Tiki Developer site or add a Powered by Tiki link at the bottom of your site. 1. Use the Register this Site page to add your site to the Tiki Directory.
Tiki will automatically populate some fields (such as Name and URL) from your site's configuration. 2. Complete the following fields on the page: Name: Name of your Tiki website. Description: Short description of what your site is about. URL: URL of your website. Country: Location or language of your site. 3. Click Save. Tiki adds your site's listing to the community directory.
Page 193
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Page 194
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The Tiki Community site. You can also use the Join Tiki link at the bottom of any *.t.o page. 2. Complete all the fields on the registration form, and click Register.
The Registration page. Note: If you use an email filter, be sure to add the domain tiki.org to your "accepted" list.
Page 195
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
3. Click the link. Make sure that your email client does not "break" the link it may be quite long. Tiki will automatically validate your registration and the Tiki Welcome page appears.
Page 196
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Page 197
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
The Welcome page. Be sure to take a moment and read the welcome letter. It includes a lot of useful information, including: how to get help who to contact for information how to become involved That's it! You're now a member of the Tiki Community.
For a complete list of Tiki groups, see http://tikiwiki.org/Networks . By joining these groups, you can help improve the "visibility" of Tiki! Don't forget to become a friend of Tiki Essentials, too!
Page 198
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
And don't forget Tiki's internal help system. Simply click the Help button ( is available on most Admin pages to access the appropriate documentation. Tip: To use the help system, enable the Help System option on the Administration: General page.
) that
IN THIS SECTION
Page 199
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Include as many specifics as possible, such as: PHP and MySQL versions, operating system details, host, etc. When possible, include a URL or image that illustrates the problem. Write clearly. The Tiki community is international. Although most information is conveyed in English, not everyone is a native speaker. There are also several language specific forums and Tiki sites.
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 200 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums Forum List Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button Using the Code Highlighter Creating the HTML Plugin Plugin Parameters Enabling the HTML Plugin Approving the HTML Plugin Displaying all Pending Plugins Enabling the JS Plugin Approving the JS Plugin Enabling the JS Plugin Approving the JS Plugin
Page 201 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Adding {literal} Tags Adding Parameters to User Modules Using Module-Specific Parameters Creating a Tracker Creating Tracker Fields Finalizing the Tracker Populate the "Internal" Tracker Using the Tracker Create the Template When to Use a Plugin Writing a Simple Plugin Defining the Function Reading the Variables and Setting Defaults Error Handling Using the Plugin Accessing the Tiki Repository Creating your own Repository Creating a Profile from a Site Writing a new Profile Writing a Simple SQL Query Creating a DSN Using the SQL Plugin Using the DBReport Plugin Changing Preferences Fixing Modules Editing Custom Code About the Tiki Websites Connecting to the Tiki Directory Accessing the Forums Forum Categories
To access the Tiki support forums: 1. From the Tiki Community website forums select Support Forums > All web
Page 202
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Accessing the support forum 2. Select the forum that is most appropriate for your question. You can use the Find field to search all forum threads.
A partial listing of the forums available from the Tiki Community site. 3. Simply click the title of the forum to access.
Page 203
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware FORUM CATEGORIES
The Tiki Community site contains several different forum categories. Make sure that you post your question in the appropriate category (and please don't cross-post the same question to multiple forums). Community and *.tikiwiki.org site organization Tiki development Development Documentation Galaxia Workflow Engine Multilingual/i18n Tiki support Architecture/Installation Features/Usability LDAP/Active directory Themes Non-English Catal Deutsch Espaol Franais Italiano Portugus
Page 204
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Don't "ask to ask" simply ask your question. If someone can help, they will. Do check the documentation, FAQs, and forums first. Most questions have already been asked (and answered). Don't post large amounts of code to the channel. Instead, use a site such as http://pastebin.com/ . Do be patient if no one answers immediately You can always check the chat log later and see if someone offered a suggestion. Remember, the world is a big place. Just because it is 3 o'clock in the afternoon for you, doesn't mean that the rest of the world is awake, too.
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries
Page 205
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Wiki Attachments and Images Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums Forum List Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button Using the Code Highlighter Creating the HTML Plugin Plugin Parameters Enabling the HTML Plugin Approving the HTML Plugin Displaying all Pending Plugins
Page 206 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Enabling the JS Plugin Approving the JS Plugin Enabling the JS Plugin Approving the JS Plugin Adding {literal} Tags Adding Parameters to User Modules Using Module-Specific Parameters Creating a Tracker Creating Tracker Fields Finalizing the Tracker Populate the "Internal" Tracker Using the Tracker Create the Template When to Use a Plugin Writing a Simple Plugin Defining the Function Reading the Variables and Setting Defaults Error Handling Using the Plugin Accessing the Tiki Repository Creating your own Repository Creating a Profile from a Site Writing a new Profile Writing a Simple SQL Query Creating a DSN Using the SQL Plugin Using the DBReport Plugin Changing Preferences Fixing Modules Editing Custom Code About the Tiki Websites Connecting to the Tiki Directory Accessing the Forums Forum Categories Reviewing the Log
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
. This is especially helpful when checking to see if your question was answered.
Reviewing the IRC chat log You can "page" through the log, from day-to-day, as well as perform keyword searches.
Page 208
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
tikiwiki-deutsch - German Language User Group (GLUG) deutschsprachige Tiki Benutzergruppe tikiwiki-users - General list for Tiki users The mailing lists are powered by mailman , a free email discussion list software. See http://www.gnu.org/software/mailman/index.html for more information. Note: See http://tiki.org/Mailing+lists lists. for information on all Tiki mailing
TIKI NEWSLETTER
You can also subscribe to the Tiki Newsletter to receive notification of new releases, community events, and other Tiki news.
Page 209
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
IN THIS SECTION
Disclaimers About this Site Valid Markup Accessibility Features Privacy Policy Copyright Information Navigation Conventions Links Images Printing Converting to PDF Translations Tags Tag Cloud Images Trademarks Privacy Using a Patchset Installing full Version Restoring your Customizations Checking out from SVN Becoming a Developer Using Pre-Built Archives Performing a Manual Installation Creating the Database File Galleries Wiki Attachments and Images
Page 210
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Tracker Attachments Language (Translation) Files Plugins and Modules Plugins Modules Anything Else Using phpMyAdmin Using the Command Line Restoring from a Backup Using phpMyAdmin From the Command Line Files Directories/folders Including an Additional CSS Creating Inline Styles Finding the Right Template Including Wiki Syntax Using modules and plugins Wiki Pages Articles Forums Forum List Forum View Forum Thread Blogs View Blog View Blog Post Copying and Pasting Using the WYSIWYG Editor Using the Wiki Editor Inserting Special Characters Using Entity Values Using the Special Characters button Using the Code Highlighter Creating the HTML Plugin Plugin Parameters Enabling the HTML Plugin Approving the HTML Plugin Displaying all Pending Plugins Enabling the JS Plugin
http://twessentials.tikiforsmarties.com Print date: Mar 2, 2012 Page 211 Copyright by Rick Sapir Some rights reserved.
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Approving the JS Plugin Enabling the JS Plugin Approving the JS Plugin Adding {literal} Tags Adding Parameters to User Modules Using Module-Specific Parameters Creating a Tracker Creating Tracker Fields Finalizing the Tracker Populate the "Internal" Tracker Using the Tracker Create the Template When to Use a Plugin Writing a Simple Plugin Defining the Function Reading the Variables and Setting Defaults Error Handling Using the Plugin Accessing the Tiki Repository Creating your own Repository Creating a Profile from a Site Writing a new Profile Writing a Simple SQL Query Creating a DSN Using the SQL Plugin Using the DBReport Plugin Changing Preferences Fixing Modules Editing Custom Code About the Tiki Websites Connecting to the Tiki Directory Accessing the Forums Forum Categories Reviewing the Log Tiki Newsletter Understand and Agree to the Three Rules Get a SourceForge.net Account Other Accounts Ask for Access
Page 212
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Tiki uses a "wiki way" software development model. With over 200 active developers continuously committing code to the repository, it is important to make the process as easy as possible. While the Tiki development process may seem chaotic and unruly to an outsider, it is important to remember that it has been working well since 2002! There are really only three rules for contributing code to the Tiki project. The Three Rules 1. Respect the environment. 2. Commit early, commit often. 3. Make it optional. All Tiki developers abide by these rules. You'll need to agree too, in order to contribute your code. Note: Review the details of The Three Ruleson the Tiki Developer site . For background on Tiki's "wiki way" model of development, you might enjoy reading "A Process That Is Not " by Hakan Erdogmus, published in the November/December 2009 (Vol. 26, No. 6) issue of IEEE Software magazine.
The Tiki SVN (Subversion) code repository is hosted by SourceForge.net. You'll need to have a SourceForge.net account in order to access the SVN repository. Registration is free and requires only a valid email address. All of your code contributions will be identified with by your SourceForge.net username. You can use the same username that you have on the Tiki websites.
OTHER ACCOUNTS
In addition to your SourceForge.net account, you'll also need a Tiki Community account. This will allow you to participate on the Tiki Community websites.
Page 213
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
To stay involved with the Tiki community, you should also: Subscribe to the Tiki mailing lists, especially the developer's list and SVN commit list Subscribe to the Tiki News RSS feed Join the other Tiki social networking sites (such as Twitter, Facebook, and LinkedIn)
Getting commit access to the Tiki SVN repository is as simple as asking for it. 1. Go to Tiki IRC channel: #tikiwiki. Note: See the Tiki Developer site for details on using IRC. 2. Ask for a Tiki Admin and simply ask for access to the SVN repository. One of the Tiki Admins will begin The Ceremony: 1. You'll need to provide your SourceForge.net account name to the Tiki Admin. 2. You'll be asked to read the Three Rules and signify your acceptance. 3. The Tiki Admin will add you to the SourceForge.net Tiki project list. You're now a Tiki developer! Welcome to the Tiki Community! 3. You should now set up your local development environment. Note: It may take several hours for your permission to be updated throughout the SourceForge.net servers. In the meantime, you should review the following items on the Tiki Developer's site: http://dev.tikiwiki.org/DevTips http://dev.tikiwiki.org/SVNTips
Page 214
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
community even if you're not a code developer. Help out on the Tiki forums. Remember, everyone was a newbie at one time. There's a good chance that other people have the same questions that you once asked. Join a Tiki Team . There are lots of opportunities to help out in marketing, graphics, user interface, translation, and much more. Help update the Tiki Documentation . Become a Tiki Facebook fan and join the other social networks and follow the Tiki on Twitter . Attend a TikiFest . Translate Tiki into your native language. Tiki already contains translations for 30+ languages , add or improve yours! Make a financial donation to the Tiki Association. There are lots of "unofficial" was to help, too. Write a review of Tiki for your blog or website. Create your own Tiki online reference or guide.
Page 215
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
In this section
Blog News Portal Corporate Web Site Club or Association Online Book Issue Tracker Collaborative Website Technical Documentation Translation Management System Collaborative Website
1. If you selected the Use simplified email format option, you must create this Subject field. 2. Where: 2 = ID of the Internal Tracker, 10 = Field ID of the primary selection (drop down list) 3. Where: 2 = ID of the Internal Tracker, 10 = Field ID of the primary selection (drop down list), 12 = ID of the item link of the External tracker, 11 = ID of the text field of the Internal tracker 4. A pull quote (also known as a lift-out quote or a call-out) is a quotation or edited
Page 216
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
excerpt typically placed in a larger typeface on the same page. http://en.wikipedia.org/wiki/Pull_quote 5. Well, maybe not 101, but I'll list as many as I can. Feel free to list your favorites, too!
10.1 Blog
A blog is typically a website that contains entries of information (called posts) that are updated on a regular basis. Usually, the posts are displayed in reversechronological order (that is, newest first) and may be categorized. Blogs also allow for readers to post comments and responses. With Tiki, you can create a site with one blog or 100. You can also have varying degrees of security for each blog. Some can be public, others accessible only by logging into the site. You can also let readers post comments to each post. Tiki provides multiple ways to reduce spam comments.
Page 217
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Example Profile
This example includes a single blog that allows comments. Each blog post can be tagged with keywords. These keywords appear in a Tag Cloud module in the left column.
Tiki-powered blog Some highlights of this profile include: 1. The Site Title and Subtitle options are used in place of a logo or image. Clicking the title displays the home page. 2. The About box is a custom module. It contains a link to the Contact Us page. 3. The Search module is used in place of the blog-specific search. This uses the full text search option (not the Tiki search). 4. The Most Popular Tags module displays the top 15 tags from the posts. 5. Another custom module appears at the bottom of the page to allow the administrator to log into the site (by linking to the default login page: tikilogin.php. It uses the box=n option to disable the module's title and decorations from appearing. 6. The site's home page is the home blog (this example has a single blog). The
Page 218
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
blog's title and description (or its custom heading) has been disabled, since the site's title the About module are used instead. 7. Each post has its own tags. Clicking a tag displays a list of related posts with the same tag. 8. This example uses the Blog Excerpt feature. On the home page, only a short portion of the blog post (user-defined) is shown. A Read More link allows visitors to read the full post. 9. The ShareThis option allows visitors to easily "share" the post to all popular networks. If you have a ShareThis account , you can even track analytics for the site. 10.Commenting has been enabled. Visitors can posts comments anonymously, if desired. Tiki includes CAPTCHA support to help reduce spam.
YAML Profile
Preferences
preferences: blog_comments_default_ordering: commentDate_desc blog_list_created: n blog_list_posts: n blog_list_title_len: 80 blog_list_visits: n browsertitle: My Tiki BLog contact_anon: y display_timezone: UTC error_reporting_adminonly: n error_reporting_level: 0 feature_blog_heading: y feature_blog_sharethis: y feature_blogs: y feature_contact: y feature_freetags: y feature_messages: y feature_search: y feature_show_stay_in_ssl_mode: n feature_wiki: n gal_use_lib: gd home_blog: 1 https_login: disabled layout_tabs_optional: n module_zones_topbar: fixed sitelogo_alt: sitelogo_src: sitelogo_title: sitesubtitle: My thoughts about Tiki Wiki CMS Groupware
Page 219
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware sitetitle: My Tiki Blog style: business.css tikiIndex: tiki-view_blog.php?blogId=1
Blog
preferences: feature_blogs: y objects: type: blog ref: personal data: title: My Personal Blog description: This is my blog, powered by Tiki Wiki CMS Groupware. user: admin public: n use_title: n use_title_in_post: n use_find: n use_author: n use_excerpt: y allow_comments: y type: blog_post data: blog: $personal title: Welcome to my new blog excerpt: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer a velit enim. Pellentesque semper felis et nisi placerat ut porta arcu sodales. Nulla sit amet dui vel diam vulputate rutrum ultrices et neque. Pellentesque vehicula justo ac risus sagittis pharetra. Nunc suscipit felis nec dui ornare tincidunt. Quisque et sem sit amet neque elementum bibendum non sit amet magna. Aliquam laoreet laoreet feugiat. Etiam vel sapien quam. Aliquam erat volutpat. Aliquam imperdiet adipiscing hendrerit. content: This post was created by the installation profile. -
Page 220
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware FEATURES & EXAMPLES
For a Tiki-powered news portal, commonly activated features include: Wiki RSS Syndication Modules Categories Ratings Comments Articles (and submissions)
Yahoo etc.
Example Profile
Example Profile
Page 221
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Example Profile
Example Profile
Page 222
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Example Profile
Example Profile
Page 223
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Example Profile
Example Profile
Page 224
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Example Profile
Page 225
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
11 Epilogue
While this may be the end of this guide, this is most definitely not the end of your Tiki journey. This guide has covered only a handful of Tiki's features. I encourage you to explore the complete Tiki documentation on all of Tiki's features, and join the Tiki Community. for information
Finally, I am curious to know what you think about this guide and this site. Please tell me what you think. Any feedback, compliments, or criticism is greatly appreciated. Even better, become a contributor and help improve this guide. Thank you!
Colophon
This site uses Tiki Wiki CMS Groupware with the following options enabled: release 6.x LTS (updated from SVN) Wiki and Structures Trackers Search (advanced) CSS menus Site logo and identity RSS feeds Multilingual, Translation, and Best language Categories Keywords Polls Copyright WYSIWYG editor File gallery User watches HTML pages SEFURLs
Page 226
Tiki Essentials: What all Smarties need to know about Tiki Wiki CMS Groupware
Page 227