Tikiwiki 1.

9+
“Sirius”

Documentation and User Manual (beta)

http://doc.tikiwiki.org/Documentation

This documentation is a community effort: Join us!

http://doc.tikiwiki.org/Welcome+Authors
http://doc.tikiwiki.org/Documentation+Status

This documentation is licensed under a Commons Attribution - ShareAlike License.

http://creativecommons.org/licenses/by-sa/2.5/
Tikiwiki Documentation

(page intentionally left blank)

Back to Table of Contents 2

 Tikiwiki Documentation 1.9+

Authors white board

Missing still (July 24, 2007 - Tiki198beta_21_with_alphabetical_index.odt):

• Add a What's new in 1.10 (users oriented, screenshots with short text below)
• Add page with Movie references and links from: http://tikiwiki.org/TikiMovies

Nice to have in this document before “beta” public well announced release:
• Add some content for:
• all the missing Plugin pages (mostly, the non official ones, in tw.o)
• all the ((stub)) Module pages (almost all!)

Other “nice to haves” after 1.9beta released:

• Documentation for the remaining Mods from mods.tikiwiki.org
•

Done in version 21: (July 24th , 2007)

• backups, import database, structures and search pages highly edited
Done in version 20: (July 22nd, 2007)
• mods type features and avatars pages added.
• Many more Plugin pages added
• minor enhancements here and there...
Done in version 19: (July 18th, 2007)
• Some Workflow pages included from workflow.tw.o)
• some more pages: search tracker items, mod svg, scroll, phpplot...
Done in version Tiki198beta_18.odt (July 13th, 2007):
• apply style to ALL tables
• added hiperlinked index at the beginning
• added alphabetical index at the end
• added FAQ's in new annex
• pluginmanager description back to english
• separated right and left page layout (header and footer)
• Added “Back to TOC” to footers for easy navigation
• Fixed problem with structure of headings for navigation through pdf bookmarks
• updated list of contributors: tw.o + doc.tw.o nowadays

Back to TOC 1
Editorial board (in alphabetical order by name):
David Thacker (dthacker), Gary Cunningham-Lee (chibaguy), Michael Philling (mlpvolt), Xavier de Pedro (xavi),...
join us!

List of authors: (889 Contributors to Tikiwiki documentation)

5pazrat, 5sm, A1isp.co.uk, A2JC4life, acemtp, adamus, ae, Ahriman, ahshang, aigarius, akira, akr, alain_desilets, albrown, alex, alexboko, almaviva,
aloof, alpeb, altar, allosaurus65, amette, amokandy, anarkim, anasis, andersb, andre.blum, andreas, AndreReis, AndriyPodanenko, andrzej, aneuhaus,
ang, anonymous, ansfans, Anthonywong, antonio.fonseca, anupriya, [email protected], ardavis, ardigo, arnaudherve, Arno, artbody,
artkuo, as6o, ashman, astarte, ataraxia, atilabelloquim, audre, avdwheel, avgasse, avh, aw, awolff, awwaiid, az3rty, baci, badger3284, bapajan, BAR,
barryk, bburgaud, BeastRider, beerlounge.de, ben.dubouloz, BenLanghinrichs, bensond, bernhard_fuerst, berryweb, bethohio3, bfleeson, bhr2,
BicTouBi, bigelf, bigjet, BillFWhite, bitinia, bitshop, blade, bligneri, BlueNinja, bluetigger, blumi, bluybrink, bnuz, bondon, boud, bpfaffenberger,
breeza21, brooksgraham, broubrou, bruce2004, bsamson, bt_schmidt, btallman, bteichmann, btodoroff, bubu.italia, Buiu, bulat, burunduk, bush2004,
BVanBuren, bwente, bzahn, Cable, cahamer, cambo, camus546, caramello, Carpe_Diem, cbarbry, cbourel, ccastaneda, cerion, cgc0202, cgrinds,
Cicada, ciccioqualiteam, cinsk.shin, cirtexhosting, clappingtree, claudio, clbustos, Clon, coffman, colin_froggatt, colinmo, colorado, collective101,
connermo, coofercat, CoolOs, cords, corelon, coreyt, CosmoBob, Court-Jus, cpcollins, crimson, cseabra, cspenc, custodio, cyface, cynt, chandra,
charlener, Chealer, Chealer9, Chet, chibaguy, chilly, chris.holman, Christophe, daaave, Damian, danam, DanielCar, DanielX, darrylxxx, darthwonka,
darussol, davemc, davenewman, DaveSanders, david2000, DavidBright, DavidCramer, davidchavalarias, davidleasure, davidmacbryde, davidpi,
DavorCengija, dawnlinux, daytonclark, dcjohn, ddiall, deboever, Deckard, deji, Demoalt, DennisDaniels, deragon, DereDior, derisavi, DerWinzer,
Devi, Devilboy, dfarrar, dheltzel, dhostetler, diana, dimaz-z, dimm, dingo12340, djw2, DMC, dmdanyluk, dmitrio, dmitrym, dmytro, docekal,
domenec58, dp7, dragos, drichli, drizzt1611, DrMaXX, drool, DrSlump, drumbytes, dryuxx, dscassa, dthacker, dwtiki, edalton, edelgreco, edtandi,
eduardo, EdwardTam, Edwin, egodwin, eHa, Eidolon77, eidosabi, eilorux, einstine, elecnix, emagin, encgo, epo, ericaat, ericgorr, ericlundstedt,
ericyu, eSeL, etienne, ewan, exspiro, fab121, Fabien, fabolo, failsure, fanha, fatalexe, FDL, felipe_pdp, Felix, filipzahradnik, filmil, finn_hakansson,
fivos, flimflam, flobi, fmathias, fortuity, Fortytwo, fov, Franck, FrancoisBachmann, freephile, freevic, ftravers, fukuchi, fumphco, funkypenguin, gab,
gacp, gaf, gahron, gambit, gambuzino, ganesht, garazy, garrett, garyalex, gazelle, gaztomy, gclift, gedeonz, gem, gene203, GEOINTEL, george.geller,
georger_br, geraldpineau, gezu1, gferreira, gg, giak, giannidv, Giddings, gilsoncav, gillesm, gio, Giotto, girishn, gladed, Globaltap, gmartin,
gmuslera, gnoemer, gnozil, gobbo712, goldmoon, gongo, gopaa, gorn, gpoints, greetlangie, GregWatson, gribble, gronnbj, grumpysmurf,
guidewebmaster, GunnarRene, Gunther, gustav, guusbosman, guyfr, gwarden, Gwayne, gzdavy, habib, hadj, halon, Hartsa, Hausi, heikohaller,
helgen, hermione, hgamboa, hina, hmackiernan, hmm2, hockleyd, homunq, hostingcomments, hotte, housetier, hsaelens, htrimas, humaneasy, hunner,
hushus, hvrietsc, hyapadi, ibtubed, ikky, illori, irq3, isadrastea, itahi.ortiz, j@ZZ, jahlewis, jahmaica1, jake, jamesoftopiya, jangseungwook, janice,
JarrodNeven, jas2000, jasko, jasondiceman, jasonglynn, javier, javorie, jbert, jbnuke, jbonnet, jburley, jbutler, jcwinnie, jcyrisse, jdaviescoates,
jdiercks, jdobbins, JeanFrancoisNoubel, jeang, jeb, jennypenny, Jeslow, JesseTilly, jev, JFNoubel, jgc94131, jh, jiayinte, jimcp, jir, jjfbbennett,
jjongsma, jjz, jkring, JMan, jmaspons, jmj, joakin, joana, joecracker, joejett, joelg, johanc, jonmartin, jordendeng, jordisancho, jorgercosta, josefgc,
joshuajensen, jozo, jpb105, jpf, jpg, jpgeorget, jpineda, jpowers, jreyes, jrobbio, jrvalverde, jsurfer, Juanan, juanjoe, jubin, kage, Kalamendorum,
kamar, kamrik, karloy, Karneevor, kemitix, kenhtanaka, kevin, kevinB, Kfmook, kiilo, Kiki, kilroyj, Knifee, kodewulf, koko77, kontikigo, koth,
krato, kreugen, krishna, krishnaveni, ktest, kumarAnant, kumquat, KurtSys, kushnir, kwow, kyoungyun, l1_wulf, l8, lancecarr, landryca, larry,
larrykluger, larsburgstahler, LaunchHQ.com, lawrence, lcworks, leon_heller, letreo, Lex, lfagundes, liangalei, lilkahuna, limako, lisaneun, littletiger,
loic, Loki, lolfman, lorello, lphuberdeau, luca, lucasdeskywalker, luci, luciash, luis, llobs, m@tt, MacGyver, Maddi, madmaxx, madsere, maeglin,
MagicFab, magius, maiky, manemae, Marbux, marcius, marclaporte, marcusb, marga, maria.rohrig, marianat, mariom, MarKel, markusvk, Marshall,
martinenders, MartinGeisler, martinmanyhats, MartinSGill, martrn, maryluke, mash, massimoi, matata, mathsinger, mattcooperrider,
mauriciocerqueira, max-max, MaxPower, maxy, Mazl, mburger, mccabem, mchurchward, mdavey, mdv137, me-g33k, MEbneter, Mendokusai,
mgfeller, mgle, mglunny, mhryciuk, MikeGras, mikehough, mikelcu, MikeManiscalco, MikeMorris, mikenielsen, mikespub, MikeW, millette, min,
minoura, miohtama, mirc, Miroslav, misuba, mitchmurphy, Mixolyde, mkumar, MLimburg, mlpvolt, mnunez, Mohamnag, mose, mrb, mstef,
mstovenour, mtb2ride, mtcooper, mtl3p, Muizeman, murat, musti, musus, mv, mwexler, Mykk, Myrdal, mytto, na, nalsar, natster, natxo, nchankov,
nedbj2, nema, nestor, Netdeveloper24, nickvidal, nicolas, nikolic, nitroburn, Nlaak, NoahWardrip-Fruin, nomejoe, NorbertHuffschmid, Norm,
Nosklo, noskule, notemas, ntw, number7, nyc, nyloth, ohertel, oka-s, oldirtyhaddad, olegk, olisb, oliverie, olivier, One_Eye, OneOfMany, orion,
orionrobots, osiris, otzuika, p00h, paco, pacoit, paedrik, pait, papercrane, Pappi, paradime, patrik, patvdv, paulap01, pberman, pdf, pek, peter5,
PeterHuisken, peterpoe, ph0rman, phielk, phil, PhilWhipps, phunkymunky, Phylip, pi, PierreCarlier, Piers, pj, PKHG, pkhuong, plison, pmichelazzo,
Poliorcetes, pongle, PPagan, PrezKennedy, psixi, pushkin, pwinnicker, Qo027, Quilbilly, R05W311, RabidDog, Rachael, ragnvald, raindeer, Randy,
rasa, rbabu, rberry, rcogley, redflo, rene, renier, repetty, RestoreHelp, rex, ricardo, RicardoNeves, rickdier, ricks99, richlew, richtl, rikrak, rima, Rip,
rjlabs, rjoe_brandon, rkchaves, rlpowell, robajz, RobbinBonthond, robertgetreuer, robi, RobinMacharg, rodrigo, rodrigo_sampaio, rogeliotg, rohit,
Rokr, rollin, RossGoodman, roysinn, rpg, rreed, rstuven, rubaiyat, RussWilde, salsbury, Sally, Santa, SantaClaus, sascha69, sbindon, sbirrer,
ScottYelich, schmidt, Schwanke, sdl, sdlee, sdpinpdx, sean, sebashenkel, seggy, sethop, SEWilco, sgoergner, Shade, shade9, shahjx, shanew,
shaun_dark_lord, shebdim, Shesh, shinhan, shiree1, shuyang, sid_gould, sigsegv, sikko, silhusk, Simmi, simon, sir-b, siridhar, sitaweb, siteground,
siteground1, sjh1226, Skee, skeeter, sku, smets, smunn, smurf, snookra, Sofos, sonic, sophana, Soron_12F, soshea, spaztica, spd, spider, spite,
Spooky, spoonyg, spyk, sQuare, Squee-D, StarRider, stedewa, steffen, stella12, Steve, stevena, stiEbiz, sting, straffin, stratege, Stryker, stuartd, stuw,
sulimma, sunny, superchango, superdude, svehei01, sven2001, swampfox, swf, swimmer, swythan, sylvaincarle, sylvie, t, tabotrieu3, Taipan, takis,
tapiov, Tarlbot, tate138, tbox, tburnham, Teco, techtonik, techudite, telenieko, Terence, terjeset, terris, tetard, tex, the_egg_man, thecatfelix, theweb,
thor574, tibi, tikito, Timedout, TimMansfield, tinjaw, tjfulopp, tkarakai, tklee, Tobias_Bergemann, toddslo2004, toggg, tohmeiphun, tom, tomek4711,
tomza, TonyColley, tonylinde, Torpedro, toxikman, tr, Traivor, trickster, trigger_my_passion, triple5, tro, Trona0, troworld_clone, Turf-69, twiker,
ujang, Unclegeo, user, v3ggi32u, valio, van_woods, vendo, veninat, viktor, VinceVeselosky, vinodgkulkarni, Vlad, vramin, vtran4270, wadooa,
wan1980, wani, watson, weedar, weichelt, wesleywillians, whitey, wicked, wiki_newbie, wikiDesign, WisTex, wlauriks, wmanent, WoG, wojtalik,
wolff_borg, Wombiroller, woop, xaman, xavi, xavidp, xenfasa, XlorepDarkHelm, yan, YannickMajoros, yarda, yogi, yoni, yuki_loe, yuzhenxin,
zaufi, zcecil, zedar, zibas, zippy, zogy, zom, zuln, ZZamboni

Special acknowledgments, for their feedback to improve this document, to:

Lukas Masek (luci) and Rick Sapir (ricks99).

2 Back to TOC
 Tikiwiki Documentation 1.9+

Documentation

Table of contents (TOC)

1. INTRODUCTION............................................................................................................ 29
1.1. Tikiwiki & Community Goals............................................................................................. 31
1.2. Social Contract...................................................................................................................... 32
2. INSTALLATION.............................................................................................................41
2.1. Requirements and Setup...................................................................................................... 47
2.1.1. Requirements.................................................................................................................. 47
2.1.1.1. Webserver................................................................................................................47
2.1.1.2. Database................................................................................................................. 48
2.1.1.3. PHP.........................................................................................................................48
2.1.2. Optional Software or Libraries....................................................................................... 50
2.1.3. Fantastico (and other ISP panels) and Tikiwiki.............................................................. 50
2.2. Downloading Tiki..................................................................................................................51
2.2.1. Latest stable releases....................................................................................................... 51
2.2.1.1. Official repository................................................................................................... 51
2.2.1.2. Mods........................................................................................................................51
2.2.1.3. Themes.................................................................................................................... 51
2.2.2. Testing future Tiki releases.............................................................................................51
2.3. Tiki Installation on Linux.................................................................................................... 51
2.3.1. Install with RPM............................................................................................................. 53
2.3.2. Install on Debian............................................................................................................. 53
2.3.2.1. Preparing supporting components for Install.........................................................53
2.3.2.2. PHP Setup............................................................................................................... 53
2.3.2.3. MySQL Setup.......................................................................................................... 54
2.3.2.4. Apache setup........................................................................................................... 54
2.3.2.5. Install Tiki............................................................................................................... 55
2.3.3. Install on Gentoo............................................................................................................. 55
2.3.3.1. Normal installation................................................................................................. 55
2.3.3.2. Installation of last package (but not CVS).............................................................. 56
2.4. Windows Desktop Install......................................................................................................57
2.5. Advanced Settings.................................................................................................................61
2.5.1. Shared Hosting................................................................................................................ 61
2.5.2. Lite install....................................................................................................................... 61
2.5.3. MultiTiki......................................................................................................................... 61
2.5.3.1. Multitiki version 1.9................................................................................................ 62
2.5.3.2. Multitiki Akira......................................................................................................... 66
2.5.4. Rewrite Rules.................................................................................................................. 68
2.5.4.1. Bundled Rewrite Rules............................................................................................ 69
2.5.5. ImageMagick Install....................................................................................................... 70
2.5.5.1. Install ImageMagick............................................................................................... 70
2.5.5.2. Install ImageMagick and Libs.................................................................................70
2.5.5.3. Install Imagick PEAR Module.................................................................................71
2.5.5.4. Tikiwiki setting up................................................................................................... 71
2.5.6. GraphViz Install.............................................................................................................. 71

Back to TOC 3
 2.5.6.1. Graphviz Install...................................................................................................... 71
2.5.6.2. Install Graphviz and Libs........................................................................................71
2.5.6.3. Testing an installed Graphviz Setup....................................................................... 72
2.5.6.4. Troubleshooting Hints............................................................................................ 72
2.6. TroubleShooting....................................................................................................................73
2.7. Upgrade..................................................................................................................................73
2.7.1. Upgrade 1.8 to 1.9...........................................................................................................75
2.7.2. Upgrade 1.9.x to 1.9.7.....................................................................................................76
2.7.2.1. First Backup whole filesystem and database.......................................................... 76
2.7.2.2. Upgrade:................................................................................................................. 77
2.7.3. Upgrade 1.9.7 to 1.10......................................................................................................79
2.7.3.1. Upgrade:................................................................................................................. 79
3. CONFIGURATION......................................................................................................... 85
3.1. Quick Start............................................................................................................................ 85
3.1.1. Installation.......................................................................................................................85
3.1.2. Features Administration.................................................................................................. 85
3.1.3. Groups and Users............................................................................................................ 86
3.1.3.1. Registration Privileges............................................................................................86
3.1.3.2. Creating additional groups.....................................................................................86
3.1.4. Customize the Appearance of the Site............................................................................ 87
3.1.4.1. Choose or design a theme....................................................................................... 87
3.1.5. Administer the modules.................................................................................................. 87
3.1.6. Create content................................................................................................................. 87
3.2. Menu HOWTO..................................................................................................................... 87
3.2.1. How to Create a Menu visible to all users...................................................................... 88
3.2.2. How to Assign Modules to specific Groups................................................................... 88
3.3. Profiles................................................................................................................................... 89
3.3.1. Using profiles.................................................................................................................. 90
3.3.1.1. How can a new profile be created?........................................................................ 90
3.3.1.2. Step by step..............................................................................................................90
3.4. Advanced Configuration...................................................................................................... 91
3.4.1. Site Identity..................................................................................................................... 91
3.4.1.1. General Description................................................................................................91
3.4.1.2. Key Function and sub-features............................................................................... 91
3.4.2. Group.............................................................................................................................. 93
3.4.2.1. Steps to create a private room:............................................................................... 94
3.5. Mods....................................................................................................................................... 94
3.5.1. Mods User....................................................................................................................... 95
3.5.1.1. Where to get them from...........................................................................................95
3.5.1.2. Installing a Mod...................................................................................................... 97
3.5.2. Mods Admin................................................................................................................... 99
3.5.2.1. Requirements...........................................................................................................99
3.5.2.2. Mods panels.......................................................................................................... 100
3.5.2.3. Mods Provider.......................................................................................................101
3.5.3. Mods Details................................................................................................................. 102
3.5.3.1. Morphology...........................................................................................................102
3.5.3.2. for developers : mods.sh....................................................................................... 103
3.5.3.3. Mods evolution......................................................................................................104

4 Back to TOC
 Tikiwiki Documentation 1.9+

4. TIKIWIKI FEATURES.................................................................................................. 107

4.1. Wiki...................................................................................................................................... 116
4.1.1. Using Wiki Pages..........................................................................................................118
4.1.1.1. The Wiki Menu...................................................................................................... 118
4.1.1.2. A Wiki Page...........................................................................................................119
4.1.1.3. Creating a Wiki Page............................................................................................120
4.1.1.4. Last Changes.........................................................................................................120
4.1.1.5. Wiki Rankings....................................................................................................... 121
4.1.1.6. Page History......................................................................................................... 122
4.1.1.7. Similar Pages........................................................................................................ 122
4.1.1.8. Undo Edit.............................................................................................................. 122
4.1.1.9. Page Export...........................................................................................................122
4.1.1.10. Page Renaming................................................................................................... 122
4.1.1.11. List Pages............................................................................................................122
4.1.1.12. Backlinks & Orphan Pages.................................................................................123
4.1.1.13. The Sandbox........................................................................................................123
4.1.1.14. Page Monitoring................................................................................................. 123
4.1.1.15. Page Permissions................................................................................................123
4.1.1.16. Share pages......................................................................................................... 124
4.1.1.17. Show Module in Wiki Page................................................................................. 125
4.1.1.18. Other Syntax Pages.............................................................................................125
4.1.2. Wiki-Syntax Links........................................................................................................ 125
4.1.2.1. Quick Reference.................................................................................................... 125
4.1.2.2. Linking to Wiki Pages........................................................................................... 125
4.1.2.3. Linking to External Wiki Pages............................................................................ 126
4.1.2.4. Linking to Web Pages........................................................................................... 126
4.1.2.5. Linking to Email Addresses...................................................................................127
4.1.3. tiki-admin_external_wikis.php..................................................................................... 127
4.1.4. Wiki-Syntax Lists......................................................................................................... 127
4.1.4.1. Quick Reference.................................................................................................... 128
4.1.4.2. Creating a Bulleted List........................................................................................ 128
4.1.4.3. Creating a Numbered List.....................................................................................128
4.1.4.4. Creating a Nested List...........................................................................................129
4.1.4.5. Adding Hidden Details..........................................................................................129
4.1.4.6. Text Continuation..................................................................................................130
4.1.4.7. Creating a Definition List..................................................................................... 130
4.1.5. Wiki-Syntax Images......................................................................................................130
4.1.5.1. Adding an image................................................................................................... 131
4.1.5.2. The image tag........................................................................................................131
4.1.5.3. Links to image related pages in Tikiwiki.............................................................. 133
4.1.5.4. Allowing pictures to be uploaded..........................................................................133
4.1.5.5. Adding Images From an Image Gallery............................................................... 134
4.1.5.6. Adding Images From Another Site........................................................................134
4.1.6. Wiki-Syntax Text.......................................................................................................... 134
4.1.6.1. The Markup Language Wiki-Syntax......................................................................134
4.1.6.2. Quick Reference - Basic Text Formatting.............................................................135
4.1.6.3. Basic Text Formatting...........................................................................................135
4.1.6.4. Web-Safe HTML Colors........................................................................................135

Back to TOC 5
 4.1.6.5. Bold Text............................................................................................................... 139
4.1.6.6. Italic Text.............................................................................................................. 140
4.1.6.7. Underlined Text.....................................................................................................140
4.1.6.8. Strike through text.................................................................................................140
4.1.6.9. Centered Text........................................................................................................ 140
4.1.6.10. Monospaced Text for Code................................................................................. 140
4.1.6.11. Text box............................................................................................................... 141
4.1.6.12. Plain Text............................................................................................................ 141
4.1.6.13. Indent.................................................................................................................. 141
4.1.6.14. Using Square Brackets........................................................................................142
4.1.6.15. Non-breaking space............................................................................................ 142
4.1.6.16. Entering code...................................................................................................... 142
4.1.7. Wiki-Syntax Special Characters................................................................................... 142
4.1.8. Wiki Config...................................................................................................................143
4.1.8.1. Admin Access........................................................................................................ 143
4.1.8.2. Sections: Tiki Config Panel...................................................................................143
4.1.8.3. Wiki settings.......................................................................................................... 144
4.1.8.4. Wiki Comments Settings........................................................................................145
4.1.8.5. Wiki Attachments...................................................................................................146
4.1.8.6. Export Wiki Pages.................................................................................................147
4.1.8.7. Remove unused pictures........................................................................................147
4.1.8.8. Wiki Home Page....................................................................................................147
4.1.8.9. Wiki Discussion.....................................................................................................148
4.1.8.10. Wiki Link Format................................................................................................ 148
4.1.8.11. Wiki page list configuration................................................................................148
4.1.8.12. Wiki features....................................................................................................... 149
4.1.8.13. Wiki History........................................................................................................ 154
4.1.8.14. Copyright............................................................................................................ 154
4.1.8.15. Wiki Watch.......................................................................................................... 154
4.1.9. Wiki Details.................................................................................................................. 155
4.1.9.1. Wiki Modules.........................................................................................................155
4.1.10. List Pages.................................................................................................................... 155
4.1.10.1. find...................................................................................................................... 155
4.1.11. Wiki Plugins................................................................................................................156
4.1.11.1. PluginAgentinfo.................................................................................................. 158
4.1.11.2. Plugin Alink........................................................................................................ 159
4.1.11.3. Plugin Aname......................................................................................................160
4.1.11.4. Plugin Article...................................................................................................... 162
4.1.11.5. Plugin Articles.....................................................................................................163
4.1.11.6. Plugin Box...........................................................................................................164
4.1.11.7. Plugin Category.................................................................................................. 167
4.1.11.8. Plugin CatOrphans............................................................................................. 169
4.1.11.9. Plugin Center...................................................................................................... 170
4.1.11.10. Plugin Code...................................................................................................... 171
4.1.11.11. Plugin Copyright...............................................................................................172
4.1.11.12. PluginDiv.......................................................................................................... 173
4.1.11.13. Plugin FancyTable............................................................................................174
4.1.11.14. PluginFiles........................................................................................................ 175

6 Back to TOC
 Tikiwiki Documentation 1.9+

4.1.11.15. PluginFlash.......................................................................................................176
4.1.11.16. PluginGoogleVideo...........................................................................................177
4.1.11.17. PluginGroup..................................................................................................... 178
4.1.11.18. Plugin Include................................................................................................... 178
4.1.11.19. Plugin Jabber....................................................................................................180
4.1.11.20. PluginJS............................................................................................................ 181
4.1.11.21. PluginLang........................................................................................................183
4.1.11.22. PluginManager................................................................................................. 183
4.1.11.23. PluginMindmap.................................................................................................187
4.1.11.24. PluginMiniQuiz.................................................................................................188
4.1.11.25. PluginModule....................................................................................................190
4.1.11.26. PluginMouseover.............................................................................................. 191
4.1.11.27. PluginPerm....................................................................................................... 192
4.1.11.28. Plugin Poll........................................................................................................ 193
4.1.11.29. Plugin Redirect................................................................................................. 194
4.1.11.30. PluginRSS......................................................................................................... 195
4.1.11.31. Plugin Sheet...................................................................................................... 196
4.1.11.32. Plugin Snarf...................................................................................................... 198
4.1.11.33. PluginSkype.......................................................................................................198
4.1.11.34. Plugin Sort........................................................................................................ 199
4.1.11.35. PluginSplit.........................................................................................................200
4.1.11.36. Plugin SQL........................................................................................................203
4.1.11.37. Plugin Tag.........................................................................................................207
4.1.11.38. PluginThumb.....................................................................................................207
4.1.11.39. PluginTracker................................................................................................... 209
4.1.11.40. PluginTrackerFilter.......................................................................................... 210
4.1.11.41. PluginTrackerItemField....................................................................................213
4.1.11.42. PluginTrackerList............................................................................................. 214
4.1.11.43. PluginTrackerStat............................................................................................. 215
4.1.11.44. PluginTranslated...............................................................................................216
4.1.11.45. PluginVersions.................................................................................................. 216
4.1.11.46. PluginVote.........................................................................................................218
4.1.11.47. PluginWMV.......................................................................................................220
4.1.11.48. PluginYouTube..................................................................................................221
4.1.12. Wysiwyg Editor.......................................................................................................... 222
4.1.12.1. Wysiwyg Editor User.......................................................................................... 222
4.1.12.2. Wysiwyg Editor Details.......................................................................................228
4.2. Image Gallery...................................................................................................................... 230
4.2.1. Image Gallery User....................................................................................................... 230
4.2.1.1. The Menu.............................................................................................................. 230
4.2.1.2. Prior to Gallery Creation..................................................................................... 231
4.2.1.3. Creating a Gallery of Images................................................................................231
4.2.1.4. Upload Image........................................................................................................234
4.2.1.5. Browse or List Galleries....................................................................................... 235
4.2.1.6. Individual permissions for image galleries...........................................................237
4.2.1.7. The System Gallery............................................................................................... 238
4.2.1.8. Tips & Tricks.........................................................................................................238
4.2.1.9. Known bugs and problems....................................................................................238

Back to TOC 7
 4.2.2. Image Gallery Config....................................................................................................239
4.2.2.1. Admin Access........................................................................................................ 239
4.2.2.2. Image Galleries.....................................................................................................239
4.2.2.3. Home Gallery (main gallery)................................................................................240
4.2.2.4. Galleries features..................................................................................................240
4.2.2.5. Uploaded images names cannot match regex.......................................................242
4.2.2.6. Remove images in the system gallery....................................................................243
4.2.2.7. Gallery listing configuration.................................................................................243
4.2.2.8. Image galleries comments settings....................................................................... 243
4.2.3. Image Gallery Details................................................................................................... 244
4.2.3.1. Permissions........................................................................................................... 244
4.2.3.2. Preferences............................................................................................................244
4.2.3.3. Files used.............................................................................................................. 245
4.2.3.4. Database............................................................................................................... 245
4.3. Articles................................................................................................................................. 246
4.3.1. Article User................................................................................................................... 247
4.3.1.1. The Articles menu..................................................................................................247
4.3.1.2. Editing or Submitting Articles...............................................................................247
4.3.1.3. Articles Home........................................................................................................249
4.3.1.4. List Articles........................................................................................................... 250
4.3.1.5. Rankings................................................................................................................251
4.3.1.6. Submit Article........................................................................................................252
4.3.1.7. View Submissions..................................................................................................252
4.3.2. Articles Config.............................................................................................................. 252
4.3.2.1. Admin Access........................................................................................................ 252
4.3.2.2. Sections: Tiki Admin Panel................................................................................... 252
4.3.2.3. Article/CMS settings............................................................................................. 253
4.3.3. Article Details............................................................................................................... 254
4.4. Blog.......................................................................................................................................255
4.4.1. Blog User...................................................................................................................... 256
4.4.1.1. Viewing a List of Available Blog...........................................................................257
4.4.1.2. Listing Blog by Rank............................................................................................. 258
4.4.1.3. Reading a Blog......................................................................................................258
4.4.1.4. Printing a Blog Entry............................................................................................260
4.4.1.5. Mailing a Blog Entry's URL..................................................................................260
4.4.1.6. Commenting on a Blog Entry................................................................................260
4.4.1.7. Creating a Blog.....................................................................................................261
4.4.1.8. Posting an Entry to Your Blog.............................................................................. 263
4.4.2. Blog Config...................................................................................................................265
4.4.2.1. Sections: Tiki Admin Panel................................................................................... 265
4.4.2.2. Blog settings..........................................................................................................266
4.4.3. Blogs Details................................................................................................................. 268
4.4.3.1. Modules.................................................................................................................268
4.4.3.2. Permissions........................................................................................................... 268
4.4.3.3. Preferences............................................................................................................269
4.4.3.4. Files used.............................................................................................................. 269
4.4.3.5. Database............................................................................................................... 271
4.5. File Galleries........................................................................................................................272

8 Back to TOC
 Tikiwiki Documentation 1.9+

4.5.1. File Gallery User........................................................................................................... 272

4.5.1.1. Listing file galleries.............................................................................................. 272
4.5.1.2. Creating file galleries........................................................................................... 273
4.5.1.3. Uploading files......................................................................................................274
4.5.1.4. Batch uploads........................................................................................................275
4.5.1.5. Listing file galleries and downloading files..........................................................275
4.5.1.6. Permissions........................................................................................................... 276
4.5.2. File Galleries Config..................................................................................................... 276
4.5.2.1. File galleries......................................................................................................... 277
4.5.3. File Gallery Details....................................................................................................... 280
4.6. Forums................................................................................................................................. 281
4.6.1. Forums User.................................................................................................................. 281
4.6.1.1. Creating/editing forums........................................................................................ 282
4.6.1.2. Using the forum.....................................................................................................284
4.6.1.3. Setting Global forum permissions.........................................................................287
4.6.1.4. Setting Individual permissions for a forum...........................................................288
4.6.1.5. Forum Rankings....................................................................................................288
4.6.2. Forums Admin.............................................................................................................. 289
4.6.2.1. Admin Access #1................................................................................................... 289
4.6.2.2. Admin Access #2................................................................................................... 290
4.6.2.3. Perms on forum posts and topics.......................................................................... 290
4.6.3. Forums Details.............................................................................................................. 290
4.6.3.1. Forum and List Synchronization...........................................................................291
4.7. Directory.............................................................................................................................. 294
4.7.1. Directory User...............................................................................................................295
4.7.1.1. Accessing the Directory........................................................................................ 295
4.7.1.2. Browsing the Directory.........................................................................................295
4.7.1.3. New Sites - Cool Sites........................................................................................... 298
4.7.1.4. Adding a site......................................................................................................... 298
4.7.1.5. Directory-Related Modules...................................................................................299
4.7.1.6. Calendar Reporting of New Sites..........................................................................300
4.7.2. Directory Admin........................................................................................................... 300
4.7.2.1. Activating the Directory feature........................................................................... 300
4.7.2.2. Directory Configuration....................................................................................... 301
4.7.2.3. Directory Administration...................................................................................... 302
4.7.2.4. Category management.......................................................................................... 303
4.7.2.5. Related categories.................................................................................................305
4.7.2.6. Admin sites............................................................................................................ 306
4.7.2.7. Site Validation.......................................................................................................307
4.7.3. Directory Details........................................................................................................... 308
4.7.3.1. Modules.................................................................................................................308
4.7.3.2. Permissions........................................................................................................... 308
4.7.3.3. Preferences............................................................................................................308
4.7.3.4. Database Tables....................................................................................................309
4.7.3.5. Files Used............................................................................................................. 309
4.7.3.6. CSS Selectors........................................................................................................ 311
4.7.3.7. Others....................................................................................................................313
4.8. FAQs.................................................................................................................................... 314

Back to TOC 9
 4.8.1. FAQs User.....................................................................................................................314
4.8.1.1. Creating new FAQ sections.................................................................................. 315
4.8.2. FAQs Admin................................................................................................................. 315
4.8.2.1. FAQs settings........................................................................................................ 316
4.8.3. FAQ Details.................................................................................................................. 317
4.9. Quizzes................................................................................................................................. 318
4.9.1. Quizzes User................................................................................................................. 318
4.9.2. Quizzes Admin..............................................................................................................320
4.9.2.1. Create/edit quizzes................................................................................................ 320
4.9.2.2. Viewing Results..................................................................................................... 322
4.9.2.3. Editing Quizzes..................................................................................................... 322
4.9.3. Quiz Details...................................................................................................................323
4.10. Trackers............................................................................................................................. 324
4.10.1. Trackers User.............................................................................................................. 325
4.10.1.1. Creating a New Tracker......................................................................................326
4.10.1.2. Adding Fields to a Tracker................................................................................. 327
4.10.1.3. Using Trackers....................................................................................................328
4.10.1.4. Adding a Tracker Item........................................................................................ 329
4.10.1.5. Item Details......................................................................................................... 329
4.10.1.6. Assigning Items to Specific Tiki Users or Groups.............................................. 330
4.10.1.7. Monitoring Tracker Items................................................................................... 332
4.10.1.8. Setting Tracker Permissions............................................................................... 332
4.10.1.9. Editing Tracker Fields........................................................................................ 333
4.10.1.10. Entering Tracker Items..................................................................................... 333
4.10.1.11. Other information............................................................................................. 334
4.10.2. Trackers Admin...........................................................................................................338
4.10.2.1. Configure Trackers............................................................................................. 339
4.10.2.2. Trackers with Mirror Tables...............................................................................341
4.10.3. Trackers Details.......................................................................................................... 344
4.10.3.1. Field types Overview...........................................................................................344
4.10.3.2. Field types options.............................................................................................. 344
4.10.4. Creating a Tracker.......................................................................................................344
4.10.5. Adding fields to a tracker............................................................................................347
4.10.5.1. Explanation of Fields.......................................................................................... 350
4.10.6. Tracker Field Type......................................................................................................353
4.10.6.1. User / Group / IP Selector Tracker Field........................................................... 353
4.10.6.2. Image Tracker Field............................................................................................354
4.10.6.3. Drop Down Tracker Field...................................................................................354
4.10.6.4. Items List and Item Link Tracker Fields............................................................. 355
4.10.6.5. Category Tracker Field.......................................................................................355
4.10.6.6. Subscription Tracker Field................................................................................. 356
4.10.6.7. Dynamic items list...............................................................................................356
4.10.7. Add items to the tracker.............................................................................................. 358
4.10.7.1. Massive addition of items to a tracker................................................................ 360
4.10.8. Searching tracker items............................................................................................... 361
4.10.8.1. (1). Default and simple search............................................................................361
4.10.8.2. (2). Customized and more advanced search....................................................... 362
4.10.9. User tracker................................................................................................................. 362

10 Back to TOC
 Tikiwiki Documentation 1.9+

4.11. Spreadsheet........................................................................................................................364
4.11.1. Basic Functionality..................................................................................................... 364
4.11.1.1. Create a New Spreadsheet.................................................................................. 364
4.11.1.2. View Revision History.........................................................................................365
4.11.2. Edit Interface...............................................................................................................365
4.11.2.1. Modify the Spreadsheet Structure....................................................................... 366
4.11.2.2. Calculations and Formulas.................................................................................368
4.11.3. Graphics and Charts.................................................................................................... 371
4.11.3.1. Select the Graphic Type and Output Format...................................................... 371
4.11.3.2. Parameters.......................................................................................................... 372
4.12. Surveys............................................................................................................................... 377
4.12.1. Surveys User............................................................................................................... 377
4.12.1.1. Listing surveys.....................................................................................................377
4.12.1.2. Taking a survey................................................................................................... 378
4.12.1.3. Survey stats......................................................................................................... 379
4.12.2. Survey Admin............................................................................................................. 379
4.12.2.1. Create a Survey...................................................................................................380
4.12.2.2. Survey questions..................................................................................................381
4.12.3. Survey Details............................................................................................................. 383
4.13. Newsletters.........................................................................................................................384
4.13.1. Newsletters User......................................................................................................... 384
4.13.1.1. Listing newsletters...............................................................................................384
4.13.1.2. Subscribing and unsubscribing...........................................................................384
4.13.2. Newsletters Admin......................................................................................................384
4.13.2.1. Enabling the Newsletter Feature........................................................................ 385
4.13.2.2. Creating newsletters........................................................................................... 385
4.13.2.3. Changing Existing Newsletters........................................................................... 386
4.13.3. Newsletter Details....................................................................................................... 386
4.14. Ephemerides...................................................................................................................... 388
4.14.1. Ephemerides User....................................................................................................... 388
4.14.2. Ephemerides Admin....................................................................................................388
4.14.3. Ephemerides Details................................................................................................... 388
4.15. Charts.................................................................................................................................390
4.15.1. Charts User..................................................................................................................390
4.15.2. Charts Admin.............................................................................................................. 390
4.15.2.1. Add or edit a chart.............................................................................................. 390
4.15.3. Charts Details.............................................................................................................. 390
4.16. Stats.................................................................................................................................... 391
4.16.1. Stats User.................................................................................................................... 391
4.16.2. Stats Admin.................................................................................................................394
4.16.2.1. Site stats.............................................................................................................. 394
4.16.2.2. Referer stats........................................................................................................ 394
4.16.2.3. Search stats......................................................................................................... 395
4.16.3. Stats Details.................................................................................................................395
4.17. Games.................................................................................................................................396
4.17.1. Games User................................................................................................................. 396
4.17.2. Games Admin............................................................................................................. 397
4.17.2.1. Activating the Games feature..............................................................................397

Back to TOC 11
 4.17.2.2. Games configuration...........................................................................................398
4.17.2.3. Management of games........................................................................................ 399
4.17.3. Games Details............................................................................................................. 400
4.18. Calendar............................................................................................................................ 401
4.18.1. Calendar User..............................................................................................................402
4.18.1.1. Navigating the Calendar.....................................................................................402
4.18.1.2. Special Features..................................................................................................403
4.18.2. Calendar Admin.......................................................................................................... 407
4.18.2.1. Calendar settings................................................................................................ 407
4.18.2.2. Create or edit calendars..................................................................................... 408
4.18.2.3. Assigning permissions.........................................................................................409
4.18.2.4. Personal calendar............................................................................................... 409
4.18.2.5. Urls..................................................................................................................... 410
4.18.3. Calendar Details.......................................................................................................... 410
4.18.4. Js Calendar.................................................................................................................. 410
4.19. Workflow........................................................................................................................... 411
4.19.1. Workflow User............................................................................................................411
4.19.1.1. The Process Manager......................................................................................... 412
4.19.1.2. Editing process activities.................................................................................... 415
4.19.1.3. The process toolbar.............................................................................................417
4.19.1.4. The add/edit activity form................................................................................... 418
4.19.1.5. The activity listing...............................................................................................419
4.19.1.6. The transition listing and form........................................................................... 419
4.19.1.7. Understanding activities..................................................................................... 420
4.19.1.8. Editing and mapping process roles.....................................................................421
4.19.1.9. Editing process activity source code and templates........................................... 424
4.19.1.10. Roles..................................................................................................................426
4.19.1.11. Setting the instance user for the next activity................................................... 427
4.19.1.12. The User Interface............................................................................................ 427
4.19.1.13. The Process Monitor.........................................................................................429
4.19.1.14. Summary........................................................................................................... 433
4.19.1.15. Acknowledgements............................................................................................ 433
4.19.2. Workflow Admin........................................................................................................ 433
4.19.3. Workflow Details........................................................................................................ 433
4.20. Integrator...........................................................................................................................434
4.20.1. Integrator User............................................................................................................ 434
4.20.1.1. How to use Integrator......................................................................................... 434
4.20.2. Integrator Admin.........................................................................................................436
4.20.3. Integrator Details.........................................................................................................436
4.21. Categories.......................................................................................................................... 438
4.21.1. Categories User........................................................................................................... 439
4.21.2. Categories Admin....................................................................................................... 442
4.21.2.1. Creating categories and sub-categories............................................................. 443
4.21.2.2. Assigning permissions to categories................................................................... 444
4.21.2.3. Adding content to categories...............................................................................446
4.21.2.4. Applying themes to categories............................................................................ 447
4.21.3. Categories Details....................................................................................................... 448
4.22. Banners.............................................................................................................................. 450

12 Back to TOC
 Tikiwiki Documentation 1.9+

4.22.1. Banners User............................................................................................................... 450

4.22.2. Banners Admin........................................................................................................... 450
4.22.2.1. Banner Zones...................................................................................................... 450
4.22.2.2. Creating a banner zone.......................................................................................450
4.22.2.3. Banner Types.......................................................................................................451
4.22.2.4. Creating Banner..................................................................................................451
4.22.2.5. Displaying Banner.............................................................................................. 453
4.22.2.6. Viewing banner stats...........................................................................................454
4.22.2.7. Future..................................................................................................................455
4.22.3. Banners Details........................................................................................................... 455
4.23. Modules..............................................................................................................................456
4.23.1. Modules User.............................................................................................................. 460
4.23.2. Modules Admin...........................................................................................................460
4.23.2.1. User modules.......................................................................................................461
4.23.2.2. Assign module..................................................................................................... 462
4.23.2.3. Module Parameters.............................................................................................462
4.23.2.4. Advanced editing.................................................................................................463
4.23.2.5. Assigned modules................................................................................................464
4.23.2.6. Edit the assignment of a module......................................................................... 464
4.23.3. User Modules.............................................................................................................. 465
4.23.3.1. Edit/Create user module..................................................................................... 466
4.23.3.2. Module Controls................................................................................................. 470
4.23.4. Module details.............................................................................................................470
4.23.4.1. Module articles................................................................................................... 470
4.23.4.2. Module assistant................................................................................................. 470
4.23.4.3. Module breadcrumb............................................................................................470
4.23.4.4. Module calendar................................................................................................. 470
4.23.4.5. Module categories...............................................................................................471
4.23.4.6. Module change_category....................................................................................471
4.23.4.7. Module comm_received_objects......................................................................... 471
4.23.4.8. Module directory_last_sites................................................................................471
4.23.4.9. Module directory_stats....................................................................................... 471
4.23.4.10. Module directory_top_sites...............................................................................471
4.23.4.11. Module eph........................................................................................................472
4.23.4.12. Module events................................................................................................... 472
4.23.4.13. Module featured_links.......................................................................................472
4.23.4.14. Module forums_best_voted_topics....................................................................472
4.23.4.15. Module forums_last_posts................................................................................ 472
4.23.4.16. Module forums_last_topics............................................................................... 473
4.23.4.17. Module forums_most_commented_forums....................................................... 473
4.23.4.18. Module forums_most_read_topics....................................................................473
4.23.4.19. Module forums_most_visited_forums............................................................... 473
4.23.4.20. Module google...................................................................................................473
4.23.4.21. Module last_actions.......................................................................................... 473
4.23.4.22. Module last_articles..........................................................................................473
4.23.4.23. Module last_blog_posts.................................................................................... 473
4.23.4.24. Module last_category_objects.......................................................................... 473
4.23.4.25. Module last_created_blogs............................................................................... 474

Back to TOC 13
 4.23.4.26. Module last_created_faqs................................................................................. 474
4.23.4.27. Module last_created_quizzes............................................................................ 474
4.23.4.28. Module last_fileslast_files.................................................................................474
4.23.4.29. Module last_file_galleries.................................................................................474
4.23.4.30. Module last_images.......................................................................................... 475
4.23.4.31. Module last_images_th..................................................................................... 475
4.23.4.32. Module last_image_galleries............................................................................475
4.23.4.33. Module last_modified_blogs............................................................................. 475
4.23.4.34. Module last_modif_events.................................................................................475
4.23.4.35. Module last_modif_pages................................................................................. 475
4.23.4.36. Module last_modif_tracker_items.....................................................................475
4.23.4.37. Module last_submissions.................................................................................. 475
4.23.4.38. Module last_tracker_comments........................................................................ 475
4.23.4.39. Module last_tracker_items................................................................................475
4.23.4.40. Module last_visitors..........................................................................................476
4.23.4.41. Module live_support......................................................................................... 476
4.23.4.42. Module logged_users........................................................................................ 476
4.23.4.43. Module login_box............................................................................................. 476
4.23.4.44. Module menupage............................................................................................. 476
4.23.4.45. Module messages_unread_messages................................................................476
4.23.4.46. Module num_submissions................................................................................. 476
4.23.4.47. Module old_articles.......................................................................................... 476
4.23.4.48. Module online_users......................................................................................... 476
4.23.4.49. Module quick_edit.............................................................................................477
4.23.4.50. Module random_images....................................................................................477
4.23.4.51. Module random_pages......................................................................................477
4.23.4.52. Module since_last_visit.....................................................................................478
4.23.4.53. Module since_last_visit_new............................................................................ 478
4.23.4.54. Module search_box........................................................................................... 479
4.23.4.55. Module search_new.......................................................................................... 479
4.23.4.56. Module search_wiki_page................................................................................ 479
4.23.4.57. Module shoutbox............................................................................................... 479
4.23.4.58. Module since_last_visit.....................................................................................479
4.23.4.59. Module switch_lang.......................................................................................... 479
4.23.4.60. Module switch_lang2........................................................................................ 479
4.23.4.61. Module switch_theme........................................................................................480
4.23.4.62. Module tail........................................................................................................ 480
4.23.4.63. Module top_active_blogs.................................................................................. 480
4.23.4.64. Module top_articles.......................................................................................... 480
4.23.4.65. Module top_files................................................................................................480
4.23.4.66. Module top_file_galleries................................................................................. 480
4.23.4.67. Module top_forum_posters............................................................................... 480
4.23.4.68. Module top_games............................................................................................ 480
4.23.4.69. Module top_images........................................................................................... 480
4.23.4.70. Module top_images_th......................................................................................480
4.23.4.71. Module top_image_galleries.............................................................................481
4.23.4.72. Module top_objects........................................................................................... 481
4.23.4.73. Module top_pages............................................................................................. 481

14 Back to TOC
 Tikiwiki Documentation 1.9+

4.23.4.74. Module top_quizzes...........................................................................................481

4.23.4.75. Module top_visited_blogs................................................................................. 481
4.23.4.76. Module top_visited_faqs................................................................................... 481
4.23.4.77. Module upcoming_events..................................................................................482
4.23.4.78. Module user_blogs............................................................................................482
4.23.4.79. Module user_bookmarks................................................................................... 482
4.23.4.80. Module user_image_galleries...........................................................................482
4.23.4.81. Module user_pages........................................................................................... 482
4.23.4.82. Module user_tasks.............................................................................................482
4.23.4.83. Module whats_relatedwhats_related................................................................ 482
4.23.4.84. Module who_is_there........................................................................................482
4.23.4.85. Module wiki_last_comments............................................................................. 483
4.24. Chat.................................................................................................................................... 483
4.24.1. Chat User.....................................................................................................................485
4.24.2. Chat Admin................................................................................................................. 485
4.24.2.1. Chat Channel Settings:....................................................................................... 486
4.24.2.2. Accessing Chat Admin........................................................................................ 486
4.24.2.3. Adding a chatroom..............................................................................................486
4.24.2.4. Deleting a chatroom............................................................................................486
4.24.2.5. Editing a chatroom............................................................................................. 486
4.24.3. Chat Details.................................................................................................................487
4.25. Live Support......................................................................................................................488
4.25.1. Live Support User....................................................................................................... 488
4.25.2. Live Support Admin....................................................................................................491
4.25.2.1. Live Support settings...........................................................................................491
4.25.2.2. Operator usage (1 user to 1 operator)................................................................492
4.25.2.3. Two operators on the same support request....................................................... 494
4.25.3. Live Support Details................................................................................................... 496
4.26. Map.................................................................................................................................... 498
4.26.1. Maps User................................................................................................................... 500
4.26.1.1. The Interface....................................................................................................... 500
4.26.1.2. Working with Maps............................................................................................. 501
4.26.2. Maps Editor.................................................................................................................501
4.26.2.1. Maps Layer Management....................................................................................501
4.26.2.2. Maps Mapfiles Manager..................................................................................... 501
4.26.2.3. Maps Details....................................................................................................... 502
4.26.2.4. Maps Mapfile Tutorial........................................................................................ 502
4.26.3. Maps Admin................................................................................................................515
4.26.3.1. Maps Install........................................................................................................ 515
4.26.4. Maps Config................................................................................................................518
4.27. Google Map feature (Gmap)............................................................................................ 519
4.27.1. Google Maps User...................................................................................................... 520
4.27.1.1. Set up your coordinates.......................................................................................520
4.27.2. Google Maps Admin................................................................................................... 522
4.27.3. Google Map Details.................................................................................................... 523
4.27.3.1. Geolocation of Tracker items..............................................................................523
4.27.3.2. Panoramio...........................................................................................................524
4.28. Tikibot................................................................................................................................527

Back to TOC 15
 4.28.1. Tikibot User................................................................................................................ 527
4.28.2. Tikibot Admin.............................................................................................................527
4.28.3. Tikibot Details.............................................................................................................527
4.29. Mobile Tiki........................................................................................................................ 528
4.29.1. Mobile Tiki User......................................................................................................... 529
4.29.2. Mobile Tiki Admin..................................................................................................... 530
4.29.3. Mobile Tiki Details..................................................................................................... 531
4.30. Structures.......................................................................................................................... 532
4.30.1. Structures user.............................................................................................................533
4.30.1.1. Navigating Structures......................................................................................... 533
4.30.1.2. Slide Show........................................................................................................... 534
4.30.1.3. PDF Creation......................................................................................................534
4.30.1.4. Table of contents tag ({toc})............................................................................... 534
4.30.2. Structures Admin........................................................................................................ 536
4.30.2.1. Managing Structures...........................................................................................536
4.30.3. Structure Details..........................................................................................................542
4.31. Slideshows..........................................................................................................................545
4.31.1. Slideshow User........................................................................................................... 545
4.31.1.1. Starting a Slideshow........................................................................................... 545
4.31.1.2. Example:............................................................................................................. 545
4.31.2. Slideshow Admin........................................................................................................ 546
4.31.2.1. Enabling Slideshows........................................................................................... 546
4.31.2.2. Changing Slideshow Appearance....................................................................... 547
4.31.3. Slideshow Details........................................................................................................547
4.32. Comments.......................................................................................................................... 549
4.32.1. Comments User...........................................................................................................549
4.32.1.1. Posting a Comment............................................................................................. 549
4.32.1.2. Controlling the display of comments.................................................................. 549
4.32.1.3. Viewing Recent Comments..................................................................................550
4.32.2. Comments Admin....................................................................................................... 551
4.32.2.1. Voting.................................................................................................................. 551
4.32.2.2. Comment perms...................................................................................................551
4.32.3. Comments Details....................................................................................................... 551
4.33. Contribution...................................................................................................................... 552
4.33.1. Contribution feature oveerview.................................................................................. 552
4.33.1.1. Admin setting...................................................................................................... 552
4.33.1.2. Examples............................................................................................................. 553
4.33.1.3. Report contributions through action log.............................................................557
4.33.1.4. Contributor feature............................................................................................. 558
4.34. Copyright...........................................................................................................................560
4.34.1. Copyright Management User...................................................................................... 560
4.34.1.1. Editing Copyright Notices...................................................................................561
4.34.2. Copyright Management Admin.................................................................................. 561
4.34.3. Copyright Details........................................................................................................ 561
4.35. Communication Center.................................................................................................... 562
4.36. Spellchecking.....................................................................................................................566
4.36.1. Spellchecking User..................................................................................................... 566
4.36.2. Spellchecking Admin.................................................................................................. 567

16 Back to TOC
 Tikiwiki Documentation 1.9+

4.36.2.1. Articles................................................................................................................ 567

4.36.2.2. Wiki..................................................................................................................... 567
4.36.3. Spellchecking Details..................................................................................................568
4.37. Redirect On Error............................................................................................................ 569
4.37.1. Redirect On Error User............................................................................................... 569
4.37.2. Redirect On Error Admin............................................................................................569
4.37.3. Redirect On Error Details........................................................................................... 569
4.38. Drawings............................................................................................................................ 570
4.38.1. Drawings User.............................................................................................................570
4.38.2. Drawings Admin......................................................................................................... 573
4.38.3. Drawings Details.........................................................................................................573
4.39. HTML Pages..................................................................................................................... 574
4.39.1.1. Editing a page..................................................................................................... 574
4.39.1.2. Applying templates for HTML pages.................................................................. 575
4.39.1.3. Editing dynamic zones for a page....................................................................... 575
4.39.1.4. How dynamic pages work................................................................................... 576
4.39.2. HTML Pages User...................................................................................................... 576
4.39.3. HTML Pages Admin................................................................................................... 576
4.39.4. HTML Pages Details...................................................................................................576
4.40. Dynamic Content System................................................................................................. 577
4.40.1. Dynamic Content User................................................................................................577
4.40.2. Dynamic Content Admin............................................................................................ 577
4.40.2.1. Creating and editing blocks................................................................................ 578
4.40.2.2. Creating and editing content for a block............................................................ 578
4.40.2.3. Displaying DCS blocks....................................................................................... 578
4.40.2.4. Programming content......................................................................................... 579
4.40.3. Dynamic Content Details............................................................................................ 579
4.41. Dynamic Variable............................................................................................................. 580
4.42. Freetags..............................................................................................................................581
4.42.1. Freetags User...............................................................................................................581
4.42.2. Freetags Admin........................................................................................................... 581
4.43. Poll......................................................................................................................................582
4.43.1. Using Polls.................................................................................................................. 582
4.43.1.1. Polls as a Plugin................................................................................................. 582
4.43.1.2. Polls as a Side Module........................................................................................582
4.43.1.3. Where to find it:.................................................................................................. 582
4.43.1.4. Creating/Adding an instance.............................................................................. 582
4.43.2. Polls User.................................................................................................................... 583
4.43.3. Polls Admin.................................................................................................................583
4.43.3.1. Configure Polls................................................................................................... 583
4.43.3.2. Creating/editing polls......................................................................................... 584
4.43.3.3. Using polls.......................................................................................................... 585
4.43.4. Polls Details................................................................................................................ 585
4.44. RSS Feeds.......................................................................................................................... 586
4.44.1. RSS Feeds User:..........................................................................................................587
4.44.1.1. Create RSS Modules............................................................................................587
4.44.1.2. Incorporate RSS Channels Into Your Tiki...........................................................589
4.44.2. RSS Admin................................................................................................................. 591

Back to TOC 17
 4.44.2.1. Configure RSS Feeds.......................................................................................... 591
4.44.3. RSS Feeds Details....................................................................................................... 593
4.45. Score................................................................................................................................... 595
4.45.1. Score Admin............................................................................................................... 595
4.45.2. Score Details............................................................................................................... 596
4.45.2.1. Creating new event..............................................................................................597
4.45.2.2. Future expansion and ideas................................................................................ 597
4.45.3. Karma..........................................................................................................................598
4.45.4. Score vs. Karma.......................................................................................................... 599
4.46. Shoutbox............................................................................................................................ 600
4.46.1.1. Adding a Shoutbox.............................................................................................. 600
4.46.1.2. Configuring the Shoutbox................................................................................... 601
4.46.1.3. Adding Banned Words........................................................................................ 602
4.46.2. Shoutbox User.............................................................................................................603
4.46.3. Shoutbox Admin......................................................................................................... 603
4.46.4. Shoutbox Details......................................................................................................... 603
4.47. Search.................................................................................................................................604
4.47.1. Search User................................................................................................................. 605
4.47.1.1. Database search engine...................................................................................... 605
4.47.1.2. Tikiwiki search engine........................................................................................ 605
4.47.2. Search Admin..............................................................................................................606
4.47.2.1. Search settings.................................................................................................... 606
4.47.3. Search Details............................................................................................................. 608
4.47.3.1. Search modes...................................................................................................... 608
4.47.3.2. Full text search....................................................................................................609
4.47.3.3. Search Stats.........................................................................................................610
4.48. MyTiki................................................................................................................................611
4.48.1. MyTiki Admin............................................................................................................ 611
4.48.2. MyTiki Details............................................................................................................ 611
4.48.2.1. MyTiki bar...........................................................................................................614
4.48.2.2. MyTiki screen......................................................................................................614
4.48.3. Webmail...................................................................................................................... 615
4.48.3.1. Configuring webmail accounts........................................................................... 615
4.48.3.2. Reading emails....................................................................................................615
4.48.3.3. Writing emails..................................................................................................... 616
4.48.4. Inter-User Messages....................................................................................................616
4.48.4.1. Mailbox............................................................................................................... 617
4.48.4.2. Composing messages.......................................................................................... 618
4.48.4.3. Broadcasting....................................................................................................... 619
4.48.4.4. How to enable this feature as admin...................................................................619
4.48.5. User Notepad...............................................................................................................621
4.48.5.1. Listing notes........................................................................................................ 621
4.48.5.2. Writing a note..................................................................................................... 621
4.48.5.3. Reading a note.................................................................................................... 622
4.48.6. User Tasks...................................................................................................................623
4.48.6.1. The list of tasks:.................................................................................................. 623
4.48.6.2. Tasks and dates:..................................................................................................624
4.48.6.3. Editing a task:..................................................................................................... 624

18 Back to TOC
 Tikiwiki Documentation 1.9+

4.48.6.4. View tasks............................................................................................................626

4.48.6.5. The user tasks module......................................................................................... 626
4.48.7. User Files.................................................................................................................... 627
4.48.7.1. Configuring userfiles...........................................................................................628
4.48.8. User Calendar..............................................................................................................628
4.48.8.1. Adding events...................................................................................................... 628
4.48.8.2. Calendar preferences..........................................................................................629
4.48.8.3. Daily view........................................................................................................... 630
4.48.8.4. Weekly view.........................................................................................................630
4.48.8.5. Event list..............................................................................................................631
4.48.8.6. Exporting.............................................................................................................631
4.48.8.7. Importing.............................................................................................................631
4.48.9. User Menus................................................................................................................. 632
4.48.10. User Preferences....................................................................................................... 633
4.48.10.1. Key Function and sub-features......................................................................... 633
4.48.10.2. Personal Information........................................................................................ 633
4.48.10.3. General Preferences......................................................................................... 634
4.48.10.4. Other Preferences............................................................................................. 636
4.48.11. User Bookmarks........................................................................................................637
4.48.11.1. The user bookmarks module............................................................................. 638
4.48.12. User (assigned) modules........................................................................................... 639
4.48.13. User Watches............................................................................................................ 640
4.48.13.1. Which sections can be watched?.......................................................................641
4.48.14. Newsreader................................................................................................................641
4.48.14.1. Selecting a server.............................................................................................. 641
4.48.14.2. Selecting a group.............................................................................................. 642
4.48.14.3. Reading news.................................................................................................... 642
4.48.15. User Action log......................................................................................................... 642
4.49. Tell a Friend...................................................................................................................... 645
4.50. Internationalization (i18n)............................................................................................... 646
4.50.1. Internationalization Admin......................................................................................... 646
4.50.1.1. How to build a monolingual site?....................................................................... 646
4.50.1.2. How to build a multilingual site?........................................................................647
4.50.1.3. To configure a multilingual site:.........................................................................647
4.50.1.4. To have a multilingual content:.......................................................................... 648
4.50.1.5. Modules displayed only for some language........................................................648
4.50.1.6. Multilingual user menu....................................................................................... 649
4.50.1.7. Goodies............................................................................................................... 649
4.50.1.8. Calendar first day............................................................................................... 649
4.51. Admin Panels.....................................................................................................................650
4.51.1. Features Admin........................................................................................................... 650
4.51.1.1. Settings Documentation...................................................................................... 650
4.51.1.2. Tiki sections and features....................................................................................651
4.51.1.3. Content Features.................................................................................................652
4.51.1.4. Administration Features..................................................................................... 653
4.51.1.5. User Features......................................................................................................653
4.51.1.6. General Layout options.......................................................................................654
4.51.1.7. Layout-per-section Options.................................................................................655

Back to TOC 19
 4.51.2. General Admin............................................................................................................ 655
4.51.2.1. General Preferences........................................................................................... 656
4.51.2.2. General Settings..................................................................................................656
4.51.2.3. Date and Time Formats...................................................................................... 658
4.51.2.4. Other Settings......................................................................................................659
4.51.2.5. Register This Site................................................................................................ 659
4.51.2.6. Change Admin Password.................................................................................... 659
4.51.3. Login Config............................................................................................................... 660
4.51.3.1. Login Settings......................................................................................................660
4.51.3.2. Login Authentication Methods............................................................................ 672
4.51.3.3. Just Tiki............................................................................................................... 672
4.51.3.4. Web Server.......................................................................................................... 672
4.51.3.5. Tiki and Pear::Auth............................................................................................ 673
4.51.3.6. Tiki and Pam....................................................................................................... 676
4.51.3.7. CAS..................................................................................................................... 676
4.51.3.8. Shibboleth........................................................................................................... 676
4.51.4. Users Management......................................................................................................679
4.51.4.1. Adding a new user...............................................................................................679
4.51.4.2. Adding new users in bulk.................................................................................... 680
4.51.4.3. Adding a user to a group.................................................................................... 681
4.51.4.4. Finding a user..................................................................................................... 681
4.51.4.5. Deleting a user.................................................................................................... 681
4.51.4.6. Modifying existing user information................................................................... 681
4.51.5. Groups management................................................................................................... 681
4.51.5.1. Creating Groups................................................................................................. 681
4.51.5.2. Assigning users to groups................................................................................... 682
4.51.5.3. Assigning permissions to groups........................................................................ 683
4.51.5.4. Changing or Removing Groups.......................................................................... 683
4.51.5.5. Changing Group Settings....................................................................................684
4.51.5.6. Assigning a tracker to a Group...........................................................................685
4.51.6. Permissions................................................................................................................. 686
4.51.6.1. General permissions........................................................................................... 687
4.51.6.2. Wiki permissions................................................................................................. 687
4.51.6.3. File galleries permissions................................................................................... 688
4.51.6.4. Comment permissions......................................................................................... 688
4.51.6.5. Blog permissions................................................................................................. 688
4.51.6.6. Image gallery permissions.................................................................................. 688
4.51.6.7. Forums permissions............................................................................................ 688
4.51.6.8. Communications permissions............................................................................. 689
4.51.6.9. Games permissions............................................................................................. 689
4.51.6.10. Quiz permissions............................................................................................... 689
4.51.6.11. Articles & Submissions permissions................................................................. 689
4.51.6.12. FAQ permissions...............................................................................................690
4.51.6.13. User permissions...............................................................................................690
4.51.6.14. Chat permissions...............................................................................................690
4.51.6.15. Content template permissions........................................................................... 690
4.51.6.16. Shout box permissions.......................................................................................690
4.51.6.17. Drawing permissions........................................................................................ 690

20 Back to TOC
 Tikiwiki Documentation 1.9+

4.51.6.18. HTML page permissions................................................................................... 691

4.51.6.19. Tracker permissions..........................................................................................691
4.51.6.20. Survey permissions............................................................................................691
4.51.6.21. Webmail permissions........................................................................................ 691
4.51.6.22. Newsletter permissions..................................................................................... 691
4.51.6.23. User message permissions................................................................................ 691
4.51.6.24. DSNs................................................................................................................. 692
4.51.6.25. Directory permissions....................................................................................... 692
4.51.6.26. Galaxia Workflow............................................................................................. 692
4.51.6.27. Charts................................................................................................................692
4.51.6.28. ExtWikis............................................................................................................ 692
4.51.6.29. Live Support...................................................................................................... 692
4.51.6.30. Calendar........................................................................................................... 693
4.51.6.31. Permissions for individual users.......................................................................693
4.51.6.32. Individual permissions...................................................................................... 693
4.51.6.33. Permissions Settings......................................................................................... 693
4.51.7. Admin DSN.................................................................................................................700
4.51.8. Backup........................................................................................................................ 700
4.51.8.1. Import database.................................................................................................. 707
4.51.9. Banning....................................................................................................................... 710
4.51.10. Cache.........................................................................................................................712
4.52. Content Templates............................................................................................................ 712
4.52.1. Cookies (Taglines)...................................................................................................... 713
4.52.2. Edit Templates............................................................................................................ 715
4.52.3. External Wikis.............................................................................................................715
4.52.3.1. Enable the feature............................................................................................... 715
4.52.3.2. Insert an external wiki reference:....................................................................... 716
4.52.3.3. List external wiki references............................................................................... 716
4.52.3.4. For more information......................................................................................... 716
4.52.4. Featured Links.............................................................................................................716
4.52.5. Mail notifications........................................................................................................ 717
4.52.6. Wiki mail-in................................................................................................................ 717
4.52.6.1. Edit/Add new mail account................................................................................. 718
4.52.6.2. Other parameters................................................................................................ 719
4.52.7. Maps Config................................................................................................................719
4.52.8. Custom Menus............................................................................................................ 720
4.52.8.1. Creating a Custom Menu.................................................................................... 720
4.52.8.2. Configuring a Custom Menu...............................................................................721
4.52.8.3. Allow viewing options/sections only under some conditions.............................. 722
4.52.8.4. Include menu in a new user module....................................................................724
4.52.9. Theme Control............................................................................................................ 724
4.52.10. Phpinfo...................................................................................................................... 726
4.52.10.1. Displaying PHP info:........................................................................................726
4.52.10.2. Admin Details....................................................................................................727
4.52.11. Action Log................................................................................................................ 727
4.52.11.1. Configuration.................................................................................................... 727
4.52.11.2. Report and Statistics......................................................................................... 729
4.52.12. Intertiki......................................................................................................................733

Back to TOC 21
 4.52.12.1. Configuration example......................................................................................733
4.52.12.2. Intertiki internal details.................................................................................... 736
4.52.13. Contribution.............................................................................................................. 736
4.52.13.1. Admin setting.................................................................................................... 737
4.52.14. Wysiwyg Editor Admin............................................................................................ 738
5. TUNING TIKIWIKI..................................................................................................... 742
5.1. Design................................................................................................................................... 742
5.1.1. Styles and Themes........................................................................................................ 742
5.1.1.1. New themes from themes.tikiwiki.org................................................................... 742
5.1.1.2. Tiki-bundled themes.............................................................................................. 744
5.1.1.3. Legacy themes....................................................................................................... 750
5.1.1.4. How To Create a Custom Theme.......................................................................... 754
5.1.1.5. Layout................................................................................................................... 755
5.1.2. How to modify TPL files.............................................................................................. 755
5.1.2.1. Overriding templates.............................................................................................755
5.1.2.2. Presentation.......................................................................................................... 756
5.1.3. Allow User to Set Theme..............................................................................................757
5.1.4. Using multiple Themes / Styles on your Tiki site.........................................................757
5.1.5. Design rules...................................................................................................................757
5.1.6. Smarty Templates......................................................................................................... 757
5.1.6.1. Smarty in Tikiwiki................................................................................................. 757
5.1.6.2. Theme Layout Schema.......................................................................................... 758
5.2. Hacking Tikiwiki.................................................................................................................760
5.2.1. The 3 rules.....................................................................................................................760
5.2.2. TikiDevNewbie............................................................................................................. 761
5.2.3. Adding a new feature.................................................................................................... 763
5.2.3.1. smarty/php.............................................................................................................763
5.2.3.2. The hello world page.............................................................................................763
5.2.3.3. tiki-setup.php.........................................................................................................765
5.2.3.4. How to debug and to see the smarty variables..................................................... 765
5.2.3.5. To execute some queries in the php...................................................................... 766
5.2.3.6. To introduce a new feature or a new preference.................................................. 767
5.2.3.7. To get/set a user preference.................................................................................. 768
5.2.3.8. To create a menu or to introduce a menu option..................................................769
5.2.3.9. To introduce a new permission............................................................................. 771
5.2.3.10. To check a permission.........................................................................................772
5.2.3.11. To wiki parse a textarea......................................................................................773
5.2.3.12. Categories........................................................................................................... 774
5.2.3.13. Theme control center.......................................................................................... 774
5.2.3.14. Search..................................................................................................................774
5.2.3.15. To add a confirmation step................................................................................. 777
5.2.3.16. To create a new module...................................................................................... 778
5.2.3.17. To create a new plugin........................................................................................779
5.2.3.18. A select all checkbox........................................................................................... 780
5.2.3.19. To do something specific in tiki.tpl function of the categories of the object.......781
5.2.4. Using Smarty Filters..................................................................................................... 781
5.2.5. Translating to a new language...................................................................................... 782
5.2.5.1. General process.................................................................................................... 782

22 Back to TOC
 Tikiwiki Documentation 1.9+

5.2.5.2. (A). Each time directly to CVS central repository of code....................................784

5.2.5.3. (B). Through Wiki................................................................................................. 785
5.2.5.4. (C) Through Tiki interface (data base)................................................................. 786
5.2.6. Tikiwiki Performance Tuning....................................................................................... 788
5.2.6.1. Apache...................................................................................................................788
5.2.6.2. PHP Settings (php.ini).......................................................................................... 789
5.2.6.3. Accelerating PHP................................................................................................. 790
5.2.7. Database Performance...................................................................................................793
5.2.7.1. MySQL.................................................................................................................. 793
5.3. ToolBox................................................................................................................................ 794
5.3.1. Multiplatform tools....................................................................................................... 794
5.3.1.1. Java based.............................................................................................................794
5.3.1.2. Text processing in local machine..........................................................................794
5.3.1.3. Firefox extensions................................................................................................. 794
5.3.1.4. Web Developing.................................................................................................... 795
5.3.1.5. Image Processing..................................................................................................795
5.3.1.6. On-line communication.........................................................................................795
5.3.1.7. Freeware (but not free software) tools................................................................. 796
5.3.1.8. Eclipse...................................................................................................................796
5.3.2. Linux tools.................................................................................................................... 800
5.3.2.1. CVS GUI's............................................................................................................. 801
5.3.2.2. PHP Editors.......................................................................................................... 801
5.3.2.3. Text editing supporting utf-8.................................................................................801
5.3.2.4. Blog posting.......................................................................................................... 802
5.3.2.5. Image editing and screenshot capturing...............................................................802
5.3.2.6. Screencasting or Desktop Session recording........................................................802
5.3.2.7. File Transfer (ftp, sftp)..........................................................................................802
5.3.2.8. File compression/decompression..........................................................................803
5.3.3. Windows tools...............................................................................................................803
5.3.3.1. CVS GUI's:............................................................................................................803
5.3.3.2. Web development local environment.................................................................... 803
5.3.3.3. PHP Editors:.........................................................................................................803
5.3.3.4. Text editing supporting utf-8.................................................................................804
5.3.3.5. Image editing and screenshot capturing...............................................................804
5.3.3.6. File compression/decompression..........................................................................804
5.3.3.7. Freeware (but not free software) tools................................................................. 804
5.3.4. Mac tools.......................................................................................................................805
6. ANNEXES.................................................................................................................. 808
6.1. About the Tikiwiki Documentation...................................................................................808
6.1.1. Welcome Authors......................................................................................................... 810
6.1.1.1. Getting Started as an Author................................................................................ 810
6.1.1.2. Sources of wisdom.................................................................................................810
6.1.1.3. Becoming an expert...............................................................................................810
6.1.2. Tikiwiki Manual of Style.............................................................................................. 811
6.1.2.1. The Imperatives.....................................................................................................811
6.1.2.2. Naming Conventions............................................................................................. 811
6.1.2.3. Headings............................................................................................................... 812
6.1.2.4. Emphasis............................................................................................................... 813

Back to TOC 23
 6.1.2.5. Links...................................................................................................................... 814
6.1.2.6. Lists....................................................................................................................... 815
6.1.2.7. Graphics................................................................................................................815
6.1.2.8. Plugins.................................................................................................................. 815
6.1.2.9. Icons...................................................................................................................... 816
6.1.2.10. Footnotes, Questions, Comments........................................................................816
6.1.3. Documentation Lifecycle.............................................................................................. 816
6.1.3.1. Tagging pages: from Stub to Review.................................................................... 816
6.1.3.2. The doc site leaves the nest................................................................................... 817
6.1.3.3. How To Tag...........................................................................................................818
6.1.3.4. Creating New Tags............................................................................................... 820
6.1.4. Documentation Templates............................................................................................ 820
6.1.5. Feature Page Template..................................................................................................821
6.1.6. Documentation Status................................................................................................... 823
6.1.7. Printing the Documentation.......................................................................................... 827
6.2. Tikiwiki FAQs..................................................................................................................... 829
6.2.1. FAQs about Images.......................................................................................................829
6.2.2. FAQs about Users and Groups......................................................................................830
6.2.3. FAQs about General Troubleshooting.......................................................................... 830
6.2.4. FAQs about Security..................................................................................................... 831
6.2.5. FAQs about Installation and Setup............................................................................... 832
6.2.6. FAQs about Look and Feel........................................................................................... 833
6.2.7. FAQs about RSS Feeds.................................................................................................834
6.2.8. FAQs about Wiki Pages................................................................................................ 835
6.3. Mods list...............................................................................................................................837
6.3.1. TikiWiki Mods Repository........................................................................................... 837
6.3.2. Mods Type Avatars....................................................................................................... 841
6.3.2.1. Mod dragonballz................................................................................................... 841
6.3.2.2. Mod gnumes.......................................................................................................... 842
6.3.2.3. Mod goldorak........................................................................................................843
6.3.2.4. Mod mcdonald...................................................................................................... 843
6.3.2.5. Mod xmen..............................................................................................................844
6.3.2.6. Mod all avatars..................................................................................................... 845
6.3.3. Mods Type Features......................................................................................................846
6.3.3.1. Mod aulawiki........................................................................................................ 846
6.3.3.2. Mod cartoweb....................................................................................................... 848
6.3.3.3. Mod cc (Community Currencies)..........................................................................848
6.3.3.4. Mod import-phpwiki..............................................................................................851
6.3.3.5. Mod kamap............................................................................................................852
6.3.3.6. Mod mapeditor......................................................................................................852
6.3.3.7. Mod phpcas........................................................................................................... 852
6.3.3.8. Mod solve.............................................................................................................. 853
6.3.3.9. Mod tikidav........................................................................................................... 854
6.3.3.10. Mod tinvoice........................................................................................................855
6.3.3.11. Mod userprefstats................................................................................................856
6.3.4. Mods Type Lib..............................................................................................................857
6.3.4.1. Mod fpdf................................................................................................................ 857
6.3.4.2. Mod fpdf_bitstreamvera........................................................................................858

24 Back to TOC
 Tikiwiki Documentation 1.9+

6.3.4.3. Mod fpdf_freefonts................................................................................................ 858

6.3.4.4. Mod jpgraph..........................................................................................................858
6.3.4.5. Mod nusoap...........................................................................................................859
6.3.4.6. Mod vtiger............................................................................................................. 859
6.3.5. Mods Type Menus........................................................................................................ 859
6.3.5.1. Mod tikiring.......................................................................................................... 859
6.3.6. Mods Type Modules..................................................................................................... 860
6.3.6.1. Mod blogroll......................................................................................................... 860
6.3.6.2. Mod calculator......................................................................................................863
6.3.6.3. Mod clock..............................................................................................................864
6.3.6.4. Mod extcalculator................................................................................................. 864
6.3.6.5. Mod join................................................................................................................ 866
6.3.6.6. Mod plazes............................................................................................................ 866
6.3.6.7. Mod worldclock.....................................................................................................868
6.3.7. Mods Type Services......................................................................................................869
6.3.7.1. Mod mailman........................................................................................................ 869
6.3.8. Mods Type SQL............................................................................................................870
6.3.8.1. Mod upgrade_1.7to1.8..........................................................................................871
6.3.8.2. Mod upgrade_1.8to1.9..........................................................................................871
6.3.8.3. Mod upgrade_1.9to1.9.1.......................................................................................871
6.3.9. Mods Type Taglines......................................................................................................871
6.3.9.1. Mod damian1........................................................................................................ 871
6.3.9.2. Mod damian2........................................................................................................ 872
6.3.9.3. Mod rcogley.......................................................................................................... 873
6.3.10. Mods Type Themes.....................................................................................................874
6.3.11. Mods Type Wikiplugins..............................................................................................875
6.3.11.1. Mod ebay.............................................................................................................875
6.3.11.2. Mod flowplayer................................................................................................... 875
6.3.11.3. Mod formula........................................................................................................875
6.3.11.4. Mod galaxia_sweet_ui........................................................................................ 876
6.3.11.5. Mod group...........................................................................................................876
6.3.11.6. Mod js..................................................................................................................876
6.3.11.7. Mod listpages...................................................................................................... 876
6.3.11.8. Mod mindmap..................................................................................................... 877
6.3.11.9. Mod mouseover................................................................................................... 877
6.3.11.10. Mod perm.......................................................................................................... 877
6.3.11.11. Mod phplot........................................................................................................ 877
6.3.11.12. Mod plazes........................................................................................................ 887
6.3.11.13. Redirect............................................................................................................. 887
6.3.11.14. Mod scroll......................................................................................................... 888
6.3.11.15. Mod svg............................................................................................................. 889
6.3.11.16. Mod trackeritemfield.........................................................................................891
6.3.11.17. Mod wikigraph.................................................................................................. 891
6.3.11.18. Mod xspf_player................................................................................................892
6.4. Third Party code................................................................................................................. 893
6.4.1. Smarty........................................................................................................................... 893
6.4.2. Adodb............................................................................................................................893
6.4.3. SmartIrc.........................................................................................................................893

Back to TOC 25
 6.4.4. Wollabot........................................................................................................................893
6.4.5. Mapserver......................................................................................................................893
6.4.6. SpellChecker................................................................................................................. 893
6.5. Download using CVS.......................................................................................................... 894
6.6. History..................................................................................................................................896
6.6.1. Changelog 1.9............................................................................................................... 896
6.6.2. Changelog 1.8............................................................................................................... 918
6.6.3. Changelog 1.7............................................................................................................... 926
6.6.4. Changelog 1.6............................................................................................................... 928
6.6.5. Changelog 1.5............................................................................................................... 929
6.7. Changelog 1.4...................................................................................................................... 931
6.7.1. Changelog 1.3............................................................................................................... 933
6.7.2. Changelog 1.2............................................................................................................... 934
6.7.3. Changelog 1.1............................................................................................................... 936
6.7.4. Changelog 1.0............................................................................................................... 936
6.8. Tikiwiki Community...........................................................................................................938
6.8.1. From http://tikiwiki.org/TikiCommunity .....................................................................938
6.8.2. From http://tikiwiki.org/CommunityWorldmap .......................................................... 938
6.8.3. From http://cvs.tikiwiki.org ......................................................................................... 939
6.8.3.1. Activity by Author .................................................................................................939
6.9. Copyrights: CC-by-sa.........................................................................................................945
6.9.1. Human-readable summary............................................................................................ 945
6.9.2. Legal Code (Full License).............................................................................................946
6.9.2.1. 1. Definitions.........................................................................................................946
6.9.2.2. 2. Fair Use Rights................................................................................................. 946
6.9.2.3. 3. License Grant....................................................................................................947
6.9.2.4. 4. Restrictions........................................................................................................947
6.9.2.5. 5. Representations, Warranties and Disclaimer................................................... 948
6.9.2.6. 6. Limitation on Liability...................................................................................... 949
6.9.2.7. 7. Termination.......................................................................................................949
6.9.2.8. 8. Miscellaneous....................................................................................................949
6.10. Alphabetical Index............................................................................................................951

(page intentionally left blank)

26 Back to TOC
 Tikiwiki Documentation 1.9+

1. INTRODUCTION

Back to TOC 27
 (page intentionally left blank)

28 Back to TOC
 Tikiwiki Documentation 1.9+

1. Introduction
Tiki CMS/Groupware (aka TikiWiki) is a powerful open-source Content Management System
(CMS) and Groupware that can be used to create all sorts of Web applications, Sites, Portals,
Intranets and Extranets. TikiWiki also works great as a Web-based collaboration tool. TikiWiki is a
multi-purpose package with a lot of native options and sections that you can enable/disable as you
need them. It is designed to be international, clean and extensible.

TikiWiki incorporates all the features present in several excellent wiki systems available today plus
a lot of new features and options, allowing your wiki application to be whatever you want it to be--
from a simple wiki to a complex site for a whole user community with many intermediate steps.
You can use TikiWiki as a forums site, a chatroom, for poll taking, and much more! The
possibilities are endless.

To understand TikiWiki, compare it to a high-end single-lens reflex (SLR) camera with lots of
expensive lenses. In a well-thought-out SLR camera system, each of the lenses gives you the ability
to look at the world in a unique way. You can choose just the right lens for the job. Similarly, Tiki
gives you lots of different ways to look at the data with which a group of people are concerned. Use
Articles (and make articles your Tiki home page) so that you and your users can post important,
fast-breaking news that everyone should read. Use Wiki pages to enable you and your users to
upload reams of content without having to learn HTML or hassle with proprietary file formats. Use
Forums to launch topic-oriented discussions. Use Blogs to give each user the ability to create
chronologically oriented journals. Make vital resources available with File and Image Galleries.

TikiWiki's major features include: article, forum, newsletter, blog, file/image gallery, wiki,
drawing, tracker, directory, poll/survey, quiz, FAQ, chat, banner, webmail, calendar, category,
ACL, and more. (see full list in Features )

You can have a quick view of a Tikiwiki installation and initial configuration at this basic
introduction and overview 24 minute video:

From http://doc.tikiwiki.org/Introduction (Video from David Lankes ). Many more videos at http://tikiwiki.org/TikiMovies

Tikiwiki community pursues some Goals detailed below, follows three basic rules for code design
(detailed in further sections of this documentation), and uses this Social Contract as much as
possible for organization within the Community.

Back to TOC 29
Useful Links
• Open Source & Free Software
http://www.fsf.org
http://opensource.org
http://en.wikipedia.org/wiki/Open_Source
• CMS
http://en.wikipedia.org/wiki/Content_management_system
• Groupware
http://en.wikipedia.org/wiki/Collaborative_software
• List of Tikiwiki Movies (in several languages)
http://tikiwiki.org/TikiMovies

30 Back to TOC
 Tikiwiki Documentation 1.9+

1.1. Tikiwiki & Community Goals

• Build a powerful, leading, complete, user-friendly, stable and secure full featured open
source web application, which includes (but is not limited to) cms & groupware features.
• Find a delicate balance between chaos and order :
• Features creativity, unrestricted and rapid development.
• Stability, extensive testing and up-to-date documentation.
• Keep track of development activity by using extensive logging and systematic publishing.
• Make it easy for small teams or lonely coder to adopt, enhance or add some features.
• Help new developers to join the team, learn more and contribute fast.
• Provide a friendly network of tikiwiki users-developers favoring mutual assistance and
support.
• Eat our own dogfood. Use tikiwiki for our community activity to see how it works first-
hand.
• To have a fun & friendly community where people can easily contribute & enhance Tiki.
• World domination!

Back to TOC 31
1.2. Social Contract
This is our Social Contract, the set of principles of our Organization. They are not specific rules, but
more general concepts that all are true in our case. Source http://www.open-
organizations.org/view/Main/IntroToOpenOrg .

INTRODUCTION TO OPEN ORGANIZATIONS

'Open Organizations' is the current name for a framework for a functional organizational structure
that people can choose to adopt in part or whole when working together. It can also be used to as a
tool to analyse other organizations. Open Organizations is in a large part the result of observing and
distilling the patterns, or processes, in the functioning of existing organizations. It is developing
according to the understanding that theory and practice rely on each other.

An Open Organization is created by carrying out certain defined processes. This is its
strength:
• processes are functional: people must carry them out continuously, (there are never 'fixed'
states). An Open Organization is thereby a self-organizing system
• because they are functional, processes and their effects can be measured
• processes are a necessary way to understand organizations in the light of the scientific
knowledge we have today of our world.

Terms
• Politics on any scale means essentially the deliberate organization of interactions between
people. Whenever people form a group and deliberately organize their interactions in a
certain way it is a political decision.
• Interactions (relationships) between people are active exchanges, not static. That is,
they are processes.
• So politics is actually the subject of choices about processes.

For example, voting is a process that people carry out. Another example is provided by the question
that is sometimes asked, "If we don't like capitalism, what can we replace it with?" The question is
based on an error - because capitalism is a set of processes that people continuously carry out.
• When people deliberately organize their work together, the processes (tasks) they
continually carry out create and maintain their organization. So the term 'organizational
structure' refers to a dynamic system, not a static one.
• When processes are deliberately selected by people forming an organization, they are chosen
on the basis that they make certain preferred outcomes more probable. These outcomes
include both internal ones - for the organization itself, and external ones - for the
organization's outward effects.
• The outcomes are aimed for because they are valued; the values given to these
outcomes are political values.

32 Back to TOC
 Tikiwiki Documentation 1.9+

So far we have identified four regular processes (and one extraordinary) and eight functional
rules for an Open Organization.

Four regular processes

1) Decision-making

Within each working group, decisions are made by rough consensus. This takes place whilst tasks
are being worked on and carried out. Otherwise those tasks might never begin or progress. Tasks
are adjusted, adapted, expanded and contracted by rough consensus, but they are not interrupted or
stopped by decision making about them, they are always ongoing.

Different levels of formality and complexity are possible, but the essence of consensus is that
anyone can make a proposal, and anyone can veto any proposal. Silence means assent - if nobody
vetoes a proposal or decision then it goes ahead. A proposal or decision can only be stopped by an
objection that it would contradict an Open Organization process and/or functional rule and/or that
it would endanger the existence of some part or the whole organization.
• A proposal must have a certain time period defined for decision about it from the beginning.
The proposed task must define measurable goals, a time frame for completion (or progress if
it is to be continuous), and a notice period that will be given if it is discontinued.

2) Accountability

Your working group regularly searches for (possible) effects of its actions on other groups. It adapts
its work to prevent adverse effects on others. If your group is told about an adverse effect of its
actions on others, your group reacts as if it found the effect. When groups communicate about this,
the group that is affected decides what is adverse to it. This makes your group, by choice,
accountable to others.

More generally, accountability means that those who are affected by a decision can participate in
making that decision. It sets limits to self-management by allowing others who are affected by a
project to overrule those who are working on it, and even to cancel the project if a major problem
arises. An adverse effect of your group's work might also be when others depend on the success of
your work. Conflicts can often be avoided if people are aware of the potential consequences of their
own work.

3) Transparency

Your working group regularly publishes, in a readily accessible form, summaries of the work you
are doing and of the knowledge gained from that work. This is part of the public ownership of
knowledge.

Back to TOC 33
This allows others to recognize interdependencies between you and other groups because they can
see what you are doing. People can identify possible consequences of your work (even during its
planning stages) and hold your group accountable for its work. Also, you need to know what other
groups are doing so that you can understand how their work relates to what you are doing. In the
process of accountability, it might be necessary for one group to intervene in the decision-making
processes of another group. To do this effectively, it must first understand the work they've done so
far and the discussions currently taking place, as well as relevant lessons learned from previous
issues. For these reasons, transparency is necessary for accountability.

4) Coordinating

This task needs to be carried out in each working group. The key tasks are: keeping track of what
work is being done by whom, keeping track of any active proposals, and writing regular summaries
of what work has been done and why, and of the main discussions taking place. Coordinating work
can be done by one person or be shared in different ways within the working group.

5) Excluding

This is an extraordinary process. If an individual or a whole group repeatedly does not fulfill
commitments, the other members of the group or the organization as a whole can exclude that
person or group from current tasks.

If a working group seems to be breaking its charter or that of the organization, or if an unforeseen
problem arises, a process must be formulated and carried out by the organization for examining the
issue and resolving the problem. This could result in modification of the group's charter, and
possibly even of the organization's charter. The organization can also decide to dissolve the group,
or suspend its activities until the problem is resolved. However, in the main, as long as there are no
complaints, each working group remains self-managing.

Eight functional rules

1) Charter

An Open Organization must have a published written charter which sets out how it choses to
implement, given its particular circumstances, the processes (and therefore values) which make it an
Open Organization.
Within the organization, people form Working Groups to take on particular tasks. Each working
group must also have a written
published charter which must be compatible with the organization's charter. It must define the
working group's methods of implementation and measurable goals for its chosen task(s). It must be
approved by the organization as a whole.

2) Open participation

34 Back to TOC
 Tikiwiki Documentation 1.9+

Anyone can work in the organization if they agree to the organization's charter and have the
necessary skills. This means that full advantage is gained from people's available skills and
enthusiasm.

Open participation is based on the 'trust first' principle: the underlying premise that people are
sociable and want to contribute to society, and should therefore be trusted to do what they undertake
to do, knowing that they are accountable for what they do. The 'trust first' attitude is always
maintained and calibrated to the circumstances. For example, implementation work may be shared
between a number of people when a task is so important that error or wrongdoing might jeopardize
the organization. This group of people can consist of experts (see Respect for skill below) and/or
peers. Approaches other than 'trust first' are likely to be needed when computer passwords,
potentially dangerous tools, etc. are being used.

3) Self-management

The people in an organization within the working groups, who do or will contribute to
implementation work on the different tasks, decide amongst themselves how, what work is to be
done in their decision-making

In this way, work is guided and done by those who know it best. It also means that those doing the
work, who are immediately affected by working practices, are able to decide on those practices
themselves.
• Implementation work is defined as the various steps taken after the design stage (discussion,
advice, consultation) involved in the production or maintaining of a task. Making a summary
of a discussion about a task from the design stage that enables the implementation of a task
to begin is also implementation work.

4) Best practices

Life is a very functional business: if a job is worth doing, it is worth doing well. For any particular
task, there is usually only a handful of commonly recognized best practices and people with
expertise in that task will probably be familiar with all of them (but see diversity) It is easier to
seek out best practices if there is public ownership of knowledge.

5) Respect for skill

One kind of knowledge can be gained, for example, by reading a book, or a transcript of a
discussion. Another kind, which is usually called 'expertise', 'experience' or 'skill' in a certain
activity, must be acquired by working with someone who already has this expertise. To benefit from
expertise, we have to first acknowledge it in those who have it and give proportional attention and
weight to their views in decision-making.

By doing this we release the full power of everyone's abilities rather than adopting a superficial
notion of equality. We grant skilled people a type of power, in proportion to their knowledge,

Back to TOC 35
(rather than giving them the right to dominate us or others). Respecting skill not only allows a group
to function and solve problems better and more quickly, it also allows those with expertise to teach
others by example. Thus, their knowledge is passed on, and can be publicly owned as well.

6) Public ownership of knowledge

The knowledge produced by an organization, including its internal debates and the lessons learnt
from them, must be recorded and maintained in publicly accessible archives, so that people inside
and outside the organization, and in future generations, can benefit from it. This history should also
be organized and presented in a way that minimises the difficulty of learning from it. This allows
knowledge to circulate where it is needed, providing the maximum benefit to the organization and
to society. The result is public ownership of knowledge. Both respect for skill and public
ownership of knowledge require transparency.

7) Diversity

Different approaches to carrying out tasks and solving problems can coexist (without hindering one
another), and learn from each other. There can be cooperation and collaboration between different
working practices. Diversity increases the probability of success in reaching goals and of the
discovery of new working practices. Diversity also allows us to challenge and improve the best
practices in any speciality.

8) Affirmative terms

The use of only affirmative (positive) terms in describing both goals and ways of working. Defining
always what an Open Organization and its Working Groups are for.

Otherwise terms such as 'non-hierarchical' and 'destroying' might be used to define organization and
work. The first term is practicably useless and meaningless, as it is impossible to build positive,
creative structures and practices, based on the conceptual idea of the negating of a structure.
Furthermore, despite the opposite intention of the term 'non-hierarchical', the concept of 'hierarchy'
is conceptually entrenched by repeatedly referring to it - even in a negated form. The second term,
'destroying' could not lead to work that furthers the organization's charter.

Internet organization

When an Open Organization uses the internet for communication. To facilitate open participation,
working groups use electronic communication tools. For example, decisions are made on Internet
mailing lists. This is so that everyone gets equal access to information from which decisions are
made, and is able to participate in the actual decision-making, unlimited by geographical location or
time constraints.

To promote transparency and public ownership of knowledge, the Internet mailing lists are publicly
archived. From time to time, for example bi-monthly, the coordinator of each working group
publishes a summary of the debates and decisions taken in the group on a mailing list that is just for

36 Back to TOC
 Tikiwiki Documentation 1.9+

summaries, or better still, on a web site created for that purpose. People outside the group can just
read the summaries to get a general idea of what's going on, and can dig into the archives of the
group's own mailing list if they want to know more.

Delegation

In discussion and decision-making involving many people, rough consensus becomes unwieldy;
delegation is one method that can be used to make it more manageable. A delegate can be seen as
someone who facilitates a consensus between two or more groups. Delegates are always chosen
temporarily, usually just to participate in a single meeting or a series of meetings on a particular
issue. The purpose of such meetings is typically to craft proposals that can be submitted to the
groups represented. Each group can give its delegate a specific mandate, allowing the delegate to
make certain proposals, to accept proposals that meet certain criteria, and to reject proposals that
meet other criteria. For maximum accountability, if the meeting produces a proposal that falls
outside the delegate's mandate, the delegate must consult with his or her group before proceeding. If
a group is dissatisfied with its delegate, it can replace the delegate at any time.

by RichardMalter and BenjaminGeer

Revision r1.49 - 26 Apr 2004

TikiWiki is and will remain Free Software

We will release our contributions to Tikiwiki as free software, under the Lesser GNU General
Public License (or other licenses conforming to our social contract, at our discretion). Any external
contributions to Tikiwiki (in the form of freely-distributable sources or binaries) may be
incorporated into Tikiwiki provided that we are legally entitled to do so. However, Tikiwiki will
never depend upon a piece of software unless it conforms to the GNU General Public License,
GNU "Lesser" Public License or some other license approved by the Open Source Initiative (OSI )
and the Free Software Foundation (FSF ).

especially:
• general public: GPL
• free software: LGPL
• no-endorsement: http://www.debian.org/misc/bsd.license
• design-science: http://dsl.org/copyleft/dsl.txt
• creative commons: http://creativecommons.org/licenses/by-sa/1.0/

See also TikiCopyrights.

Back to TOC 37
 (page intentionally left blank)

38 Back to TOC
 Tikiwiki Documentation 1.9+

2. INSTALLATION

Back to TOC 39
 (page intentionally left blank)

40 Back to TOC
 Tikiwiki Documentation 1.9+

2. Installation
Work in progress. This page is part of the Basic Docs Project, and is currently being improved.

Related pages:
Installation FAQ
Installation Problems- use this page to get help.
Migrate to Tikiwiki
Upgrade

Before You Begin

Before installing Tiki, please read the Requirements and Setup information. Proper planning can
ensure a worry-free installation. If you are looking for a new webhost, we have a list of
TikiFriendlyHosts.

If you want to build your site offline, try setting up a Local Development Server?

Step 1: Download Tiki

You can download the current version of Tiki from SourceForge. The full download is ~10MB.

Step 2: Install
Move all the Tiki installation files to your webhost. If you have a hosted webserver, you can simply
use FTP to move the files. Note that you need to set the necessary permissions for the installation
files and directories:

2.1 General Help

Install by SSH?
Install by FTP
Install by Fantastico?
Using SSH? (for newbies)
Using FTP? (for newbies)

Back to TOC 41
 2.2 Specific Installation Guides
Environment Help Page Comments

Remote
If you only have FTP
InstallWithOnlyFtpAccess
access
SourceForge hosted SourceForge Install
For Free, the french
FreeFr Install? running with flaws
provider

GNU/Linux
Generic GNU/Linux + Apache Linux Install
Debian or Debian-based Debian Install
Gentoo Linux ebuild
Gentoo Install
instructions
RPM Package Manager distros RPM Install
Mitel SME Server Mitel SME Install http://www.e-smith.org
Apache Virtual Hosting Virtual Hosting Install
Gforge Server Gforge Install Very easy for multitiki's

Windows
Windows Desktop Install + IIS Windows IIS Install
Windows Desktop Install + IIS Windows MSSQL
Not for the faint-hearted...
+ MS SQL Server Install

Multitiki (on GNU/Linux)

"Virtual Hosting" based MultiTiki Recipe
"Subdirectories" based MultiTiki Akira (or GForge Install for GForge'd sites)

Intranet / Local Installations

GNU/Linux (Fedora) +
Linux Intranet Install
Apache
Mac
Mac OS X (Server) OS X Install
Windows
Windows Desktop Install
Windows Desktop Install
desktop
Windows Desktop Install Windows Local Install
XP, 2000, ME, 98
desktop (alternative) EasyPhp

42 Back to TOC
 Tikiwiki Documentation 1.9+

Environment Help Page Comments

x86 Checkout Version

GNU/Linux Live CD + download, burn, reboot (or use it with VMWarePlayer
TikiLive CD
Tikiwiki )

VMware
VMware Player TikiWiki VMware Appliance (or TikiLive CD + VMWare Live CD player )

Moving
Move Tiki to a new
Move Tiki to another server server
Worked for me. Feel free to add!

Specific Webhosts
commercial webhost specific instructions for installing using various
Tikiwiki installation installation webhost environments

For more information on the Tiki installation process

• Install Tiki Help is there for you if anything does not work right...
• Database Performance and Tikiwiki Performance Tuning have tips to improve server
performance
• Upgrade Instructions are at Upgrade
• Linux

Step 3: Create the Database

Tiki requires a database. Be sure to read the Database Requirements section in Requirements and
Setup information. Be sure to record the following items:
• The database name
• The user name and password that has admin authority in the database.

Step 4: Run tiki-install.php

In English:
Open a web browser to: http://www.yourdomain.com/tiki-install.php

In other languages (since Tikiwiki v1.9.7 onwards):

Open a web browser to: http://www.yourdomain.com/tiki-install.php?lang=XX

where XX is the language code of your preference, to have the interface in your language provided
that it has beeen translated already.

Back to TOC 43
In either case, enter your database name, username, and password.

Sample Tiki installation screen. Click for full-size

image.

Be sure to update your PHP.INI file, as needed. See the Requirements and Setup information for
more information.

After submitting your database details, select which installation profile you would like to use for
your tiki site:

Then you should see some long screen like this ones:

44 Back to TOC
 Tikiwiki Documentation 1.9+

Your database has been configured and Tiki is ready to run, if this is your first install your admin
password is 'admin'. You can now log in into Tiki as 'admin' - 'admin' and start configuring the
application.
Note: This install script may be potentially harmful so we strongly recommend you to disable the
script and then proceed into Tiki. If you decide to reuse later, just follow the instructions in tiki-
install.php to restore

On the second half of that screen, some more information will be shown, regarding the php
configuration settings in your server and some final tips. Read it, and select one of the options at the
bottom (for instance, "Click here to disable the install script and proceed into tiki.", or whatever
you prefer):

Back to TOC 45
 Step 5: Configure Your Tiki

Now the easy part is over, and you are now in a world of options to Configure? Tikiwiki.

Default Login

Log into Tiki for the first time with the username admin and the password admin. Use the Features
Admin to enable Tiki features, then use the Admin page for each specific features.

46 Back to TOC
 Tikiwiki Documentation 1.9+

Sample Features Admin page. Click for full-size image.

For more information on the Tiki installation process...

You can check these specific pages: Installation FAQ, Installation Problems, Migrate to Tikiwiki or
Upgrade, or just keep reading any of the following pages of this section of the documentation.
What you should check first: Requirements and Setup. Understand that getting Tiki to run without
checking those doesn't mean that everything will always work.

You can always opt to choose a friendly host ( http://tikiwiki.org/TikiFriendlyHosts). Some even
offer to Install Tiki for you!

2.1. Requirements and Setup

This document needs review to verify the installation requirements
About
This page lists the minimum requirements for installing Tikiwiki.

2.1.1. Requirements

2.1.1.1. Webserver

Tikiwiki should run on any webserver (such as Apache) that supports PHP and meets the following
minimal requirements:
• 512 MB Ram
• 100 megs free storage
• At least 32 Megs of Memory allocated for PHP.
Note on PHP Memory Limits: most ISP's install PHP with a memory_limit = 8m. While Tikiwiki
may install, and initially appear to work fine, when faced with even a slight load, this limit will be
easily passed and the system will constantly fail: pages will not load properly, odd errors will occur
etc. To check this limit, try yourdomain.com/tiki-phpinfo.php . Run that and search for three values

Back to TOC 47
on your ISP’s server:
• max_execution_time = 300 ; Maximum execution time of each script, in seconds
• max_input_time = 60 ; Maximum amount of time each script may spend parsing request
data
• memory_limit = 32M ; Maximum amount of memory a script may consume
This limit is not generally user managable so you must rely on the kindness of your ISP to grant you
more resources. On a busy shared server that will also mean that all other PHP users on that shared
server will also be granted those resources. ^

2.1.1.2. Database

Tikiwiki requires an active relational database connection. The database can be installed in the same
physical location of the webserver (localhost). Tikiwiki supports the following databases:
• MySQL 4.0.x (or higher)
• For MySQL 4.1.x, you must use Tiki 1.9.x (full support)
• For MySQL 5.x, you must use Tiki 1.9.3+. See MySQL5 for details.
• Postgres (partial support)
• SQLite (partial support)
• Oracle (partial support)
• Sybase (partial support)
• MSSQL (partial support)

2.1.1.3. PHP

Tiki requires PHP 4.1+ (if you want to use LDAP authentication you need 4.3.2+), version 4.2+ is
recommended. For PHP 5.0, you must use Tiki 1.9.1 (or higher) with the MySQLi extension.

Libraries
libxml must be enabled http://us2.php.net/manual/en/ref.xml.php
mbstring is a plus if you work with a language that
http://us2.php.net/manual/en/ref.mbstring.php
needs it
.... list to be completed

We recommend using the following configuration in your php.ini file:

PHP.INI setting Description

Specify the maximum memory for PHP scripts. We recommend 16MB as a
memory_limit = 16M mimimum. For best performance, use 32MB.
file_uploads = On Required to allow uploads (files, images, etc.) to your Tiki
upload_max_filesize = XXM Specify the maxium upload filesize (in MB).
allow_url_fopen = On Allow trackback pings in your Tiki blogs.
session.save_handler = files The path that PHP stores session information. Ensure that the location exists and

48 Back to TOC
 Tikiwiki Documentation 1.9+

is writable. In Shared Hosting environments, if you do not have access to /tmp,

session.save_path = /tmp use temp (no slash) instead.
max_execution_time = 60 Specify the idle timeout (in seconds). If you experience timeouts (such as when
max_input_time = 60 performing Admin functions) you may need to increase these settings.
magic_quotes_gpc = Off Turn off PHP's Magic Quotes function.
default_charset = "utf-8" Specify the default charcter encoding.

The location of the php.ini file may vary, depending on your operating sytem. Some common
locations include:
• /etc/php.ini
• /etc/php/php.ini
• /etc/php4/php.ini
• /etc/php/apache1-php4/php.ini (Gentoo)
• /etc/php/cli-php4/php.ini (Gentoo)
• /etc/php4/apache2 (Debian)

Notes:
1. PHP 4.1.2 has a known session bug and should not be used.

Back to TOC 49
2.1.2. Optional Software or Libraries
Some TikiWiki feautures require the following additional software or libraries:

Feature Additional Requirements

Image processing, used for thumbnail generation,
Use either GD Library 1.5 (or higher) or ImageMagick.
dynamic chart generation, and to prevent ImageMagick is included, by default with PHP 4.3+
bot/automatic registration.
WikiGraph? for creating and manipulating
GraphViz
graphs.
Webmail PHP 4.2+
PDF Genration php-xml
Manage and display maps as a GeoCMS
Mapserver 4.6+
(Geospastial Content Management System).
Use the Apache Rewrite Rules to create shorter, or
Rewrite Tiki's default URLs custom, URLs.

2.1.3. Fantastico (and other ISP panels) and Tikiwiki

If your web host uses Fantastico or another web hosting control paner, you'll need to verify that
their script will install the current version of Tikiwiki, with all the proper security updates.
Using Fantastico for upgrades is not recommended as it will not preserve any theme changes, image
galleries, etc. that have been made.

50 Back to TOC
 Tikiwiki Documentation 1.9+

2.2. Downloading Tiki

2.2.1. Latest stable releases

2.2.1.1. Official repository

You can find all official Tiki releases, documentation, and add-ons at Sourceforge :
http://sourceforge.net/project/showfiles.php?group_id=64258&package_id=112134

2.2.1.2. Mods

You can find Tiki Mods (modular extensions in features, avatars, services... that Tiki can provide)
at http://mods.tikiwiki.org . More information in the Mods section of this documentation.

2.2.1.3. Themes

You can find custom Tiki themes at http://themes.tikiwiki.org .

2.2.2. Testing future Tiki releases

And if you want to try future versions of Tiki for testing what's coming on the next release (not for
production, since since they are not considered stable yet for all the features that they include), you
can get some pre-release tarballs through the developers site at this page: http://dev.tikiwiki.org/
Download .
Related pages
• Download using CVS

2.3. Tiki Installation on Linux

Initial Steps: Download, Unpack, Create Directories

These initial steps presume you're installing on a Linux machine running the Apache Webserver.
Read this once top to bottom before getting started. If you're using a Windows box you can ignore
the portion about setting permissions, but you'll have to set up some of Tiki's directories manually.
Before you get started it's a good idea to know
• your database user name and password
• your apache user and group ID

Back to TOC 51
If you're using the rpm that is available you can skip down to browser based install.

These are notes on how to setup and configure Tiki.

Step one:
Unpack and set the necessary permissions
unpack to the document root of where you want tiki installed, e.g. /var/www/tiki/
bz2 file Use:
tar xvjf tikiwikiv.xxx
Step two:
CHMOD the file setup.sh to 755.
chmod 755 setup.sh

The script setup.sh in this directory assigns necessary permissions for the directories that the
webserver writes files to. It also creates the (initially empty) cache directories.
Usage: ./setup.sh user group rights list of virtual host domains

For example, if apache is running as user $AUSER and group $AGROUP, type:
You can find your group using the command 'id'.
su -c './setup.sh $AUSER'

Alternatively, you may wish to set both the user and group:
If not root then
su -c './setup.sh $USER $AGROUP'

This will allow you to delete certain files/directories without becoming root. Or, if you can't become
root, but are a member of the group apache runs under (for example: $AGROUP), you can type:
./setup.sh $USER $AGROUP

If root then, and are not a member of the apache group, then type:
./setup.sh $USER yourgroup 02777

Replace yourgroup with your default group.

NOTE: If you do execute this last command, you will not be able to delete certain files created by
apache, and will need to ask your system administrator to delete them for you if needed.

To use Tiki's multi-site capability (virtual hosts from a single DocumentRoot) add a list of domains
to
the command to create all the needed directories. For example

If Root then
root@localhost tiki]# sh ./setup.sh youruser nobody 02775 test1 test2 test3

If not Root then

./setup.sh $USER $AGROUP 02777 domain1 domain2 domain3

This will get you to the next screen go to step three below.

52 Back to TOC
 Tikiwiki Documentation 1.9+

Step three: browser based setup

• create a tiki database
• using PhpMyAdmin (cache) and MySQL
• or on the command line mysqladmin create dbname the database name is usually called
"tiki"
• Point your browser to the web address that corresponds to the file tiki-install.php?lang=XX
(http://your_host/tiki/tiki-install.php?lang=XX); being XX the two letter language code of
your choice (available from Tiki version 1.9.7).
• Follow the instructions there: you will need the password and user name for your database
• For the first time to log into Tiki is
• user: admin
• password: admin

Step four: Custom configuration

Next you can configure Tiki to your needs:
• Choose which features you want switched on
• click on http://localhost/tiki/tiki-admin.php on the left side of your screen
• (Optionally) create groups of users that share permissions
• Assign appropriate permissions

2.3.1. Install with RPM

Please see the page Linux as this contains the source code installation procedure.

2.3.2. Install on Debian

Install on Debian Gnu Linux

Debian Sarge, using PHP 4.1.x, MySQL 4.11.1

Using your favorite Debian package manager, verify that these packages (and their dependencies)
are installed:

apache2
mysql-server-4.1
php4-mysql
libapache2-mod-php4

2.3.2.1. Preparing supporting components for Install

There are three major components you need to configure before you actuall install tikiwiki: PHP,
MySQL, and Apache

2.3.2.2. PHP Setup

There are several settings that need to be edited in the php.ini file. If you have installed the Debian

Back to TOC 53
Sarge PHP packages, you will find this file in /etc/php4/apache2/php.ini

1. Make a backup of the php.ini file.

cp php.ini php.ini.org

2. You must edit these configurations. Some need to be changed, others just need to be
umcommented. Set them to the values below:
max_execution_time = 60 ; Maximum execution time of each script, in seconds
memory_limit = 32M ; Maximum amount of memory a script may consume (8MB)
session.save_path = /var/www/tmp
log_errors = error_log
error_log = syslog
extension=mysql.so
mysql.connect_timeout = -1

3. Save the file and restart apache

pince:/etc/php4/apache2# /etc/init.d/apache2 restart
Forcing reload of web server: Apache2.
pince:/etc/php4/apache2#

2.3.2.3. MySQL Setup

If you have installed MySQL from Debian packages, it should already be set up, and the 'mysql'
database should be created. You'll need to secure the database, create the tiki database, and grant
rights to the tiki database user.

1. Verify that MySQL is running.

2. Secure the mysqladmin (root) user. Follow the instructions

at www.mysql.com. Do it now. Leaving this user without a password is insecure.

3. Follow the instructions in Requirements and Setup to create the tiki database. Use a secure name
for the database user. Do not use "admin".

2.3.2.4. Apache setup

1. Make the appropriate modifications to the Apache configs to set up tikiwiki as a host or virtual
host. Put a simple file (index.html.en) in the DocumentRoot of your host or virtualhost. Test access
from localhost and from external machines.

2. Find the name of the user that Apache runs as. Debian Sarge uses userid "www-data" by default.

54 Back to TOC
 Tikiwiki Documentation 1.9+

2.3.2.5. Install Tiki

1. Download the latest release.

2. Move the tiki tarball to the appropriate directory. Debian Sarge places it's document root at
/var/www.
3. Untar the tiki release file. It should create a subdirectory with the release number. Here's what
mine looked like:
pince:/var/www# ls -l
total 35236
lrwxrwxrwx 1 root root 24 2005-11-15 07:26 analog ->
/usr/share/analog/images
drwxr-xr-x 3 root root 4096 2005-12-26 17:07 apache2-default
drwxrwxr-x 20 www-data 1015 16384 2005-12-28 00:36 tikiwiki-1.9.2
-rw-r--r-- 1 root root 36014080 2005-12-26 19:38 tikiwiki-1.9.2.tar

4. I like to create a symbolic link to my tiki directory:

pince:/var/www# ln -s /var/www/tiki-1.9.2 tiki
pince:/var/www# ls -l
pince:/var/www# ls -l
total 35236
lrwxrwxrwx 1 root root 24 2005-11-15 07:26 analog ->
/usr/share/analog/images
drwxr-xr-x 3 root root 4096 2005-12-26 17:07 apache2-default
lrwxrwxrwx 1 root root 23 2005-12-27 23:42 tiki ->
/var/www/tikiwiki-1.9.2
drwxrwxr-x 20 www-data 1015 16384 2005-12-28 00:36 tikiwiki-1.9.2
-rw-r--r-- 1 root root 36014080 2005-12-26 19:38 tikiwiki-1.9.2.tar

5. Run fixperms to set perms on the directories.

fixperms.sh close

More to come........

2.3.3. Install on Gentoo

2.3.3.1. Normal installation

To install Tikiwiki on gentoo system simply type

emerge tikiwiki

Back to TOC 55
 2.3.3.2. Installation of last package (but not CVS)

In /etc/portage/package.keywords add line

www-apps/tikiwiki ~x86

and type

emerge tikiwiki

56 Back to TOC
 Tikiwiki Documentation 1.9+

2.4. Windows Desktop Install

Why install Tiki on a Windows desktop ?
Tiki is typically used on a server. However, there are instances where installing on a server is not
ideal or necessary.
• Tiki can be used as a personal knowledge base
• Testing out Tiki before getting a host
• Easier to install & test locally
• Using Tiki on a local Intranet
• If you have a slow or unreliable Internet connection.
• ..add your reason here!
Tiki has an internal backup system. You will be able to transfer all your data to a another Tiki
installation later on if you wish.

Is Tiki complicated to install ?

Tiki is fairly easy to install thanks to the install script. However, it is not yet a double click
experience Windows users are used to. It gets complicated because Tiki relies on three major
external applications to run.
• PHP (scripting language)
• Web server (usually Apache)
• Database (usually MySQL)
These three applications are needed to run Tiki. The nice folks at EasyPHP have bundled these
three plus phpMyAdmin (to administer your database via a browser). Once these applications
installed, a Tiki database must be created and a Tiki MySQL user must be created with appropriate
priviledges.

OK, I'm ready to go. What do I need ?

These instructions are designed to be used as a step-by-step guide. You can print them out and/or
just keep this browser window open. They explain how to install EasyPHP (which provides in a
quick way PHP, Apache, MySQL and more) and then setup Tiki. They were tested on a Windows
XP machine with EasyPHP 1.7 and TikiWiki 1.8, and a Windows 2000 machine with EasyPHP 1.6
and TikiWiki 1.7.1.1. They should work with few differences on similar environments.

Requirements
• A Windows PC (XP, 2000, ME, 98, ...)
• 20 minutes (excluding download time for about 16 MB, from step 1 to 9)
• A decompression utility, as 7-Zip (see Useful Links section at bottom of this page).
• Disk space: 60 MB (Keep in mind you will have Tiki + EasyPHP (PHP + Apache + MySQL
+ phpMyAdmin))

Back to TOC 57
 Step 1: Download EasyPHP and TikiWiki
See the links at the bottom of this page. For TikiWiki, you can choose between different
compression formats, you most probably want the .zip, or the .7z if you have 7-Zip.

Step 2: Setup EasyPHP

1. After the file has downloaded, execute easyphp1-7_setup.exe
2. Accept all the default settings (some messages may be in French)
3. Start EasyPHP (click start->Programs->EasyPHP 1.7->EasyPHP)
You should then see an EasyPHP logo in your system tray (to the right, near the clock). You can
scan what option it features if you wish. If you want to use Tiki on a regular basis check Start on
windows startup.

Step 3: Create a database for Tiki

1. Point your browser to http://127.0.0.1/mysql/
2. In the field Create new database enter tiki (or something else if you want).
3. Click Create.
You should see Database tiki has been created.

Step 4: Create a MySQL user

1. Point your browser to http://127.0.0.1/mysql/
2. Click Privileges.
3. Click Add a new User.
4. Fill some informations :
1. User name: Enter tikiadmin or another name if you wish.
5. Password: Put a safe password here, you will need it later.
6. Re-type: Re-enter the password.
7. Check all privileges.
8. Click Go.
You should see You have added a new user.

Step 5: Decompress Tiki files

• Uncompress Tiki files (normally in Program Files\EasyPHP\www)
Make sure the files are in \www\tikiwiki-1.8\ and not under \www\

Step 6: Run the install script

1. Point your browser to http://127.0.0.1/tikiwiki-1.9/tiki-install.php?lang=en (or instead “en”,
your 2 letter language code if not English). You can then just follow the script's instructions
or follow the rest of this step.
2. Fill the informations :
1. Database type: MySQL 4.x
3. Host: localhost (leave as is)
4. User: Enter tikiadmin or what you chose at step 4.4.1.

58 Back to TOC
 Tikiwiki Documentation 1.9+

5. Password: Enter the password you chose at step 4.4.2.

6. Database name: Enter tiki or what you chose at step 3.2.
7. Click Submit Query.
If your browser offers to "remember values" say no.
8. Choose the profile that will determine initial settings. BasicEnabled is recommended for
quick testing but you may want Default instead. Detailed descriptions can be read using the
link.
9. Click create.
You should see Your database has been configured and Tiki is ready to run, if this is
your first install your admin password is 'admin'.
10.Click Click here to remove the install script and proceed into tiki.
You should finally enter the Tiki interface and see Permission denied you cannot view this page.
If you get a timeout error, you need to change your php.ini to (: max_execution_time = 120) and
restart Apache. The first time a page is called, Tiki generates a template. The next time, the page is
generated much faster.

Step 7: Log in for the first time

Log in using the login box in the right-hand column.
1. Enter those informations :
1. user: Enter admin.
2. pass: Enter admin.
3. Click login.
4. Change the default password.

Step 8: Congratulations !
It is recommended to create a new user and give him admin priviledges instead of regularly using
the admin account. You can now explore the interface but you should check the extra steps before
to get you started.

Optional extra steps

Activate some features

Click Admin (click!) and then the first icon, Choose what you want to use. As always you can click
the help icon at the top of the page to get some information on what you can do.

Create a new user and a group

• Click Users from the Admin menu to add users.
• Click Groups from the Admin menu to add groups.
• From Admin groups click assign perms to assign the right permissions to your groups.
You probably need to spend some time there so that everyone has access to and only to what it
should access.

Back to TOC 59
Raise PHP's memory limit
Although PHP should run Tiki with 8MB of memory only, it's likely that you will need to set it to
16 MB even if it seems to work at most places.

Enable GD
GD is an graphic library used to perform manipulations on images. Image galleries need such a
library. Since GD is bundled with EasyPHP, all you need to do to get image galleries working is to
uncomment the line in php.ini that includes GD's DLL and restart Apache.

Install GraphViz and/or Mapserver

If you want to use WIKIGRAPH plugin, you need to install GraphViz. Maps need Mapserver to
work.
Useful Links
• EasyPHP
http://www.easyphp.org
• Download EasyPHP (8-11 MB)
http://easyphp.org/telechargements.php3
• Download Tiki (6-10 MB)
http://doc.tikiwiki.org/download
• Decompression utilities
• 7-Zip (Open Source, 41 languages, recommended)
http://www.7-zip.org
• WinZip (Free evaluation version available)
http://www.winzip.com
• PowerArchiver
http://www.powerarchiver.com

60 Back to TOC
 Tikiwiki Documentation 1.9+

2.5. Advanced Settings

2.5.1. Shared Hosting

2.5.2. Lite install

2.5.3. MultiTiki
Note: This documentation is for Tiki, version 1.8. It probably works for earlier versions, but I
haven't tested it. For Tiki version 1.9 and later there is a different approach that requires editing
db/tiki-db.php and using some new features in tiki-install.php. The newer variant is scantily
documented in the following pages (at MultiTiki 1.9).

Multiple Tikis on a Single Server

It is possible to have multiple Tikis on a single server. There are three major requirements that must
be satisfied:
• Tiki must have an access to a separate database for each URL.
• Apache must know how to associate multiple URLs with the Tiki.
• You must create the necessary directories with the Tiki's main directory.

Create a separate database for each url.

• Each database will have a different name. In mysql, creating the databases is normally
accomplished with the mysqladmin command. You may have permission to create the
database, or you may have to ask a system administrator. To actually tell Tiki which
database goes with which URL you have to edit one of Tiki's PHP files. The file
db/local.php is designed for this purpose.

Configure Apache for multiple Tikis.

• Typically, each Tiki will be accessed by a separate URL through Apache. Generally, the
URLs are specified as virtual hosts — often in VirtualHost stanzas within Apache's
configuration file. Remember to restart Apache after you have changed the configuration
files. On Linux this is usually best done with the "apachectl" graceful command.

Back to TOC 61
 Create the necessary directories within Tiki's main directory.
• On a Unix system, the easiest way to create the new directories and set permissions is by
specifing more than one tikidomain when you run setup.sh. You would run setup.sh with a
command like:
./setup.sh apache apache 02755 domain1 domain2 domain3

Create the directories manually for Windows hosting.

It is possible to add additional tikis after you have installed a single Tiki. However, with the
execption of the case in the following paragraph, you will have to manually create the needed
directories. If you are hosting on a Unix system, you will also need to manually set the ownership
and permissions.

http://tikiwiki.org/tiki-index.php?page=RecipeMultiTiki has a detailed recipe tested under RedHat,

version 8 and version 9 and Yellow Dog Linux, version 3.0. Root access to the Linux machine is
required for this approach. If you follow the instructions exactly, there is a Python script you can
use to add additional Tikis later.

There are a few minor problems that crop up with this approach. The admins for the various tikis
have the ability to overwrite each others changes to the css. Ordinary. users with the same login
names on different tikis would also be able to overwrite each other's changes to css files. Finally,
you must use Apache's mod_rewrite if you want the different Tikis to have their own favicons.

2.5.3.1. Multitiki version 1.9

This is an installation guide.

Multitiki appeared in tiki 1.7, it was one of my first contributions in june 2003. After some time and
evolution this special tiki setup is now robust and well-tested. The current documentation talks
about the 1.9 multitiki version. There is an alternative proposed by ggeller? on RecipeMultiTiki?
that is more adapted to 1.8 version.

Multiki under Windows XP

For those who want to setup Multitiki under Windows XP, please check MultitikiWindowsXP

Following steps only apply to GNU/Linux environment.

Simple steps to add one virtual tiki to an existing one

Setup (perms and dir creation)

Run setup.sh with an extra parameter that will be the name of your virtual tiki. Either

62 Back to TOC
 Tikiwiki Documentation 1.9+

TIKI_VIRTUAL, SERVER_NAME, or HTTP_HOST can be used to detect in which multitiki to go

fdepending the apache configuration. Here is what I typed to add http://lir.be test website to my
multitiki collection.
su ./setup.sh mose www-data 02775 lir.be

The script will :

• verify that web-writable dirs exist, as well as virtual subdir
• change perms to those dirs to make apache can write in it
• update the file db/virtuals.inc that is in 1.9 the central file where all virtuals are listed

Install (db feeding)

Re-activate your web-install file if your neutralized it by a chmod. for example
chmod 444 tiki-install.php

Point your browser on http://yourtiki/tiki-install.php. There should be a new item in the menu on the
topleft, indicating the state of the db connection (actually the existence and validity of the local.php
file for that virtual). That menu is based on db/virtuals.inc file so you can want to change things
manually there for tuning. Clicking on the link activates the virtual web-install page like if it was a
lone tiki. Then you can follow the install steps :
• give connection settings, that step will create a file named db/lir.be/local.php in my case
• select a db operation, either feeding a created but empty db, or upgrading a 1.8.3 version.

Secure (neutralize tiki-install.php)

The best known way is to change perms on the tiki-install, if you use cvs it won't break all things
chmod 500 tiki-install.php

The fast way (without using tiki-install.php)

On already setup multitiki, you can perform the required operation with command line. For example
in case of the lir.be that we saw above :
mysqladmin -uroot -p create tiki_dbname
mysql -uroot -p tiki_dbname < db/tiki.sql
# optionaly, if you want some prepared set of tiki :''
# mysql -uroot -p tiki_base < db/profiles/BasicEnabled.prf
mysql -uroot -p -e "grant usage on *.* to tiki_user@localhost identified by
'tiki_pass';" tiki_dbname
mysql -uroot -p -e "grant all on tiki_dbname.* to tiki_user@localhost identified
by 'tiki_pass';" tiki_dbname

Back to TOC 63
then copy the local.php from another instance of the multitiki, edit it and change the dbname, user
and password accordingly to the above creation.
Here is the console shoot of a 5-minutes install of a new multitiki :

How it works ?

Tikiwiki uses his database a lot for storing most content. Therefore, some temporary or volatile
content is written to disk, in some directories
• templates_c (smarty pre-compiled templates)
• temp (general temporary dir for tiki)
• temp/cache (centralized cache dir)
• modules/cache (used by smarty)
• img/wiki_up (where are stored wiki images)
• img/wiki (where are stored images generated by jgraphpad)
• maps/ (if maps feature is used)

Multitiki uses a subdir in each of these directories so each virtual tiki has his own temporary stuff
and there is no collision risk. In more than temporary and cache directories, 1.9 adds a subdir in
other places that become specific for each virtual
• db/lir.be/ (where there is a simple local.php file for db connection)
• templates/lir.be/ (for templates)
• styles/lir.be/ (for css and images linked to css)

About templates and styles, the virtual tiki uses its subdir by cascading. the subdir can be empty,

64 Back to TOC
 Tikiwiki Documentation 1.9+

then the 'root' items (templates or css) are used. Then the non-subdired templates and styles are
what is common to all virtual tikis on this system. If there is an equivalent file name in a subdir for
a virtual tiki, that local file will be preferred, in same order than in main tiki in case of styled
templates.
Ok. I lost you. Here is an example :
• templates/lir.be/styles/moreneat/tiki-showpage is used if exists, else
• templates/lir.be/tiki-showpage is used if exists, else
• templates/styles/moreneat/tiki-showpage is used if exists, else
• templates/tiki-showpage is used (because it exists)

About how the hell tiki knows what virtual to use, it's located in db/tiki-db.php. That file tests the
hostname and attribute it to the tikidomain variable that is the name of the subdirs used. Nothing
very complicated. If you have multi-named hosts you can change that code to fit your needs. That's
also where can be solved the case of subdirs (rather than virtual domains) by testing on url path.

mose?

OPTIONAL
MULTITIKI ON SUBDOMAIN ONLY

To do multitiki according to the subdomain name (www, subdomain1, subdomain2...) whatever the
main domain name is, add the following lines to tiki-db.php after line 55. That will select the
database
according to subdomain only. You must then have run the script to create the directory for
subdomain.
$pattern="(.*)\.(.*)\.([[:alpha:]]{3})";
eregi($pattern,$_SERVER['HTTP_HOST'],$results);
$subdomain=$results[1];

then this line after conditions on HTTP_HOST

elseif (isset($_SERVER['HTTP_HOST']) and is_file('db/'.$subdomain.'/local.php'))
{
$multi = $subdomain;

END MULTITIKI ON SUBDOMAIN ONLY

Note
Before 1.9rc4, make sure you have $tikidomain_multi = true; in db/tiki-db.php
Since 1.9rc4 that is not necessary anymore.
More
InstallVirtualHosting?

feedback is welcome, feel free to edit that page for adding or changing

Back to TOC 65
 2.5.3.2. Multitiki Akira

This is an installation guide, and it describes how to setup multiple tiki sites using one install but
NOT using Virtual Hosting.
by UserPageakira

In my example I am using Red Hat 7.3, apache 1.3.27-4, php-4.1.2-7.36, mysql-3.23.58-1.73.

The key to this example is that I want multiple sites but only under one hostname.

First setup your databases. I have chosen to create a separate mysql user and password for each
database. You can do this or have a common user/password. If you have a common user/password
you will need to change the code for local.php below. Make sure you follow all the steps for
creating the databases as outlined in the INSTALL file. Also outlined here: RecipeMultiTiki?. Don't
forget to restart mysql.

I plan to put my single tikiwiki install in /var/www/tikiwiki/tikiwiki. Knowing this I setup my

httpd.conf. I am going to use three subdirectories under my one hostname using aliases. Here is
what one looks like, repeat however many times you want changing only the Alias line:
Alias /tiki-test1 "/var/www/tikiwiki/tikiwiki"
<Directory "/var/www/tikiwiki/tikiwiki">
Options Indexes
AllowOverride None
Order allow,deny
Allow from all
##### Overrides the php.ini setting for this directory
#php_value phpa.cache_dir /tmp/phpa_eita_tiki
# PHP settings to allow larger file uploads
php_value max_execution_time 240
php_value memory_limit 60M
php_value upload_max_filesize 50M
php_value post_max_size 60M
</Directory>

Please be careful with the php_value settings. Don't use these unless you know what they are doing.

Restart your webserver.

# service httpd restart

Get a distribution of Tikiwiki from sourceforge.net. Unpack it and place it where you want, creating
directories if you haven't already done so.
# tar -xzvf tikiwiki-1.8.1.tar.gz
# mkdir /var/www/tikiwiki
# mv tikiwiki-1.8.1 /var/www/tikiwiki/tikiwiki
# ln -s tikiwiki/ tikiwiki-1.8.1 (I do this so I can quickly see what version I

66 Back to TOC
 Tikiwiki Documentation 1.9+

currently have installed)

Next we create the databases through the web install script. Load http://your-domain.com/tiki-
test1/tiki-install.php. First fill in the first database and account information. Submit and go to the
next screen. Chose the type of database you want to create or update and submit the form. Next
click "Execute the Tiki installer again". Then click "Reset database connection settings" and enter
your next install's database information. Rinse and repeat these steps for as many sites as you are
creating. Once you have created the last site click "Rename/remove tiki install script and proceed to
site."

We need to run setup.sh to setup the files and directories for tiki as well as for the multiple sites.
Replace tiki-test1, tiki-test2 and tiki-test3 with the alias names you used above in httpd.conf.
# ./setup.sh apache apache 02755 tiki-test1 tiki-test2 tiki-test3

Now we want to edit db/local.php. The custom php below does what I want. It extracts the web path
from the variable "$SCRIPT_URL". For each site you will need a "case" stanza. The case stanza
should include database user/pass/name information as well as the tikidomain variable which we
chose above when running setup.sh. If you want to have one mysql user/pass for all sites you would
move the $user_tiki and $pass_tiki of the switch section, placing it just below $host_tiki.
1 . <?php
2 .
3 . $db_tiki = 'mysql';
4 . $dbversion_tiki = '1.8';
5 . $host_tiki = 'localhost';
6 .
7 . switch ( extractTopPath( $SCRIPT_URL ) ) {
8 . case '/tiki-test1/':
9 . $user_tiki = 'tiki-test1';
10 . $pass_tiki = 'foobar1';
11 . $dbs_tiki = 'tiki-test1';
12 . $tikidomain = 'tiki-test1';
13 . break;
14 . case '/tiki-test2/':
15 . $user_tiki = 'tiki-test2';
16 . $pass_tiki = 'foobar2';
17 . $dbs_tiki = 'tiki-test2';
18 . $tikidomain = 'tiki-test2';
19 . break;
20 . default:
21 . exit();
22 . }
23 .
24 . function extractTopPath( $in ) {
25 . if ( ( $point = strpos( substr( $in, 1 ), "/" ) ) === false )
return ( $in . "/" );
26 . return substr( $in, 0, $point + 2 );
27 . }
28 .
29 . ?>

Back to TOC 67
I HIGHLY recommend making local.php read-only for user apache. Should you follow these steps
later on for a new site and use the tiki-install.php web script to create a new database it WILL
overwrite local.php.

Now you are ready to configure each site! Since tikiwiki uses cookies we have to make sure the
cookies know which site you are at. To do this you need to login as admin and go to the Login
administration page. Toward the bottom is HTTP(S) server name, HTTP(S) port and HTTP(S) URL
prefix. You will want to fill the appropriate fields in. For my example site I would fill these fields in
like this:
HTTP server name domain.com
HTTP port 80
HTTP URL prefix tiki-test1/

If you are going to use the remember me feature you will also want to fill out these fields:
Remember me domain, Remember me path.
For my example site I would fill these fields in like this:
Remember me
domain.com
domain
Remember me path tiki-test1/

After that you should be able to login to each site and configure them and everything will be
separated!

If you have any questions or suggestions please leave them in the comments of this page.

-Akira

2.5.4. Rewrite Rules

Using the Rewrite Engine in your Apache or similar options in your web server, its possible to
shorten URLs to your information.

With Rewrites enabled you can access your articles, wiki pages or any other TikiWiki item using
URLs similar to these:
http://tikiwiki.org/TikiWiki -> http://tikiwiki.org/tiki-index.php?page=TikiWiki
http://tikiwiki.org/forum4 -> http://tikiwiki.org/tiki-view_forum.php?forumId=4
http://tikiwiki.org/art133 -> http://tikiwiki.org/tiki-read_article.php?articleId=133

However, links generated by Tiki (in wiki pages or menus for example) will continue to have the
long format (which still work). There is a mods addressing this.

Since Tiki 1.9.3, an htaccess file is now available directly in the Tiki download. Just rename

68 Back to TOC
 Tikiwiki Documentation 1.9+

_htaccess to .htaccess
It is not activated by default because it may not work with all server configurations.

2.5.4.1. Bundled Rewrite Rules

<FilesMatch "\.(bak|inc|lib|sh|tpl|sql)$">
order deny,allow
deny from all
</FilesMatch>

RewriteEngine On

# direct one-word access

RewriteRule ^calendar$ tiki-calendar.php [L]
RewriteRule ^articles$ tiki-view_articles.php [L]
RewriteRule ^blogs$ tiki-list_blogs.php [L]
RewriteRule ^categories$ tiki-browse_categories.php [L]
RewriteRule ^charts$ tiki-list_charts.php [L]
RewriteRule ^chat$ tiki-chat.php [L]
RewriteRule ^contact$ tiki-contact.php [L]
RewriteRule ^directories$ tiki-directory_browse.php [L]
RewriteRule ^eph$ tiki-eph.php [L]
RewriteRule ^faqs$ tiki-list_faqs.php [L]
RewriteRule ^files$ tiki-file_galleries.php [L]
RewriteRule ^forums$ tiki-forums.php [L]
RewriteRule ^images$ tiki-galleries.php [L]
RewriteRule ^galleries$ tiki-galleries.php [L]
RewriteRule ^games$ tiki-list_games.php [L]
RewriteRule ^login$ tiki-login.php [L]
RewriteRule ^my$ tiki-my_tiki.php [L]
RewriteRule ^newsletters$ tiki-newsletters.php [L]
RewriteRule ^quizzes$ tiki-list_quizzes.php [L]
RewriteRule ^stats$ tiki-stats.php [L]
RewriteRule ^surveys$ tiki-list_surveys.php [L]
RewriteRule ^trackers$ tiki-list_trackers.php [L]
RewriteRule ^irc$ tiki-irc_logs.php [L]
RewriteRule ^mobile$ tiki-mobile.php [L]
RewriteRule ^wml$ tiki-mobile.php [L]
RewriteRule ^sheets$ tiki-sheets.php [L]

# access any object by its numeric identifier

RewriteRule ^article([0-9]+) tiki-read_article.php?articleId=$1 [QSA,L]
RewriteRule ^art([0-9]+) tiki-read_article.php?articleId=$1 [QSA,L]
RewriteRule ^cat([0-9]+) tiki-browse_categories.php?parentId=$1 [QSA,L]
RewriteRule ^blog([0-9]+) tiki-view_blog.php?blogId=$1 [QSA,L]
RewriteRule ^blogpost([0-9]+) tiki-view_blog_post.php?postId=$1 [QSA,L]
RewriteRule ^chart([0-9]+) tiki-view_chart.php?chartId=$1 [QSA,L]
RewriteRule ^directory([0-9]+) tiki-directory_browse.php?parent=$1 [QSA,L]
RewriteRule ^eph([0-9]+) tiki-directory_browse.php?parent=$1 [QSA,L]
RewriteRule ^faq([0-9]+) tiki-view_faq.php?faqId=$1 [QSA,L]
RewriteRule ^file([0-9]+) tiki-list_file_gallery.php?galleryId=$1 [QSA,L]
RewriteRule ^dl([0-9]+) tiki-download_file.php?fileId=$1 [QSA,L]
RewriteRule ^forum([0-9]+) tiki-view_forum.php?forumId=$1 [QSA,L]
RewriteRule ^image([0-9]+) tiki-browse_gallery.php?galleryId=$1 [QSA,L]
RewriteRule ^gallery([0-9]+) tiki-browse_gallery.php?galleryId=$1 [QSA,L]
RewriteRule ^newsletter([0-9]+) tiki-newsletters.php?nlId=$1 [QSA,L]
RewriteRule ^quiz([0-9]+) tiki-take_quiz.php?quizId=$1 [QSA,L]
RewriteRule ^survey([0-9]+) tiki-take_survey.php?surveyId=$1 [QSA,L]
RewriteRule ^tracker([0-9]+) tiki-view_tracker.php?trackerId=$1 [QSA,L]
RewriteRule ^wiki-([A-Za-z0-9]+) tiki-index.php?page=$1 [QSA,L]
RewriteRule ^page-([A-Za-z0-9]+) tiki-index.php?page=$1 [QSA,L]

Back to TOC 69
RewriteRule ^irc([0-9]+) tiki-irc_logs.php?focus=$1 [QSA,L]
RewriteRule ^int([0-9]+) tiki-integrator.php?repID=$1 [QSA,L]
RewriteRule ^sheet([0-9]+) tiki-view_sheets.php?sheetId=$1 [QSA,L]

# todo add support for all characters allowed in a Wiki name

# make sure this is the last rule!
RewriteRule ^show:(~?)([-_\+A-Za-z0-9]+)$ tiki-slideshow.php?page=$1$2 [QSA,L]
RewriteRule ^([-_\+A-Za-z0-9]+)$ tiki-index.php?page=$1 [QSA,L]

#for multi-byte char support use

RewriteRule ^/([^a-z]+)([^\/]+)([^tki-]+)(.*[^.js]+)(~?)(.*)$ tiki-
index.php?page=$1$2$3$4$5$6$7$8$9 [QSA,L]

If you manage your server, be sure

• to load the rewrite module. Something like this line in httpd.conf: LoadModule
rewrite_module modules/mod_rewrite.so (adjust the path if necessary). You can check it is
ok if you see the mod_rewrite in the apache loaded modules.
• to enable the access to .htaccess. To do so you must have lines like
<Directory "/">
...
Options FollowSymLinks
AllowOverride FileInfo
...
</Directory>
Adapt the directory path to your need. This block can be in httpd.conf or in your virtual host
config(vhosts.d directory in apache2)
• restart your server

2.5.5. ImageMagick Install

2.5.5.1. Install ImageMagick

For those that use the image gallery in tiki, note that GD is used by php for image processing. But
GDlib comes with some restrictions on file formats, especially regarding GIF use. Support for
Image Magick is added now, that offers a wider range of available file formats.

2.5.5.2. Install ImageMagick and Libs

Get Image Magick from http://www.imagemagick.org/www/archives.html

• Be sure to install the libraries.
• On RPM based system (RedHat, Mandrake)
rpm -q libMagick5
libMagick5-5.4.8.3-2mdk
• On APT based system (Debian, Knoppix)
apt-get -s install imagick

70 Back to TOC
 Tikiwiki Documentation 1.9+

2.5.5.3. Install Imagick PEAR Module

Get the PEAR module from http://pear.php.net/package-info.php?pacid=76

• Windows Users can download a dll from http://php.chregu.tv/php_imagick.dll which has to
be placed into /php/extensions, add
extension=php_imagick.dll

to php.ini, and finally copy all the dll files from ImageMagick installation root directory to
/windows/system32.
• Debian sid users have that package : apt-get install php4-imagick
• Other users have to compile it. To compile it, you have to recompile your PHP Get the PHP
sources on http://php.net, read the INSTALL file from the imagick module and ./configure
PHP with --with-imagick
Special Tip :
If your compilation stops, There are 2 Bugs:
• do a "rm ./configure" in your php src directory before performing Step 8 of the INSTALL-
file of imagick.
• edit imagick.c (Version 0.95) Line 624 should be "RunlengthEncodedCompression" not
"RLECompression", this may depend on your libMagick however your make should tell you
the right way. Install your new PHP, restart your webserver. Do a phpinfo() to see if Imagick
support is added. If not, you may have forgot to rm ./configure.

2.5.5.4. Tikiwiki setting up

In the Image Gallery Config select Imagick as Library to use for processing images. If PHP is
unable to find the PHP Imagick the setting reverts back to GD.
Useful Links
• Next Version of the PEAR module will work with GraphicsMagick too:
http://graphicsmagick.sourceforge.net/

2.5.6. GraphViz Install

2.5.6.1. Graphviz Install

Graphviz provides a collection of tools for manipulating graph structures and generating graph
layouts.

For those who would like to use Dynamic SiteMap graph generation in Tikiwiki, we
recommend the Graphviz library and the Wikigraph plugin?.

2.5.6.2. Install Graphviz and Libs

• On Windows the default installer exe should do all necessary steps.

Back to TOC 71
 Get Graphviz from http://graphviz.org/pub/graphviz/ .
• On RPM based system (RedHat, Mandrake)
rpm -q graphviz
• On APT based system (Debian, Knoppix)
apt-get -s install graphviz
• For Portage users (Gentoo)
emerge graphviz

2.5.6.3. Testing an installed Graphviz Setup

Point your browser to

http://127.0.0.1/tiki-wiki_graph.php?page=HomePage&level=2

2.5.6.4. Troubleshooting Hints

• Graphviz consumes LOTS of memory with even small (no. of wikipages less than 100) wiki
content. Try to keep the Level of the graph low in order to use wiki pages including dynamic
graphs.
• you use Windows, copy GraphViz binary files (dot.exe, neato.exe, etc) from the GraphViz
bin folder to the windows\system32 or equivalent folder (NaV/system32). The installer
should have done this job for you, but we recommend double-checking if you encounter
errors. It's not the same to put the exe's in the path, they must be in a Windows system
directory.
• In PHP Safemode environments, special adjustments need to be made to use external
libraries.
• These settings will be included here.

From Here
• Take a look at how to use the Wikigraph plugin?.

Useful Links
• Development home of the Graph Visualization Project
http://graphviz.org/
• GraphVIZ Reference Manual
http://www.research.att.com/sw/tools/graphviz/refs.html
• Download Graphviz
http://www.research.att.com/sw/tools/graphviz/download.html
• Graphviz Source License
http://www.research.att.com/sw/tools/graphviz/license/index.html
• Graphviz Binary License

72 Back to TOC
 Tikiwiki Documentation 1.9+

http://www.research.att.com/sw/tools/graphviz/license/binary.html

2.6. TroubleShooting
Installation Problems - A Symptom / Diagnosis page
Admin Problems - Problems and errors which occur while using Admin pages.
Wiki Problems - A Symptom / Diagnosis page
Theme Problems? - A Symptom / Diagnosis page
Smarty Errors? - Create a page for each type of
PHP Errors? - Create a page for each type of error message
Error Messages - For errors within the CMS
Database Errors - For errors related to the database.
Lost edit - a list of ways to lose your edit.
Lost admin password - it happens sometimes.
Full list of related pages
• Wiki Problems
• Tikiwiki Performance Tuning
• Login Problems
• Installation Problems
• Install Tiki Help
• Get Help
• Error Messages
• Documentation Status,nl
• Documentation Status Tracker
• Database Performance
• Database Errors
• Admin Problems

2.7. Upgrade
Upgrading Tiki is easy when you have mastered its installation.

1. Create a Backup

See: Backup
Note: To protect your content, you must backup your database. Before you upgrade, make sure you
have a backup of your sql database.

Back to TOC 73
 2. Choose an upgrade path.
Like most software, you should not attempt to upgrade a very old installation to a very new one.
Some upgrades include changes to the database, some do not. If you skip over an upgrade that
contains a database change, this change may not be included in later versions of the database
upgrade scripts.

Frequently used upgrade paths.

• Upgrade 1.7 to 1.8
• Upgrade 1.8 to 1.9
• Upgrade 1.9.x to 1.9.7 - Current release
• Upgrade 1.9.7 to 1.10 - stable "beta"

3. General Notes:

Warning: follow only the specific instructions for each upgrade path. - This is just an overview.

On the tiki-install.php page of this "new" site connect to the same database as your current site and
run the various sql upgrade scripts if needed. You can run the upgrade scripts several times, they are
meant to be not destructive. You may need to run for instance 1.8 to 1.9 then 1.9 to 1.9.7 (if exists),
in case your current site is on 1.8 and want to upgrade to 1.9.7.
Do not run the install sql scripts or you will delete your current database

Proceed as usual to the wiki site while disabling the tiki-install.php script.
Check your new web site contains everything from the old web site. Things that you may need to
copy from your old site to your new site:
• img/wiki_up folder content (wiki images)
• some customised tpl
• some customised styles (css)
• some customised wiki-plugins and pages

When you are happy with the result delete the directory structure of the old site and move the
directory of the new site in place. In fact on linux you can use a symlink instead, making upgrade
easy.
ln -s tikiwiki-1.9.7 tiki

4 Upgrade your Theme

If your site uses a custom theme, you will need to copy the all the appropriate css file and image
folder from the /styles folder, the custom templates from the templates/styles folder, and upgrade

74 Back to TOC
 Tikiwiki Documentation 1.9+

yout css to include any new classes. Between releases, css? classes are often added to accommodate
new features. You will find the list of the changes in the directory styles/transitions/ in the
downloaded install package. These are named something like version_to_version.css. To update
your css file, add the new classes and update at the top your file a line that give the Tikiwiki version
your css is. For instance
@version:1.9

For a more detailed description, read Styles and Themes

2.7.1. Upgrade 1.8 to 1.9

Upgrading from Version 1.8.x

1. Clear templates and module cache in Admin -> System Admin
2. Backup your existing database (use the command mysqldump or use phpMyAdmin)
3. Download the 1.9.x package from our SourceForge Project Area
4. Uncompress the 1.9.x package
5. Upgrade your database (see below)
6. Copy over the contents of the 1.9.x tiki dir to your exisiting tiki web root (eg
/var/www/html/tiki)
• Linux users can use: cp -R tiki/* /var/www/html/tiki/
• Windows users equiv: xcopy tiki\* c:\inetpub\wwwroot\tiki\ /e
7. Run setup.sh again to verify the correct permissions are set (read Installation again if you
don't remember how to use this script)
8. Remove the contents of templates_c, the temp and modules/cache directories

You should now be running a 1.9.x site.

Notes:
• Do not delete the 1.8.x directory and uncompress tiki 1.9.x over. You may loose images
uploaded in wiki or custom avatars or some other content. If you want to have a clean install
(no old files) then make a backup of the 1.8.x installation directory before you do that.
• You can use the secdb database files to check your installation directory for old/modified
files. See AdminSecurity

Upgrading the database

Upgrade scripts are located in the "db" subdirectory and are run with this mysql command:
mysql -f -u dbuser -p tikidb < tiki_1.8to1.9.sql

where "dbuser" is the name of a mysql user with sufficient privs in the tiki db to modify that table
structures and data rows (probably root), and "tikidb" is the name of your tiki database. The -p is
only needed if you have a password on the database (which is highly recommended). The -f is

Back to TOC 75
required to force all the updates to occur.

(Note: If you are upgrading to 1.9.y from a previous 1.9.x, you will also need to run the
1.9.xto1.9.y.sql script)

You can safely ignore any errors, but if the script aborts (as it would without the -f), then your
database will be missing part of the update.

Upgrading your css file

The new classes that have been added from 1.8 to 1.9 are listed in the file
styles/transitions/1.8to1.10.css

Warnings
Please also see the following links if you want to upgrade to the latest stable version of Tikiwiki
from either 1.8.x or 1.9.x

Other warnings:
• 1.9.0 does contain security issues, you are advised to upgrade straight to release 1.9.3.1, at
least, or to the latest stable version (without installing 1.9.0)
• As with any new stable version, you can expect minor bugs with 1.9.x branch. Please report
them on http://dev.tikiwiki.org/tracker5
Any sane admin with a valuable Tiki will want to backup its database before the upgrade,
using MySQL (for example mysqldump or phpMyAdmin).
plus backup daily in case of problems.
• Upgrading will require a number of files. Leaving tiki-install.php or sql files after upgrading
is a bad idea that could potentially help people to screw up your Tiki.

Upgrading from before 1.8

• Please see the UpgradeTo18 page, and follow the steps carefully

Related information
• Upgrade
• Installation
• Backup

2.7.2. Upgrade 1.9.x to 1.9.7

This page explains to to upgrade any Tikiwiki installation of the 1.9.x branch (1.9.0, 1.9.1, 1.9.2, ...)
to the latest version of the stable 1.9.x branch.

2.7.2.1. First Backup whole filesystem and database

76 Back to TOC
 Tikiwiki Documentation 1.9+

2.7.2.2. Upgrade:

Download the tar-ball from sourceforge and have it transfered to your server. We assume that you
have not changed any tikiwiki-files (php, tpl, ... -files); if you have, then make a backup of your
modified files, to put them back to your installation after the basic upgrade is performed.

Very strange bug in the upgrade script, affecting Internet Explorer. Please use Firefox and not
IE to upgrade your Tiki to 1.9.7 If you want to use IE, please replace your templates/tiki-install.tpl
with this one . For more details , please see Revision 1.34.2.47

1. Untar it somewhere
(windows users might like to use the free software program 7-zip, translated to many
languages, for decompressing any of those file formats)
2. copy it over your existing tikiwiki source (replace files)
3. Run tiki-install.php (or tiki-install.php?lang=XX to have the installation menssages in a
language other than English, if it has been translated already) to login as admin

After that, you will see the main install & upgrade screen

Back to TOC 77
 4. In Upgrade section, select tiki_1.8to1.9.sql

5. Click on "Do nothing and enter Tiki", at the bottom of the page

78 Back to TOC
 Tikiwiki Documentation 1.9+

6. log into the tikiwiki as admin and check the preferences

7. done!

2.7.3. Upgrade 1.9.7 to 1.10

First Backup whole filesystem and database

2.7.3.1. Upgrade:

Download the tar-ball as tar.bz2 or zipped file.

Have it transfered to your server. We assume that you have not changed any tikiwiki-files (php, tpl,
... -files); if you have, then make a backup of your modified files, to put them back to your
installation after the basic upgrade is performed.
1. Untar it somewhere
(windows users might like to use the free software program 7-zip, translated to many
languages, for decompressing any of those file formats)
2. copy it over your existing tikiwiki source (replace files)
3. Run tiki-install.php (or tiki-install.php?lang=XX to have the installation menssages in a
language other than English, if it has been translated already) to login as admin

Back to TOC 79
 After that, you will see the main install & upgrade screen

4. In Upgrade section, select tiki_1.9to1.10.sql

80 Back to TOC
 Tikiwiki Documentation 1.9+

5. Click on "Do nothing and enter Tiki", at the bottom of the page
6. log into the tikiwiki as admin and check the preferences
7. done!

Back to TOC 81
 (page intentionally left blank)

82 Back to TOC
 Tikiwiki Documentation 1.9+

3. CONFIGURATION

Back to TOC 83
 (page intentionally left blank)

84 Back to TOC
 Tikiwiki Documentation 1.9+

3. Configuration

3.1. Quick Start

This page is an overview of the steps required to start a Tikiwiki as a site administrator.

For non-administrators (end users) wishing to learn how to use various features in tikiwiki, see
Features.

3.1.1. Installation
The first step to creating your Tikiwiki is installing the software and creating a database.

Please review the Tiki installation instructions. installation:

1. Have a working environment (database server, webserver with php)
2. Download latest official Tiki release
3. Extract into web hosting directory of webserver
4. Create and use database for Tiki in database server
1. Create tikidatabase
5. Create tikisqluser, assign tikisqluser password
6. Assign permissions on tikidatabase to tikisqluser
7. Edit db/local.php to include: tikisqluser, tikisqluser password, tikidatabase
8. Setup Tiki permissions and folders in web hosting directory - (setup.sh)
9. Open Tiki in web browser: http://127.0.0.1/tiki-index.php?lang=XX (being XX the two
letter code of your local language)
10.Choose a Profile to start your Tiki with it pre-configured.
11.Login using username admin, password admin

When you log in to your successful installation, you will be greeted by the default configuration,
opening the Wiki features default HomePage.

3.1.2. Features Administration

Once installed, choose the features you would like to offer in your Tiki. Tikiwiki has a wide variety
of features to choose from; wiki, news article, blog, workflow management, forums, and much
more. Be warned that the array of choices can be mind-boggling, so you might want to get
acquainted with the Tikiwiki community and find a mentor to advise you on your implementation
and to lend a hand up the steepest parts of the learning curve.

for more info: Features Admin

Back to TOC 85
Most of the main features have their own administrator panel, to configure that particular feature.
Once you choose the features you want, then visit the appropriate admin page for each feature. In
doc.tikiwiki.org, most features have an admin page ((featurename admin)) which describes the
configuration options available.

You may also be interested in turning on Image Gallery or File Gallery features.

3.1.3. Groups and Users

Once you have dictated what your Tiki is to be user for, establish by whom it shall be used.

3.1.3.1. Registration Privileges

Is your Tiki open to the public, or is it closed (even for viewing) to a select circle? A full array of
options is available. Most Tikiwiki installations start with three basic user types:
• admin - Each site begins with one "god-level" administrator, who can create/shape/delete
pretty much anything. (There should only be one top level admin by default, don't create
others unless you really really trust them to know what they are doing.)
• registered - Registered users are one of the two user group?s created by default. Administer
the permissions of this group for each feature of your Tiki to reflect the permissions settings
that you intend to be universal.
• anonymous - Anonymous users can be viewed as either:
• users who haven't logged in yet - in which case they get minimal permissions (view
and login/register)
• users who prefer to remain anonymous - in which case you award the group your minimal
permissions across all features you want to allow anonymous participation in.
• lazy/stupid users - Admins who are looking to maximize the contributions (grow content)
are likely to facilitate users who are either too lazy or clumsy to manage logging in
(probably not a small percentage of the traffic). In this case, be aware you are creating a
"wild west" and should maintain surveillance over the changes to your site

see: Login Config.

3.1.3.2. Creating additional groups

In addition to the three basic groups above. You can create other groups, generally for one of the
following reasons:
• junior administrators / site editors - knowledgeable users can have their permissions bumped
up so they can assist in the maintenance and design of the site.
• private user groups - Tikiwiki can be configured using the categories? system to create
private pages and areas on the site that are accessible only to users belonging to a certain
group.

For a quick setup of permissions and features, take a look at Using profiles or learn to use your

86 Back to TOC
 Tikiwiki Documentation 1.9+

custom profile starting from Permission

see also: Groups Management and Users Management

3.1.4. Customize the Appearance of the Site.

3.1.4.1. Choose or design a theme

Themes are the "skins" of Tikiwiki. Themes use a CSS framework to change the look and feel of all
the elements of the site. Tiki comes with a substantial variety of themes installed, some prettier than
others and more robust (not all themes work for all features).

Themes can be applied globally, to specific categories of pages (which can correspond to user
groups.) With the appropriate settings, users can pick their own theme.

It is possible to enable the editing of the .tpl files within Tikiwiki, but most will use a web design
program via FTP to make changes to a template.

3.1.5. Administer the modules

Modules are the "boxes" that surround the main content area of the site. In each module is placed
some "content", a menu, a search field, an image/advertisement, a plugin, etc. Tikiwiki generally
stacks modules on the left and right margin, but with a little programming skill they can be added
pretty much anywhere. Modules can be sorted in any order and made visible/invisible for different
user groups.

To create your own menu in a module and assign it to the columns in Tiki, please read the Menu
HOWTO.

3.1.6. Create content

Once you have established all of the above you (and your users) are ready to start adding the
content to your site.

See: features page for information on how to add/edit content in each of the features you are using.

To learn how to format the content of your wiki pages, read Using Wiki Pages

3.2. Menu HOWTO

This tutorial briefly introduces the use of custom menus in Tikiwiki. We quickly set up a custom
menu, and introduce module assignment to specific groups.

For purposes of this tutorial, we presume you are logged in as admin of your basic Tiki install.

Back to TOC 87
In Tikiwiki we call those boxes visible in the left and right columns Modules. The default Tiki
installation has the application_menu module and the login_box modules assigned.

no s'ha trobat la imatge img/icons2/alert.gif In a default Tiki installation modules are displayed to
all users always.

3.2.1. How to Create a Menu visible to all users

• By default modules are displayed to all users always. See below how-to assign modules to
a specific group.
• First, Create a new Menu: Go to Admin -> Menus and create a new menu. See Menu for
details.
• Include some options in your menu:
• For example the link tiki-index.php could be titled Home as in the default
application_menu.
• Second, Create a new Module: Go to Admin -> Modules and create a new module. See
• Set the Title of the Module as you would like to see the modules/menu title to
appear in the columns.
• The Name of the Module will be used to identify the module as assigned in Module Admin
• Include your Menu in the Module:
• Choose from available Tiki Objects to be included in the Module your new
Menu.
• Or include the menu by typing the resource identifier in the module: e.g.: ''{menu id=1}.
• Finally, Assign your Module:
• Choose your new module to appear in the left or right column in a specified order,
assigned to some group. (As all users can see all modules by default yet, your group
specific assignments will not be seen.)

3.2.2. How to Assign Modules to specific Groups

Now we are going to separate which modules specific groups of user can see and access in your
Tikiwiki.
• First of all, go to Admin -> Modules and we recommend you assign at least the
application_menu and the login_box to the anonymous group. You should also assign your
custom menus and other modules to group anonymous.

You do not have to assign the login_box module. You are always able to log in to your Tiki
using http://127.0.0.1/tiki-login_scr.php.
• Now turn off diplay modules to all groups in Admin -> General.
• If you now log out of your Tiki, there should be no great differences, if you have
assigned your modules to groups.
• From now on, you will be able to assign each module to a specific group, and that module
will be seen by that group as assigned in order in the columns.

The nesting of groups in Groups Management is an easy way of assigning modules to

88 Back to TOC
 Tikiwiki Documentation 1.9+

hierarchies of users.

3.3. Profiles
"Profiles" is a feature used only when you install? Tikiwiki. It sets up the Tikiwiki according to an
existing configuration that was "saved" from another site.

The installer includes options to apply a profile of admin settings. A profile that matches your usual
preferred settings will save you time not having to manually go through each admin screen and
check/uncheck boxes and such.

This feature is only active during the installation process. You cannot go back and pick a different
profile unless you re-install the database, losing all your changes.

Selection of profile at http://yourdomain/tiki-install.php?lang=XX

General Description
Profiles give the installer a choice of partially configured sites to install. The intent is to give a head
start on the configuration process by picking a type of site that is similar in purpose.

Key Function and sub-features

This feature is only active during the installation process. You cannot go back and pick a different
profile unless you re-install the database, losing all your changes.

Details of Supported Profiles

Only add here Profiles available to download somewhere or in CVS.
TikiProfilesDefault
TikiProfilesSlash
TikiProfilesFishclub
TikiProfilesBasicEnabled
work has started on a:
• Social Event Management System Profile

Back to TOC 89
 • TikiProfilesNGO, for non-governmental organizations (NGO).

Typical Uses
• test suite : build a collection of samples representative of data in different quantity, using
every features, for use with a testuite.

For more information

• Using profiles
• TikiProfilesDev

3.3.1. Using profiles

3.3.1.1. How can a new profile be created?

There is a shell script to create one in the doc/devtools directory (only included within CVS
checkouts, i.e. .tar.gz files don't have it).

Basically create a blank database, go through your admin settings and then run the script.

3.3.1.2. Step by step

Before starting, you should decide on a short name for the file and also a somewhat longer
description of the profile. You will also need to define what features, groups, and group permissions
you want to include. A good practice would be to create this info as a wiki page here on tikiwiki.org
and then when you are finished and it is uploaded to cvs, you just link the page describing your
profile into Using profiles where they are documented.
1. Prepare a Tiki instance as a reference point. This can be a new install where you configure
all the needed feature as and groups, or an existing site that you want to model the profile
after.
2. Perform a mysql dump of the refernece site's DB
3. cd db/profiles
4. ./mk_profile.sh <dumpfile name> <profile name>
5. Edit the resulting .prf file to remove personal, inaccurate or un-needed inserts, e.g.
'feature_server_name', 'cookie_path' and 'cookie_domain'. Change the comment on the first
line to have a better description.
6. Test your new profile. It will show up automatically if it is in the db/profiles dir and has an
extension of prf.
7. Document in Wiki page linked to Using profiles
8. Upload prf file to CVS

90 Back to TOC
 Tikiwiki Documentation 1.9+

3.4. Advanced Configuration

There are some more steps that can be followed to configure further your tiki site. Some of them are
listed here:

After that, you may wish to install and configure some Mod for your site, so that you can extend
Tiki with features not provided by default inside the installation package by default, but installed
optionally in a later stage by the admins of the tiki site.

3.4.1. Site Identity

The quickest way to customize a Tiki site is to use its built-in Site Identity feature. While not
"theme-making" in the full sense, it is mentioned here because it is related and might be used in
conjunction with other aspects of site design.

3.4.1.1. General Description

Site Identity feature helps an admin to simplify the customization process of his/her site. Instead of
manually hacking the code of the template (*.tpl) files, you can have your own Site Header area
with Site Logo and more optional elements set up directly from Tikiwiki Admin section. Site
identity was introduced in Tiki 1.9.x

3.4.1.2. Key Function and sub-features

Site Identity can be enabled by switching the checkbox on (off by default) at Admin -> (Admin
Home ->) Features page. The main sub-feature is the Site Logo which will appear on the top Site
Header of every Tikiwiki page and by default it links to the index page ("./") of the used site as is
common.
Site Identity Settings can be found on Admin -> (Admin Home ->) Site Identity (it used to be on the
General settings page).

Currently you can:

• enable Site Location bar (aka breadcrumbs)
• customize the Site Logo image source, background color, title and alt attributes
• put your own Custom Code in the Site Header
• setup banner zones and enable the Banner area
• enable Site Search bar

This is the admin interface at "Admin -> (Admin Home ->) Site Identity"

Back to TOC 91
92 Back to TOC
 Tikiwiki Documentation 1.9+

3.4.2. Group
In Tikiwiki, Groups are the primary means to control permissions settings and access to categories
of objects in your web site. It is one of the features that makes Tikiwiki stand out from the other
wiki/cms software out there.

Using groups and categories, you can create your own "wiki hotel" where any number of groups

Back to TOC 93
can have private "rooms" (sets of pages) that only they (and the site administrators of course) can
access.

Related pages: Groups Management, Permissions

Each group can have a group home page that they are automatically taken to when they log into the
site.

To configure groups goto http://yoursite/tiki-admingroups.php

3.4.2.1. Steps to create a private room:

1. Create a group and a category with the same name e.g: steering (a committee)
2. Have a list of users, you can upload a .csv if you like, either way assign all your users to this
group.
3. Assign pages to the category you created.
4. Assign permissions to the category such that the permissions view_categories and
admin_categories are awarded to the appropriate group.
5. Ensure that any new pages created are included in the category as well, otherwise they will
not be protected.

Tikiwiki, moreover, has another way to manage groups, categories and permissions in a more
flexible and advanced way, but if you are new to Tikiwiki, you will be fine adding groups,
categories and permissions step by step.

When you are an advanced user / admin, and you need to manage large sets of groups with some
frequency (like educational scenarios), you can take profit of the "Workspaces" feature (included in
"AulaWiki" Mod).

3.5. Mods
(A modular install for Tikiwiki components)

The tikimods feature is in 1.9+ Tikiwiki release the new tool for distribution, install, upgrade and
removal of Tikiwiki components, also called mods. A Mod can be a feature, a plugin, a module, a
theme, a language file, a replacement for an existing feature, or a combination of all the previous
items.

The tikimods tool is available in versions 1.9 and above. Tikimods allows you to distribute, install ,
upgrade and remove a Tikiwiki Mod. Mod's can consist of features, plugins, modules, themes,
language files, or any combination of those packaged together. Here are two examples:

Modules:Clock is a single module that allows you to put a clock in the left or right column.

tinvoice is a feature that will allow you to generate invoices from Tikiwiki. This mod consists of
many files including php files, templates, and sql statements to create additonal tables.

94 Back to TOC
 Tikiwiki Documentation 1.9+

Basic principle
The Tiki Mods behaves like many package management software that is known in the unix world,
and could be compared to the debian apt, the redhat yum; mandrake urpmi; or gentoo emerge, but
adapted to the tikiwiki environment. It's a web-based tool for update operations on some tikiwiki
extensions. It fulfills the following functions:
• listing of a remote mods server, by default http://mods.tikiwiki.org/
• maintenance of locally stored mods : comparison with remote, downloading of new versions
• installation of local mods, upgrade and removal

Related pages
• Mods User
• Mods Admin
• Mods Details

3.5.1. Mods User

3.5.1.1. Where to get them from

You can get them through two processes:

1. Download them from http://mods.tikiwiki.org, and install them by hand
2. Download and install them directly from "Admin -> Mods" (tiki-mods.php)interface in
your tiki web site

Back to TOC 95
 1. Manually from mods.tikiwiki.org

96 Back to TOC
 Tikiwiki Documentation 1.9+

2. Automatically from tiki-mods.php web interface

3.5.1.2. Installing a Mod

We will see the process of installing a Mod through the Web interface, while installing AulaWiki
Mod, as example.

You can see a short video here (using an old mods repository) :
http://netdrive.montclair.edu/~schwarj/vids/aulawiki/install/aulawiki_install.html

Alternatively, you can keep reading below.

First you should click on Admin mods, as shown in Figure 1:

Figure 1

The mods page will open and you will need to change the server to get the latest package, because
the original one offered is not current. So click on Mods configuration, see Figure 2:

Back to TOC 97
Figure 2

When the configuration page opens, you'll have the chance to define the mods provider you want to
use. By default, you can use http://mods.tikiwiki.org as in the picture

Figure 3

There we could switch to use other mod providers. In this case, change the settings and click on the
Save button. then click on the Mods Install/uninstall link to bring you back to the mods page (see
Figure 3). Usually you don't need to change the mods provider, since mods.tikiwiki.org tend to be
the most updated and complete one to use.

Now you will need to download and install the package. You may need to go to the root of your
install and run the fixperms.sh script to allow you to install this. To ensure that you have the latest
version, click on Update remote index (Figure 4). Lets say that the latest version is 0.5 (change for
newer version were needed in the following instructions and figures). Click on the link 0.5 as
circled in red on the left. The last step is to install the package by clicking on the link install that is
circled in red on the right (see Figure 4).

98 Back to TOC
 Tikiwiki Documentation 1.9+

Figure 4

If you already have an earlier version of the Mod installed on your site (for instance, 0.5 and the
latest version is 0.6), then you'll have the option to upgrade your Mod (you'll see the option 0.5 >
0.6). Click on the >0.6 link next to the install field to upgrade your AulaWiki Mod.

There are a few ways to get the menu to refresh to bring up the Aulawiki options. But your best bet
is to log out and then log back in.

Further instructions on the usage of this Mod can be found at:

http://edu.tikiwiki.org/tiki-index.php?page=AulaWiki
Related pages
• Mods
• Mods Admin
• Mods Details

3.5.2. Mods Admin

3.5.2.1. Requirements

For being able to move files around in tikiwiki file tree, apache user needs to be granted the right to
do so, which shouldn't be the normal setting. You can enable that permission setting by
./setup.sh www-data all

or nobody, apache or anything instead of www-data, as far as it matches with the apache user
./fixperms.sh open

Back to TOC 99
After mods operation, the perms have to be setup back to the previous state, which depends your
environment.
./fixperms.sh fix

and when requested give the name of the files owner, which depends if you use CVS.
Note that Windows users don't have to bother with perms.

If permissions are not set correctly, you might see a message like this one:

3.5.2.2. Mods panels

tiki-mods.php
It is the main mods management panel. It displays a list of both local and remote mods listed in
index (00_list) files.
The top link row proposes 3 links :
• Mods configuration leads to the configuration panel
• Update remote index rebuilds the list of remote mods from the mods provider configured
in the admin panel
• Rebuild local list rebuild the list of local mods, by reading all the control files
If the mods provider option is enabled, there are 3 more links :
• Republish all rebuilds and upgrades all available packages from local ones
• Publish all publishes all packages
• Unpublish all unpublishes everything
The table displayed below the links row is basically listing the index informations :
• the rows are displaying all mods, separated by types
• if the mods provider checkbox is checked, the first column displays the publication status of
the mod, with a link to publish or unpublish it. That operation mainly rebuilds the
00_list.public.txt file by adding or removing the mods of that row. The version number of
the packaged tarball is displayed, and if local verison is more recent, and upgrade link
(republish) is visible.
• the next column is the version available remotely, with a link to download it. That is the first
column is you are not providing mods to others

100 Back to TOC

 Tikiwiki Documentation 1.9+

• then the name of the mods. If the mod is present locally, a link leads to the detailed view of
the mods.
• next columns are revision number, licence and description
• the last column is only displayed if the mod is present locally (either downloaded from
remote provider either built locally and specific to your use)
• if the mod is not installed, an install link is the only thing displayed
• otherwise, the columns holds 3 parts :
• the status of the revision : up to date, or not
• the status of installation (basically installed but more can come there)
• a link to remove the mod from tikiwiki (but it will still remain in the local mods repository
• when a local mod is clicked, the mods table is displayed with the specific mod information
displayed just below eth row of the selected mod, reading the control file and displaying
author, lastmod, changelog, as well as list of files contained in that mod (and ultimately any
information available about that selected mod).

tiki_mods_admin.php
That is the mods cobnfiguration panel, that for now handles 3 parameters
• a checkbox for being a mods provider. It will add the 'publish' link in each row of the mods
main panel
• the local mods directory
• the url of the remote mods provider

3.5.2.3. Mods Provider

The mods features make possible for anyone to become a mods provider, for local or specific
releases. The tikiwiki.org repository should be the collective one, and other repositories can either
provide the same repository (which is the cvs module named mods on sourceforge) for local areas
as mirrors for faster access, or be dedicated to personal development, as it's rather easy to build a
new mod following the above guidelines.
• the publish link will add the mod to 00_list.public.txt for remote reading
• that link also build the tarball in mods/Dist/ directory, with name syntax type-name-
revision.tgz, using the tarlib (no exec needed).

Back to TOC 101

3.5.3. Mods Details

3.5.3.1. Morphology

Each Mod is defined by a type and a package name. the types are arbitrary strings to group mods in
mods families. The initial set is composed of avatars, icons, menus, themes, languages, sqlupgrade,
wikiplugins, features, services ... more types can be added with time, but please do not add wild
types. New types should be only added after proper discussion with knowledgeable people
(whatever that means for you).

A mod is managed by a control file with following characteristics :

• follows name convention type-name.info.txt
• stored in mods/Packages/ dir typically
• the syntax of this file is intended to be human-readable, composed by parameters and values
• each parameter block is separated by 2 line breaks
• the first line of parameter block is the parameter name, possibly ended by a colomn (:)
which is stripped if present
• the following lines, until a blank one appear, is the value of the parameter
• the initial set of parameters is composed of :
• contributor : the login or name of the one that commits, can use the $Author$ cvs
macro
• revision : the incremental number of the version of the mod. it can follow the revision
number $Revision$ from cvs but not necessarly
• requires : the optional list of required mods by this mods. It must be one line by depend,
each line must be of the form: type-name < | > | <= | >= | = revision (and you can have
multiple revision tests in one line)
• suggests : the optional list of suggesteds mods. Same syntax than requires.
• conflicts: the optional list of mods that conflict with this mod. Same syntax than requires.
• lastmodif : the date of last version of the mod, using the macro $Date$
• files : a list of all the files that compose the mod. One line per file, composed of the origin
and the destination separated by a space. The origin is relative to mods/ and the destination
relative too the tiki documentroot. Files in mods can be prepended with sample: prefix in
which case they will be modified by the configuration at install time.
• Description : an arbitrarily verbose (but not much) description of the functionalities of the
mod
• Docurl : the list of relevant urls (one per line) related to documentation of the mod
• Devurl : list of urls used for the development of the mod (usually, but not mandatorily, in
http://mods.tikiwiki.org)
• Licence : the legal form under wish the mod is distributed. If not specified, follows the
tikiwiki licence scheme
• Author : the name, login or identifier of the author(s) of the mod. If it's a coolactive work,
one name per line is accpetable.
• Version : the list of restrictive version for which the mod is designed. If that field is absent,
any version should be able to use the mod. (not functional yet)
• Changelog : the list of changes, descending, usually one line per change
• Configuration : enables install-time setup of some values. One line per variable, composed
of Label, name of the variable and default value from $_SERVER array (for example

102 Back to TOC

 Tikiwiki Documentation 1.9+

$HTTP_HOST will propose $_SERVER['HTTP_HOST'] as a default value in configuration

screen). The configuration variables suubstituation will be processed only on files begining
with "sample:" prefix in mods repository.
• Configuration help : the text displayed on configuration screen at install time (remember to
avoid empty lines as they are parameters separators).
• help : a freeform text instruction about the mod installation and first use
• sql-install : the list of sql command issued at install time, one command per line.
• sql-remove : same as sql-install, but executed at removal time.
• sql-upgrade : that's a special sql statement list. It's splited by version numbers to which the
upgrade sql statements apply. The version number has to be on a line prepended with a
column. The lines below the version value will be associated to that version upgrade, so
multiple upgrade can be run at once if needed.

The maintenance of the mods repository is managed by other text files that have to be present in the
mods/Packages/ dir as well. Those files are indexes in CSV format, so they can be used by other
tools. The indexes are following the conventions :
• name convention is that all indexes files begin with 00_list. and end with .txt so they are at
the top of the list when Packages content is sorted alphabetically
• each line in indexes is composed by strings enclosed with simple quotes and separated with
commas
• the fields are 'type','mod name','revision','description','licence' (probably more will be added,
but the order shouldn't change).
• of course the content of fields has to be addslashed (simple quotes preceeded by a
backslash).
• there is differnt index files for different uses
• 00_list.txt : is the index of locally available mods. This index can be rebuidl locally
by using the 'rebuild local list' link in tiki-mods.php
• 00_list.public.txt : is the index that is generated when you setup your mods to be able to be
mods provider. It lists the mods that are available for other tikiwikis
• 00_list.xxxxxx.txt : is the index of remotely available from the sevrer configured in the tiki-
mods_admin.php panel where xxxxxx is the urlencoded url of the server it comes from

3.5.3.2. for developers : mods.sh

In 1.9cvs you can find that script in doc/devtools/mods.sh. This script is recent and has only a few
features, but the goal is to make possible to manage the mods only with it. Before use edit this
script to adapt the configuration to your environment, and when done you can launch it from your
tiki root directory.
Usage: ./doc/devtools/mods.sh <package_name> [copy|diff|install]

copy : copy tiki files to mods

diff : diff tiki files with mods
install : copy mods files to tiki
without 2nd arg, returns the list of files from package in tiki tree

!!! note that this script only works with installed packages !!!
!!! (this is work in progress, use is quite limited for now) !!!

Back to TOC 103

 3.5.3.3. Mods evolution

The first version of mods feature is very basic, and will need to handle some more things :
• md5 signature of the tarball present in the control file
• management of scripted operation at install and remove time, for patching or anything. But
anything being able to be anything by nature, it requires a good security attention and a non-
risky context.
• adding more information in the control file
• possibility for having multiple author displayed in the mod details
• new type of mods for maintenance operations like upgrade, janitoring, cleaning, archiving,
or anything that can be handled by sql commands, those mods are never installed and can be
run at will
• languages modularisation, that would involve a new convention about translating mods-
specific strings as well as gathering all strings in a common place for easy translation.
• styles modularization, by cutting the css in part, so mod can embed, as for language, the
specific part needed for its use.
• Link to the installer to garantee a non-regressive upgrade from 1.8 or 1.9rc.
• development of a shell-based script for mods management, for easy administration and
avoiding the perms change.
• maybe even development of a VB-based clickable tool for binboze users that reproduces the
functionalities of the shell script cited above.
• find a way to manage the perms change for ftp-only users. Maybe the best way would be to
use a ftp script to install mods on a remote server, using lftp on *nix or the vb-script for
binboze victims.
• manage a dependancies system for linking installs
• add a way to update everything in a click
• manage a checking of existing tiki version to take in account the required minimal version
for each mod
• remove the mod-application_menu.tpl so we can refer to the sql-based application menu
(thhat can be changed easier by the mods installer
• change the features admin panel for it takes the features from the db rather than hardcoded,
so mods can interact and add items in features admin panel.
• setup a new page for displaying the focus. The disply inside the list won't last long (as the
list will grow).
Most of those evolutions should be ready before 1.9 final release.

mods system was initially designed by mose, use at your own risk and read the source code.
Related pages
• Mods
• Mods User
• Mods Admin

104 Back to TOC

 Tikiwiki Documentation 1.9+

4. TIKIWIKI FEATURES

Back to TOC 105

 (page intentionally left blank)

106 Back to TOC

 Tikiwiki Documentation 1.9+

4. Tikiwiki Features
Tikiwiki CMS/Groupware is one of the most feature-rich CMS software packages in the World.
Unlike other open source projects that ship only a small set of features and encourage 3rd party
Add-ons, the Tiki community has chosen to include a very large number of features in the main
code base, which helps to ensures that - unlike other projects - when you upgrade, your features will
not get broken. It also permits tight integration of the various features and makes it easier for
content re-use. The Wiki syntax works throughout the application. Not all features are fully
developed however, so this page provides a feature rating to help judge if Tikiwiki is right for you.
• Tikiwiki Features
• Content features
• Navigation features
• Transversal features (which apply to more than one section)
• Text Area features (features you can use in all text areas, like wiki pages, blogs, articles,
forums, etc)
• Administration features
• Advanced features for programmers
• Other
• General notes: About Tikiwiki Features

Rating System

A: Excellent — B: Very Good — C: Good — D: Poor — E: Very Bad

Content features
Tiki's Content Creation and Management Tools

Subjective self-evaluation by the Tiki community

Setup/admin UI: How easy / intuitive is to setup this feature?
UI end user : Once setup, how easy / intuitive is it for the end-user? (was it worth it?)
Stability: How many bugs left?
Feature-set / power: How does this feature compare to other Open Source apps? This field is the
default sort order
Dev (Bug
Setup/a UI
Feature name reports & Feature-
Descripció dmin end Stability
and link Feature set / power
UI user
requests)
Fast-breaking news, announcements.
Articles Articles C A A A
Submission & approval. Topics & Types.
Online discussions on a variety of topics.
Forum Forum B C B A
Threaded or flat. File attachments, etc
Collections of graphic images for
Image Gallery Image Gallery B C B A
viewing or downloading (photo album)

Back to TOC 107

 Dev (Bug
Setup/a UI
Feature name reports & Feature-
Descripció dmin end Stability
and link Feature set / power
UI user
requests)
Facts and figures storage & retrieval. A
Tracker forms & database generator, with Tracker C A C A
reporting.
Collaboratively authored documents with
history of changes. Tiki's Wiki has all the
features you could want from a first-rate
Wiki Wiki A A A A
wiki. Ex.: attach files, comments, history,
images, warn on edit, page locking,
powerful wiki syntax, etc
Navigable, interactive maps with user-
Map Map E B B A
selectable layers (requires mapserver)
Provide content organization and
communication tools for registered users
MyTiki Bookmark, User Preferences, Watch, MyTiki A A C B
User Menu, Task, Inter-User Messages,
User Files, Notepad and Mini Calendar
Questionnaire with multiple choice or
Survey Survey A A B B
open ended question
Quiz Timed questionnaire with recorded scores Quiz C B
Directory
User-submitted Web links Directory C B
(links)
Computer files, videos or software for
File Gallery File Gallery A B A B
downloading
Events calendar with public, private and
Calendar Calendar C B C B
group channels
Simple menu system which can
Featured Links optionally add an external web page in an Featured Links B A A B
iframe
To do list. Can send tasks to other users.
Task Task B
Also shared group tasks.
Turn a wiki page into slideshow by using
more than one title bar in the page. You
can also make slideshows from a
Slideshow Slideshow C B B B
structure. Here is a nice example of a
slideshow about Using a Wiki as an
Organizational Portal
Enable users to send internal messages to
each other. (like email but internal to
Inter-User your tiki site). A broadcast is a message Inter-User
B B A C
Messages sent to many users, the message can be Messages
sent to a Tiki group or to all users (if
permissions are ok).
Spreadsheet Datasheets with calculations and charts Sheet A A C C
FAQ Frequently asked questions and answers FAQ C C
Newsletter Content mailed to registered users Newsletter A A B C

108 Back to TOC

 Tikiwiki Documentation 1.9+

Dev (Bug
Setup/a UI
Feature name reports & Feature-
Descripció dmin end Stability
and link Feature set / power
UI user
requests)
Blog Online diaries or journals Blog C B C C
Live Support One-on-one chatting with customer Live_Support C B C C
Static and dynamic HTML content. Note:
HTML Page HTML can be used in wiki pages. This is HTML Page B A C
a separate feature.
Like polls, but more feature-rich;
Charts Charts D D D C
displayed in center column
Use of Google Maps interactively inside
GMap Gmap B B B C
Tiki, added to 1.9.4
Users upload files and store them in their
User Files tiki personal space, they can then User Files C C B C
download the files.
Users can write, upload, download and
read notes. Notes can be read as raw text
files or as Wiki pages interpreting the
Notepad Notepad C
Wiki markup syntax. The user-quota that
admin can control is used to set the
maximum size that user notes can take.
Chat Real-time group text chatting Chat A C D D
Provide a graffiti box on the site's home
Shoutbox Shoutbox A A A D
page.
Contact Basic form from visitor to admin Contact E A A D
Newsreader NNTP newsreader Newsreader D
Game? Flash games Game D A A D
Give users Web-based access to their
Webmail Webmail E
POP3 e-mail accounts
Friendship Users can identify other users as their Friendship_Net
B E
Network friends. work
The generated webhelp is a static
representation of the structure with a js
WebHelp tree that can be used to navigate the WebHelp D D E E
structure and a search function, print
function, history and some other gizmos.

Navigation features
Dev (Bug
Setup/a UI Feature-
Feature name reports &
Descripció dmin end Stability set /
and link Feature
UI user power
requests)
Global category system. Items of different
Category types (wiki pages, articles, tracker items, Category B B B A
etc) can be added to one or many

Back to TOC 109

 Dev (Bug
Setup/a UI Feature-
Feature name reports &
Descripció dmin end Stability set /
and link Feature
UI user power
requests)
categories. Categories can have
permissions.
Menu items can be filtered by permission,
by group or if a feature is turned on or off.
Menu Menu C A B A
Also works with phplayersmenu for nice
dynamic menus.
Boxes of content, typically on the left &
right of portal-styles sites. Very useful for
navigation & content re-use. 90+ modules
Module available in Tiki 1.9.x Modules Module A A B A
administrators can make many more
predefined modules available and create
their own using HTML.
Create hierarchically organized
breadcrumb navigation aids for Wiki
Structure pages, and also allow printing all pages in Structure C B A A
the structure and in the same order
through an easier way than one by one.

Wiki 3D Morcego 3D network browser Java applet Wiki 3D C C B B

Site Identity feature helps an admin to

simplify the customization process of
his/her site. Instead of hacking the tpl files
Site Identity code manually you can have your own Site Identity B A B C
Site Header area with Site Logo and more
optional elements set up directly from
TikiWiki Admin section.
If enabled, a customized page will serve
as the home page for the Tiki. Custom
CustomHome Custom Home B A C
home page by default group is also
possible
Administer your meta tags via the admin
Meta Tags Meta Tag B A C
panel (no FTPing)
Tiki is search engine friendly. If you are
Search Engine Search Engine
using Apache, you can rename _htaccess C
Friendly Friendly
to .htaccess to get Short URLs
User bookmarks let users bookmark
internal or external pages, create folders
and organize their personal bookmarks in
Bookmark folders. Bookmarks can be cached if that Bookmark unrated
option is enabled. A module is provided to
let the users see their bookmarks, navigate
through them, and add new bookmarks.
Add personal items to the User Menu
User Menu User Menu unrated
section in the application menu.
Freetags are the folksonomyexternal link
Freetags Freetag E unrated
implementation of TikiWiki.

110 Back to TOC

 Tikiwiki Documentation 1.9+

Transversal features (which apply to more than one section)

Dev (Bug
Setup/ UI Feature-
Feature name reports &
Descripció admin end Stability set /
and link Feature
UI user power
requests)
Transparently compress your pages on-
Compression the-fly, if the requesting browser compression A A B A
supports this
35 built-in themes. Easy to add more or
Theme Theme C B B A
to create your own.
Generates RSS feeds and RSS feeds can
RSS RSS B B B A
be included in Tiki.
Interaction with
For example: Google video, Google
popular external
Maps, YouTube, Skype, Google A
softtware, services
AdSense, Mindmap and many more!
or websites
Tiki is translated in 30 languages.
i18n Handles multilingual navigation & i18n C B B B
content. Can link to Babelfish.
js calendar is a nice date & time picker
js calendar js calendar B B E B
optional in calendar and trackers.
Quick feedback available for many
Comment Comment B B B B
features (wiki pages, articles, blogs, etc)
Provide voice-based browsing capability
Mobile Tiki & and WAP / PDA / i-mode / etc for Web-
Mobile B B B B
Voice Tiki enabled cell phones. http://
mobile.tikiwiki.org
Receive an email when an item is
Watch Watch B B C B
updated
A new tool for distribution, install,
Mods upgrade and removal of tikiwiki mods E B D C
components, also called mods.
Site-wide statistics for many features.
Stats Referrer stats and search stats also Stats B B C C
available.
Insert, track, and manage advertising
Banner Banner B A B C
banners.
Lets users vote on wiki pages & tracker
Rating Rating D B D C
items
internal search engine which indexes
Search Search C C C C
through many features
Allow selecting, reporting and exporting
Contribution the type of contributions of your users. Contribution A A B C
(only for tikiwiki = 1.10+)
Score This feature is a game to motivate Score C
people to participate in the community.
Users are given points for things they do
in the site, like writing an article,
reading an article, starting a new topic in

Back to TOC 111

 Dev (Bug
Setup/ UI Feature-
Feature name reports &
Descripció admin end Stability set /
and link Feature
UI user power
requests)
forum, voting a poll, etc. They also earn
points by being popular, like having
his/her blogs and articles read and
commented. Then the users will be able
to see their position in a ranking.
Vote comments from 1 (poor) to 5 (very
Karma Karma D D D D
cool)
Submit Wiki pages or articles via e-
Mail-In Mail-In unrated
mail.
Accessibility Web accessibility Accessibility unrated
PDF Generate a PDF version PDF unrated

Text Area features (features you can use in all text areas, like wiki pages, blogs,
articles, forums, etc)
Dev (Bug
Setup/a UI
Feature name reports & Feature-
Descripció dmin end Stability
and link Feature set / power
UI user
requests)
About 50 Wiki plugins extend the
function of wiki syntax with more
Plugin Plugin B B B A
specialized commands. It is very easy
to create your own plugins
Apply formatting without learning &
Wiki Syntax using HTML. Usable throughout Wiki Syntax B B B A
various features, not just the wiki!
Dynamic Content Bloc of content which can be reused Dynamic
C A A A
System and programmed (timed). Content System
Those little icons on the left the edit
page : you click on it and a javascript is
used to insert a tag in the textarea,
QuickTag Quicktag C C B A
depending on your actual selection.
Useful to add wiki syntax. You can
create your own quicktags.
CODE plugin Displays a snippet of code B B C B
Can add flash to a wiki page, an article,
Flash Plugin B A B B
etc
Drawing engine inside wiki pages
Drawing using JGraphPad, a powerful java Drawing B B D B
drawing applet.
External Wikis Create links easily with other wikis. B B A C
A table of content generated
Table of content A C A C
automatically from a list of headers.
Cookie Taglines drawn randomly from tagline Cookie B B A C

112 Back to TOC

 Tikiwiki Documentation 1.9+

Dev (Bug
Setup/a UI
Feature name reports & Feature-
Descripció dmin end Stability
and link Feature set / power
UI user
requests)
database
If enabled, Wiki pages are parsed and
Hotword some words are automatically Hotword C
converted to HTML links.
External URLs can be cached inside
TikiWiki - this is possible for links
Cache B B A C
from the Wiki as well as for the User
Bookmarks
Choice of pre-filled texts for Wiki
pages, articles, newsletters and html Content
Content Template B B B C
pages to give a consistent look and Template
feel.
Brief list of votable options; appears in
Poll Poll B A C C
module (left or right column)
Snippets of text which can be reused Dynamic
Dynamic Variable C C
throughout Tiki. Variable
Love them or hate them! (:smile:)
Smiley Smiley A A A C
(:eek:)
Spellcheck Spellcheck D C D D
Insert a module in a Wiki page, an
PluginModule unrated
article, etc

Administration features
Setup/a UI
Feature name and Dev (Bug reports & Feature-
Descripció dmin end Stability
link Feature requests) set / power
UI user
Different rights can be assigned
Permission Permission C A A
to groups. (ACLs)
Using multiple Themes / Styles
Theme Control Theme A A A A
on your Tiki site
Tiki uses the Smarty template
Cacheing A A B A
engine 's built-in cache
User
Registration, Login & Banning User Administration A
Administration
Groups can be included in
Group Group A
groups to inherit permissions.
Can create (via the browser) new
Edit CSS theme B
css suffixed with -user
Communication Send/receive objects to and from Communication
B A A B
Center other Tiki-powered sites Center
Authenticate users based on
Intertiki Intertiki D C D B
users data from external tiki.

Back to TOC 113

 Setup/a UI
Feature name and Dev (Bug reports & Feature-
Descripció dmin end Stability
link Feature requests) set / power
UI user
(several "slave" sites and a
"master" site). Groups & setting
can be transferred. Introduced in
Tiki 1.9.3.
Can use LDAP (Active
External Directory), PAM, Auth , Http External
B
Authentication web server or CAS . In 1.10 Authentication
Shibboleth
A wizard installer script +
Install? Install C B B
profile selector
Follow what a user is doing on a
single or multiple users, groups
Action log Action log B B B C
or categories basis. New to Tiki
1.10
Block access from individual IPs
Banning Banning C
or ranges of IPs.
Added a phpinfo link to check
Phpinfo your php installation in the C
admin menu.
tiki-backup.php is to make a
backup of your data via Tiki.
Backup Use of this feature is NOT Backup E E D
recommended. Please use
phpMyAdmin instead.
Edit Template Edit SMARTY templates. Theme unrated

Advanced features for programmers

Dev (Bug reports UI
Feature name Setup/ad Feature-set
Descripció & Feature end Stability
and link min UI / power
requests) user
Galaxia is a open source activity-
Workflow based Workflow engine. Workflow E B A
http://workflow.tikiwiki.org
Automatically import external
Integrator Integrator D B B B
HTML pages into Tiki.
Display select queries in your wiki
SQL plugin C C B
pages
Debugger
Debugger Console for programmers Debugger Console B
Console

Other
Feature name and Descripció Dev (Bug reports &

114 Back to TOC

 Tikiwiki Documentation 1.9+

link Feature requests)

We eat our own
Tiki is a community. Tiki is a software.
DogFood
Written and maintained by an active and international community of
volunteer contributors. While many developers offer consuting
Open development services, no company controls the development.

Think of Tiki as applying the wiki way

Tiki developers are Tiki users too and prefer open protocols and
Open standards &
standards.
protocols
http://tikiwiki.org/TikiStandards
Database mysql
Database Tiki uses the ADOdb database abstraction library so Tiki works with
Database
independance many databases (MySQL, PostgreSQL, etc)
independance
Platform Tiki runs wherever PHP runs, on Linux, Mac, Windows and many
Platform independence
independence more other operating systems.
Browser On the client side, all you need is a Web browser such as Firefox,
Browser Compatibility
Compatibility Konqueror, Internet Explorer and many more.
Tiki's documention is handled on a wiki (of course!). So you can
participate! The are links from your installed Tiki application directly
Documentation Documentation
to the corresponding documentation wiki page. Many links are broken
because of a major reorganization. Please bear with us and participate!

General notes: About Tikiwiki Features

Tiki Wiki/CMS/Groupware offers a very large number of features "out-of-the-box", arguably more
than any other Open Source Web Application. It's so feature-rich that it can be overwhelming, even
to an experienced user or administrator. Tiki has all the classic CMS/portal features but also has
some features not yet available in other similar applications. Highly configurable & modular, all the
features are optional and administered via a web-based interface. What makes Tiki so powerful is
the tight integration of all the features.

Tiki is a very active project. On average, there is a commit to the code (a bugfix, a new feature, etc)
every 2 hours. So, over time, features get better. It is an Open source project so you too can
participate to make it better!

Over 200 people have contributed to the source code. Some features are widely used & very stable
while others are unmaintained or buggy. The self-evaluation above will help you know what to
expect. All features are optional so you can pick & choose what you need for your project. If you
are are beginner, stick to features which have mostly As & Bs.

To enhance the list above, please login and click the name of the feature. Please fill in the missing
information and correct what you feel is incorrect. Say you feel a feature X deserves a B instead of
a D, then please go ahead! (All changes will be reviewed by a project admin, and reverted if need
be.) You can also add comments. For example: "I believe this feature will deserve a "B" when this
option is offered"

If you are reporting a bug or suggesting a feature enhancement, please use our bugs & wishlist

Back to TOC 115

tracker. Features & ratings below are based on the latest stable version of Tiki (1.9.7 as of now).
However not all feature have yet been added above. Many plugins are missing, for instance.

4.1. Wiki
At the heart of TikiWiki is the Wiki feature, which enables users to create and edit a virtually
unlimited number of content pages, even if they don't know any HTML. On the surface, the Wiki
feature can be thought of as an exceptionally easy-to-use tool for adding content to a TikiWiki-
powered Web site — but this view understates this feature's significance. Wikis are, put simply,
perhaps the most useful tool yet created for online teamwork and collaboration. There are several
standalone Wiki server packages available (see "Useful Links," below); TikiWiki's Wiki feature is
among the most feature-rich and stable available, and what is more, gives you a wide range of
additional ways of organizing and looking at collaboratively developed data (including forums,
articles, and blogs).

To grasp the nature and utility of TikiWiki's Wiki feature, you'll need to understand the simple (but
important) design philosophy that underlies all Wiki software (see "Understanding Wikis," below).
Then take a look at "Feature Overview," also below, for a birds-eye scan of the many capabilities of
TikiWiki's implementation of the underlying Wiki concept.

Understanding Wikis
In brief, a Wiki is a computer-based collaboration system based on three major principles:
• Ease of Use Users shouldn't have to learn HTML or deal with complicated file upload/
download protocols, and the inevitable file format incompatibilities, in order to create and
maintain documents collaboratively. Typically, wikis solve these problems by using their
own, easy formatting syntax (called wiki syntax) and by enabling users to create and
maintain documents with a Web browser.
• Wide-Open Read/Write Access If the purpose of a wiki is wide-open collaboration, then
every document in the wiki should be instantly available for editing and revision — and
what's more, anyone should be able to edit an existing wiki document (or create a new one)
without having to get permission from authors or supervisors.
• Emergent Structure In physics and biology, the term emergent structure is used to describe
the striking (and often beautiful) patterns that emerge from fundamentally chaotic processes,
such as the spiral arms of our galaxy. In a Wiki, this term refers to the navigation structures
that Wiki users invent as they try to impose pattern and meaning on a collection of Wiki
pages.

Few would debate that online collaborative tools should be easier to use, but the second of these
two principles — "Wide-Open Read/Write Access" — sounds risky to most people. But don't get
scared off just yet. In TikiWiki (as in most other leading wiki packages), you don't have to throw
open your Wiki pages to the whole, wild Internet. You can:
• Use Permissions Restrict Wiki page-editing rights to registered users, or to more narrowly
defined user groups, or to forbid page editing entirely, if you wish.
• Lock Pages Any individual Wiki page can be locked by the site admin or page author so
that the content can't be altered.
• Monitor Important Pages You can monitor a page, which means that you're notified (via e-

116 Back to TOC

 Tikiwiki Documentation 1.9+

mail) whenever a change is made.

• Restore from Page Histories If someone messes up a page, not to worry. TikiWiki (again,
like most Wiki packages) keeps a detailed history of all the changes made to a given page.
Previous versions can be quickly restored — typically, in less than one minute — without
having to fuss with backup tapes.

Don't let the wide-open read/write access philosophy scare you off. Throughout the world, leading
corporations and universities are quietly using Wiki software to facilitate team-based, collaborative
writing — and they're reporting success after success. To be sure, authors need to know what
they're getting into; after all, someone might come along and make changes to the "brilliant page"
they just posted. (Of course, the original author can go back in an remove the changes, but it would
be much better to revise the page to show that there are differing points of view!) To avoid ego-
related squabbles, TikiWiki administrators need to explain the Wiki philosophy to team members
(and provide plenty of tools that enable users to work through conflicts regarding page content).

Historical Note The term Wiki is short for wiki-wiki, which means quick in Hawaiian. The first
Wiki was created (and dubbed "Wiki-Wiki") by Ward Cunningham, a Portland, OR computer
programmer, in 1995. The largest Wiki is the remarkable Wikipedia, which now contains more than
300,000 publicly-contributed entries.

Feature Overview
TikiWiki's Wiki feature enables users as well as admins to create virtually limitless numbers of
readable, Web-accessible pages without the need to learn HTML or master complicated file
uploading protocols. No matter who originally created a given Wiki page, it is almost instantly
accessible for editing, providing the user has the appropriate permissions and the page has not been
locked.

When a Wiki page is opened for editing, authors can make use of Wiki Syntax, a set of formatting
codes that is designed for maximum ease of use. If they have the appropriate permissions, they can
also use HTML. Even if they use no formatting at all, the saved page will still look pretty much as
the author intended — TikiWiki reproduces carriage returns and blank lines they way they look in
the textarea input box. Optionally, Wiki pages can include graphics, and users (with the appropriate
permissions) can attach files of any type. Users can include three types of links in Wiki pages: links
to other Wiki pages within the same TikiWiki site, links to external Wikis, and Web links (see Wiki
Linking? ). Users can also draw from a large and growing list of Wiki Plugins, which provide a
variety of enhancements (including split-page formats, a Jabber client, automatically included
article text, and many more). They can also categorize pages using Category, if these have been
enabled and previously created by the site's administrator.

When a saved page is displayed, users (assuming they have the appropriate permissions) can save
the page to their local systems, export the page to a PDF file, view the page in a format suitable for
printing, or save the page to their MyTiki notepad. They can also monitor the page, which means
that they'll receive e-mail if a change is made to the page. They can view the page's history,
including previous versions of the page and differences among the various versions. They can see
an automatically generated list of similar pages, as well as a list of pages (called backlinks) that
contain links to the current page.

Back to TOC 117

From Here

To learn how to create wiki pages and use wiki syntax, go to Using Wiki Pages
To Administer the wiki system, go to Wiki Config
To see the developer details, go to Wiki Details
Further Reading
• Wikipedia
http://wikipedia.org
• Wiki entry at Wikipedia
http://en2.wikipedia.org/wiki/Wiki
• Wiki Design Principles
http://c2.com/cgi/wiki?WikiDesignPrinciples
• Wiki RFC
http://tikiwiki.org/RFCWiki

4.1.1. Using Wiki Pages

To understand what a Wiki page is and how they work, please read the Wiki page. Depending on
how the TikiWiki administrator has configured the TikiWiki site you're using, you may be able to
do some or all of the following:
• Create new pages
• Edit existing pages
• Read pages
• Add Comments to pages
• Find Similar pages
• See what is hot and what is not
• Much, much more

The following sections explain how to do this.

4.1.1.1. The Wiki Menu

The following image is the menu that most users will see if all options are activated.

The options are as follows:

• Wiki the Wiki Home page is viewed. See A Wiki Page below
• Wiki Home the Wiki Home page is viewed. See A Wiki Page below
• Last Changes this allows the user to see which pages have changed. See Last Changes

118 Back to TOC

 Tikiwiki Documentation 1.9+

below
• Dump this allows the user to create a compressed file from the page
• Rankings this will show which pages are hot or how much activity they have had. See Wiki
Rankings below
• List Pages this provides a complete listing of all pages in the site. See List Pages below
• Orphan Pages pages do get orphaned with time - that is - the links to them are removed.
This option provides a way to find them. See Backlinks & Orphan Pages below
• Sandbox this is a safe place to experiment with Wiki Syntax or HTML. See The Sandbox
below
• Print this allows multiple pages to be printed. See Wiki Printing below
• Structures (not shown in the image) are visible to anyone with Admin privileges. Structures
are a way of applying an order to Wiki pages, like building a directory tree.

4.1.1.2. A Wiki Page

The following image is for the Wiki Home Page before any content was added to it.

The buttons across the top have the following meaning:

• Edit Button this opens the Wiki Page editor for this page. See the Wiki Page Editor page
• Remove Button this allows a Wiki page to be deleted. NOTE: A deleted page can be
recovered by admin.
• Rename Button this allows the page to be renamed. See Page Renaming below
• Lock/Unlock Button a page can be locked to prevent it from being edited. If this is done,
only the Author (if enabled) or Admin will be able to unlock it.
• Perms Button Group Permissions can be assigned to a page. See Page Permissions below
• History Button this provides a detailed History of the page. See Page History below
• Similar Button this is a search facility for finding similar pages. See Similar Pages below
• Undo Button this will undo the last edit. See Undo Edit below
• Export Button this allows the page to be exported to a text file on your system. See Page
Export below
• Comment Button users can add comments to a page. See Page Comment below
The Icons at the top have the following meaning:

• Opens the editor for this page. See the Wiki Page Editor page
• Provides a listing of every page that references this page. See Backlinks & Orphan
Pages below
• This will display a printer-friendly version of the page by removing menus, sidebars,
banners and anything else except the central column.
• Will create an Adobe PDF file from the current page.

Back to TOC 119

 • Creates a copy of the page and saves it to your Notepad in the MyTiki section. See
Notepad
• Allows the page to be monitored. When a change is made to the page, an email is
automatically sent to every user who is monitoring the page. See Page Notification below

4.1.1.3. Creating a Wiki Page

If configured, Wiki pages can be created using Smashed Word syntax. This can be defined as a
number of capitalized words joined together without spaces like MaryHadALittleLamb.
Alternately, a user can specifically tell the system to create a page like this ((This is a New Page)).
In either case, when the page is saved the Wiki will add a question mark to indicate a new page. The
question mark is a link to the Wiki page editor for that page. After the new page is saved, the
question mark is replaced from the original page and the link will be indicated.

TIP: A Fast Way to Create a New Wiki Page

• Edit ANY Wiki Page
• Somewhere at the top of the page, add the name of the page you want to create in double
parentheses. Example: ((My New Page))
• Hit Preview
• Select the underlined Question Mark. Example: My New Page?
You will be editing the page you wanted to create. The page that you changed to create this page
was not saved or updated - so it does not need to be modified or repaired. This method allows you
to see if the page already exists. A link will be displayed if a page with that name exists (instead of
the question mark) so you can change the page's name and hit Preview again.

4.1.1.4. Last Changes

This screen allows you to see which Wiki pages have changed. The buttons across the top specify
how far back to search for changes and the find box allows you to search for changes on specific
pages.

120 Back to TOC

 Tikiwiki Documentation 1.9+

As you can see, the date of each change, the page name, who made the change and his IP address
are recorded. Under each of the page names are 6 links. They are explained as follows:
• (hist) provides a detailed History of the changes made to this page. See Page History
• v View will show the page as it was when that change was made
• b Back or Rollback is used to revert a page to a given version. Confirmation is asked before
the page is rolled back to a previous version. Another alternative is to remove all the
versions that you don t like until the desired version becomes the current one.
• c Compare shows a side-by-side comparison between the selected version and the current
version.
• d The Difference tool computes a difference between the current version and any selected
version in the history. Some people prefer the Difference tool while others prefer the
Comparison tool, you can use whatever you want or both.
• s Displays the Source code of the selected version. This is nearly identical to what is seen in
the Wiki Page Editor.

4.1.1.5. Wiki Rankings

Back to TOC 121

 4.1.1.6. Page History

4.1.1.7. Similar Pages

Similar Pages show a listing of pages with named similar to the current page. Pages are created and
named using words combined together, so Similar Pages will show pages where one more of these
words are the same as the words in the current pages. As an example MyPage, NFLResultsPage
OpinionsPage are similar because they share the word Page

4.1.1.8. Undo Edit

The Undo button can be used to Undo the last edition of a page. If the Undo feature is enabled then
a user that can edit pages will be able to Undo what they did even if they can’t Rollback pages or
Remove page versions.
Pressing the undo button removes the current version of the page making the last version in the
history the current page; if no version is in the history then the page is reverted to an empty page.
Note: A users will only be able to Undo their editing and not the editing that any other user has
done unless the user has permission to remove page versions.

4.1.1.9. Page Export

The Export button can be used to export the current version of the page. When clicked your browser
will prompt you to save the file. The exported page can then be edited and later be imported back
into the Wiki. You can also export all the versions of a page. This link is inside the Page Editor.
Page Comment

4.1.1.10. Page Renaming

The Rename button can be used to rename a Wiki page; all wiki links referencing the page will be
updated as well. An error message will be generated if the new page name is already in use.
Note: A user must have a permission to rename pages.

4.1.1.11. List Pages

122 Back to TOC

 Tikiwiki Documentation 1.9+

4.1.1.12. Backlinks & Orphan Pages

Every page has a list of Backlinks. Backlinks are links from any page to the current page (the page
you are reading), you can use the Backlinks option to see which pages are linking to a particular
page and find Orphan pages (pages with no Backlinks). Orphan pages are unlikely to get visited
very often. On many occasions, Orphan pages are old pages that were removed from the Wiki and
should have been deleted.

4.1.1.13. The Sandbox

Like a real Sandbox, in TikiWiki – the Sandbox is a place to play. You can test out ideas here,
experiment with Wiki Syntax or HTML safely. The contents of the Sandbox are never saved, so
when you have something perfected - copy the contents and paste them into a Wiki page.

4.1.1.14. Page Monitoring

Page monitoring allows a registered user to receive an email when ever there is an edit or new
comment applied to a a wiki page. Logged in users can click the monitor button at the top of a wiki
page to turn monitoring on or off per a page.

4.1.1.15. Page Permissions

NOTE: in TikiWiki 1.9 permissions can be applied to an entire wiki structure.

Users in a group with permissions tiki_p_admin_wiki can set permissions per a page. Click perms
and then select the permissions you wish to apply for what user groups to that page. If no individual
permissions are applied to a page, global permissions apply.

If tiki_p_creator_admin is set too and if the user is the creator, he can also redifine the perms. As
soon as one permission is applied, all global permissions are overridden and thus you will probably
have to apply a few individual permissions so one or more user groups can view and edit the page.

Back to TOC 123

 4.1.1.16. Share pages

Version Introduced in 1.10

Page sharing allows users with non-administrative rights to allow groups of users to view or edit the
page. The interface indicates which user groups are allowed to view or edit the page using icons.
Permissions obtained from the group directly are displayed in green. Permissions assigned on a
category containing the wiki page are displayed in yellow. The concerned categories are displayed
in a tooltip over the icon.

Permissions not attributed by groups or categories can be assigned using this interface as an
individual object permission. Groups not currently having permissions on the wiki page can be
added to the list using the "additional permissions" form.

Unlike the page permission section, share page only requires the tiki_p_share_page permission to
be used. The basic rule is that anyone with a given permission can assign it to other users. The
permissions assigned are the following :
read tiki_p_view
read & write tiki_p_edit
tiki_p_edit

124 Back to TOC

 Tikiwiki Documentation 1.9+

4.1.1.17. Show Module in Wiki Page

Module are usually displayed on the left or right columns. To display a module in a wiki page, use
the syntax:
{MODULE(module=>module_name_here)}{MODULE}

4.1.1.18. Other Syntax Pages

4.1.2. Wiki-Syntax Links

In this page, you'll learn how to include links in your Wiki pages, including links to other Wiki
pages within the same TikiWiki site, links to an external Wiki site, and links to the Web.

4.1.2.1. Quick Reference

Link to a Wiki page WikiPageName or ((Wiki Page Name))

Link to an external ExternalWikiName:ExternalWikiPageName or ((External Wiki Name:
Wiki page External Wiki Page Name))
Link to a Web page [http://www.somesite.org] or [http://www.somesite.org| Some Site!]

Note: Tiki's linking capabilities are affected by the following administrative options:
• Use WikiWords If this feature in the Wiki Features area (Wiki tab) is disabled, you must
use doubled parentheses to create a Wiki page link.
• Open External Links in New Window If this feature in the General Settings area (General
tab) is disabled, external links open in the existing browser window.

4.1.2.2. Linking to Wiki Pages

Wikis are designed to detect Wiki page names automatically and to format them as hyperlinks,
which can be clicked to display the linked page. Either of the following is a valid Wiki page name:
• TheWikiWay Two or more words are stuck together (no spaces, but accept - and _), and
each is capitalized.
• ((The Wiki Way)) This method is used to refer to Wiki page names that include spaces.

If you would like to add a description, type the link like this:
• ((TheWikiWay|The Wiki Way))

Be sure to include the vertical bar character (|).

When you add a description, the Wiki page will show the description text as a clickable link.

Back to TOC 125

Help!
• If you save the page but see a question mark after the page name, and you're sure the page
exists, search for the page in the Search module to make sure you've typed the name
correctly.

• Sometimes the Wiki software mistakenly thinks a word with odd capitalization is a Wiki
page name. It places a question mark after the word to indicate that it cannot find a page
with that name. To keep the Wiki software from formatting a word as a Wiki page name,
surround the word with doubled, reversed parentheses, as in the following example:
))WordStar((.

4.1.2.3. Linking to External Wiki Pages

If your administrator has enabled this option (see InterWiki for admin setup instructions), you can
link to pages in an external Wiki. You'll need to know the name of the external Wiki in order to use
this feature.

To link to an external Wiki page, type the link using the following pattern
• ((Name of external Wiki:Name of page in external Wiki))

To link to this page, you'd type the following (this example assumes that your administrator had
defined an external Wiki link and named it 'Tikiwiki'):
• ((Tikiwiki:WikiLinkingDoc))

Ask your administrator whether any external Wikis have been defined and named.

4.1.2.4. Linking to Web Pages

You can link to any page on the Web that has a valid URL. By default, Tiki creates a local cache of
the page so that it will be available even if the remote Web site is down. In addition, Tiki opens
external Web pages in a new browser window. (See WikiLinkingAdmin? for information on
changing these administrative options.)

To link to a Web page, enclose the URL within square brackets, as in the following example:
• [http://www.virginia.edu]

The link looks like this: http://www.virginia.edu.

The Wiki page will display the link text (http://www.virginia.edu) as a clickable link.

If you would like to add a description, type the link like this:
• [http://www.virginia.edu|University of Virginia]

126 Back to TOC

 Tikiwiki Documentation 1.9+

The Wiki page will display the description (University of Virginia) as a clickable link.

Important: If you are linking to a PDF file, a multimedia file, or any file other than an HTML
page, please include the nocache directive, as in the following examples:
• [http://www.somesite.org/docs/chapter1.pdf |nocache]
• [http://www.somesite.org/docs/chapter1.pdf|Chapter One|nocache]

Help!
• If the link doesn't work, try copying the URL into your browser window, and click Enter. If
the page exists, go back and check your typing. Chances are you'll find that you've made a
typing error. Did you type both brackets correctly?

4.1.2.5. Linking to Email Addresses

To link to an Email Address, enclose the mailto URL within square brackets, as in the following
examples:
• [mailto:[email protected]]

The link looks like this: mailto:[email protected]

• [mailto:[email protected] | John Doe]

The link looks like this: John Doe

4.1.3. tiki-admin_external_wikis.php
External Wiki Linking

4.1.4. Wiki-Syntax Lists

In Wiki pages and other contexts that support Wiki formatting (including articles, forums, and
blogs), you can easily create bulleted, numbered, and definition lists. In numbered lists, Tiki
numbers the items automatically. You can also create nested lists. The following sections explain

Back to TOC 127

the details; see the Quick Reference for an overview. Scroll down to Help! if something goes
wrong.

4.1.4.1. Quick Reference

* Bulleted list
# Numbered list
;term:definition Definition list

If you forget which character to use while you're editing, click the Wiki Quick Help tab.

4.1.4.2. Creating a Bulleted List

If you type an asterisk (*) at the beginning of a line, Tiki places a bullet (a black dot) at the
beginning of the line. The line is indented and formatted with a hanging indent, so that second and
subsequent lines are indented and aligned with the first line.

To create a bulleted list, do the following:

1. Place the insertion point at the beginning of the line.
2. Type an asterisk.
3. Type the item's text.
4. Press Enter.

Example :
• I put an asterisk at the beginning of this line
• And on the second too
• and on the third
• And you can see all the lines aligned.

4.1.4.3. Creating a Numbered List

If you type a hash mark (#) at the beginning of a line, Tiki numbers the line and indents it from the
left margin. The item's text is formatted with a hanging indent, so that second and subsequent lines
are indented and aligned with the first line.

To create a numbered list, do the following:

1. Place the insertion point at the beginning of the line.
2. Type a hash mark. Tiki supplies the period automatically.
3. Type the item's text.
4. Do one of the following:
1. To continue typing items, press Enter once, and go to Step 2, above.
5. To stop typing the list, press Enter twice.

no s'ha trobat la imatge img/icons2/alert.gif If you place more than one numbered list in a page, the
items are separately numbered.

128 Back to TOC

 Tikiwiki Documentation 1.9+

4.1.4.4. Creating a Nested List

A nested list is a bulleted or numbered list that has more than one level — that is, some items have
"sub-items," as in the following example:
• This is a Level 1 item.
• This is another Level 1 item
• This is a Level 2 item.
• Yet another Level 1 item.
• This is a Level 2 item.
• Sub-items can have their own sub-items! This is Level 3.
• Back to Level 1.

In a bulleted list, you can create additional sub-levels beyond the third level, but Tiki doesn't use
distinctive bullets beyond Level 3.

Here's a numbered list with nested levels:

1. This is a Level 1 item.
2. This is another Level 1 item
1. This is a Level 2 item.
3. Yet another Level 1 item.
1. This is a Level 2 item.
4. Another Level 2 item. Note the numbering.
1. Sub-items can have their own sub-items! This is Level 3.
5. Back to Level 1.

To create a nested list, type two or more asterisks (bulleted lists) or hash marks (numbered lists) at
the beginning of the line, as shown in the following examples:
*Level 1 (bulleted list)
**Level 2 (bulleted list)
***Level 3 (bulleted list)
#Level 1 (numbered list)
##Level 2 (numbered list)
###Level 3 (numbered list)

You can create deeper levels of nesting, but doing so might prove confusing to your readers.
You can combine bulleted and numbered list items. Try it!

4.1.4.5. Adding Hidden Details

An expandable area allows you to display the major items in your list by default. Every item is still
there, but it needs to be expanded to become visible. An expandable area is created by adding a
minus - character after the star * characters.
• This is a Level 1 item.
• This Level 1 item has Hidden Details. Click the Plus [+] to open it.
[+]
• This is a Level 2 item. Clicking the Minus [-] will close it.

Back to TOC 129

 • This Level 2 item did not need the minus character.
• Back to Level 1.

Expandable areas work with Bulleted and Numbered lists.

4.1.4.6. Text Continuation

Text can be forced to continue at the same indentation level in a list without having a bullet or a
Number assigned to it. This is accomplished by having a Plus + character start each line. The
number of Plus characters controls the indentation level.
• This is a Level 1 item.
This line begins with a single Plus character
• This is a Level 2 item.
This line begins with a 2 Plus characters
• Back to Level 1.

Expandable areas work with Bulleted and Numbered lists.

4.1.4.7. Creating a Definition List

A definition list displays a term that is aligned flush left; the term's definition is positioned on the
subsequent line and indented. Here's an example:
unordered list
A list in which the order of the items is unimportant; also called a bulleted list.

To create a definition list, do the following:

1. At the beginning of a line, type a semicolon (;).
2. Type the term to be defined.
3. Type a colon (:).
4. Type the definition.
• Your line should look like this: ;term:definition
5. Press Enter.
6. Do one of the following:
• To type another item, go to Step 2, above.
7. To end the list, press Enter again.

no s'ha trobat la imatge img/icons2/alert.gif Better definition lists can be created using the DL
plugin.

4.1.5. Wiki-Syntax Images

This is a tutorial, in which you'll learn how to:
• add Images to Wiki pages, articles, forums and blogs.

130 Back to TOC

 Tikiwiki Documentation 1.9+

Related pages: wiki syntax

Tiki is compatible with the following image formats: .BMP, .JPG, .GIF, .PNG

4.1.5.1. Adding an image.

To add an image or picture to a page in tikiwiki, first it has to be uploaded to one of the image
galleries. By default, Images are uploaded to the folder img/wiki_up// unless they are uploaded to
special image galleries (see below). In these instructions, wiki pages are referred to, but the
instructions also work for articles and blogs.
1. Edit: while editing the page, place the cursor at the point where you want the picture
inserted.
2. Upload: scroll down in the edit window to where it says "Upload Picture"
1. click the browse button and locate the file on your computer. After you have selected
the image and clicked open the file location should be displayed in the Upload
picture field
3. Preview: click the preview button and tikiwiki will upload the picture and place it on the
page.
4. Check: In the preview window, is the picture displayed how you would like it? Did it
display at all? You will have to look back into the edit window to tweak the image tag.
Using the image tag you can do the following:
1. align your picture: by default, most tikis place the picture inline with the text. This is
okay for very small Images, but in most cases you want to have the text wrap around
the picture. See below.
5. resize your picture: if the picture is too big or too small you will want to resize it. Note that
resizing a picture will decrease the quality, so you might want to do this with an external
editor and upload again.
6. you can also add a link for that picture or a descriptive message.

4.1.5.2. The image tag

The image tag in tikiwiki is not really any different from the standard HTML tag for Images, and it
supports the same attributes. Like HTML, wiki will ignore any commands with typos or unknown
commands.

In later versions of tikiwiki, the image tag will be displayed where you left the cursor last before
you previewed. (in earlier installs, it only is added to the very bottom of the text in the edit
window.)
Note: the IMG syntax for wiki has been buggy in the past (prior to 1.9.7?) please upgrade for the
following syntax to work.

Syntax {img src= width= height= align= desc= link= }

src= The name and location of the image Mandatory
width= The width of the displayed image Optional
height= The height of the displayed image Optional
align= Alignment on the page - right, left, or center Optional

Back to TOC 131

imalign= Alignment on the page - right, left, or center Optional
desc= A text description of the image Optional
link= A valid URL to make the image link to that URL Optional
hspace= adds a space, in pixels, on either side of the image
alt= Add alternative text. Must be encased in quotes. Optional

special note: as of writing, (May 2007) the img tag above won't allow text to wrap around the
image unless the width= and height= are defined. If you enable HTML on the page and use the full
HTML tag you don't need this - use < > instead of { }

note 1: using quotation marks around all arguments is reccomended, but not always necessary.
note 2: if you upload a file, some filenames may not be supported. stick to machine readable
characters: a-z,0-9 no spaces.

examples: using the image tag

Right aligned: image tag, 50x50 pixels, no description, links to google.

text text text text text text text text text text text text text text text text text text text text text text text
text text text text text text text text text text text text text text text text text text text text text text text
text

Left aligned: img src="img/wiki_up/50px-work-in-progress-sign.gif" width="50" height="50"

align="left" desc="work in progress" link="http://google.ca"alt="Sample Image."

work in progress
text text text text text text text text text text text text text text text text text text text text text text text
text text text text text text text text text text text text text text text text text text text

Left align: img src="img/wiki_up/50px-work-in-progress-sign.gif" align="left" desc="work in

progress" link="http://google.ca" alt="Sample Image."

work in progress
text text text text text text text text text text text text text text text text text text text text text text text
text text text text text text text text text text text text text text text text text text text

Left imalign: img src="img/wiki_up/50px-work-in-progress-sign.gif" imalign="left" desc="work

in progress" link="http://google.ca" alt="Sample Image."
work in progress
text text text text text text text text text text text text text text text text text text text text text text text

132 Back to TOC

 Tikiwiki Documentation 1.9+

text text text text text text text text text text text text text text text text text text text

Inline (default) aligned: 10x10 pixels

text text text text text text

Note: If an image is used and the size of it is unknown, display the image first. Hover the cursor
over the image and do a Right Mouse Button / Properties. This will provide the image size so you
can scale it to whatever you desire.

4.1.5.3. Links to image related pages in Tikiwiki

This table shows where image files are located on a Tiki site. It gives the directory, a brief
description of the files, the number of files in that directory and a link to a page where the files can
be viewed.
Directory Description Qty :: Link
Images Most of the Icons used in Tiki 68 Directory Images Files
img Backgrounds & Logos 24 Directory Img Files
img/avatars Users Avatars 580 Directory Img-Avatars Files
img/custom Images for Articles, Blogs, Files Etc. 27 Directory Img-Custom Files
img/flags Flag from Everywhere X Directory Img-Flags Files
img/icn Icons for File Types 33 Directory Img-Icn Files
img/icons A Variety of Small Icons 234 Directory Img-Icons Files
img/icons2 More Small Icons 147 Directory Img-Icons2 Files
img/mytiki Icons used in My-Tiki 14 Directory Img-MyTiki Files
img/smiles Smiles used Everywhere 23 Directory Img-Smiles Files
img/tiki Tiki Icons 4 Directory Img-Tiki Files
img/webmail Icons used in WebMail 13 Directory Img-WebMail Files
Dir Too Long ADOdb Icons 4 Directory Lib-Adodb Files
Dir Too Long More Small Icons 130 Directory Lib-Galaxia Files
lib/jHotDraw Various Drawing Buttons 51 Directory Lib-jHotDraw Files
Dir Too Long X 19 Directory Lib-TikiHelp Files

4.1.5.4. Allowing pictures to be uploaded

This feature is enabled/disabled by the administrative options see:

• Pictures feature which is set in Wiki Config page
• tiki_p_upload_pictures permission

end of verified/ recently edited documentation

more documentation on less used features

Back to TOC 133

 4.1.5.5. Adding Images From an Image Gallery

Images stored in one of the Image gallery can be displayed on Wiki pages. The following is an
example of the message given at the bottom of an Image when it is selected.
http://tikiwiki.org/tiki-
You can view this image in your browser using:
browse_image.php?imageId=72
<img
You can include the image in an HTML or Tiki
src="http://tikiwiki.org/show_image.php?id=72"
page using
/>

Not all of the second line is needed. The name of the site can be omitted because it already knows
where it is. The following image is displayed with this statement:
{img src=show_image.php?id=72 /}

Please Note: That there are no Quotation Marks included in this statement!

4.1.5.6. Adding Images From Another Site

The source (src=) is a location. That includes a URL of an image on another site. When a URL is
used, Tiki will automatically capture the image and store it in the database and update the link so
that it points to that image. This allows Images to be maintained on the pages even if they are
removed from the remote servers that originally had them.

Note: This feature is controlled by the administrative option:

• tiki_xxxxxxxxx which is set in the Wiki Features area (Wiki tab) under xxxxxxx.

4.1.6. Wiki-Syntax Text

On this page, you'll learn how to format text on Wiki pages and other area that support Wiki
formatting (including articles, forums, and blogs).

4.1.6.1. The Markup Language Wiki-Syntax

The markup language used on a Wiki page is most commonly called Wiki Syntax. It uses common
characters in uncommon ways (or character combinations that are not normally used together) and
provides them with a special meaning. Some of the character combinations only work at the
beginning of a line, while others can be inserted anywhere in the text and are active until they are
turned off.

Wiki-Syntax uses a character repeated twice for most functions, but it also has a few 2-character
combinations. With a 2-character combination, the characters are reversed when the function is
turned off. MonoSpaced Text provides a good example of this; the Minus (-) and Plus (+) characters
are used to start the using MonoSpaced Text and a Plus (+) and Minus (-) characters specifies the
end of it.

134 Back to TOC

 Tikiwiki Documentation 1.9+

4.1.6.2. Quick Reference - Basic Text Formatting

Formatting Reason Characters Used Example

Bold Text 2 Underscores "_" __text__
Centered Text 2 Colons ":" ::text::
Colored Text 2 Tildes "~" ~~blue:text~~
Italic Text 2 Single Quotes "'" ''text''
MonoSpaced Text Minus & Plus "-" & "+" -+text+-
Underlined Text 3 Equals "=" ===text===
Text Box One carat "^" ^text^
Plain Text surrounding np tags "~np~" ~np~__not bold__~/np~

4.1.6.3. Basic Text Formatting

The Wiki-Syntax given in this section can be located anywhere in the text so that specific
characters, words, or sentences can be emphasized.

Colored Text
Text can be any color you want it to be. Two Tildes (~) are used followed by the name of a color
and a Colon (:) to specify the start of the Colored Text. Two other Tildes (~) are used to end the
Colored Text.
Example: ~~red:This is text is Red~~ produces:
This is text is Red

Colored Text can also be specified using HTML colors. HTML colors use 3 pairs of Hex numbers;
one for Red, Blue, & Green so that 00 00 00 would produce white. The syntax is two Tildes (~)
followed by the Pound (#) character and the Hex Numbers with a Colon (:) followed by the text to
be colored. Two Tildes (~) mark the end of the Colored Text.
Example: ~~#ff00ff:This is text is the color Magenta ~~ produces:
This is text is the color Magenta

4.1.6.4. Web-Safe HTML Colors

Courtesy of Damosoft Web Design

Color Name Color HEX - Colored Text -
AliceBlue #F0F8FF Colored Text
AntiqueWhite #FAEBD7 Colored Text
Aqua #00FFFF Colored Text
Aquamarine #7FFFD4 Colored Text
Azure #F0FFFF Colored Text

Back to TOC 135

 Color Name Color HEX - Colored Text -
Beige #F5F5DC Colored Text
Bisque #FFE4C4 Colored Text
Black #000000 Colored Text
BlanchedAlmond #FFEBCD Colored Text
Blue #0000FF Colored Text
BlueViolet #8A2BE2 Colored Text
Brown #A52A2A Colored Text
BurlyWood #DEB887 Colored Text
CadetBlue #5F9EA0 Colored Text
Chartreuse #7FFF00 Colored Text
Chocolate #D2691E Colored Text
Coral #FF7F50 Colored Text
CornflowerBlue #6495ED Colored Text
Cornsilk #FFF8DC Colored Text
Crimson #DC143C Colored Text
Cyan #00FFFF Colored Text
DarkBlue #00008B Colored Text
DarkCyan #008B8B Colored Text
DarkGoldenRod #B8860B Colored Text
DarkGray #A9A9A9 Colored Text
DarkGreen #006400 Colored Text
DarkKhaki #BDB76B Colored Text
DarkMagenta #8B008B Colored Text
DarkOliveGreen #556B2F Colored Text
Darkorange #FF8C00 Colored Text
DarkOrchid #9932CC Colored Text
DarkRed #8B0000 Colored Text
DarkSalmon #E9967A Colored Text
DarkSeaGreen #8FBC8F Colored Text
DarkSlateBlue #483D8B Colored Text
DarkSlateGray #2F4F4F Colored Text
DarkTurquoise #00CED1 Colored Text
DarkViolet #9400D3 Colored Text
DeepPink #FF1493 Colored Text
DeepSkyBlue #00BFFF Colored Text
DimGray #696969 Colored Text
DodgerBlue #1E90FF Colored Text
Feldspar #D19275 Colored Text

136 Back to TOC

 Tikiwiki Documentation 1.9+

Color Name Color HEX - Colored Text -

FireBrick #B22222 Colored Text
FloralWhite #FFFAF0 Colored Text
ForestGreen #228B22 Colored Text
Fuchsia #FF00FF Colored Text
Gainsboro #DCDCDC Colored Text
GhostWhite #F8F8FF Colored Text
Gold #FFD700 Colored Text
GoldenRod #DAA520 Colored Text
Gray #808080 Colored Text
Green #008000 Colored Text
GreenYellow #ADFF2F Colored Text
HoneyDew #F0FFF0 Colored Text
HotPink #FF69B4 Colored Text
IndianRed #CD5C5C Colored Text
Indigo #4B0082 Colored Text
Ivory #FFFFF0 Colored Text
Khaki #F0E68C Colored Text
Lavender #E6E6FA Colored Text
LavenderBlush #FFF0F5 Colored Text
LawnGreen #7CFC00 Colored Text
LemonChiffon #FFFACD Colored Text
LightBlue #ADD8E6 Colored Text
LightCoral #F08080 Colored Text
LightCyan #E0FFFF Colored Text
LightGoldenRodYellow #FAFAD2 Colored Text
LightGrey #D3D3D3 Colored Text
LightGreen #90EE90 Colored Text
LightPink #FFB6C1 Colored Text
LightSalmon #FFA07A Colored Text
LightSeaGreen #20B2AA Colored Text
LightSkyBlue #87CEFA Colored Text
LightSlateBlue #8470FF Colored Text
LightSlateGray #778899 Colored Text
LightSteelBlue #B0C4DE Colored Text
LightYellow #FFFFE0 Colored Text
Lime #00FF00 Colored Text
LimeGreen #32CD32 Colored Text
Linen #FAF0E6 Colored Text

Back to TOC 137

 Color Name Color HEX - Colored Text -
Magenta #FF00FF Colored Text
Maroon #800000 Colored Text
MediumAquaMarine #66CDAA Colored Text
MediumBlue #0000CD Colored Text
MediumOrchid #BA55D3 Colored Text
MediumPurple #9370D8 Colored Text
MediumSeaGreen #3CB371 Colored Text
MediumSlateBlue #7B68EE Colored Text
MediumSpringGreen #00FA9A Colored Text
MediumTurquoise #48D1CC Colored Text
MediumVioletRed #C71585 Colored Text
MidnightBlue #191970 Colored Text
MintCream #F5FFFA Colored Text
MistyRose #FFE4E1 Colored Text
Moccasin #FFE4B5 Colored Text
NavajoWhite #FFDEAD Colored Text
Navy #000080 Colored Text
OldLace #FDF5E6 Colored Text
Olive #808000 Colored Text
OliveDrab #6B8E23 Colored Text
Orange #FFA500 Colored Text
OrangeRed #FF4500 Colored Text
Orchid #DA70D6 Colored Text
PaleGoldenRod #EEE8AA Colored Text
PaleGreen #98FB98 Colored Text
PaleTurquoise #AFEEEE Colored Text
PaleVioletRed #D87093 Colored Text
PapayaWhip #FFEFD5 Colored Text
PeachPuff #FFDAB9 Colored Text
Peru #CD853F Colored Text
Pink #FFC0CB Colored Text
Plum #DDA0DD Colored Text
PowderBlue #B0E0E6 Colored Text
Purple #800080 Colored Text
Red #FF0000 Colored Text
RosyBrown #BC8F8F Colored Text
RoyalBlue #4169E1 Colored Text
SaddleBrown #8B4513 Colored Text

138 Back to TOC

 Tikiwiki Documentation 1.9+

Color Name Color HEX - Colored Text -

Salmon #FA8072 Colored Text
SandyBrown #F4A460 Colored Text
SeaGreen #2E8B57 Colored Text
SeaShell #FFF5EE Colored Text
Sienna #A0522D Colored Text
Silver #C0C0C0 Colored Text
SkyBlue #87CEEB Colored Text
SlateBlue #6A5ACD Colored Text
SlateGray #708090 Colored Text
Snow #FFFAFA Colored Text
SpringGreen #00FF7F Colored Text
SteelBlue #4682B4 Colored Text
Tan #D2B48C Colored Text
Teal #008080 Colored Text
Thistle #D8BFD8 Colored Text
Tomato #FF6347 Colored Text
Turquoise #40E0D0 Colored Text
Violet #EE82EE Colored Text
VioletRed #D02090 Colored Text
Wheat #F5DEB3 Colored Text
White #FFFFFF Colored Text
WhiteSmoke #F5F5F5 Colored Text
Yellow #FFFF00 Colored Text
YellowGreen #9ACD32 Colored Text

no s'ha trobat la imatge img/icons2/alert.gif Not all Color Names are valid in all Browsers, so to be
on the safe side, it is useually best to use the HTML number by default. If these colors do not meet
your requirements, see the link at the bottom of the page for the Color Picker II.

4.1.6.5. Bold Text

Two Underscore (_) characters are used to make text Bold.

Example: __This Text is Bold__ produces:
This Text is Bold

Back to TOC 139

 4.1.6.6. Italic Text

Two Single Quote (') characters are used to make text Italic.
Example: ''This Text is Italic'' produces:
This Text is Italic

4.1.6.7. Underlined Text

Three Equal (=) characters are used to underline text.

Example: ===This Text is Underlined=== produces:
This Text is Underlined

4.1.6.8. Strike through text

Use the {TAG} plugin.

Example:
{TAG(tag=>strike)}This text uses strikethrough{TAG}
produces:
This text uses strikethrough.

4.1.6.9. Centered Text

Two Colon (:) characters are used to Center text. The Centered Text can be centered within a Box, a
Table, or almost anything else.
Example: ::This Text is Centered:: produces:
This Text is Centered

4.1.6.10. Monospaced Text for Code

Monospaced Text is useful when displaying Code and can be created in two ways. The easiest is to
start a new line with one or more spaces. The Minus (-) and Plus (+) character combination can also
be used to specify a Monospaced Text.
Example: -+This Text uses a Monospaced Font+- produces:
This Text uses a Monospaced Font

no s'ha trobat la imatge img/icons2/alert.gif If using a Monospaced Font, be sure to keep the line
length short. If the lines are too long, they will push the right column out of the browser display
area.
no s'ha trobat la imatge img/icons2/alert.gif The Leading Space Monospaced Font is disabled on
many sites.

140 Back to TOC

 Tikiwiki Documentation 1.9+

4.1.6.11. Text box

Apply one caret at start and end of text to be in a box.

Example: ^This Text is in a box^ produces:

This Text is in a box

NOTE: This CSS style is called "simplebox" and may look different or may not exist, depending on
your theme CSS.

4.1.6.12. Plain Text

To turn off tiki formatting, surround your text with 'np' a.k.a. 'no processing' tags

Example: ~np~This ''text'' is __not__ being ===formatted===~/np~ produces:

This ''text'' is __not__ being ===formatted===

NOTE: np tags cannot be used within an np block. To display an unprocessed ~np~ tag, escape all
the characters (not just the tildes) while in normal processing mode:

~126~~110~~112~~126~ produces: ~np~

~126~~47~~110~~112~~126~ produces: ~/np~

4.1.6.13. Indent

Indent is formed by the combination of the ; and : characters. ; must appear at the beginning of a
line and : must appear between introduction text and the indented text. The introduction text portion
is useful for forming definition type indention like Example 1 below. However the introduction text
can be eliminated by simply including ;: together followed by the text as shown in Example 2.
Example 1:
;Intro Text: First example of indented text
produces:
Intro Text
Indented text

Example 2:
;:2nd example of indented text
2nd example of indented text

Back to TOC 141

 4.1.6.14. Using Square Brackets

If you wish to include square brackets in your text (i.e. as regular text and not a link) simply add an
additional open bracket to start. E.g.

[[this would not be a link]

Would render like this...

[this would not be a link]

4.1.6.15. Non-breaking space

Use ~hs~~ to add the HTML "&nbsp;" for a non-breaking space.

4.1.6.16. Entering code

You enter code blocks by enclosing the block between CODE() and CODE tags (you need to put
curly braces around the tags). Note this is a smarty construct, not a Wiki syntax.

Useful Links
• The Color Picker II is located at http://www.pagetutor.com/pagetutor/makapage/picker/
• WebDevlopper extension for Mozilla Firefox
• The wiki syntax is not standardised accross applications. There is an initiative to publish the
Wiki-Syntax as an RFC from the IETF. See [http://tikiwiki.org/RFCWiki|RFCWik

4.1.7. Wiki-Syntax Special Characters

Of course - any of the characters in the following table can be added to a wiki page by enclosing it's
number within a pair of Tildies. Example: ~169~ will display ©
000 001 002 003 004 005 006 007 008 009 010 011 012 013 014 015 ::

016 017 018 019 020 021 022 023 024 025 026 027 028 029 030 031

032 033 034 035 036 037 038 039 040 041 042 043 044 045 046 047
! " # $ % & ' ( ) * + , - . /
048 049 050 051 052 053 054 055 056 057 058 059 060 061 062 063
0 1 2 3 4 5 6 7 8 9 : ; < = > ?
064 065 066 067 068 069 070 071 072 073 074 075 076 077 078 079
@ A B C D E F G H I J K L M N O
080 081 082 083 084 085 086 087 088 089 090 091 092 093 094 095
P Q R S T U V W X Y Z [ \ ] ^ _

142 Back to TOC

 Tikiwiki Documentation 1.9+

096 097 098 099 100 101 102 103 104 105 106 107 108 109 110 111
` a b c d e f g h i j k l m n o
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
p q r s t u v w x y z { | } ~ 
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
€ � ‚ ƒ „ … † ‡ ˆ ‰ Š ‹ Œ � Ž �
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
� ‘ ’ “ ” • – — ˜ ™ š › œ � ž Ÿ
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
¡ ¢ £ ¤ ¥ ¦ § ¨ © ª « ¬ ® ¯
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
° ± ² ³ ´ µ ¶ · ¸ ¹ º » ¼ ½ ¾ ¿
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
À Á Â Ã Ä Å Æ Ç È É Ê Ë Ì Í Î Ï
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
Ð Ñ Ò Ó Ô Õ Ö × Ø Ù Ú Û Ü Ý Þ ß
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
à á â ã ä å æ ç è é ê ë ì í î ï
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
ð ñ ò ó ô õ ö ÷ ø ù ú û ü ý þ ÿ

4.1.8. Wiki Config

4.1.8.1. Admin Access

To access administration, go to Home Page and, on the Menu, click on "Admin (click!)".

4.1.8.2. Sections: Tiki Config Panel

You will see the Sections Tiki Config Panel (see Tiki Config ), as shown in the image below:

Back to TOC 143

 4.1.8.3. Wiki settings

Wiki

From the Tiki Config Panel, click the Wiki icon to display its settings panel, the top of which
appears like so:

Dumps
This section can be used to generate/download an XHTML dump of your Wiki that can be used for
offline browsing, distributing the Wiki in a CD, off-site presentations, and so on.
• Click on the links to download dumps

144 Back to TOC

 Tikiwiki Documentation 1.9+

Create a tag for the current wiki

• Push the button to create a tag

Restore the wiki

• Push the button to restore a tag

Remove a tag
• Push the button to remove a tag

Tags: A tag is a mark in the current state of the Wiki. They can be
used to save the Wiki at regular intervals and to recover the whole
Wiki to a particular state if something disastrous occurred. To
create a tag simply enter a tag name and click the create tag
button. To restore a tag select one of the existing tags and click
restore (all your Wiki pages will be lost and the saved state for the
wiki will be restored!). Since tags can take a lot of space you can
remove tags that you don't want to use by clicking the remove tag
button after selecting the tag that you don't want to use anymore.

4.1.8.4. Wiki Comments Settings

If the Comments option is selected in the Wiki Features area, you can add comments to your wiki
pages. Use this area to configure the the default display of wiki comments.

Wiki Comments Settings area on Wiki Configuration page.

Back to TOC 145

 Field Description
Default Number of Enter the number of comments to show at a time. If a page contains more comments, Tiki
Comments will create NEXT/PREVIOUS links. (Default = 10)
Specify how the comments are shown:
Comments Default Points: Comments with the highest point value are shown first. (Default)
Ordering Newest First: The newest comments are shown first.
Oldest First: The oldest comments are shown first.

Enter your options and click Change Settings. Note that when comments are displayed on a wiki
pages, users have the option to override these defaults and resort the comments.

4.1.8.5. Wiki Attachments

A Wiki page can have attached files. You can specify if the attachments are stored in the datbase or
in the file directory.

In the Wiki Administration area, click __Manage attachement preferences.

Wiki Administration area of the Wiki Configuration page.

The Wiki Attachements page appears. In this panel you can configure whether attachments are
allowed and where to store the files.

You can store attachments in the database or a directory. The directory path can be absolute or
relative to the Tiki directory. The maximum size of an attachment is specified by your webserver's
PHP.INI upload_max_filesize setting. By default, the maximum upload size is 2MB.

Wiki Attachments page

146 Back to TOC

 Tikiwiki Documentation 1.9+

Field Description
Wiki Attachements Specify if files can be attached to wiki pages.
Use Database to Store If selected, files that are attached to wiki pages will be converted to BLOBs and stored in the
Files Tiki database in the tiki_wiki_attachments table.
If selected, files that are attached to wiki pages will be stored in the specified dirctory. The
directory can be an absolute path (such as http://www.foo.bar/attachments/_) or reltative to
Use a Directory to
the Tiki installation directory (such as attachements/).
Store Files
Note: The trailing slash (/) is mandatory and must be included in the path.
This area lists all current attachments. You can use this area to change an attachements storage
Wiki Attachments
location to either Datbase to File.

Enter your options and click .Change Preferences.

4.1.8.6. Export Wiki Pages

The Export link can be used to export all your Wiki pages to a PHPWiki compatible format. Then
you can import pages if you want using the Import PHPWiki Dump link in the Admin menu.
Each page is exported to a file where all the versions of the page are stored in MIME format.
• Click on the link to export wiki pages

4.1.8.7. Remove unused pictures

This link can be used to remove all the pictures that are stored in the Wiki pictures directory
(img/wiki_up) but are not referenced in any Wiki page.
• Click on the link to remove unused pictures

4.1.8.8. Wiki Home Page

Indicates the name of the page that will be the HomePage for your Wiki.
• Click on the button to set the page

Back to TOC 147

 4.1.8.9. Wiki Discussion

Discuss pages on forums activates a discuss button on every Wiki page that takes users to a thread
in the specified forum for that particular page. The forum must be created before, if not created.
This allows users to create an open discourse about pages using the public forums. If the thread for
a page does not exist, Tiki creates it.
Note: Wiki Discussion feature overlaps the Comments feature and was introduced because of the
difficulty to spot new comments in a Wiki with many pages but this is not problematic anymore. It is
similar to the Comments features and the two can be used at the same time although it is probably
better to use only one.
• Click on the button to change preferences

4.1.8.10. Wiki Link Format

This control can be used to control recognition of Wiki links using the two parenthesis Wiki link
syntax ((page name)).
• english allows only letters, numbers, space, underscore, dash, period and semicolon (but
space, dash, period and semicolon not allowed as either the first or last characters).
• latin adds accented characters.
• complete allows anything at all but is not guaranteed to be bug-free or secure.
Note that this only affects the Wiki syntax ((page name)). It does not affect recognition of the Wiki
naming convention of Smashed words starting with capital letters (example: ThisIsSomePage).
• Push the button to set the format

4.1.8.11. Wiki page list configuration

Simply determines which columns will show in the Pages screen (available as List pages in the
Wiki menu).
• Push the button to set preferences

148 Back to TOC

 Tikiwiki Documentation 1.9+

4.1.8.12. Wiki features

This section can be used to enable/disable specific Wiki features.

Back to TOC 149

 Sandbox
The Sandbox page allows users to practice their Wiki page editing skills. The Sandbox is a special
page where everybody has write permission and no history is saved.

Last Changes
This feature displays the last changes to the Wiki.

150 Back to TOC

 Tikiwiki Documentation 1.9+

Dump
If enabled dumps can be used.

Export
Allows users to export individual pages and structure pages content as a file (requires
tiki_p_admin_wiki permission).

Rating
This allows you to add a poll from polls? feature to any wiki page. The poll is unique to the page,
created from a "poll template" which is created in the Poll feature: set a poll's 'active' drop-down to
"template". You may have to adjust your groups permissions for tiki_p_wiki_view_ratings and
tiki_p_wiki_vote_ratings.

History
If enabled users can see the history of each Wiki page.

List Pages
If enabled users can see the list of Wiki pages--like a directory of Wiki pages.

Backlinks
Allows users to view a list of pages that link to the current page

Like pages
If enabled users can see a listing of pages named similarly to the current page.

Rankings
If enabled users can see several charts or rankings about the Wiki.

Undo
If enabled then the user who last edited a page can undo his or her edit.

Multiprint
If enabled a section is provided where a user can select several Wiki pages and then view them in a
printer-friendly version. This can be used to print multiple pages.

PDF generation
If enabled Wiki pages can be converted to PDF format for printing, archiving, or other purposes.
There are known bugs in the PDF generation.

Back to TOC 151

 Comments
If enabled Wiki pages can have comments. This feature overlaps the Wiki Discussion feature, you
can read the note about Wiki pages comments/discussion at the bottom of this page.

Spellchecking
If enabled the spellchecker can be used for Wiki pages.

Minor Edits
Users with the right permission can do minor edits on Wiki pages. Minor edits are not reflected in
the history and users watching the page are not notified of them.

Use templates
If enabled templates can be used to edit Wiki pages. The user editing a page can select one of the
templates available for Wiki pages. See ContentTemplatesDoc to learn how to create templates for
wiki pages.

Warn on edit
If enabled then when a user is editing a page the edit button will be colored red and the name of the
user editing the page will be displayed as a tooltip. If the user saves or cancels his or her edit or if
the indicated amount of time passes the edit button will be displayed normally. This feature is
useful to prevent collisions when editing pages.

Pictures
If enabled users can quickly add an image to a Wiki page by simply uploading the picture when
editing a page. The picture will be stored in img/wiki_up using the name of the picture as an Id.

Use page description

If enabled a description can be entered when editing a page and descriptions will be displayed
below the page name when viewing a page.

Show page title

If enabled the page title will be displayed. If disabled no title will be displayed (and it will be hard
to know what page you are editing!).

Cache Wiki pages

If enabled then Wiki pages can be cached, so the Tiki engine will not have to parse the page content
to display it. After the indicated time passes or if the page is changed, the cache is invalidated.

Footnotes
If enabled logged users can write personal footnotes when editing a page. The footnotes will be

152 Back to TOC

 Tikiwiki Documentation 1.9+

displayed only to the user who edited them inmediately below the Wiki page. This can be used as a
good way to let users make personal notes and observations about pages.

Users can save to notepad

If enabled and if the user's notepad feature is enabled and if the user is logged a save icon will be
shown when viewing a page, letting the user save the page to his or her personal notepad.

Users can lock pages

If enabled then users with permission to lock pages can lock pages and only the user who locked a
page or admin can unlock it.

Use WikiWords
If enabled then words using the Wiki naming convention of Smashed words will automatically
become links. WikiWords start with capital letters and include capitals in the middle of the word
(example: ThisIsAWikiWord).

Page creators are admin of their pages

If enabled then users who create a page are also in control of that page. They have administrators
rights over it.

Table syntax
This selects the syntax to be used for new rows in tables. Can be || or "\n" (line break).
Example of both ways for inserting a new row
Using || for new rows Using \n for new
||r1c1|r1c2||r2c2|r2c2|| rows
||r1c1|r1c2

r2c1|r2c2||

Automonospaced text
If this is enabled, the Tiki code lines starting with at least one space are interpreted and rendered
with monospaced font. Generally if you have occasional users this can get them puzzled and
wondering what's happening.

Uses Slideshow
If enabled users can generate slideshows from structures.
• Push the button, when finished to set preferences.

Back to TOC 153

 4.1.8.13. Wiki History

This panel is to control the deletion of old versions of Wiki pages.

Maximum number of versions for historydetermines how many versions of a Wiki page will be
kept before older versions are deleted. This affects the level of undo that is possible, but also how
much of the page's evolution you can see. This can be useful in a highly collaborative environment
where it seems that some elements don't make sense anymore.
Never delete versions younger than days can be used as a basic way to avoid vandals or to make
sure that editors can review all the changes done to a page if many edits were done in a short time.
• Push the button to set preferences.

4.1.8.14. Copyright

You can use or not the Copyright to specify a

content license under which all Wiki pages are
published when submitted. License Page
indicates the Wiki page containing the default
license of your Wiki. It won't be created
automatically. Submit Notice is seen when
editing a Wiki page to indicate what content is
suitable considering the license.

• Push the button to set preferences.

4.1.8.15. Wiki Watch

The two first options automatize the monitoring of

Wiki pages.
Create watch for author on page creation
automatically makes a page creator monitor the page
he created.
Enable watches on comments notifies monitorers of
new comments, as for a new edit.
Used less often, Enable watch events when I am the
editor cancels the normal behavior which assumes
that editors do not want to be notified themselves
when they modify a page they are monitoring.

154 Back to TOC

 Tikiwiki Documentation 1.9+

• Push the button to set preferences.

4.1.9. Wiki Details

4.1.9.1. Wiki Modules

module name usage

Shows the name of the commented pages, the beginning of comment and in tooltip the
wiki_last_comments
commenter and comment date.
comm_received_objec
A summary of objects received in your site from other sites (including Wiki pages)
ts
last_modif_pages Shows the name of the latest changed Wiki pages. Extremely useful to review modifications
quick_edit Allows to edit or create a Wiki page by simply entering its name
random_pages Shows random pages at each pageload
search_wiki_page Searches for Wiki pages matching (can be partially) the name entered
top_pages Most visited Wiki pages
user_pages Shows the pages edited (or created) by the module viewer

4.1.10. List Pages

tiki-listpages.php
The setting in admin->wiki->wiki->list pages.
The perm is tiki_p_view

4.1.10.1. find

The find option filters on the pagename.

If you enter abc, it will search for the pages that have a name containing abc (for instance, the pages
abcde, abc, wabc will be returned, but the page abxc will not)
If you enter 'abc efg' or 'abc, efg'(string containing different word), it will search for the pages with
a name containing abc or efg or both (for instance 'abcee', 'xxabc zz yyefg'). If you want only the
pages containing 'abc efg', you have to match exact match option.

It is possible to use wildcards in the find string:

• % to match an arbitrary number of characters (including zero characters)
• _ to match any single character
To match any special character precede it with \
Examples:
ab%c will return adbc, aeebcdd
a\%b will return a%bccc but not acb

Back to TOC 155

4.1.11. Wiki Plugins
The Wiki syntax is powerful enough for normal Wikis, but sometimes you need features not present
in the Wiki. To ease the process of extending the Wiki syntax Tiki allows you to define a "plugin"
to extend the Wiki syntax. Minimum PHP programming skills are needed to build a plugin.

Wiki plugins extend the function of wiki syntax with more specialized commands. Usually
expressed in {curly brackets} plugins compact a chunk of PHP or HTML code into something that
can be understood by non-programmers. You can view a list of plugins (maybe not the whole list)
by clicking wiki help --> show plugins near the bottom of any wiki edit page.
Plugins documented on this site

Frequently used Plugins still documented on tikiwiki.org:

See the entire PluginsList - from tikiwiki.org.

Here is a generated list: PluginManager

Installing a new plugin

Some plugins are not installed by default in your tiki installation. They can be installed at a later
stage as a Mod. See how to install them:

http://doc.tikiwiki.org/Mods+User

What they look like:

Plugins often have "begin" and "end" tags and are identified in a wiki page using the following
syntax:

{PLUGINNAME(parameter1=>value,parameter2=>value)} content affected by plugin

{PLUGINNAME}
• {NOSPACESAREALLOWEDINPLUGINS(anywhere)}
• plugins are often case sensitive
• parameters you don't specify will be set to their defaults.
• parameters are separated by commas, values within a parameter are separated vertical bars |
• you can use either => or = in parameters.

Example:

Creating A Plugin
We may want to create a plugin to allow text formatting in any font and size:

{FONT(size=>20,face=>arial)} some text {FONT}

If a plugin doesn't require parameters you can use

156 Back to TOC

 Tikiwiki Documentation 1.9+

{EXAMPLE()} content {EXAMPLE}

When tiki finds a plugin the engine will look at the plugin name and look for the file

lib/wiki-plugins/wikiplugin_name.php

For example

lib/wiki-plugins/wikiplugin_font.php

That file should be a PHP file defining the function

function wikiplugin_font($data,$params) {}

The function receives the plugin content in $data and the parameters in the $params associative
array. The function manipulates the content and must return a string with the HTML that will
replace the plugin content when rendering the wiki page (it can be just text if no HTML markup is
needed).

This is an example: the example plugin:

1 . function wikiplugin_example($data,$params) {
2 .
3 . extract($params);
4 .
5 . if(!isset($face)) {
6 . return ("<b>missing face parameter for plugin</b><br/>");
7 . }
8 . if(!isset($size)) {
9 . return ("<b>missing size parameter for plugin</b><br/>");
10 . }
11 . $ret = "<span style='font-face: $face; font-size: $size'>$data</span>";
12 . return $ret;
13 . }

Plugins are a powerful tool. These are some ideas for plugins:
• Display some language code hightliting it's syntax
• Display snippets of code
• Display poetry
• Display text using a special style
• Display charts, gauges.
• Show information from other sites.
• Use plugins to display and maintain bibliography information (using Pybliographer for
instance)
• Etc etc etc

Back to TOC 157

 Special Plugins
These aren't real plugins but, like plugins, use a slightly different curly braces syntax. Unlike
plugins, you don't "close" them. e.g., use {maketoc} instead of {maketoc()}{maketoc}. These can
also appear in template (.tpl) files.
banner
Displays a banner. {banner zone=}. Set up banners via admin menu. Note that if you assign
multiple banners to the same zone, {banner} will pick a different banner in that zone each
time (more or less) the page is refreshed.

content
Displays dynamic content

draw
Displays a drawing which is an image that can be modified via a Java applet. {draw name=}.
name must be unique for the entire site. Requires "drawing" feature to be turned on via the
admin menu. If the drawing doesn't exist, the page will display a button that will create the
drawing.

img
Displays an image {img src= height= width=}. Mimics the HTML img tag.

maketoc
Displays an indented table of contents using !, !!, !!! headers. {maketoc}.

rss
Displays an RSS feed. {rss id= max=}. Set up RSS feeds via admin menu (RSS Modules).

toc
Displays a table of contents for the structure that the page belongs to.

4.1.11.1. PluginAgentinfo

This plugin displays the client browsers information into the current page. It can currently display:
your browser's IP address, user agent, or your server's software.

Usage
To display a module in a wiki page, use the syntax:
{AGENTINFO(info=>IP or SVRSW or BROWSER)/}

Parameter Accepted values Effect Since

IP,BROWSER,SVR Displays the Ip address (default), Browser of servers
info
SW software information

158 Back to TOC

 Tikiwiki Documentation 1.9+

Example
This code,
will display the visitors IP address
^{AGENTINFO(info=>IP)}{AGENTINFO}^

Would produce:
85.58.17.82

This code,
will display the visitors user agent string
^{AGENTINFO(info=>BROWSER)}{AGENTINFO}^

Would produce:
Mozilla/5.0 (Windows; U; Windows NT 5.1; ca; rv:1.8.1.5) Gecko/20070713 Firefox/2.0.0.5

This code,
will display the servers software.
^{AGENTINFO(info=>SVRSW)}{AGENTINFO}^

Would produce:
Apache/2.0.54 (Unix) PHP/4.4.7 mod_ssl/2.0.54 OpenSSL/0.9.7e mod_fastcgi/2.4.2 DAV/2
SVN/1.4.2

Related pages
• Wiki Plugins
• Mods Type Wikiplugins

4.1.11.2. Plugin Alink

This is a plugin that puts a link to an anchor in a wiki page. Use in conjunction with the ANAME
plugin, which sets the location and name of the anchor.

Usage
To display a module in a wiki page, use the syntax:

Back to TOC 159

{ALINK(aname=anchorname,pagename=Wiki Page Name)}linktext{ALINK}

Example
ANAME PLUGIN USAGE

{ANAME()}

anchorname <--put the name of the anchor here. Use this same name for the aname= parameter in
the ALINK plugin (see just below).

{ANAME}

ANAME EXAMPLE: {ANAME()}anchorname{ANAME}

ALINK PLUGIN USAGE

{ALINK(

aname=anchorname <-- put here the name of the anchor you created using the ANAME plugin!

)}

link text <-- put here the text to appear as the link.

{ALINK}

ALINK EXAMPLE: {ALINK(aname=anchorname)}link text{ALINK}

DEMONSTRATION
HERE

Related pages
• Wiki Plugins
• Mods Type Wikiplugins
• PluginAname

• PluginA as an alternative to ANAME/ALINK

4.1.11.3. Plugin Aname

This is a plugin that puts an anchor into a wiki page. Use in conjunction with the ALINK plugin,
which makes links to the anchor.

160 Back to TOC

 Tikiwiki Documentation 1.9+

Usage
To display a module in a wiki page, use the syntax:
{ANAME()}anchorname{ANAME}

Example
ANAME PLUGIN USAGE

{ANAME()}

anchorname <--put the name of the anchor here. Use this same name for the aname= parameter in
the ALINK plugin (see just below).

{ANAME}

ANAME EXAMPLE: {ANAME()}anchorname{ANAME}

ALINK PLUGIN USAGE

{ALINK(

aname=anchorname <-- put here the name of the anchor you created using the ANAME plugin!

)}

link text <-- put here the text to appear as the link.

{ALINK}

ALINK EXAMPLE: {ALINK(aname=anchorname)}link text{ALINK}

DEMONSTRATION
HERE

Related pages
• Wiki Plugins
• Mods Type Wikiplugins
• PluginAlink

• PluginA as an alternative to ANAME/ALINK

Back to TOC 161

 4.1.11.4. Plugin Article

This plugin includes an article field in a wiki page.

Usage
To display a module in a wiki page, use the syntax:
{ARTICLE(Id=>''articleId'',Field=>''fieldname'')}{ARTICLE}

Parameter Accepted values Effect Since

articleId numeric id of the article to be displayed
Value can be any field in the tiki_articles table, but title,heading, or
fieldname title,heading,body,...
body are probably the most useful.

Example
Let's say you wish to display the contents of an article with the Id of 10 from your site
(http://doc.tikiwiki.org/art10 taken as example) inside a Wiki page. Simply, include this type of
code in your page:

Title
This code,
^{ARTICLE(Id=>10,Field=>title)}{ARTICLE}^

would produce:
Documentation Status Page Updated to new tagging system

Heading
This code,
^{ARTICLE(Id=>10,Field=>Heading)}{ARTICLE}^

would produce:

We've made some changes to the Documentation Status page that will help keep things up to date.
Take a look!

Body
This code,
^{ARTICLE(Id=>10,Field=>body)}{ARTICLE}^

162 Back to TOC

 Tikiwiki Documentation 1.9+

would produce:
Over that last several weeks, we've moved the Documentation Status page to a new system. We're
now using backlinks to index to show pages that need attention. We've created a new
Documentation Lifecycle document that explains the new status tags, and a How To Tag reference
page that will show you how to use tags to help documents move to final production status. This
idea was conceived and created by mlpvolt, and dthacker pitched on the supporting documents.
Please take a few moments to review these documents and start applying tags as you find
opportunities to improve the docs. If you have any questions, please drop me an internal message
or catch me on irc. Thanks for your help.

Related pages
• Wiki Plugins
• Mods Type Wikiplugins

4.1.11.5. Plugin Articles

This is a plugin includes any number of articles into a wiki page. For a plugin that includes
components of a single article, see pluginArticle?.
This is particularly useful if you want to include the top 2 articles into your homepage, but being
anyway able to write some custom Wiki text.

To display a module in a wiki page, use the syntax:

{ARTICLES(max=>3,topic=>tw,type=>news,categId=>1,lang=>en,sort=>lastModif_asc)}{
ARTICLES}

Parameter Accepted values Effect Since

Meant to control number
max Numeric
of articles
topic String Filter on the topic
type Numeric Filter on the type Id
categId Numeric Filter on the category Id
lang String(en,fr,en_uk...) Language 1.9.7
String(columnName_asc or columnName_desc where sort on column asc or
sort 1.10
columnName is a column name (lastModif) desc

Example
In this example below, a wiki page is shown including the articles plugin, so that last articles are
shown below the "! News" heading of the page:

Back to TOC 163

In that example, the syntax was:
{ARTICLES(max=>5,topicId=>!5)}{ARTICLES}

Multilingualism
The multilingualism is managed on 2 aspects:
• If you have selected the multilingualism and best_language features, and when this plugin is
inserted in a page that has a defined language, some articles can be filtered out. For each set
of translations, when one article of this set has the same language as the page language, only
this article in the set will be displayed. Please note that you can still see an article of another
language, if this article is not in a set of translations or if this set of translations has no article
in the page language.
• If you use the parameter lang, only the articles in this language will be shown

Bugs:
As of 1.9.7 Max=>1 does not set articles displayed to 1. Perhaps it should.

4.1.11.6. Plugin Box

This plugin creates a box with a title bar. Optionally, you can add title text, a background color,

164 Back to TOC

 Tikiwiki Documentation 1.9+

and/or a width (specified in pixels or a percentage of the available window space). The title bar is
formatted using the CSS style used for module headings, so the box will look consistent no matter
which theme is chosen.

To place a simple box around text , you can use the ^ tag, as explained in Wiki-Syntax Text.

Usage
To display a module in a wiki page, use the syntax:
{BOX([title=>title],[bg=>color],[width=>num[%]])}
Text inside box
{BOX}

The square brackets [ ] indicate that the parameter is optional. The commas aren't needed unless you
type two or more of the options.
Parameter Accepted values Effect Since
Text that appears in a one-line title box. Keep it short!. Title bar
title text is formatted using the module heading style defined in the
current theme
anglophone color name or a
bg hexadecimal color code, a background color
such as #FFFFFF (white)
width of the box in pixels or, if followed by a percent sign, the
width number or %
width as a percentage of the available window area

TIP: Even though the title is optional, be sure to define a title. The default title is "Message Box",
which isn't very helpful to your readers.

Example

No options
(note that Tiki supplies a default title automatically, but you probably don't want this title)

This code,

{BOX()}
A whole lot a shakin goin on
{BOX}

Would produce:
A whole lot a shakin goin on

Back to TOC 165

Title only
This code,

{BOX(title=>Tiki Rocks)}
A whole lot a shakin goin on
{BOX}

Would produce:
Tiki Rocks
A whole lot a shakin goin on

Title and background color

This code,

{BOX(title=>Tiki Rocks, bg=>#CCCCCC)}

A whole lot a shakin goin on
{BOX}

Would produce:
Tiki Rocks
A whole lot a shakin goin on

Title, background color, and width

This code,

{BOX(title=>Tiki Rocks, bg=>#CCCCCC,width=>90%)}

A whole lot a shakin goin on
{BOX}

Would produce:
Tiki Rocks
A whole lot a shakin goin on

Step by step instructions for beginners

To use the BOX plugin, do the following:
1. Place the insertion point on a blank line.

166 Back to TOC

 Tikiwiki Documentation 1.9+

2. Define the box and the options you want (title, background color, and/or width ) by
following these examples:
1. Title: {BOX(title=>Title)}
2. Background color: {BOX(bg=>#CCCCCC)}
3. Width in pixels: {BOX(width=>256)}
4. Width in percentage: {BOX(width=75%)
5. All options: {BOX(title=>Title, bg=>#CCCCCC, width=>75%)}
3. Type the text you would like to place within the box, and press Enter.
4. Type {BOX}.

Help!
Did something go wrong?
• Double-check your typing to make sure you have included all the necessary curly braces,
commas, and parentheses.
• If you're sure you typed the plugin syntax correctly, ask your administrator whether the
BOX plugin is enabled.

Related pages
• Wiki Plugins
• Mods Type Wikiplugins

4.1.11.7. Plugin Category

This plugin will display a bulleted list of categories and items in those categories. Options let you
decide what level of category, what types of objects to list, how they should be sorted, whether to
display items in subcategories, and whether multiple categories displays should be split.

Usage
To display a module in a wiki page, use the syntax:

{CATEGORY(id=>1+2+3, types=>article+blog+faq+fgal+forum+igal+newsletter+event+poll+
quiz+survey+tracker+wiki+img, sort=>[type|created|name|hits|shuffle]_[asc|desc], sub=>y|n,
split=>y|n)}{CATEGORY}

parameters:

id=>1+2+3 # defaults to current

types=>article+blog+faq+fgal+forum+igal+newsletter+poll+quiz+survey+tracker+wiki+img # list
of types of objects, default * (all),
sort=>[type|created|name|hits]_[asc|desc] # default name_asc,
sub=>true|false # display items of subcategories, default is 'true';
split=>true|false # when displaying multiple categories, whether they # should be split or not;
defaults to yes. Use n for false.

Back to TOC 167

 How to Determine a Category ID

(short of guessing)

Browse the categories (See Categories USer?), hover over a category item, and look at the browser's
status bar.

Example

This code,
^{CATEGORY(id=>4,sub=>true)}{CATEGORY}^

Would produce:
3.In Progress
wiki page: Design rules · Dynamic Content Admin · FAQ Details · Games · Hacking Tikiwiki ·
Linux tools · Live Support Admin · MyTiki Admin · Newsreader · Phpinfo · Stats · Stats Admin ·
Survey Details · ToolBox · Bookmark · User Calendar · User Files · User Menu · User Modules ·
User Preferences · Multiplatform Tools · Webmail · Windows tools · Survey User · Calendar Details
· Stats Details · Integrator Details · Module Details · Stats User · Game User · Integrator User · Live
Support User · Mobile Tiki User · Comment User · Drawings User · Live Support Details · RSS
Feeds Details · Search Details · MyTiki Details · Tikiwiki Community · GraphViz Install · Menu
HOWTO · Survey · Calendar User · Directory Img-Flags Files · Directory Img-Icons Files ·
Directory Img-Icons2 Files · Directory Lib-Adodb Files · Wiki-Syntax Separators · Tracker User ·
Game Admin · Advanced Configuration · Requirements and Setup,nl · Collaborative
Documentation,nl · Introduction,cs · Smarty Templates · Wiki-Syntax Lists,fr · Advanced
Settings,fr · Rewrite Rules,fr · Using profiles · Install on Debian,fr · Image Gallery User,es ·
MultiTiki,fr · Image Gallery,fr · Download,nl · RSS · MyTiki · RSS User · Wiki,fr · Wiki · Blog ·
FAQ Admin · Features,es · Wiki Admin,ca · RSS Admin · Blog User · Integrator · Tracker Details ·
Mobile · Advanced Configuration,fr · Formatting Standards,fr · HomePage,fr · Users
Management,fr · Module · Module User · Using Wiki Pages,es · Using+Blogs,es · Blogs User,es ·
Forum · Featured Links · Newsletter · Task · Trackers,es · Wiki,es · File Gallery User · File
Galleries User,es · Modules,es · Categories User,es · Categories Admin,es · Forums User,es ·
Trackers User,es · RSS Feeds User,ca · Mapserver · Maps Details · Wiki-Syntax Images,es · Wiki-
Syntax Images,ca · Documentation Status,ca · Comment Admin · Maps Mapfile Tutorial ·
Comments · Maps Install · Maps Admin · Tutorial: Registration and Login · Map · Maps User ·
HomePage,cs · Structures,es · Using Wiki Pages,ca · Search Admin · Directory · Translating to a
new language · Live Support · Upgrade · Freetags · Spreadsheet · Tutorials · Install on Debian ·
Tracker Admin · Category · Permissions · External Wikis · Features Admin · Groups Management ·
Quick Start · Using Wiki Pages · Documentation Status,fr · Goals,es · Documentation Status,es ·
Mailin · Blogs,es · AdminCalendar · Tutorial: Navigating Maps · Goals · Theme Control · Copyright
· Chat · Styles and Themes · i18n Admin · Content Organization Tools and Navigation Aids ·
Adding a new feature · Login Config · Watch · Meta Tag · Tiki Config · Requirements and Setup ·

168 Back to TOC

 Tikiwiki Documentation 1.9+

Meta Tags Config · General Admin · Dynamic Content · Survey Admin · Tikiwiki Manual of Style ·
Documentation · Calendar · Calendar Admin · Tracker · Welcome Authors · RSS Modules ·
Structure · Structure Details · Structure Admin · Features · Wiki Plugins · Slideshow User · Wiki-
Syntax Text · Ephemerides · Ephemerides Details · How To Review Documentation · Spellcheck
User · Documentation Status · Module Admin · Quiz · Quiz Admin · FAQ · FAQ User · Menus ·
View List In Progress · Users Management · Wysiwyg Editor Admin · Wysiwyg Editor · Wysiwyg
Editor User · Site Identity · Module Control · commercial webhost installation · siteground.com
installation · Upgrade 1.9.7 to 1.10 · Upgrade 1.9.x to 1.9.7 · PluginRSS · Using Wiki Pages,el ·
Documentation,el · Forum and List Synchronization · Games User · Search · Game Details · Eclipse
·
article: Top 5 Documentation Tasks This Week, September 24, 2006 ·

FAQ
WRONG
{CATEGORY(id=>[2]types=>faq)}{CATEGORY}

{CATEGORY(id=>6, types=faq)}{CATEGORY}

CORRECT
{CATEGORY(id=>2,types=>faq+blog+article)}{CATEGORY}

{CATEGORY(types=>wiki,sort=>created_asc)}{CATEGORY}

{CATEGORY(split=>true)}{CATEGORY}

{CATEGORY()}{CATEGORY}

Related pages
• Wiki Plugins
• Mods Type Wikiplugins

• Categories
• Categories User?
• Categories Admin?
• Categories Details

4.1.11.8. Plugin CatOrphans

This plugin can be added to any wiki page to list all objects (wiki pages, articles, etc) which are not
included in Tiki's category system.

Back to TOC 169

 Usage
To display a module in a wiki page, use the syntax:

{CATORPHANS(objects=>wiki|article|blog|faq|fgal|forum|igal|newsletter|poll|quizz|survey|
tracker)}{CATORPHANS}

Example
See it in action here: http://tikiwiki.org/CatOrphans
Related pages
• Wiki Plugins
• Mods Type Wikiplugins
• Category
• Category Admin

4.1.11.9. Plugin Center

This plugin can be used to center data in a wiki page.

Usage
To display a module in a wiki page, use the syntax:
{CENTER()} data{CENTER}

Example
This code,
{CENTER()}
|| __table__
a | ::b:: | c
1 | 2 | 3 ||
{CENTER}

Would produce:
This is a table that will be centered in the middle of the page
a b c
1 2 3

Related pages
• Wiki Plugins
• Mods Type Wikiplugins

170 Back to TOC

 Tikiwiki Documentation 1.9+

4.1.11.10. Plugin Code

This plugin is used when you need to embed any source code, including most wiki syntax, in the
wiki.

It is controlled by styles in the stylesheet, but is generally in its own box and in a fixed-width
monospaced font. This is the standard notation used in most books and online resources with code
snippets.

The plugin will escape syntax, preventing tiki from accidentally parsing them, but there are a few
difficult areas that you need to beware of. XML or SGML syntax may cause a hiccup if you have
enabled the HTML flag on the document. This also means that you must be wary with the greater
than , or less than signs.

Usage
To display a module in a wiki page, use the syntax:

{CODE(ln=>1,colors=>php|highlights|phpcode,caption=>caption
text,wrap=>1,wiki=>1,rtl=>1)}code{CODE} - note: colors and ln are exclusive

And if you have not figured it out yet, the example of the use of the code plugin, actually uses the
code plugin - neat eh? You can recurse code tags, and it will simply render all those but the ending
one.
Beware - this will cause a problem if you mismatch them.

Parameters
Accepted
Parameter Effect Since
values
This setting if present (set to 1) will provide line numbering. Warning: The
ln 0,1
ln or colors parameters are used mutually exclusively
This will provide code syntax colouring and highlighting. You can set this to
php,highlights, "php","highlights" or "phpcode". Additional syntaxes may be added at a
colors
phpcode future date. Warning: The ln or colors parameters are used mutually
exclusively
caption 0,1 This allows you to provide a caption for the code box
wrap 0,1 This enables line wrapping on the code, if necessary.
This enables wiki interpretation of the code, otherwise wiki style markup in
wiki 0,1
the code is left alone.
rtl 0,1 This enables the right to left display of text

Example
Example (with dummy code):
^{CODE(caption=>"Would display:")}

Back to TOC 171

~myClass()
{
baseClass.refCount--;
baseClass.iter[refCount].delete();
a = b + ((c + d));
}
{CODE}^

Would display:
Would display:
~myClass()
{
baseClass.refCount--;
baseClass.iter[refCount].delete();
a = b + ((c + d));
}

Related pages
• Wiki Plugins
• Mods Type Wikiplugins

4.1.11.11. Plugin Copyright

This plugin inserts a copyright notice.

Usage
To display a module in a wiki page, use the syntax:

{COPYRIGHT()}~title~~year~~authors~text{COPYRIGHT}

Example
This code,

{COPYRIGHT()}~Tikiwiki Documentation and user manual~~2007~~Tikiwiki community~The

documentation on this web site is licensed under a Commons Attribution - ShareAlike License{
COPYRIGHT}

Would produce:

(help needed)

172 Back to TOC

 Tikiwiki Documentation 1.9+

Related pages
• Wiki Plugins
• Mods Type Wikiplugins

4.1.11.12. PluginDiv

The DIV is HTML tag.

It can be used for positioning and formating content.
SPAN tag are better sometimes
User Documentation
This is used in Wiki Syntax and works in WikiPages?:

{DIV()} Your content {DIV}

Produces

Your content

Options
• align=>left :: {DIV(align=>left)} Your content {DIV}
• align=>right :: {DIV(align=>right)} Your content {DIV}
• align=>center :: {DIV(align=>center)} Your content {DIV}

• bg=>color :: {DIV(bg=>#eebb00)} Your backgroud color {DIV}

• width=>num % :: {DIV(width=>50%)} Your width {DIV}

Produces

Your content RIGHT by {DIV(align=>right)} {DIV}

Your backgroud color by {DIV(bg=>#eebb00)} {DIV}

Your width by {DIV(width=>50%)} {DIV}

code rendering
align <div style=" text-align: right;"> your content </div>
bg <div style=" background: #eebb00;"> your background color </div>
width <div style=" width: 50%;"> your width </div>

Trick:

Back to TOC 173

When you use a floated div, you need to do a clear. One method is to use a dynamic variable NaV.
The variable must be set to
<br style="clear: both" /> . To set its value, click on NaV the first time.

4.1.11.13. Plugin FancyTable

This plugin displays the data using the Tikiwiki odd/even table style.

Usage
The data (and the head parameter) is given one row per line, with columns separated by ~|~.

To display a module in a wiki page, use the syntax:

{FANCYTABLE(head=>,headclass=>)}cells{FANCYTABLE}

Parameter Accepted values Effect Since

header column 1 ~|~ header column 2 ~|~ the column header row, heads (and cells)
head
header column 3 separated by ~|~
headclass 1.10

Example
This code,
{CODE()}{FANCYTABLE( head => header column 1 ~|~ header column 2 ~|~ header
column 3 )}
row 1 column 1 ~|~ row 1 column 2 ~|~ row 1 column 3
row 2 column 1 ~|~ row 2 column 2 ~|~ row 2 column 3
{FANCYTABLE}{CODE}

Would produce:
header column 1 header column 2 header column 3
row 1 column 1 row 1 column 2 row 1 column 3
row 2 column 1 row 2 column 2 row 2 column 3

As a reference, under tikineat.css style, it shows as:

Related pages
• Wiki Plugins

174 Back to TOC

 Tikiwiki Documentation 1.9+

• Mods Type Wikiplugins

4.1.11.14. PluginFiles

Plugin FILES
Can be found in the mods
Purpose
This plugin allows you to display a list of files like in the list file in a gallery script.
The files can be :
• in a gallery
• in a gallery with a special category (>= Tikiwiki 1.10 where category on file has been
introduced)
• with a category

The files will respect the perms

• its gallery must be visible by the user
NOTA: a category with a perm on a file has no effect
Parameters
{FILES(galleryId=id,categegoryId=id,sort=name_asc)}Title{FILES}

galleryId numeric gallery ID

categoryId numeric category ID
column_asc or
sort sort column and asc or desc
column_desc

• If you give only categId, all the files that are in a gallery with this category and all the files
of this category(after Tikiwiki1.10) will be returned.
• If you give only galleryId, all the files of this gallery will be returned
• If you give galleryId and categId, all the files of the gallery that have this category will be
returned
• The fields that are displayed are those specified in one of the gallery
• if you specify Title, instead to see the category name or the gallery name as title, you will
see this text as title

Example
{FILE(categoryId=5) /}
{FILE(galleryId=1)/}

Back to TOC 175

 4.1.11.15. PluginFlash

To embed a Flash movie in a wikipage, use the syntax:

{FLASH(movie=>movie_url_here)}{MOVIE}

This syntax is that of a standard wiki plugin, so it is possible to use the shorthand syntax:
{FLASH(movie=>movie_url_here)/}

You can optionally pass other parameters :

{FLASH(movie=>movie_url_here,height=___,width=___, quality=high)/}

Parameter Accepted values Effect

movie url of flash movie If the URL contains an =, the url must be enclosed in quotes
height Numeric pixel height of movie
width Numeric pixel width of movie
quality high

176 Back to TOC

 Tikiwiki Documentation 1.9+

Example:
{FLASH(movie=>http://studiolife.net/flash/TW-
plugtest.swf,width=>550,height=>400,quality=>high)/}

{FLASH(movie=>"tiki-download_file.php?fileId=1")/}

shows as:
Missing parameter movie to the plugin flash

4.1.11.16. PluginGoogleVideo

This is using the PluginFlash

To add a Google video in a wiki page, forum post, blog post, use the FLASH plugin like this:

{FLASH(movie="http://video.google.com/googleplayer.swf?docId=-
3275007704055224798&hl=en",width=>425,height=>350,quality=>high)}{FLASH}

It will generate:

Make sure you use the URL has " " around it. If not, the embedded equal sign (=) causes a problem

Related: PluginYouTube

Back to TOC 177

 4.1.11.17. PluginGroup

This plugin is useful if you want to display something only for some groups.

To display a module in a wiki page, use the syntax:

{GROUP(groups=>Registered|Admins, notgroups=Editors)}some text{ELSE}other
text{GROUP}

Parameter Accepted values Effect Since

String - each group is if the user displaying the page belongs to one of this group(directly or
groups separated with a by inheritence, displays the 'some text'. If there is an ELSE part,
vertical bar displays the other text if the user does not belong to any of the groups
String - each group is
notgroups separated with a Works as the opposite of groups 1.9.7
vertical bar

The part {ELSE} id optional.

Both parameter groups and notgroups can be combined.

Security
Be careful, not to use this plugin to display secure information if the user can see the source

4.1.11.18. Plugin Include

This plugin can be used to include the contents of a Wiki page inside another page (it must be a
Wiki page located in the Wiki section of your Tikiwiki, as other types of pages won't work yet!).

Install
This plugin may not be automatically installed with Tiki, but resides in the /lib/wiki-plugins-dist/
folder. Please check with your SysAdmin, if needed.

Usage
Use the syntax:
{INCLUDE(page=>name [,start=>start-marker] [,stop=>stop-marker])}{INCLUDE}

Accepted
Parameter Effect Since
values
page page of name Gives the name of the page to include
Gives a string to search for to begin the include. Text before that marker (and
the marker itself) will not be included. Default is the beginning of the included
start full line
page. The marker must appear on a line by itself; white space before or after the
marker is ignored.
Gives a string to search for to end the include. Text after that marker (and the
marker itself) will not be included. Default is the end of the included page. The
stop full line
marker must appear on a line by itself; white space before or after the marker is
ignored.

178 Back to TOC

 Tikiwiki Documentation 1.9+

If both start and stop are specified and the pair of strings occurs multiple times in the included page,
each section so delimited will be included in the calling page.
Note:
• The design and implementation of the start/stop feature is experimental and needs some
feedback (and, no doubt, improvement) from the community.
• If there's a cycle or if the page includes itself, Tiki will crash. So use this with discretion.
Maybe this is only suitable for intranets where you know what you are doing.
• In the current version, a page can only be included up to 5 times, so infinite loops are not
possible

Example
This code,
{BOX()}
{INCLUDE(page=>HomePage , start=>!!Learn , stop=>!!!Other ways to learn )}
{INCLUDE}
{BOX}

Would produce:
Doc.Tikiwiki.org holds more than 1,100 wiki pages, explaining Tiki CMS/Groupware (known as
TikiWiki). This documentation is written by the user community — including you!
Most Popular Pages

• Features - an overview with links to the documentation on all (ok, most) features.
• Installation - an overview with links to
• Documentation - hierarchical table of contents.
• Keywords - organized alphabetically.
• Get Help - A guide to getting help.
• Troubleshooting - help thyself!
• Download - information about downloading the software
• Old documentation in PDF The original 1.6 documentation.

Learn by doing! - the Tikiwiki experts who are watching this site continuously will help those who
help the project.

Related pages
• Wiki Plugins
• Mods Type Wikiplugins

Back to TOC 179

 4.1.11.19. Plugin Jabber

This plugin allows a Jabber Chat with Tikiwiki: runs a Java applet that connects to a local (same
machine as the webserver running Tiki) Jabber service. Written by Dennis Heltzel, 9/15/2003

Jabber, in short, is a open protocol for chat, using the Extensible Messaging and Presence Protocol
(XMPP), which is an open, XML-based protocol for near-real-time, extensible instant messaging
(IM) and presence information (a.k.a. buddy lists). It is the core protocol of the Jabber Instant
Messaging and Presence technology. The protocol is built to be extensible and other features such
as Voice over IP and file transfers have been added.

Requirements
• A Jabber server on your web host (same PC)
• JAVA enabled browsers
You can only use this plugin to connect to a jabber server that is running on the same server as the
http server for tiki. This is a constraint of the applet for security reasons. you can get more info
about that at http://jabberapplet.jabberstudio.org .

Installation
To make this plugin work:
1. get the JabberApplet from here: http://jabberapplet.jabberstudio.org/JabberApplet.jar
2. put it in a directory called jabber under $TIKI_BASE/lib, the path must resolve to:
lib/jabber/JabberApplet.jar
3. make sure your local jabber server is started and you know it's name
4. substitute the name of your local jabber server for 'jabber.org' in the example above and put
it into a wiki page.

Usage
To display a module in a wiki page, use the syntax:

{JABBER(height=>200,width=>200,xmlhostname=>jabber.org,defaultColor=>255,255,255)}{JA
BBER}.

Parameter Accepted values Effect Since

height number pixels
width number pixels
xmlhostname name name of jabber host
defaultColor 3 numbers RGB?

180 Back to TOC

 Tikiwiki Documentation 1.9+

Example
This code,

{JABBER(height=>200,width=>200,xmlhostname=>jabber.org,defaultColor=>255,255,255)}{JA
BBER}

Would produce:
screenshot needed. Add it here if you can take one

Related pages
• Wiki Plugins
• Mods Type Wikiplugins

• http://jabber.org
• http://jabberapplet.jabberstudio.org

4.1.11.20. PluginJS

Use the JS plugin to include Javascript files or Javascript code in a wiki page.

Install
See Mods Admin for instructions on how to install a Mod.

The plugin can be found in the Mods. The source can also be found on the sourceforge
http://tikiwiki.cvs.sourceforge.net/tikiwiki/_mods/wiki-plugins/js/wiki-plugins/ and copy in the
directory lib/wiki-plugins.

Usage
Once installed, you will see some new lines under the Wiki "edit > wiki help > Show Plugins
Help":

Insert a javascript file or/and some javascript code.

{JS(file='file.js')}javascript code{JS}

The file.js file is in this case in the tikiwiki root.

This will produce the following code for your Tiki:

<script type="text/javascript" src="file.js"></script>

Note that it has to be surrounded by quotes.

Back to TOC 181

{JS(file="http://www.foo.com/tiki.js")}{JS}

Example 1
To include Javascript code, use:
{JS()}
var....
function ...
...
{JS}

This will produce the following code for your Tiki:

<script type="text/javascript">
var....
function ...
...
</script>

Note: the file is inserted before the param, if you need the reverse order use 2 calls to the JS plugins

Example 2

{JS()}alert('coucou'){JS}

Would produce a pop up window that the user would have to click on "Accept" button ("D'acord" in
this localized example) to make it disappear.

Note
Note: Some javescript are modified for security reasons. in 1.9
For instance you need to use
document.write('<form name="form" method="" action="" on');
document.write('Submit="return verif_champs( );">');

182 Back to TOC

 Tikiwiki Documentation 1.9+

not to have onsubmit transformed

4.1.11.21. PluginLang

Displays the text only if the language matchs lang/notlang

Example:
{LANG(lang=>en)}Hello{LANG}
{LANG(lang=>fr)}Bonjour{LANG}

If the current language is en, Hello will be displayed. If it is fr, Bonjour.

Another example
{LANG(lang=>fr)}Bonjour le monde!{LANG}
{LANG(lang=>es)}¡Hola, mundo!{LANG}
{LANG(notlang=>fr+es)}Hello world!{LANG}

Will produce:
Hello world!

Note: Cached pages don't render this plugin correctly.

In Tiki1.9, the language can match the param lang of the url. So if you couple this plugin with the
TRANSLATED plugin, you can have a kind of multilinguism

Example:
{LANG(lang=>fr)}en Français{LANG}
{LANG(lang=>en)}in English{LANG}
---
{TRANSLATED(flag=>France,lang=>fr)}[./tiki-index.php?page=MyPage&lang=fr|
>>]{TRANSLATED}
{TRANSLATED(flag=>United_States,lang=>en)}[./tiki-index.php?page=MyPage&lang=en|
>>]{TRANSLATED}

For use in modules and templates

See MultilingualModulesAndTemplates

Source code (version 1.9.x):

http://tikiwiki.cvs.sourceforge.net/tikiwiki/tiki/lib/wiki-
plugins/wikiplugin_lang.php?view=markup&pathrev=BRANCH-1-9

4.1.11.22. PluginManager

Note: there is small problem with the list below. Don't click on the red question mark :-)

Back to TOC 183

 Plugin description
AGENTINFO? Displays browser client info:{AGENTINFO(info=>IP or SVRSW or BROWSER)/}
Puts a link to an anchor in a wiki page. Use in conjunction with the ANAME plugin,
ALINK? which sets the location and name of the anchor:{ALINK(aname=anchorname,
pagename=Wiki Page Name)}linktext{ALINK}
Puts an anchor into a wiki page. Use in conjunction with the ALINK plugin, which
ANAME?
makes links to the anchor:{ANAME()}anchorname{ANAME}
Include an article:{ARTICLE(Field=>[, Id=>])}{ARTICLE}Id is optional. if not
ARTICLE?
given, last article is used. default field is heading.
{ARTICLES(max=>3, topic=>topicName, type=>type, categId=>Category parent
ARTICLES?
ID)}{ARTICLES} Insert articles into a wikipage
Displays an attachment or a list of them: {ATTACH(name| file=file.ext, id=1| num=1,
showdesc=0| 1, dls=0| 1, icon=0| 1, inline=0| 1)}comment{ATTACH} num is optional
ATTACH?
and is the order number of the attachment in the list. If not provided, a list of all
attachments is displayed. Inline makes the comment be the text of the link.
Displays the user Avatar:{AVATAR(page=>, float=>left| right)}username{
AVATAR?
AVATAR}
List all pages which link to specific pages:{BACKLINKS(info=>hits| user,
BACKLINKS? exclude=>HomePage| SandBox, include_self=>1, noheader=>0,
page=>HomePage)}{BACKLINKS}
Insert theme styled box on wiki page:{BOX(title=>Title, bg=>color, width=>num[%],
BOX?
align=>left| right| center, float=>| left| right)}text{BOX}
Insert list of items for the current/given category into wiki page:{
CATEGORY(id=>1+2+3, types=>article+blog+faq+fgal+forum+igal+
CATEGORY? newsletter+event+poll+quiz+survey+tracker+wiki+img, sort=>[type| created| name|
hits| shuffle]_[asc| desc], sub=>y| n, split=>y| n)}{CATEGORY}
Display Tiki objects that have not been categorized:{CATORPHANS(objects=>wiki|
CATORPHANS? article| blog| faq| fgal| forum| igal| newsletter| poll| quizz| survey|
tracker)}{CATORPHANS}
Insert the full category path for each category that this wiki page belongs
CATPATH?
to:{CATPATH(divider=>, top=>yes| no)}{CATPATH}
CENTER? Centers the plugin content in the wiki page:{CENTER()}text{CENTER}
Displays a snippet of code:{CODE(ln=>1, colors=>php| highlights| phpcode,
CODE? caption=>caption text, wrap=>1, wiki=>1, rtl=>1)}code{CODE} - ''note: colors and
ln are exclusive''
Insert copyright notices:{COPYRIGHT()}~title~~year~~authors~text{
COPYRIGHT?
COPYRIGHT}
Example:{COUNTDOWN(enddate=>April 1 2004[,
COUNTDOWN?
locatetime=>on])}text{COUNTDOWN}
Insert a division block on wiki page:{DIV(class=>class, type=>div| span| pre| i| b| tt|
DIV? blockquote, align=>left| right| center| justify, bg=>color, width=>num[%], float=>left|
right])}text{DIV}
DL? Creates a definition list:{DL()}term:definition{DL} - one definition per line
{EVENTS(calendarid=>id1+id2, maxdays=>365, max=>-1, datetime=>0| 1, desc=>0|
EVENTS?
1)}{EVENTS} Insert rss feed output into a wikipage
EXAMPLE? Example:{EXAMPLE(face=> size=>)}text{EXAMPLE}
Displays the data using the Tikiwiki odd/even table style:{FANCYTABLE(head=>,
FANCYTABLE?
headclass=>)}cells{FANCYTABLE} - ''heads and cells separated by ~| ~''
Displays a SWF on the wiki page:{FLASH(movie=url_to_flash, width=>xx,
FLASH?
height=>xx, quality=>high)}{FLASH}
FORMULA? Formula:{FORMULA(width=>500, height=>400, paper=>letter,
orientation=>landscape, steps=>150, min=0, max=100, y0=>, y1=>,

184 Back to TOC

 Tikiwiki Documentation 1.9+

Plugin description
...)}Title{FORMULA}
Displays a graphical GAUGE:{GAUGE(color=>, bgcolor=>, max=>, value=>,
GAUGE?
size=>, label=>, labelsize=>, perc=>, height=>)}description{GAUGE}
Display wiki text if user is in one of listed groups: {GROUP(groups=>Admins|
Developers)}wiki text{GROUP} {GROUP(notgroups=>Developers)}wiki text for
GROUP?
other groups{GROUP} {GROUP(groups=>Registered)}wiki text{ELSE}alternate
text for other groups{GROUP}
iframe:{IFRAME(width=> , height=>, scrolling=> yes| no|
IFRAME?
auto)}source_URL{IFRAME}
INCLUDE? Include a page:{INCLUDE(page=> [, start=>] [, stop=>])}{INCLUDE}
Runs a Java applet to access a local Jabber service:{JABBER(height=>200,
JABBER? width=>200, xmlhostname=>jabber.org, defaultColor=>255, 255, 255)}{JABBER}.
See lib/wiki-plugins/wikiplugin_jabber.php to make this plugin work
Displays the text only if the language matchs
LANG?
lang/notlang:{LANG([not]lang=>code[+code+...])}text{LANG}
Insert a Mediawiki/Wikipedia-type contents link box on a wiki page, using
MAKETOCBOX?
maketoc.:{MAKETOCBOX(float=>[left| right])}{MAKETOCBOX}
MAP? Displays a map:{MAP(mapfile=>, extents=>, size=>, width=>, height=>) /}
Displays an miniquiz: {MINIQUIZ(trackerId=>1)}Instructions::
MINIQUIZ?
Feedback{MINIQUIZ}
Displays a module inlined in page:{MODULE(module=>, float=>left| right| none,
MODULE?
decorations=>y| n, flip=>y| n, max=>, np=>0| 1, args...)}{MODULE}
MONO? Displays the data using a monospace font:{MONO(font=>}text{MONO}
Displays object hit info by object and days:{OBJECTHITS(object=>, type=>,
OBJECTHITS?
days=>)/}
Display wiki text if user has one of listed permissions:
PERM?
{PERM(perms=>tiki_p_someperm| tiki_p_otherperm)}wiki text{PERM}
Provides a list of plugins on this wiki.:{PLUGINMANAGER(info=>version|
PLUGINMANAGER? description| arguments)}{PLUGINMANAGER}
Displays the output of a poll, fields are indicated with numeric ids.: {POLL(
POLL?
pollId=>1)}Good Poll{POLL}
Quote text by surrounding the text with a box, like the QUOTE
QUOTE?
BBCode:{QUOTE(replyto=>name)}text{QUOTE}
REDIRECT? Redirects you to another wiki page:{REDIRECT(page=pagename)/}
{RSS(id=>feedId+feedId2, max=>3, date=>1, desc=>1, author=>1)}{RSS} Insert rss
RSS? feed output into a wikipage
Automatically creates a link to the appropriate SourceForge object:{SF(aid=>, adit=>,
SF?
groupid=>)}text{SF}
SHEET? TikiSheet:{SHEET(id=>)}Sheet Heading{SHEET}
SHOWPAGES? List wiki pages:{SHOWPAGES(find=>criteria [, max=>qty])/}
SKYPE? Clickable Skype link:{SKYPE(action->call| chat)}name or number{SKYPE}
Sorts the plugin content in the wiki page:{SORT(sort=>asc| desc| reverse|
SORT?
shuffle)}data{SORT} - one data per line
Split a page into rows and columns:{SPLIT(joincols=>[y| n| 0| 1], fixedsize=>[y| n| 0|
SPLIT? 1], colsize=>size1| size2| ...)}row1col1---row1col2@@@row2col1---
row2col2{SPLIT}
SQL? Run a sql query:{SQL(db=>dsnname)}sql query{SQL}
SUB? Displays text in subscript.:{SUB()}text{SUB}
TAG? Displays text between an html tag:{TAG(tag=a_tag, style=a_style)}text{TAG}

Back to TOC 185

 Plugin description
Displays the thumbnail for an image:{THUMB(image=>, max=>, float=>,
THUMB?
url=>)}description{THUMB}
Inserts a Mediawiki/Wikipedia-look thumbnail with caption that links to a full-size
image.:{THUMBDIV(align=>[right| left], width=>[number and px| %], imgid=>,
THUMBDIV?
title=>, alt=>, thumbwidth=>[number only], thumbheight=>[number
only])}text{THUMBDIV}
Search the titles of all pages in this wiki:{TITLESEARCH(search=>Admin,
TITLESEARCH?
info=>hits| user, exclude=>HomePage| SandBox, noheader=>0)}{TITLESEARCH}
Displays an input form for tracker submit: {TRACKER(trackerId=>1,
TRACKER? fields=>id1:id2:id3, action=>Name of submit button, showtitle=>y| n, showdesc=>y|
n, showmandatory=>y| n, embedded=>y| n)}Notice{TRACKER}
Filters the items of a tracker, fields are indicated with numeric ids.: {
TRACKERFILTER? TRACKERFILTER(filters=>2/d:4/r:5, action=>Name of submit button,
TRACKERLIST_params )}{TRACKERFILTER}
Displays the output of a tracker content, fields are indicated with numeric ids.: {
TRACKERLIST(trackerId=>1, fields=>2:4:5, showtitle=>y| n, showlinks=>y| n,
showdesc=>y| n, showinitials=>y| n, showstatus=>y| n, showfieldname=>y| n,
TRACKERLIST? status=>o| p| c| op| oc| pc| opc, sort_mode=>, max=>, filterfield=>, filtervalue=>,
exactvalue=>, checkbox=>fieldId/name/title/submit/action/tpl, goIfOne=>y|
n)}Notice{TRACKERLIST}
Links to a translated content:{TRANSLATED(flag=>France, lang=>fr)}[url] or
TRANSLATED?
((wikiname)) or ((inter:interwiki)) (use wiki syntax){TRANSLATED}
Insert a Tikipedia-look box on wiki page:{TWOCOLORTITLEBOX(title1=>[text],
TWOCOLORTITLEBOX? title2=> [text], title1color=> [hex], title2color=>
[hex])}text{TWOCOLORTITLEBOX}
Displays the number of registered
USERCOUNT?
users:{USERCOUNT()}groupname{USERCOUNT}
Split the text in parts visible only under some conditions:{VERSIONS(nav=>y| n,
VERSIONS?
title=>y| n, default=>)}text{VERSIONS}
WANTEDPAGES? Lists wanted Wiki pages:
{WANTEDPAGES(ignore=>Page-Pattern'splitby'Page-Pattern, splitby=>+,
skipext=>0|1, collect=>from|to, debug=>0|1, table=>sep|co|br, level=>strict|full|
complete|custom)}Custom-Level-Regex{WANTEDPAGES}
Parameters: key=>value,...
key default comments
ignore empty string A wildcard pattern of originating pages to be ignored.
(refer to PHP function fnmatch() for details)
splitby '+' The character, by which ignored patterns are separated.
possible values: characters
skipext 0 Whether to include external wikis in the list.
possible values: 0 / 1
collect "from" Collect either originating or wanted pages in a cell and
display them in the second column.
possible values: from / to
debug 0 Switch-on debug output with details about the items.
possible values: 0 / 1 / 2
table "sep" Multiple collected items are separated in distinct table
rows, or by comma or line break in one cell.
possible values: sep / co / br
level empty string Filter the list of wanted pages according to page_regex

186 Back to TOC

 Tikiwiki Documentation 1.9+

Plugin description
or custom filter. The default value is the site's current
page_regex.
possible values: strict / full / complete / custom
Custom- empty string A custom filter for wanted pages to be listed (only used
Level- when level=>custom).
Regex? possible values: a valid regex-expression (PCRE)

Note: plugin arguments can be closed in double quotes ("); this allows them to contain , or = or >.

4.1.11.23. PluginMindmap

This plugin allows to generate a drawing illustrating connected ideas in a graphical way, previously
generated with "Freemind" mind map generator (free software, also). You need in your local
computer either the flash plugin or the java virtual machine installed, in order to view and browse
the drawing of the mind map. Moreover, you can give a realtive url of the .mm file in the server, or
the id of the Wiki attachment in Tiki which has the .mm file.

Usage:
For example, this code:
{MINDMAP(src=>./lib/mindmap/wikiplugin-
mindmap.mm,plugin=>java,mode=>inline,width=>100%,height=>400)}{MINDMAP}

would produce this mind map:

• Related pages: Plugins

Back to TOC 187

 How to Install
By the time of writing this note, Mindmap plugin was not yet included in main code of Tikiwiki. If
it is not inside main tikiwiki release, you can get the needed files from:
http://tikiwiki.cvs.sourceforge.net/tikiwiki/_mods/wiki-plugins/mindmap/

Download all the directories and files to your local computer, and upload them later on to the
Tikiwiki document root on your server, to the equivalent directories, etc.

External Links
● Freemind Homepage: http://freemind.sourceforge.net
● Freemind on Wikipedia: http://en.wikipedia.org/wiki/FreeMind
● Mind maps and concept maps: http://en.wikipedia.org/wiki/Mind_map

4.1.11.24. PluginMiniQuiz

Purpose
Mini quiz using the tracker
Syntax
{MINIQUIZ(trackerId=>1)}Instructions::Feedback{MINIQUIZ}

The tracker must have the following fields

• question a text field - the question
• answer a text field - correct answer
• option a a text field - false answer
• option b a text field - false answer
• option c a text field - false answer
• valid ia checkbox field - ndicates that the tracker item is to be used as a quiz item

Each questions of the quizz must be an item with valid checked. For instance if the tracker miniquiz
has 2 items, the plugin will display:

188 Back to TOC

 Tikiwiki Documentation 1.9+

and the result can be

Back to TOC 189

 4.1.11.25. PluginModule

Modules are usually displayed on the left or right columns. To display a module in a wiki page, use
the syntax:
{MODULE(module=>module_name_here)}{MODULE}

This syntax is that of a standard wiki plugin, so it is possible to use the shorthand syntax:
{MODULE(module=>module_name_here)/}

You can optionally pass other parameters :

{MODULE(module=>module_name_here,align=>left|center|right,max=>,np=>0|
1,args...)/}

Parameter Accepted values Effect Since

left, center, right, nofloat, Alignment of the module in the page nofloat causes module to
align
none be inlined
Meant to control number of rows (apparently works only for
max Numeric
some modules)
np 0, 1 If set to 1, the HTML output isn't parsed for WikiSyntax

190 Back to TOC

 Tikiwiki Documentation 1.9+

Parameter Accepted values Effect Since

flip n, y If set to y, module is shadeable Tiki 1.9
decorations n, y If set to n, box decorations are suppressed, see Module Admin Tiki 1.9
float left, none, right Sets the position of the module in the page Tiki 1.9
other Depends on the parameter The parameter is passed to the module.

Example:
{MODULE(module=>wiki_last_comments)/}

shows:
Darrers wiki comentaris
1) Wysiwyg Editor: Re: wysiwyg
2) Wysiwyg Editor: wysiwyg
3) Wiki Page Editor: documentation for editor problems
4) Webmail: Debug 1.9, 1.10
5) Features: Re: Own dogfood
6) Upgrade 1.9.x to 1.9.7: Disable tiki-install.php?
7) Wiki: Re: Re: Temporarily Locked for security until fivos learns how to create greek pages a
part, and lin
8) Wiki: Re: Temporarily Locked for security until fivos learns how to create greek pages a part,
and link tr
9) Wiki: Temporarily Locked for security until fivos learns how to create greek pages a part, and
link transl
10)Wiki-Syntax Lists: Locked to avoid fivos editting the english page as if it was greek

4.1.11.26. PluginMouseover

The plugin can be found in the mods or by using admin->admin mods

The plugin is based on the library overlib

Example

A Simple Mouseover
{MOUSEOVER(text="Hello over there. It's fine!")}Hello{MOUSEOVER}

WARNING: No such module MOUSEOVER! Hello

A Distant Sticky Mouseover

MOUSEOVER(text="this is sticky", sticky=,offsetx=200)}sticky{MOUSEOVER}

WARNING: No such module MOUSEOVER! sticky

Back to TOC 191

An HTML Formatted Mouseover
{MOUSEOVER(text="<b>bold</b><i>italic</i>")}html{MOUSEOVER}

WARNING: No such module MOUSEOVER! html

A Wiki Parse Mouseover

{MOUSEOVER(text=__wiki bold__''italic'', parse=1)} BIS{MOUSEOVER}

WARNING: No such module MOUSEOVER! BIS

Parameters
url an url optional
text the text that will appear in the mouseover
parse y or n if the text must be wiki parsed
all the other overlib parameters see http://www.bosrup.com/web/overlib/?Command_Reference for detail

4.1.11.27. PluginPerm

This plugin is useful if you want to display something only if some perms are checked.
This plugin can be found in the mods (mods.tikiwiki.org or on cvs sourceforge)

To display a module in a wiki page, use the syntax:

{PERM(perms=>tiki_p_view|tiki_p_edit, notperms=>tiki_p_rename, global=1)}some
text{ELSE}other text{PERM}

Parameter Accepted values Effect Since

String - each perm is if the user displaying the page belongs to one of this group(directly or
perms separated with a by inheritence, displays the 'some text'. If there is an ELSE part,
vertical bar displays the other text if the user does not belong to any of the groups
String - each perm is
notperms separated with a Works as the opposite of perms 1.9.7
vertical bar
global 1 or 0 global perm or local perm to the object 1.9.7

The part {ELSE} id optional.

Both parameters perms and notperms can be combined.

Security
• Be carefull, not to use this plugin to display secure information if the user can see the source
• Local perm can not work depending on the place or object the syntax is inserted (ex: works

192 Back to TOC

 Tikiwiki Documentation 1.9+

for tiki-index.php but not for tiki-editpage.php)

4.1.11.28. Plugin Poll

This plugin replaces itself with a box containing the poll in question.

Usage
To display a module in a wiki page, use the syntax:
{POLL(pollId=>1)}Example Poll{POLL}

Example
This code
{POLL(pollId=>1)}Example Poll{POLL}

Would produce:

Example Poll

What type of hosting are you using

• Hosted Server via FTP

• Unix Server
• Windows Server
• Fantastico

View Results

(Votes: 1)

(Comments: Array)

You can see below also this output using tikineat.css, as a reference:

Back to TOC 193

Related pages
• Wiki Plugins
• Mods Type Wikiplugins
• Poll
• Poll Admin

4.1.11.29. Plugin Redirect

This plugin semi-permanently redirects any wiki page to any other specified wiki page.

Installation
This wiki plugin is available as a Mod. See Mods Admin for instructions on how to install it, since
this is the easiest way to install the plugin.

Alternatively, you can install it by hand, downloading it from

http://mods.tikiwiki.org/Dist/wikiplugins-redirect-1.2.tgz
Installation from the .tar.gz file is easy, just copy the wikiplugin_redirect.php to your lib/wiki-
plugins/ folder in your Tiki site.

The source code is in the mods CVS area, so if you want to improve it cvs co mods and get on with
it! (:smile:) (see http://dev.tikiwiki.org/Download if needed for more help about cvs usage)

Usage
The redirect plugin usage is:
{REDIRECT(page=pagename) /}

Note:
• It does not check permissions
• It only works to another wiki page
• There is no warning about "you will be redirected in 5 seconds message" or similar; it's
instant!

194 Back to TOC

 Tikiwiki Documentation 1.9+

• There is a check to stop possible loops

How to edit the redirect page?

Q:How do you go back to original page for editing...
A: Use /tiki-editpage.php?page=TheTargetPageWithTheRedirectPlugin

New version (1.10)

There is a new option to redirect to wiki pages for Tikiwiki 1.10? (it is not working in doc.tw.o yet).
It's not properly a plugin by a new syntax allowed in wiki pages.

To create a redirect, you could also use the syntax:

REDIRECT:((anypage))

in the first line of the page's content.

Who made it:

Plugin by Sylvie (programmer) and mlpvolt (put up the bounty).
Related pages
• Wiki Plugins
• Mods Type Wikiplugins
• Mods
• Mods Admin

4.1.11.30. PluginRSS

This plugin includes an RSS feed in a wiki page, and it has been introduced in Tikiwiki 1.9.

For information about what an RSS feed is, please read RSS.

Usage
{RSS(id=>feedId,max=>numberOfItems,date=>1,author=>1,desc=>1)}{RSS}

feedId is the id of the feed in the feed list of Admin / RSS, max is the number of shown entries, date
and author (may be missing) are added if the switch is 1, and hidden if the switch is 0, desc is a
short description of the current rss item (may be missing).

You can also combine feeds by indicating 1+2, or 1+2+3 to add feeds together. Note, however, that
if you are combining feeds, "show publish date" must be checked in the RSS module settings, in
order to allow this plugin to sort the combined feeds.

Back to TOC 195

 Example
Let's say you wish to display the contents of 10 items of a feed with the Id of 5 inside a Wiki page.
Simply include this in your page, with date, but no author:
{RSS(id=>5,max=>10,date=>1,author=>0,desc=>1)}{RSS}

4.1.11.31. Plugin Sheet

This plugin allows to integrate the data from a Tiki Spreadsheet in a wiki page.

Usage
To display a module in a wiki page, use the syntax:
{SHEET(id=>sheet_id)}table_caption{SHEET}

Example
This code,

{SHEET(id=15)}Table 2. Advantages and disadvantages detected by the teaching staff after using
Wiki methodology{SHEET}

On a tiki site have sheet id 15 (tiki-view_sheets.php?sheetId=15) as:

196 Back to TOC

 Tikiwiki Documentation 1.9+

Would produce, in the middle of a wiki page context:

Back to TOC 197

The edit sheet button is shown while a registered user is logged in to the site. When logged out, no
"edit sheet" button is shown.
Images taken from this study of usage of Tikiwiki in educational scenarios:
http://uniwiki.ourproject.org/aw1l
Related pages
• Wiki Plugins
• Mods Type Wikiplugins

• Spreadsheet

4.1.11.32. Plugin Snarf

This plugin replaces itself with the body (HTML) text at the URL given in the url argument.

Arbitrary regex replacement can be done on this content using regex and regexres, which are used
as the first and second arguments to preg_replace, respectively, after pulling out just the <body>
data.

Usage
To display a module in a wiki page, use the syntax:

{SNARF(url=>http://www.lojban.org,regex=>;.*(.*).*;, regexres=>$1)}This data is put in a CODE

caption.{SNARF}

params: url, regex, regexres

Example

{SNARF(url=>http://www.livejournal.com/users/rlpowell/2418.html,regex=>/.*<!-- Content --
>.*?<td>(.*?)<\/td>.*?<\/div>(.*?)<hr.*?<!-- \/Content --
>.*/s,regexres=><p>$1</p>$2)}[http://www.livejournal.com/users/rlpowell/2418.html]{SNARF}

Related pages
• Wiki Plugins
• Mods Type Wikiplugins
• http://wikipedia.org/wiki/regex

4.1.11.33. PluginSkype

SKYPE plugin for Tiki Wiki/CMS/Groupware.

Creates an clickable link to call or chat with a Skype user.

198 Back to TOC

 Tikiwiki Documentation 1.9+

Demo

echo123?chat

Usage
{SKYPE(action->chat)}echo123{SKYPE}

New feature for Tiki 1.9.5

4.1.11.34. Plugin Sort

This plugin allows you to sort lines of text alphabetically in ascending or descending order, reverse
the current sorting, or shuffle them.

Usage
To display a module in a wiki page, use the syntax:
{SORT(sort=>asc|desc|reverse|shuffle)}data{SORT} - one data per line

Note that the plugin treats the lines that {SORT()} and {SORT} are on as the first and last line. This
may be changed in the future.

Example
This code,
^{SORT(sort=>asc)}Some messy lines
that need to be sorted
now we can
thanks to Oliver{SORT}^

Would produce:
Some messy lines
now we can
thanks to Oliver
that need to be sorted

Todo
parameter for sorting case insensitive
Related pages

Back to TOC 199

 • Wiki Plugins
• Mods Type Wikiplugins

4.1.11.35. PluginSplit

This plugin can be used to generate an html table without all the tags. Ideal for creating two or more
columns in a wiki page, this plugin allows for wiki formating and line breaks within the cells of a
table, unlike the simple table? syntax.

Syntax
Plugin command: {SPLIT(fixedsize=__, colsize=__, joincols=__, first=__ )}

additional syntax:

--- separates columns

@@@ separates rows

Parameters: Split uses the following parameters:

joincols=y|n|0|1 : if it is true 'colspan' attribute will be generated if there are cells mising in a row. -
default 'y'
fixedsize=y|n|0|1 : 'width' attribute will be generated for TDs - default 'y'
colsize=>size1|size2|...: are the size in pixels by default
or
colsize=>percent%|percent| : using % tiki will take the values as the relative percentage size of each
table cell. Numbers that add up to more than 100 will be proportional.

In 1.10:
first=> col|line : col is the editorial way: the column is filled first, line is the html way, the row is
filled e.g.
first{SPLIT(first=col)}r1c1---r2c1---r3c1@@@r1c2---r2c2{SPLIT} {SPLIT(first=>line)}r1c1---
r1c2@@@r2c1---r2c2{SPLIT}

padding? - the split plugin doe not use a cellpadding parameter, but colsize can be used to create
narrow "spacer" columns.

Examples
To split a page in two or more columns, use --- as the separator:
Example:
{SPLIT()} -=hey=- one two three --- -=hoy=- foo bar test {SPLIT}

Produces:
hey hoy
one two three

200 Back to TOC

 Tikiwiki Documentation 1.9+

foo bar test

If you want to do another row, use @@@:

Example:
{SPLIT()} -=hey=- one two three --- -=hoy=- foo bar test @@@ next --- next{SPLIT}

Produces:
hey hoy
one foo bar test
two
three
next line next line

note: If you want to use the horizontal rule in a split cell ---, you have to use more than 3 dashes ----

In tikiwiki1.10 : There is 2 additional parameters

- first=col|line. The default is line , the behaviour of 1.9 or the html table behavior. First=col
enables you to describe first the first column, second the second column.. It is more appropriate for
an editorial behavior.
Ex:
{SPLIT(first=col)}r1c1---r2c1---r3c1@@@r1c2---r2c2{SPLIT}
- edit=y to be able to edit the split section (if you have the perms of course). The parameter works
only if first=col has been choosen and on a wiki page. It will create a little edit icon in the corner of
the split section and will allow you to edit the section without the rest.

FAQ

• How do i make the border disappear?

The table created with a spli has a class wikiplugin-split and a class normal if the table with be
100% width

Bugs
Bugs: Content within the table doesn't seem to be parsed for all tiki markup, it doesn't work for
italics, in any case.

More Examples

{SPLIT(colsize=300|100|300)}r1c1---r2c1---r3c1@@@r1c2---r2c2{SPLIT}
r1c1 r2c1 r3c1
r1c2 r2c2

Back to TOC 201

{SPLIT(fixedsize=y, colsize=300|100|300)}r1c1---r2c1---r3c1@@@r1c2---r2c2{SPLIT}
r1c1 r2c1 r3c1
r1c2 r2c2

{SPLIT(fixedsize=n, colsize=300|100|300)}r1c1---r2c1---r3c1@@@r1c2---r2c2{SPLIT}
r1c1 r2c1 r3c1
r1c2 r2c2

{SPLIT(fixedsize=n, colsize=20|60|10|10)}r1c1---r2c1---r3c1--r4c1@@@r1c2---r2c2{SPLIT}
r1c1r2c1 r3c1-
-r4c1
r1c2r2c2

{SPLIT(fixedsize=y, colsize=20|60|10|10)}r1c1---r2c1---r3c1--r4c1@@@r1c2---r2c2{SPLIT}
r1c1r2c1 r3c1r4c1
r1c2r2c2

{SPLIT(fixedsize=y, colsize=20%|60|10|10)}r1c1---r2c1---r3c1--r4c1@@@r1c2---r2c2{SPLIT}
r1c1r2c1 r3c1r4c1
r1c2r2c2

{SPLIT(fixedsize=y, colsize=20|60%|10|10)}r1c1---r2c1---r3c1--r4c1@@@r1c2---r2c2{SPLIT}
r1c1r2c1r3c1r4c1
r1c2r2c2

{SPLIT(fixedsize=n, colsize=20|60|10|10, joincols=n)}r1c1---r2c1---r3c1--r4c1@@@r1c2---

r2c2{SPLIT}
r1c1r2c1 r3c1-
-r4c1
r1c2r2c2

202 Back to TOC

 Tikiwiki Documentation 1.9+

• What you can see, fixedsize has no importance if colsize is specified.

• If one colsize has a % , the table gets the class normal ->100% width

4.1.11.36. Plugin SQL

This plugin can be used to display the results of SELECT queries in a Wiki page. The plugin
displays the results of the query in an attractively formatted table.

Back to TOC 203

Or in other words: have you ever wished you could retrieve data that is actually in TikiWiki's (or
some other) database, but not organized or displayed on-screen in the way you'd like? The SQL
plugin allows you to do that.

Please also see WikiPluginsDb & (tw:WikiPluginsDbTutorial)) (a different but similar feature)

Preamble: A Word About Security

Use of the SQL plugin can pose a risk to the security of your Tikiwiki site. If you use the SQL
plugin on a Wiki page and give users permission to access the page, be sure to lock the page avoid
users to see the source of that page. If you don't, users with appropriate permission could see the
SQL code — and might decide to do a little "experimentation" to see what else they can pull out of
the database! (This has actually happened in the past....)

The SQL plugin can be used to pull in data from other databases, but this capability should be used
only with caution. For example, suppose you use the plugin to draw data from an Oracle database
that contains information about your company's financial transactions. If you leave Wiki page
containing the SQL plugin statement unprotected, an intruder might be able to deduce how to pull
confidential data from that database. If you want to use the SQL plugin to access confidential or
sensitive data, do so ONLY in the context of a well-secured intranet that is not accessible to
external users.

Introduction
To use the SQL plugin, you must do the following:
1. Use Admin DSN to define the database to be used by the SQL plugin. For instructions,
please see AdminDSN?.
2. Place a SQL plugin statement in a Wiki page.
Start by trying a simple query — and experiment!

The following sections detail the plugin syntax, discuss some simple queries, and illustrate some
more complex (and useful) queries you can try.

Remember, though, that this page tells you how to insert the SQL statement in a Wiki page, but it
won't work until you've defined a DSN.

Usage
To use the SQL plugin in a Wiki page, click Edit, and insert a statement that conforms to the
following syntax:
{SQL(db=>''DSN name'')} SELECT column1[,column2,column3,...] FROM table{SQL}

Note the following parameters:

204 Back to TOC

 Tikiwiki Documentation 1.9+

Accepted
Parameter Effect Since
values
name of
DSN name This is the name you defined using AdminDSN? 1.7.5
DSN
The names of the columns from which you want to retrieve data. These must
column1, name of be typed exactly as they are stored in your database program. Tip: To make
1.7.5
column2, etc. columns sure you spell the column names correctly, take a look at your database's
structure with a utility such as PHPMyAdmin.
name of The name of the table from which you want to retrieve the data. Again, the
table
table name must be typed exactly as it is stored in the database

Examples

Basic examples
Here are some examples that are known to work:
{SQL(db=>tiki)} SELECT login,email FROM users_users {SQL}

{SQL(db=>tiki)} SELECT authorName,title FROM tiki_articles {SQL}

Note: If you're used to terminating SQL queries with punctuation, note that none is needed here!

The result is a table with the select output:

Sorting and Selecting Data with the SQL Plugin

You can use ORDER BY to sort the output by a specified column name:
{SQL(db=>tiki)} SELECT authorName,title FROM tiki_articles ORDER BY authorName{SQL}

Secondary sort:
{SQL(db=>tiki)} SELECT authorName,title FROM tiki_articles ORDER BY authorName asc, title

Back to TOC 205

asc{SQL}

Use WHERE to limit the output to rows that meet specified criteria:
{SQL(db=>tiki)} SELECT authorName,title FROM tiki_articles WHERE
authorName='rocky'{SQL}

In the above example, note the use of single quotes — double quotes won't work.

Whoopee - a join:
{SQL(db=>stshome)} SELECT t1.name, t2.value FROM tiki_tracker_fields AS t1,
tiki_tracker_item_fields AS t2 WHERE t2.itemId = '5' AND t1.fieldId=t2.fieldId{SQL}

An example to retrieve in a single table all the distinct users assigned to every group. This is useful,
for instance, in the education area where a teacher appreciates having a list of all the students
succesfully registered and assigned to his/her class/subject.
{SQL(db=>db_uniwiki2)} SELECT DISTINCT
`users_usergroups`.`groupName`,`users_users`.`login`,`users_users`.`email`,`users_users`.`default_
group`
FROM `users_usergroups` , `users_users`
WHERE `users_users`.`userId` = `users_usergroups`.`userId`
ORDER BY `users_usergroups`.`groupName` DESC,`users_users`.`login` ASC{SQL}

Note in the example above, that other columns are included in the table, such as their e-mail, default
group, ... Note, also, that they are sorted first by group name in descending order (DESC), and then,
by login (user name in tiki) in ascendent order (ASC).

In tiki1.10, you have the possibilty to pass global variables as the username to the query
{SQL(db=>local, 0=>$user, 1=>5)}SELECT * from users_users WHERE login=? OR
userid=?{SQL}

where 0 is for the first ? and 1 for the second

For more information on SQL when used with MySQL, see Select Syntax
(http://www.mysql.com/doc/en/SELECT.html ), which is part of MySQL's online documentation.

Note: Please post more examples of how complex SQL select statements can be successfully used
with the SQL plugin.
Related pages
• Wiki Plugins
• Mods Type Wikiplugins
• See AdminDSN? to learn how to name and define an external DSN connection, which the
SQL plugin requires.

206 Back to TOC

 Tikiwiki Documentation 1.9+

• http://tikiwiki.org/WikiPluginsDb
• http://tikiwiki.org/WikiPluginsDbTutorial

4.1.11.37. Plugin Tag

This plugin puts the text around html tag. If the tag is not specified, SPAN will be used
Eventually, you can put some style information.

Usage
To display a module in a wiki page, use the syntax:
{TAG(tag=a_tag, style=a_style)}text{TAG}

Parameter Accepted values Effect Since

tag html tag Produce this html tag 1.9.2
style html style Produce this html style 1.9.2

Example
This code,
{TAG(tag=STRIKE, style=color:#FF0000)}toto{TAG}

Would produce:

toto

Which corresponds to this html code generated:

<STRIKE style="color:#FF0000">toto</STRIKE>
Related pages
• Wiki Plugins
• Mods Type Wikiplugins

4.1.11.38. PluginThumb

This plugin is useful to include images in wiki pages with minimal disturbance of the text flow. It's
an autonomous plugin, you should be able to use it with any version of Tiki (at least since 1.6). If
you want to use it in an old version just copy the file in lib/wiki-plugins/

Back to TOC 207

 Syntax
{THUMB(image=>img/wiki_up/393px-Pears.jpg,max=>42,float=>left)}{THUMB}

will be transformed in the following thumbnail. Pass your mouse over the thumbnail to get a frame/
popup/thing with the full sized image.

You will see something like:

You can also use an image from an image gallery (tw >= 1.9.8)
with the scaled image in the popup
{THUMB(id=94)}{THUMB}

no image
with the original image in the popup
{THUMB(id=94,original=y)}{THUMB}

no image

208 Back to TOC

 Tikiwiki Documentation 1.9+

Parameters
• Mandatory
• image : the local path to the image file (won't work with remote files)

or
• id: the image Id
• Optional
• url : the url of the link
• max : indicate the max width or height (whichever is higher) for the thumbnail
(default 84)
• float : none (default), left or right to make the text run around the thumbnail if
wanted
• data : it's the special plugin parameter to name what is between the tags. If text is
included there, it will be printed over the image. This can be weird, but fun.
• original: y - optional if it is an image of a scale gallery, the popup will display the
original iamge, otherwise, the scaled image
• sticky: y|n - default n - ioptional - to have a sticky popup (tw 1.10)

Note
• for tw <1.9.8, you must specify url

4.1.11.39. PluginTracker

Purpose
This plugin allows you to display in a wiki page a tracker creation form. You can specify what
fields will be asked.
Use
{TRACKER(trackerId, fields, action, showtitle, showdesc, showmandatory,
embedded, email, view, url)}user-defined text{TRACKER}

Parameters
• trackerId is the numeric ID of the tracker to be used
• fields is the list of the numeric field IDs separated by :
the fields beginning by - are optional
• action is a user-defined name of the button to validate the form (default: Save)
• showtitle=>y|n, shows the tracker title at the top of the form
• showdesc=>y|n, shows the tracker description
• showmandatory=>y|n, shows the mandatory fields with a *
• embedded=>y|n, page?????
• the user-defined text will be displayed when the tracker item will be recorded ( For example,
it can be "Thank you")
• email=>from|to|template to send an email when the tracker item is created. The fields are
separated with a bar. *from is an email or the fieldId containing the email, to is an email or

Back to TOC 209

 a list of emails separated with comas or the fieldId containing the email, template is the
template of the message body. The subject will be the template_subject.tpl. Both templates
must be in the templates/mail directory.
• view=user will be the user tracker if the feature is activated (>= tw 1.9.7)
• url = url the user will be sent after the item creation (>=tw 1.9.8). Notice that if you have
problem with the parse, you can put double quotes around the url (ex:
url="http:/tikiwiki.org")

Administration
• You can limit the tracker fields that can be used in this plugin in the field admin panel of the
tracker:
"Field is public? (for use thru trackerlist plugin)" option

Warning
• the plugin can not be used on a cached wiki page

Example
{TRACKER(trackerId=>1,fields=>1:3:4,action=>Send)}Thank for your contribution!{
TRACKER}

4.1.11.40. PluginTrackerFilter

This plugin has been introduced in tikiwiki 1.9.5

Purpose
To give an interface to filter a tracker's items by filtering some fields.
Syntax
example

{TRACKERFILTER(filters=>1/d:2/r:3, fields=>1:4:5)}{TRACKERFILTER}

Parameters:
• filters is the list of fields that can be filtered with the format of their display.
The fields are identified by their numeric Ids. All the fields must belong to the same tracker.
The Id can be followed by the character / and one of this format:
• d: drop down list of all the values occurring for the field: only one value can be
selected
• r: radio buttons
• m: multiple choice in a drop down list ( a multiple choice acts as an OR between the
values of the choice)
• c: checkbox (multiple choice)
• fields will show the fields displayed for the selected items
• action : name of the submit button - default filter (tw >= 1.9.8)

210 Back to TOC

 Tikiwiki Documentation 1.9+

• all the params of the tracker TRACKERLIST can be added to customized the look of the
result (except the filterfiled, exactvalue and filtervalue - that will overwrite the filter
selection) Some are inetersting
• goIfOne: go directly to the item display (tiki-view_tracker_item.php) if only one
item is found (tikiwiki >= 1.9.8)

example

{TRACKERFILTER(filters=>1/d:2/r:3,
fields=>1:4:5,showtitle=>n,showlinks=>y,showdesc=>n,showinitials=>n,showstatus=>n,status=>o
pc,sort_mode=>f_1_asc)}{TRACKERFILTER}

It can be interesting to use the checkbox capacity of trackerlist to do some action on some filtered
items
example

{TRACKERFILTER(filters=>82/d:84,fields=>82:83, checkbox=85/to/Email to checked/send/soho-

send_message.php/soho-send_message.tpl)}

You can also get directly be connected to the message box

example

{TRACKERFILTER(filters=>82/m:84,fields=>82:83, checkbox=85/to/Email to
checked/xxx/messu-compose.php) /}

Restriction
For the moment, the trackerfilter plugin can work with the following field types:
• category - e
• drop-down list - d
• email - m
• text field - t
• textarea - a
• numeric field - n
• country - y

but not:
• item list
• item link
• user
• group

Note:
For a drop-down list, the values of the drop down list will be displayed, For the other field types,

Back to TOC 211

the values found in the database will be displayed.
Description
Imagine a tracker

The page will look like

and when you click on filter you will have something like this

212 Back to TOC

 Tikiwiki Documentation 1.9+

4.1.11.41. PluginTrackerItemField

This plugin is one of several that works with the trackers feature. This plugin can be downloaded at
mods (mods.tikiwiki.org or on sourceforge cvs).

This plugin allows you to display or to test the value of a field of a tracker item.
The tracker item can be specified by its ID with the itemId plugin param. If it is not specified, if the
url has a param itemId, the value of itemId will be used. If after this test is not set and if the
usertracker feature is set on, the user item of the user will be selected.

For example, you have a user tracker with a field containing the phone number of the user, you can
use this plugin with the fieldId=>phone_field_id to display in the page the phone number of the
user looking at the page
{TRACKERITEMFIELD(fieldId=1) /}

Another example, you want to add a link in a page to a page where a user can fill his user tracker
only if the user has no user tracker. You can use this plugin with the fieldId that is the user selector
field.
{TRACKERITEMFIELD(fieldId=1, test=1)}Welcome new member, please visit
((this_page)) to fill up your information{TRACKERITEMFIELD}

Syntax
Example:
{TRACKERITEMFIELD(itemId=>1,fieldId=1, test=1)}Text{TRACKERITEMFIELD}

Options
Name Type Meaning!tw release
The id of the item that is used. If the param is not specified, the user tracker item
itemId Numeric
for the current user will be selected
fieldId Numeric The id of the field displayed or tested
test 1 or 0 If 1, the value field must not be empty, otherwise the Text is displayed

Security
The field must not be hidden

Back to TOC 213

 Optimisation
If this plugin is called many times on the same page with the same itemId, some sqls queries with
be remembered between each call

4.1.11.42. PluginTrackerList

This plugin for trackers enables you to display the listed items of a tracker.
You can choose which fields you want to display (only public fields), you can display status of the
item, and you have the opportunity to filter the items.
Syntax
example

{TRACKERLIST(trackerId=>1,fields=>2:4:5,
showtitle=>y|n,showlinks=>y|n,showdesc=>y|n,showinitials=>y|n,showstatus=>y|n,status=>o|p|c|
op|oc|pc|opc,
sort_mode=>,max=>,
filterfield=>,filtervalue=>,exactvalue=>,
checkbox=>fieldId/name/title/submit/action/tpl)}
Notice
{TRACKERLIST}

Parameters:
Tikiwiki
Parameter Options/Syntax Default Explanation
version
trackerId=> (numeric) required You must enter the ID number of the right tracker
Allows the selection of specific tracker fields. In 1.10,
(numeric,colon
fields=> the order of the fieldIds will be respected, in 1.9, the
separated)
order is the one defined in the tracker
showtitle=> y/n n Displays the title of the tracker
showlinks=> y/n n Hyperlinks to the tracker item view for each item.
Displays an alphabetical index by first letter (A,B,C,...)
showinitials=> y/n n
above the list to assist navigation.
showdesc=> y/n n Displays the tracker's description
Displays the tracker field names as
showfieldname=> y/n y tw >=1.9.8
heading of the table
showcreated=> y/n Tracker config Displays the creation date tw >=1.10
o/p/c/op/pc/oc/o Filters by status (open,pending,closed) - e.g. "op"
status=> o
pc displays only the open and pending items.
Orders the columns (fields) of the tracker in a specific
(field_asc or default (numerical)
sort_mode=> order, where field is the field name either acending or
field_desc) order
descending
max=> (numeric)=> or Default is the list the maximum number of items to list
-1 for all values number set in admin-

214 Back to TOC

 Tikiwiki Documentation 1.9+

Tikiwiki
Parameter Options/Syntax Default Explanation
version
>general
(numeric) see The field Id used for filtering (with a little dev, could be
filterfield=>
below an array of field IDs)
Filter value of the filterfield. (ex: *value will look for
filtervalue=> (text) something finishing with value , value* begin with,
value contain value)
Exact value of the filter (if filterfield is an array, exact
exactvalue=> (text)
value must be an array)
Adds a checkbox on each line to be able to do an action.
checkbox=> see below
The parameters of this parameter are separated with /
go directly to tiki-
goIfOne=> y or n n view_tracker_item.php if only one item tw >=1.9.8
is found

filterfieldId
• when filterfieldId is a dropdown box, exactvalue must be the text of the item in the
drop down list without quotation marks
• when filterfieldId is a category, exactvalue must be the numeric id (without quotation
marks) of the category item to filter the list

checkbox
• fieldId is the field Id whose value will be posted to the action
• name is the name of the post
• title is the title of the button
• submit is the name of the submit button
• action is the script that will be called on the submit
• tpl is an optional template that be inserted before the submit button that will also be
returned
• Example: checkbox:6/to/Email to the checked//messu-compose.php - in this example
the fieldId 6 is the user name as messu-compose.php accepts to as param

4.1.11.43. PluginTrackerStat

Purpose
This plugin allows you to display in a wiki page some statistics about a tracker. You can specify
which fields can be displayed. The plugin can be used several times on a same page with different
tracker.
Syntax
Example:
{TRACKERSTAT(trackerId=>1,fields=>2:4,show_percent=>y,show_bar=>n,status=>o|c|p|

Back to TOC 215

op|oc|pc|opc)}Title{TRACKERSTAT}

Will give (If the fieldId 2 is "My question", a radio field "yes, no" and if fieldId 3 is "And rate it" a
drop down list

Remarks
>= Tikiwiki1.10
Related pages
Trackers

4.1.11.44. PluginTranslated

A quick plugin for help with multi-lingual links.

use it like this :

{TRANSLATED(flag=>France,lang=>fr)}[url] or ((wikiname)) or ((inter:interwiki))
(use wiki syntax){TRANSLATED}

It's really a freeform linker, so it can be used in multi-tiki lingual setup, or for smaller website with
all translated content internally, anything.

Source code (version 1.9.x):

http://tikiwiki.cvs.sourceforge.net/tikiwiki/tiki/lib/wiki-
plugins/wikiplugin_translated.php?view=markup&pathrev=BRANCH-1-9

4.1.11.45. PluginVersions

This is one of the many plugins available in tikiwiki. Use this plugin to show several different
versions of text on the same page. with a navigation box that allows the user to click on each
version to see it.

216 Back to TOC

 Tikiwiki Documentation 1.9+

Usage
{VERSIONS(nav=>y,title=>y)}

This is the default text

---(version 3)-----------------------------

This is version 3 info

---(version 2)-----------------------------

This is version 2 info

---(version 1)-----------------------------

This is version 1 info

{VERSIONS}

The indicator for version is 3 dashes/hyphens plus the version label in parenthesis followed by at
least 3 other dashes or hypens. Note that cached pages don't render this plugin correctly.

Use (nav=>n) in the plugin declaration to remove the version menu for the various versions and
only display the Default text.

Display

Sample usage in conjunction with PluginTracker and PluginTrackerList:

Back to TOC 217

 Default text: Formulari, using PluginTracker

Alternate version: Mostra les pre-inscripcions ja realitzades, , using

PluginTrackerList

Source code (version 1.9.x):

http://tikiwiki.cvs.sourceforge.net/tikiwiki/tiki/lib/wiki-
plugins/wikiplugin_versions.php?view=markup&pathrev=BRANCH-1-9

Plugin introduced in tiki1.9rc3 but you can use it in any version of tiki, by copying the plugin file in
lib/wiki-plugins/ dir

Note: Until version 1.9.8, it only worked with 2 versions

4.1.11.46. PluginVote

>= Tikiwiki 1.10

Purpose
This plugin is a specific use of the trackers feature, specialized for voting and survey, which can be
inserted into any wiki page, article, or blog. It operates in a manner similar to the Poll and Survey
feature, but with more robust features.

218 Back to TOC

 Tikiwiki Documentation 1.9+

It is combines 2 tracker plugins:

• PluginTracker - which allows each user (with the appropriate permissions) to enter their
vote. ( = create a tracker item)
• PluginTrackerStat - which displays voting results ( = statistics on the tracker).

The advantage to use the tracker is that you can :

• unlike polls, use a variety of input fields (like country, drop down, radio...)
• unlike polls, ask a number of questions.
• have mandatory fields
• unlike surveys, you can have as many vote boxes in a page as you want. (limitation: each
vote must use a different tracker)
• you can use the plugin trackerlist to have the detail - who votes what

Syntax
Example:
{VOTE(trackerId=>19, fields=>73,float=>right)}Thank you for your vote{VOTE}

Parameters
The parameters of this plugin are the parameters of the tracker plugin and the trackerStat plugin.

Name Type Value Description

mandatory - the tracker must have certain
trackerId numeric the tracker ID
settings (see below)
optional - if not set all the fields that can
list of numerics the fields ID of the tracker that are used
fields be used (except IP, user, system, private
separated with : for voting and display.
fuields) are used
float rigth or left the box position on the page optional.
show_stat y or n displays the statistics or results optional - default y
displays the statistics or results only
show_stat_onl
y or n after the after date given in the tracker optional - default n
y_after
configuration
show_creator y or n displys the user that creates the tracker optional - default n

Configuration
The tracker uses for a vote must be configured specifically to behave like a vote system.
• a user or an IP can vote only one time must be checked
• the tracker must have a field of type 'IP selector' or 'User selector' with an option 1
• if you want to have your vote or survey activated only during a certain period of time, you
have to set the 2 dates ( or only one) after and before.

If there is only a field 'IP selector', a vote with the same IP replaces any previous one. If there is
only a field 'user selector', a vote with the same user that a previous one replaces the vote. If the

Back to TOC 219

tracker has both fields, a vote with the same user or the same IP will replace the previous one.

If you give a "after" date, the vote box will display "the vote begins after" before this date
If you give a "before" date, the vote box will display "the vote ends after" before the end, and "the
vote is closed since" after the date

4.1.11.47. PluginWMV

Description
This plugin plays a Windows Media Player movie in a wiki page (.wmv)

Usage
Copy attachment to:
lib/wiki-plugins/

WMV Displays a Windows Media Player Movie on the wiki page:

{WMV(width=>xx,height=>xx,
controller=>true|false,autostart=>1|0)}Movie{WMV}

with and height optional (default 320 x 240)

controller optional (default true) 16 pix are added to height to show up the contoller
autostart optional (default false)

alternative you could write

{WMV(movie=>URL to Movie, width=>xx,height=>xx,
controller=>true|false,autoplay=>1|0)}{WMV}

Example

{WMV()}http://yoursite.org/pub/sample.wmv{WMV}

220 Back to TOC

 Tikiwiki Documentation 1.9+

Link .wmv file in file galleries

You can link .wmv files in file galleries as a plugin in wiki page by using the files' id in file
galleries.

First you have to edit the wikiplugin_wmv.php

Add "tiki-download_file.php?fileId=" in this line in wikiplugin_wmv.php

$asetup .= "<param name=\"Filename\" value=\"$movie\"> ";

change to
$asetup .= "<param name=\"Filename\" value=\"tiki-
download_file.php?fileId=$movie\"> ";

After that you just need to enter fileid of the wmv file instead of file's url
{WMV(movie=>fileid, width=>xx,height=>xx,
controller=>true|false,autoplay=>true|false,loop=>false|true)}{WMV}

• Remember to change back the code if you want to link to file by using url or you can just
create another new plugin.

Download
You can download it from the attachment to http://tikiwiki.org/PluginWMV , and copy it to copy to
lib/wiki-plugins.

4.1.11.48. PluginYouTube

This plugin is an adaptation of the PluginFlash

To add a YouTube video in a wiki page, forum post, blog post, use the FLASH plugin like this:

{FLASH(movie=http://www.youtube.com/v/wWmE6Zvo37E,width=>425,height=>350,quality
=>high)}{FLASH}

It will generate:

Back to TOC 221

Make sure you use the URL which looks like this "/v/wWmE6Zvo37E" and not this one: "
watch?v=UmAfQ-GgtCQ"

Related: PluginGoogleVideo

4.1.12. Wysiwyg Editor

This documentation is needed for 1.10. This page needs review

If enabled at Admin -> Features, editing wiki pages can be achieved in a visual manner, thanks to
an integrated FckEditor (http://www.fckeditor.net ), from Tikiwiki version 1.10 onwards. This
means that information can be copied and pasted from a word processing program (or web page,
etc.) right into the wiki page keeping most (if not all) the markup of your document.

See more infromation in the following pages:

• Wysiwyg Editor User
• Wysiwyg Editor Details
• Wysiwyg Editor Admin

4.1.12.1. Wysiwyg Editor User

If the site administrator has selected the Wysiwyg editor as the default at (Wysiwyg Editor
Admin?), the edit page will look like this:

222 Back to TOC

 Tikiwiki Documentation 1.9+

If not enabled by default, the edit page would show a tab saying "Use wysiwyg editor", which
would shift the editor from the classical (below) to the visual one (see previous image).

Back to TOC 223

 Shifting from visual editor to viewing html source code
Once using the wysiwyg editor, you can shift from the visual editor to the html source code, for
instance, using the corresponding "source" button.

And after pressing at the "source button", this other content (html code) would be shown:

224 Back to TOC

 Tikiwiki Documentation 1.9+

Pasting from word processor documents

There is a special feature (and button) to paste content from a word processor program ( ), which
opens a pop up box with a visual text area. Use this to paste the content from your favourite editing
program (such as OpenOffice.org Writer, KWord, ... or whatever other closed source alternatives):

Back to TOC 225

 Inserting or editing internal Wiki links

Pressing on the button "Inserting or editing internal Wiki links" ( ), will open pop up window
that will allow you to create links to current wiki pages in the Tiki site.

226 Back to TOC

 Tikiwiki Documentation 1.9+

Inserting Tiki images

Pressing on the button "Tiki image" ( ), will open a pop up window that will allow you to insert
images into the page.

If you click in the "Browse server" button, you'll be able to select images from the tiki site to be
inserted in that wiki page.

Back to TOC 227

More information
• Wysiwyg Editor Details
• Wysiwyg Editor Admin

4.1.12.2. Wysiwyg Editor Details

This is the list of icons available in the Wysiwyg Editor while visual editing the Wiki pages.
Icon What it Does
Common Fckeditor icons
View or edit document source code (for advanced users).
Preview what the HTML page will look like for users.

Select a layout template. See "Templates" for details.

Remove the highlighted text... (You must select the text first)
Copy the highlighted text... (You must select the text first)
Paste the text you copied (with or without formatting)
Copy content from word processing programs, then paste it into the HTML editor using the pop-
up accessed from this icon.
Print the HTML page.
Spell check the HTML page.
Undo or redo the most recent action taken.
Find a word or phrase within the text of the HTML page.

Find and replace a word or phrase within the text.

Select all of the text in the HTML page (usually used before copy or cut or to apply a style or
format to the whole page).

228 Back to TOC

 Tikiwiki Documentation 1.9+

Icon What it Does

Remove the formatting from highlighted text... (You must select the text first)
Bold, italic, underscore or strikethrough highlighted text.
Superscript or subscript the highlighted text.
Change the color of the highlighted text.

Change the background color behind the highlighted text.

Add numbering or bullets to highlighted text lines.

Increase or decrease the highlighted text's indentation.
Alignment of highlighted text (left, centered, right, justified).
Add or remove hyperlink from highlighted text. Also used to manage file uploads and links to
files on the web server.
Upload or insert your own or other's images into the HTML page.
Insert table. Number of columns or rows, and table width, height, borders, & alignment can also
be set.
Insert divider line (horizontal rule).

Insert emoticons (e.g. smiley faces, email icon, lightbulb).

Insert symbols & special characters (trademarks, currency, etc.) .

Insert page break. Only impacts printed version.

Online keyboard for certain non-roman character languages.

Styles & formatting determine the appearance of HTML text. You may also use the drop down
boxes to style specific elements (such as headings), or set overrides for font face, font size, etc.

Tikiwiki specific icons

Edit/Create Internal Wiki link

Insert Tiki images

Related pages
• Wysiwyg Editor Admin
• Wysiwyg Editor User

Back to TOC 229

4.2. Image Gallery
Image galleries are collections of images. If the Image Gallery feature is enabled in your Tiki
installation, you can create public or private galleries and upload images to them from your local
hard drive or another Internet URL. Tiki automatically creates thumbnail versions of your uploaded
images; you don't have to do so yourself. Galleries can be used for photo albums of course, but also
creatively for other applications such as product "showrooms".

Feature Overview
The following is a short list of Image Gallery features:
• Enable or disable the Image Gallery feature.
• Set display of listing fields, such as description or created date.
• Make a gallery public or private, and control its permissions.
• Create, modify and delete galleries.
• Adjust auto-thumbnailing settings.
• Set the number of thumbnail rows and columns.
• Categorize your galleries.
• Upload images from URL or disk.
• Override auto-thumbnailing by uploading your own thumbnails.
• Enter a name for your uploaded image, or, let Image Gallery use the filename.
• Put coordinates on images and display them using the maps? feature.

From Here
• To enable Image Galleries for your Tiki site, see General Admin.
• To read the user manual for Image Galleries, see Image Gallery User.
• To learn about administering Image Galleries, see Image Gallery Config.

4.2.1. Image Gallery User

4.2.1.1. The Menu

When Image Galleries are enabled and you have the right permissions, site visitors can see an
Image Gallery menu can be clicked to open. From here you will be able to create galleries and
upload images to the galleries.

Collapsed and Expanded Menu:

There are usually three options in the menu — Galleries, Rankings and Upload Images — and the

230 Back to TOC

 Tikiwiki Documentation 1.9+

options may change depending on your permissions. In our example, you can see an additional
option "System Galleries". In this section, let's examine each option in detail.

4.2.1.2. Prior to Gallery Creation

At first, before galleries are created or images uploaded to them, the Galleries center panel appears
as in this illustration. Notice the "create new gallery" link.

4.2.1.3. Creating a Gallery of Images

Clicking the "create new gallery" link displays a form to create a new gallery, with fields to fill-in,
as you can see here:

Back to TOC 231

The fields are explained in the following table:
Field Description
Name Short name for the gallery. Appears in listings.
Description A description of the contents of the gallery.
Gallery is visible to non- If not checked, then the gallery will be visible only to users with the
admin users tiki_p_admin_galleries permission set.
if checked then images can have a longitude and latitude and be displayed using the maps?
Geographic
feature.
Used for formatting gallery appearance, this is the maximum number of rows of
Max Rows per page
thumbnails, per page, that will be displayed to visitors.
Used for formatting gallery appearance, this is the maximum number of thumbnails per
Images per row
row.
Thumbnails size X Width for Thumbnails, in pixels.
Thumbnails size Y Height for Thumbnails, in pixels.
Scales available, according to your web hosts' image formatting software. May display 'No
Available scales
scales available'.

232 Back to TOC

 Tikiwiki Documentation 1.9+

Field Description
Add scaled images size X
If available, you can add a scaled image of size X pixels by Y pixels.
xY
Use categories to group your Gallery with other Tiki objects. Here you can show and hide
Categorize the category list, choose a pre-created category, check "Categorize" to add the gallery to a
category, or, Admin your categories.
Other users can upload If checked, users will be allowed to upload images to your gallery, but they won't be able
images to this gallery to delete images or change the gallery.

Create a gallery for testing by filling in the form, and clicking Save at the bottom of the form. Once
Tiki creates the gallery, it will be listed like so:

If you want to browse the gallery, click its name. On each line in the listing, depending on your
permissions set you can see the "Actions" you can take on each gallery:

If you hover your mouse above each of the Actions icons, you can infer that they link to a set of
tools including:
• Edit: edit the gallery information using the same form you used to create the gallery. Here,
you can change gallery information, your categories or the size of existing thumbnail
images.
• Delete: remove the entire gallery and its images. Use this with care, as it is a permanent
operation.
• Upload: upload images to the gallery.
• List: browse the gallery's images as a list.
• Perms: configure permissions for the gallery (if you are an admin).

Back to TOC 233

 • Make Map: Generate a layer to be used with the maps? feature (only availabl e for
geographic galleries).

Let's examine some of these items in more detail:

4.2.1.4. Upload Image

The Upload Action allows you to upload images to the listed gallery, and displays a form as
follows:

After selecting a gallery you create, or a public gallery created by another user, you can either enter
the URL of your image or select it from your local hard disk. Use only one method for each image,
as results can be unpredictable if you upload the same image using both methods.

Tiki auto-generates thumbnails for uploaded images, but if you don't like the way they look, or if
you do not want a simple thumbnail of the entire image, you can also upload your own thumbnails
along with the image.

If the image is successfully uploaded, you will see its and its thumbnail displayed, as in this
graphic:

234 Back to TOC

 Tikiwiki Documentation 1.9+

Success! The image was uploaded and stored into the Tiki database or into a folder on your server.
Note the image, the thumbnail, and information about how to browse the image or include it in an
HTML page or a Wiki page. Keep these links in mind for use in your Wiki pages or Blog posts.

Note: If Tiki's thumbnail is the same size as the image, there are several possible explanations:
• The image is a GIF. Tiki cannot resize GIFs do to copyright limitations regarding their
format.
• Your web server's PHP installation does not have the GD or ImageMagick graphics
manipulation packages installed.
• Your web server's PHP installation's GD or ImageMagick packages are too old.

4.2.1.5. Browse or List Galleries

Clicking on the gallery name link allows you to browse a listing of thumbnails for the images in the
gallery. Clicking on the "List" action displays a non-graphical, quick-loading list representation of
the gallery with one image per line. The list looks like this:

Back to TOC 235

In List View, click "Browse Gallery" to toggle back to its Thumbnail View. In the following
graphic, you will notice a horizontal menu with links to Edit the gallery, rebuild thumbnails, upload
images, or toggle back to List View. Above the image list or thumbnails, there are links to sort by
name, date, hits, user or size. For example, clicking Name sorts in alphabetical order, from A to Z,
and clicking Name again sorts in reverse alphabetical order, from Z to A. Try sorting for all the
options, once you have several images uploaded.

For each image, a thumbnail is displayed showing the image title, its size and the number of hits (a
hit is computed each time the image is browsed). Under each thumbnail, you will find icons for
Delete, Edit and Popup which act on that image.

Click the thumbnail to browse the image actual-size. Here, you will find image information, an
option to move the image to another gallery (if you have permission), and link information to allow
you to display the image in an HTML page or a Wiki page, an article or a Blog. You will also see
links to the Next and Previous images in the gallery to browse all the gallery images if you like.

236 Back to TOC

 Tikiwiki Documentation 1.9+

4.2.1.6. Individual permissions for image galleries

From the gallery listing screen, if you have the right permissions you can use the "Perms" action to
set up individual permissions for an image gallery:

When you assign a individual permission for a gallery, you can override Tiki's global permissions
system, so that only the users that have the permissions you have set for the gallery can view, edit
or upload. This feature can be used to configure, for example, private galleries, paid galleries or

Back to TOC 237

galleries where only a special group of users can upload images.

4.2.1.7. The System Gallery

If enabled from the admin screen, Tiki can capture images referenced from other sites or URLs,
storing them in its database, or in a folder on your webserver. Tiki displays those images in a
special gallery called the "System Gallery". If you are an admin, you can browse the System
Gallery, and remove images from it.

4.2.1.8. Tips & Tricks

Utility Gallery: One idea for a creative use of a Tiki Image Gallery is to upload buttons or icons
that you might use in the pages on your site.

4.2.1.9. Known bugs and problems

GIF Patent Issue: Thumbnail generation does not work for GIF format, resulting in a thumbnail
which is the same size as the original image. This is due to patent issues, and cannot be resolved
unless the patent for GIF format expires.
More documentation

Related Information
• To enable Image Galleries for your site, see General Admin.
• To specify permissions for Image Gallery users, see Permission for the general procedure.
• To administer Image Galleries, see Image Gallery Config.
• For technical details, see Image Gallery Details.

Useful Links
• Unisys' GIF Patent
http://www.unisys.com/aboutunisys/lzw

238 Back to TOC

 Tikiwiki Documentation 1.9+

• Why No GNU GIFs?

http://www.gnu.org/philosophy/gif.html

4.2.2. Image Gallery Config

4.2.2.1. Admin Access

To access administration, go to Home Page and, on the Menu, click on "Admin (click!)".

Sections: Tiki Admin Panel

You will access the Sections Tiki Admin Panel , as shown in this graphics:

4.2.2.2. Image Galleries

Image Galleries

From the Tiki Admin Panel, click the Image Galleries icon to display its settings panel, the top half
of which appears like so:

Back to TOC 239

Here you can:
• Choose a home gallery.
• Enable and disable rankings and comments.
• Set the image storage location.
• Choose the graphics library.
• Set regular expressions ("regex") to control uploaded file names.

4.2.2.3. Home Gallery (main gallery)

In the above graphic, the home gallery is set to "Rick's Pix". The home gallery is the default gallery
displayed when visitors simply click the menu "Image Galleries" without expanding the menu, or
when as the "top page" in your Tiki site if you set the Tiki system home page to be an Image
Gallery.
• Push the button when you have finished to configure this feature.

4.2.2.4. Galleries features

Use database to store images

Use directory to store images

Choose Storage Location: You can decide for images to be stored either in the database, or in a

240 Back to TOC

 Tikiwiki Documentation 1.9+

folder on your webserver. Storing images in your database is OK for small images, but a folder is
recommended for a high volume site or when your images are relatively large. Note the trailing
forward slash in the path entered in the above graphic, but also here in red. Be warned, if you want
to restrict access to the images, you have to choose a folder that is not browsable (not inside the
document root of your webserver).
/home/cogley/www/uploads/tikiimg/rm/

Path characteristic checklist:

• Has a trailing slash.
• Is specified from the root.
• Is in a separate folder from Tiki, for better security.
• Has its permissions set (e.g. via the chmod command) to allow uploads by the webserver
user.
• Has enough space to allow storage of your expected image volume.

If you take a look at your folder after uploading some images, you can see that Tiki randomizes the
filenames, as shown in this graphic:

Troubleshooting Tip: If you are having trouble with image uploads, you can edit settings in
your php.ini, or, place an .htaccess file in the root of your tiki installation.
# Partial .htaccess file sample.
#
# Override PHP.ini variables, which can be viewed using phpinfo:

<IfModule mod_php4.c>
# If you are using Apache 2, you have to use <IfModule sapi_apache2.c>
# instead of <IfModule mod_php4.c>.

php_value max_execution_time 300

php_value upload_max_filesize "10M"
php_value memory_limit "32M"
php_value session.cache_expire 20000
php_value session.gc_maxlifetime 20000
php_value session.cookie_lifetime 20000
</IfModule>

# Zero means unlimted request body size:

LimitRequestBody 0

Back to TOC 241

 Troubleshooting Tip: If you encounter random errors and webserver crashes, you may have
updated your apache, but forgot to update/recompile your graphics library. The apache error log
will give you some hints..

Library to use for processing images

Choose Graphics Library: You can choose which software library to use for manipulating images.
Currently, your choice is:
• GD
• Image Magick

See below links to the GD and Image Magick sites.

Uploaded images names must match regex

4.2.2.5. Uploaded images names cannot match regex

• Push the button when you have finished to configure these features.
Now, take a look at the bottom half of the Image Galleries admin panel, as shown in this graphic:

242 Back to TOC

 Tikiwiki Documentation 1.9+

4.2.2.6. Remove images in the system gallery...

This is a link for removing images in the system gallery, which are "orphaned" and not used in Wiki
pages, blogs or articles. A useful function for space-saving in the database.
• Click on the link to remove images

4.2.2.7. Gallery listing configuration

Here you can control the display of fields in the Gallery Listings.
• Push the button when you have finished to configure these features.

4.2.2.8. Image galleries comments settings

Here you can make settings regarding to comments.

• Push the button when you have finished to configure these features.

More documentation

Related Information
• To enable Image Galleries for your site, see General Admin.
• To specify permissions for Image Gallery users, see Permission for the general procedure.
• To create and use Image Galleries, see Image Gallery User.
• For technical details, see Image Gallery Details.

Useful Links
• imagick php module
http://pecl.php.net/package-info.php?package=imagick
• Image Magick Image Software Library:
http://www.imagemagick.org
• GD Image Software Library:
http://www.boutell.com/gd/
• Apache WWW Server htaccess tutorial:
http://httpd.apache.org/docs/howto/htaccess.html
• PHP htaccess information:
http://jp2.php.net/configuration.changes
• Absolute Path Glossary Entry
http://linux.about.com/cs/linux101/g/absolute_path.htm

Back to TOC 243

4.2.3. Image Gallery Details
Image Galleries Details
• Image Galleries Details
• Permissions
• Preferences
• Files used
• Database

4.2.3.1. Permissions

Perm Name Default Level Description

tiki_p_admin_galleries editors Can admin Image Galleries.
tiki_p_create_galleries editors Can create Image Galleries.
tiki_p_upload_images admin Can upload images to Image Galleries.
tiki_p_view_image_gallery basic Can view Image Galleries.
tiki_p_batch_upload_images editors Can upload zip files with images.

4.2.3.2. Preferences

Pref name in tiki_preferences table default value comment

feature_image_galleries_comments y
gal_list_created y
gal_list_description y
gal_list_imgs y
gal_list_lastmodif y
gal_list_name y
gal_list_user y
gal_list_visits y
gal_match_regex -
gal_nmatch_regex -
gal_use_db n
gal_use_dir -
gal_use_lib gd
image_galleries_comments_default_orderin points_desc
image_galleries_comments_per_page 10
max_rss_image_galleries 10

244 Back to TOC

 Tikiwiki Documentation 1.9+

max_rss_image_gallery 10
rss_image_galleries y
rss_image_gallery n

4.2.3.3. Files used

Main files nnnn.php

Admin nnn.php
Libs lib/nnn/nnn.php
Modules modules/mod-nnn.php
Misc files templates/mail/nnn.tpl
Related images img/custom/nnn.jpeg

4.2.3.4. Database

Table Usage
tiki_galleries
tiki_galleries_scales
tiki_images
tiki_images_data

Back to TOC 245

4.3. Articles
Articles and submissions are one of the central features of the TikiWiki Content Management
System (CMS). With articles you can build the foundation for a site like those constructed using
CMS systems like PHPNuke or Postnuke with the added advantages of Tiki.

There are three structural components for the Articles sub-system: Topics, Articles and
Submissions.
• Topics - Each item belongs to one, and only one, topic. You can also assign multiple
categories to each item.
• Article - The actual content item that gets displayed, commented on, etc.
• Submission - This is an article that hasn't been approved yet by an authorized admin.

Feature Overview

Topics
Articles and submissions are classified in topics. You can edit topics from the admin topics screen.
Note: You must create a topic before anyone can submit an article!
In this screen you can add and remove topics or you can activate/deactivate topics without
removing them. You can also click the perms link to assign permissions to the topic.

The permissions for topic works as follows:

• If no permission is assigned to the topic then everybody can read articles or reviews in this
topic.
• If the tiki_p_read_topic permission is assigned for the topic only the groups with the
permission can view the topic and other users won t see content in the topic (Articles,
reviews,etc). This can be used to manage private topics that only users in some groups can
read.

NB: Topics are not categories. Topic is only for articles, category is for a lot of Tikiwiki objects

Article Types
There are currently 3 different article types:
• Article - Normal type, only displays in "Article Home" after the publication date.
• Review - Articles with reader-added ratings. Only displays in "Article Home" after the
publication date.
• Event - Used for showing upcoming events or to automatically remove content from your
site. Events display until the "Publication/Event Date". Switching the type between article
and event should cause it to appear and disappear from the Article Home page. (Note:
Events are a v1.8 feature)

246 Back to TOC

 Tikiwiki Documentation 1.9+

From Here
• To enable articles for your site, see General Admin.

4.3.1. Article User

4.3.1.1. The Articles menu

As a user this is a simple menu. You can visit the Articles Home, see a list of articles, view
Rankings, send a submission or view active submissions. Of course, what you can or can't do and
what you see in this menu is configurable.

If you are admin click the Edit article link in the admin menu to enter a new article.

4.3.1.2. Editing or Submitting Articles

This is the screen where you can edit and existing article or create a new article, we'll examine each
field in detail:

Back to TOC 247

 • Title - The article title
• Author Nam - The name of the author as it will appear in the article (you can use any name
here).
• Topic - The topic to which the article is assigned. If you don't see options in the select box
for topics then you must first create a topic. Use the admin topics link in the admin menu to
create a topic and then go back to the edit article screen.
• Type is the type of article to use.
• Rating - This only shows up for Review articles. Assign a numerical rating to whatever you
are reviewing.
• Own Image - Articles can have an associated image. If you want your article to have an

248 Back to TOC

 Tikiwiki Documentation 1.9+

associated image you can upload an image using the Own Image field.
• Use own imag - By default the article will display the topic image (each topic has an
image), if you want the article to display its own image instead of the topic image, check the
Use own image checkbox.
• Float text around image - Well, do you want the text to float around the image?
• Own image size x and Own image size y - Allows you to adjust the display size of the
article image.
• Apply template - To use this, you must have the "Use templates" box checked in the CMS
admin page. Any templates created in the Content template section with the "use in cms:"
box checked will show up in this drop down list.
• Categorize - Assign categories for this article.
• Heading and Body - The heading and the body are self explanatory. Use the Wiki Tag
System here as if you were editing a Wiki Page. If you want to use HTML in the article
make sure that the AllowHTML option is checked at the bottom.
• Publish/Event Date - Set the publishing date for the article. This affects when the article is
visible on the Articles Home page.
• Allow HTML - Check this box to allow HTML content in the Heading or Body.

Finally, use the preview feature as many times as you want to preview and edit the article. Make
sure you click save before navigating away from the page.

4.3.1.3. Articles Home

The Articles Home displays the articles most recently added to the Tiki. system. The number of
articles displayed on Articles Home can be configured from the General Admin CMS admin page.
Articles Home can be set up as the Tiki Home Page from the admin screen if you want to use Tiki
as a CMS system.

You will see each article displayed showing the heading and a link to read more where you can read
the whole article:

Back to TOC 249

You can also filter the list of articles shown here by:
• type (article, review)
• topic (numeric id)
• find (a string to search for in the title, heading or body)

For example, you could make a Wiki link to a page showing only "reviews" with this:
[tiki-view_articles.php?type=review]

or, only articles with the word "Tiki" in them with:

[tiki-view_articles.php?type=article&find=Tiki]

You can also change the sort order from the default (newest to oldest) with the "sort_mode" option.
For example, to list upcoming events in order of occurrance, use:

tiki-view_articles.php?sort_mode=publishDate_asc&type=Event

4.3.1.4. List Articles

The list articles section shows a list of articles.

250 Back to TOC

 Tikiwiki Documentation 1.9+

This list can be sorted by any column. Articles can be filtered by keyword. If you have the proper
permissions you will see options to edit, read or remove articles in the actions column.

4.3.1.5. Rankings

In the Rankings page you will access to rankings for the CMS system such as Top Articles, Top
Authors, etc. You have to select the ranking to display and the number of records to display and
click the view button to see the ranking.

Back to TOC 251

 4.3.1.6. Submit Article

Submitting and article is the same as editing an article with the difference that the result will be
stored as a submission and not published inmediately as an article. The process to edit and send a
submission is the same as editing and article so you should read about editing above articles if you
haven't to find out.

4.3.1.7. View Submissions

You will a list of submissions and if you have the permissions you may see links to edit, remove or
approve a submission. Once a submission is approved it becomes an article.

In the Action column, holding your mouse over the icons will indicate which action they will
perform.

4.3.2. Articles Config

4.3.2.1. Admin Access

To access administration, go to Home Page and, on the Menu, click on "Admin (click!)".

4.3.2.2. Sections: Tiki Admin Panel

You will access the Sections Tiki Admin Panel, as shown in this graphics:

252 Back to TOC

 Tikiwiki Documentation 1.9+

4.3.2.3. Article/CMS settings

Articles

From the Tiki Admin Panel, click the Articles icon to display the Articles setup panel, the top of
which appears like so:

Back to TOC 253

You can select here if the rankings and comments features are enabled for articles and submissions.
You can also select the maximum number of articles to display in the articles home page.

4.3.3. Article Details

254 Back to TOC

 Tikiwiki Documentation 1.9+

4.4. Blog
An abbreviation for Weblog, the term "blog" refers to a collection of related posts, which are sorted
(by default) in reverse chronological order (the most recent posts are shown first).

Some blogs have a single author, who uses the blog to keep what amounts to an online diary: a day-
to-day record of the individual's varied thoughts, reflections, and pertinent Web links. Other blogs
contain posts from two or more authors; typically, these blogs focus on a more or less well-defined
topic, such as sci-fi movie reviews. In schools and colleges, blogs are increasingly used to facilitate
student journals.

TikiWiki's Blogs feature enables users to enjoy all the best features of weblogs (including RSS
output, trackback pings, and remote posting via Blogger-compatible programs, such as w.Bloggar),
but without the hassle (and, often, the expense) of using commercial blogging services.

A TikiWiki site can be set up to display a blog as its home page (see General Admin ). This means
you can use TikiWiki as an alternative to less-feature-rich alternatives, such as Moveable Type.

Feature Overview
TikiWiki's Blogs feature enables administrators to set up as many blogs as they like, or
administrators can give users permission to create their own blogs. Blogs can be accessed by listing
them (Menu/Blogs/List Blogs) or by creating a link to one or more blogs in a custom menu.

Blog configuration options include the number of posts to display, whether other users are allowed
to post in the blog, and whether searches and comments are allowed. In addition, the blog heading
can be edited; by default, it displays the date of creation and last modification, the total number of
posts and visits, and a figure that sums up the blog's activity level.

When posting to a blog, users can choose between the textarea or WYSIWYG editors; posting
options include title and one or more trackback URLs. (See "About Trackback," below.) Users can
also take advantage of TikiWiki's implementation of Blogger's XMLRPC protocol, which enables
users to use a Blogger-compatible program (such as wBloggar ) to post to their TikiWiki blogs (see
"About XMLRPC," below).

About Trackback
The Trackback protocol, developed by Moveable Type, provides a blog author with a very
convenient, low-bandwidth way to tell other blog authors that their posts have been referenced and
discussed. For example, suppose you've just read a post on blog A. You post to your blog (Blog B)
and discuss the Blog A post. When you save your post, you include the trackback URL. TikiWiki
then sends a trackback ping (actually, it's not a ping, but a short message conforming to the
Trackback protocol) to Blog A; Blog A's author can then see that you've posted something that's
related. Now suppose the Blog A author posts something about YOUR post. When you look at your
post, you'll see a list of trackback pings (including the page title, URL, and blog name). For more
information on using trackback, see Blog User.

Back to TOC 255

 About XMLRPC
TikiWiki implements the XMLRPC standard developed by Blogger, a popular commercial blogging
site. This standard is an wp:Application_programming_interface, which means that any application
conforming to the standard can upload content to Blogger — or any service that conforms to the
same API on the receiving end. For this reason, any application that correctly implements the
Blogger XMLRPC API can be used to post and edit content in Tiki blogs. To use Blogger
XMLRPC API with a Tiki, enable it in the Features panel. You can then use Tiki blogs using
dekstop applications like wBloggar.

More documentation

• Blogs TikiMovie
View in action click after click how to use Blogs in a Flash movie.

Related Information
• To enable blogs for your site, see General Admin.
• To enable the XMLRPC API, see Features Admin.
• To choose configuration options for all blogs on your site, see Blog Config.
• To specify permissions for blog users, see Permission for the general procedure; see Blogs
Detail? for specific permission settings relevant to blogs.
• To create and use a blog, see Blog User.
• To configure the popular wBloggar blog-posting tool for use with TikiWiki, see wBloggar.

Useful Links
• Moveable Type
http://www.moveabletype.org
• Blogger
http://new.blogger.com
• wBloggar
http://wbloggar.com/
• Other blog software options (tikiwiki directory)
http://tikiwiki.org/tiki-directory_browse.php?parent=26
• Weblog on wikipedia
http://en2.wikipedia.org/wiki/Weblog
• Beginner's Guide to Trackback (Moveable Type)
http://www.movabletype.org/trackback/beginners/
• The ultimate Weblogging system, outlined
http://mpt.phrasewise.com/2003/05/02#a507

4.4.1. Blog User

A blog (short for Weblog ) is a collection of posts (submissions) by one or more authors; typically,
they're sorted in reverse chronological order (most recent first). You can think of a blog as an online
journal or diary. TikiWiki's Blog feature enables each user of a TikiWiki site to set up one or more

256 Back to TOC

 Tikiwiki Documentation 1.9+

blogs, and provides many (if not most) of the features you'll find in the top blog-only packages,
such as Movable Type.

Depending on how the TikiWiki administrator has configured the TikiWiki site you're using, you
may be able to do some or all of the following:
• See a list of all the available blogs on your TikiWiki site
• See which blogs are popular
• Read a blog
• Comment on a blog entry
• Print a blog entry
• Mail a blog entry to one or more recipients
• Create a blog
• Post an entry to a blog
• Edit or delete an existing post

The following sections explain how to perform these actions.

4.4.1.1. Viewing a List of Available Blog

To view a list of available blogs, do the following:

1. On the Menu, click to the left of Blog, if necessary, to see the options under Blogs.
2. Click List Blogs. You'll see the Blog list, shown in the following illustration:

List of Available Blogs

no s'ha trobat la imatge img/icons2/alert.gif If you've created a blog (and you've been granted the
appropriate permissions by your TikiWiki administrator), you'll see icons that enable you to post to
the blog, edit the blog's configuration, define blog permissions, or remove the blog entirely. The
remove option is dangerous — it will remove the blog and all the entries contained in the blog!
Don't click the remove icon unless you're sure you know what you're doing.

Is the list too long for a visual search? Type part of a blog name in the Find box, and click Find.

Click one of the following column headers to change the sort order: Title, Created, Last

Back to TOC 257

Modified, User, Posts, Visits, or Activity. To reverse the sort sequence (ascending or descending),
click the same header again.

4.4.1.2. Listing Blog by Rank

If your TikiWiki site has many blogs, you may wish to see which ones are more popular than
others. To do so, click Rankings under Blog in the Menu. You'll see the Rankings list, shown in the
following illustration:

Blogs Ranked by Number of Visits

To view the blog rankings, do the following:

1. In the first text box, select one of the following:
• Top Visited Displays the blog list with the most-visited blogs listed first.
• Last Posts Displays the blog list with the most recently updated blogs listed first.
• Top Active Displays the blog list with the most frequently updated blogs listed first.
2. In the second list box, select the number of blogs to display (top 10, top 20, top 50, or top 100).
3. Click View.

4.4.1.3. Reading a Blog

To read a blog, do the following:

1. Display the blog list (see "Viewing a List of Blog," above).
2. In the Title column, click the name of the blog you want to read. You'll see the blog's
contents, as shown in the following illustration:

258 Back to TOC

 Tikiwiki Documentation 1.9+

Reading a Blog

By default, blog entries are sorted in reverse chronological order, but the TikiWiki administrator
may have chosen a different default sort order. Note that the blog header, by default, shows the blog
title, the date of creation, the date of last modification, the number of posts, the number of visits
(that is, by users other than the blog owner and admin), and the blog description, if any. Some of
this information might not be visible on your TikiWiki's blogs, depending on how your
administrator configured the Blog feature.

At the bottom of each blog entry, you'll see the following:

• Permalink The permalink is the unique URL of the current entry. This URL is useful for
people who are reading the blog and would like to link to this entry in particular. With most
browsers, it's possible to copy a link by right-clicking the link and choosing the appropriate
option (such as "Copy Link Location") from the popup menu.
• Referenced By This area indicates the number of blog pages (in this TikiWiki site or
elsewhere on the Web) that have set up a trackback to this page. For more information on
trackbacks, see Blog.
• References This area indicates the number of blog pages to which this entry has sent
trackback pings. For more information on trackbacks, see Blog.

If there are so many entries that they can't all be shown on one page, click Next (at the bottom of
the page) to see the next page of entries; click Prev to see the previous page.

Back to TOC 259

 If you see a mini-calendar box in the left or right sidebars, select a date to filter the list. You'll
see only those entries that were created on or before the date you select. To return to the full list,
click Today.

To search the full text of the entries, type a search word or phrase in the Find box, and click
Find. You'll see only those entries (if any) that contain the text you typed. To see all the entries
again, leave the Find box blank, and click Find again.

4.4.1.4. Printing a Blog Entry

To print a blog entry, do the following:

1. Display the blog entry that you want to print.
2. Click the Print icon (located in the entry's lower right corner). You'll see the entry by itself,
without the topbar or sidebars to distract from the entry's content.
3. Click the Print icon on your brower's toolbar, or choose Print from the File menu.
4. Click Return to Blog.
5. Display the blog entry that you want to print.
6. Click the Print icon (located in the entry's lower right corner). You'll see the entry by itself,
without the topbar or sidebars to distract from the entry's content.

4.4.1.5. Mailing a Blog Entry's URL

To mail a blog entry's URL to one or more recipients, do the following:

1. Display the blog entry that you want to print.
2. Click the Print icon (located in the entry's lower right corner). You'll see the Send Blog Post
page.
3. In the text area, type the e-mail address to which you want to send the page. To send the
page to two or more recipients, separate the e-mail addresses with commas.
4. Click Send.

4.4.1.6. Commenting on a Blog Entry

You can comment on a blog entry if:

• Your TikiWiki administrator has given the group to which you belong permission to make
comments, and
• The blog has been set up with comments enabled.
To comment on a blog entry, do the following:
1. Display the entry.
2. At the bottom of the entry, click View Comments.
3. Click Comment to display the comment composition box, shown in the following
illustration.
4. In the Title box, type a brief but descriptive title for your comment.
5. In the Comment box, type the text of your comment.

260 Back to TOC

 Tikiwiki Documentation 1.9+

6. To preview your comment, click Preview.

7. To save your comment, click Post.

Posting a Comment

If there's already at least one comment, and you'd like to comment on the comment rather than
the blog entry, click Reply to This. (This option isn't visible unless at least one comment has
already been posted.)

4.4.1.7. Creating a Blog

If your TikiWiki administrator has granted the appropriate permissions to users, you can create one
or more blogs.

To create a blog, follow these steps:

1. Under Blog in the Menu, click Create Blog. You'll see the Edit Blog page, shown in the
following illustration.
2. Choose the configuration options you want (see "Blog Configuration Options," below).
3. Click Save.

Back to TOC 261

 Creating a Blog

Blog Configuration Options

You can configure the following settings when you create your blog:
• Title The title of your blog. Since this title must fit in horizontally formatted blog lists, keep
it short!
• Description A description of your blog's contents. Like the title, the description must fit in
horizontally formatted blog lists, so keep it short.
• Number of posts to show (Default: 10)
• Allow other user to post in this blog If you leave this option unchecked, you're the only
user who can post in the blog. Depending on how your administrator has set up blog-related
permissions, some or all users will still be able to read your blog (Default: No).
• Use titles in blog posts Leave this option unchecked to title each entry with its creation date
alone. This is a good choice for a diary (Default: Yes).
• Allow search Check this option to allow readers to search the full text of your blog entries.
• Allow comments Check this option to allow readers to comment on your blog entries. Just
who can comment depends on how your TikiWiki administrator has defined commenting
permissions; in most configurations, only registered users can comment(Default: Yes).
• Blog heading This box shows the code used to generate the blog heading, which appears at
the top of your blog. You don't need to modify this text in order to create a blog. For more
information, see "The Blog Header," below.
• Categorize If you have created categories and would like to categorize the blog, click Show
Categories. Select a category (use Ctrl + Left Click to select more than one category). Be
sure to check Categorize this Object.

262 Back to TOC

 Tikiwiki Documentation 1.9+

The Blog Header

If you don't like the way the blog headers look, and you're reasonably knowledgeable about HTML
and Smarty code, you can edit the code that's used to generate the header. Here's how the default
code looks:

<div class="blogtitle">{tr}Blog{/tr}: {$title}</div>

<div class="bloginfo">
{tr}Created by{/tr} {$creator}{tr} on {/tr}{$created|tiki_short_datetime}<br/>
{tr}Last modified{/tr} {$lastModif|tiki_short_datetime}<br/><br/>
({$posts} {tr}posts{/tr} | {$hits} {tr}visits{/tr} | {tr}Activity={/tr}{$
activity|string_format:"%.2f"})
{if $tiki_p_blog_post eq "y"}
{if ($user and $creator eq $user) or $tiki_p_blog_admin eq "y" or $public eq
"y"}
[<a class="bloglink" href="tiki-
blog_post.php?blogId={$blogId}">{tr}Post{/tr}</a>]
{/if}
{if $rss_blog eq "y"}
[<a class="bloglink" href="tiki-blog_rss.php?blogId={$blogId}">RSS</a>]
{/if}
{/if}
{if ($user and $creator eq $user) or $tiki_p_blog_admin eq "y"}
[<a class="bloglink" href="tiki-
edit_blog.php?blogId={$blogId}">{tr}Edit{/tr}</a>]
{/if}
</div>
<div class="blogdesc">{tr}Description:{/tr} {$description}</div>

Blog Header Code

4.4.1.8. Posting an Entry to Your Blog

When you post an entry to your blog, you can choose from all of the rich formatting options that
TikiWiki makes available:
• Wiki tags In blog posts, you can use the same formatting tags that you use in a Wiki page.
• WYSIYWG editor You can choose the WYSIWYG editor option for creating your entry.
Unlike t__he default (textarea) editor, this editor enables you format text by selecting it and
then clicking a format icon.
• HTML In keeping with weblog tradition, HTML is enabled (by default) for blog posts.

To post an entry to your blog, do the following:

1. Display your blog.
2. Click Post. You'll see the Edit Post page, shown in the following illustration.

Back to TOC 263

 3. If you would like to use the WYSIWYG editor, click Use WYSIWYG Editor.
4. In the Title box, type a brief, descriptive title.
5. In the Data box, type the text of your post.
6. Do one of the following:
1. Click Preview to see how your post will look.
7. Click Save to save your post but keep the editing area on-screen.
8. Click Save and Exit to save your post and return to your blog.

Posting an Entry

Posting Options

Here's an overview of the options you can choose when you create a blog post.
• Blog If you have permission to post to more than one blog, make sure you choose the
correct blog here.
• Smileys To include a smiley in your post, click one of the icons. The smiley code appears at
the end of your post; move it to where you want the smiley to appear.
• Quicklinks To see how to format your text using Wiki tags, click one of the Quicklinks.
The Quicklink code appears at the end of your post.
• Title Type a short but descriptive title (required).
• Data Type the text of the post here.
• Send trackback pings to:(comma separated list of URIs) Type the URIs of one or more
sites to which you want to send trackback pings. (For more information on trackback pings,
see Blog.
• Spellcheck Check this option to check your spelling after you save your post. Note: This

264 Back to TOC

 Tikiwiki Documentation 1.9+

option will not work unless your TikiWiki administrator has enabled spell checking.

Editing Your Post

To edit an entry you have already saved,

1. Display your blog.
2. Click the Edit icon on the post you want to change. You'll see the Edit Post page.
3. Make the changes.
4. Do one of the following:
1. Click Preview to see how your post will look.
5. Click Save to save your post but keep the editing area on-screen.
6. Click Save and Exit to save your post and return to your blog.

From Here
Are you a TikiWiki administrator? Learn how to administer TikiWiki's blog functions in Blog
Config.
Curious to see what's under the hood? See Blog Ref for the details.

4.4.2. Blog Config

Admin Access
To access administration, go to Home Page and, on the Menu, click on "Admin (click!)".

4.4.2.1. Sections: Tiki Admin Panel

You will access the Sections Tiki Config Panel , as shown in this graphics:

Back to TOC 265

 4.4.2.2. Blog settings

Blogs

From the Tiki Config Panel, click the Blogs icon to display its settings panel, the top of which
appears like so:

266 Back to TOC

 Tikiwiki Documentation 1.9+

Home Blog (main blog)

The Home Blog will have the following properties:

• If not selected it will default to the first blog created.
• It's where you go if you click on blogs in the main menu (without expanding the menu).
• It's where you go as the home page if you select the home page to be a blog (in the general
settings).

Back to TOC 267

 Blog features

Enable/disable rankings/comments and you can select which is the Home Blog.

Blog listings configuration

Blog comments settings

From Here
Learn how to administer daily TikiWiki's blog functions in Blogs Admin?.
Curious to see what's under the hood? See Blog Ref for the details.

4.4.3. Blogs Details

4.4.3.1. Modules

The blogs activity can be used by some modules, mostly using rankings features :
module name usage
last_blog_posts
last_created_blogs
last_modified_blogs
top_active_blogs
top_visited_blogs
user_blogs

4.4.3.2. Permissions

Perm Name Default Level Description

tiki_p_create_blogs editors Can create a blog
tiki_p_blog_post registered Can post to a blog
tiki_p_blog_admin editors Can admin blogs
tiki_p_read_blog basic Can read blogs
tiki_p_admin admin Administrator

268 Back to TOC

 Tikiwiki Documentation 1.9+

4.4.3.3. Preferences

Pref name in tiki_preferences table default value comment

blog_comments_default_ordering points_desc
blog_comments_per_page 10
blog_list_activity y
blog_list_created y
blog_list_description y
blog_list_lastmodif y
blog_list_order created_desc
blog_list_posts y
blog_list_title y
blog_list_user y
blog_list_visits y
blog_spellcheck n
feature_blog_comments n
feature_blogposts_comments n
feature_blog_rankings y
feature_blogs n
max_rss_blog 10
max_rss_blogs 10
rss_blog n
rss_blogs y

4.4.3.4. Files used

Main files tiki-blog_post.php

templates/tiki-blog_post.tpl
tiki-blog_rankings.php
templates/tiki-ranking.tpl
tiki-edit_blog.php
templates/tiki-edit_blog.tpl
tiki-list_blogs.php
templates/tiki-list_blogs.tpl
tiki-print_blog_post.php
templates/tiki-print_blog_post.tpl
tiki-send_blog_post.php
templates/tiki-send_blog_post.tpl
tiki-view_blog.php

Back to TOC 269

 Main files tiki-blog_post.php
templates/tiki-view_blog.tpl
tiki-view_blog_post.php
templates/tiki-view_blog_post.tpl
tiki-view_blog_post_image.php
tiki-blog_rss.php
tiki-blogs_rss.php

Admin tiki-admin_include_blogs.php
templates/tiki-admin-include-blogs.tpl

Libs lib/blogs/bloglib.php
lib/tikilib.php
lib/searchlib.php
lib/admin/adminlib.php
lib/calendar/calendarlib.php
lib/categories/categlib.php
lib/hawhaw/hawtikilib.php
lib/rankings/ranklib.php
lib/search/refresh.php
lib/search/searchlib.php
lib/stats/statslib.php
lib/searchlib.php obsolete

Modules modules/mod-last_blog_posts.php
templates/modules/mod-last_blog_posts.tpl
modules/mod-last_created_blogs.php
templates/modules/mod-last_created_blogs.tpl
modules/mod-last_modified_blogs.php
templates/modules/mod-last_modified_blogs.tpl
modules/mod-top_active_blogs.php
templates/modules/mod-top_active_blogs.tpl
modules/mod-top_visited_blogs.php
templates/modules/mod-top_active_blogs.tpl
modules/mod-user_blogs.php
templates/modules/mod-top_active_blogs.tpl

Misc files templates/mail/blogs_send_link.tpl

templates/mail/user_watch_blog_post.tpl

270 Back to TOC

 Tikiwiki Documentation 1.9+

Main files tiki-blog_post.php

Related images img/custom/weblog.jpeg

img/custom/weblog3.jpeg
img/custom/weblogs.jpeg
img/custom/weblogs2.jpeg
img/icons/admin_blogs.png

4.4.3.5. Database

Table Usage
tiki_blog_activity
tiki_blog_posts
tiki_blog_posts_images
tiki_blogs

Back to TOC 271

4.5. File Galleries
The file galleries section of Tiki is a download manager. A file gallery is a collection of files. You
can use file galleries to distribute free multimedia, (mp3's, podcasts), software (releases, patches,
docs) and to hold files that users can download from Wiki pages, articles, or blog posts.

The file galleries tool allows you to create and edit galleries. You can use the Tiki permissions
system to specify who can create galleries, upload files and download files. Statistics are kept of
each download. You can produce stats for the most downloaded files, most visited file galleries and
last uploaded files..

4.5.1. File Gallery User

The file galleries section of Tiki is a download manager, you can create/edit file galleries which are
collections of files, you can define with the permission system who can create file galleries, upload
files and download files. Statistics are recorded for each download, rankings where defined for the
top downloaded files, most visited file galleries and last uploaded files. Modules are also available
to display last changed file galleries, last uploaded files, top downloaded files and top visited file
galleries.

You can use file galleries to distribute free multimedia (mp3, avis, etc), to distribute software
(versions, patches, releases), to add files that users can download from Wiki pages, articles or
weblog posts, etc.

If you enable the file galleries section from the admin menu you ll see a menu section in the main
menu for file galleries. From the menu according to the permissions you have you will be able to
list existing file galleries (where you can create a new gallery) or upload a file to a gallery.

A file gallery is just a collection of files that can be downloaded, files are kept in the Tiki database
and the number of downloads for each file are registered.

The List galleries option in the main menu will take you to the following screen:

4.5.1.1. Listing file galleries

272 Back to TOC

 Tikiwiki Documentation 1.9+

From this screen you can create a new gallery, edit existing galleries, remove existing galleries,
upload a file to a gallery or list the contents (files) of an existing gallery. The options you see as a
user depend on the permissions the admins have set for your groups.

4.5.1.2. Creating file galleries

To create a new file gallery click the create new gallery link and the following form will be
displayed.

Back to TOC 273

The same form is displayed to edit and existing gallery, you have to fill the gallery name, a
description and the maximum number of rows (files) that will be displayed for each page in the file
gallery listing.

You can make a gallery invisible to normal users unchecking the gallery is visible to non-admin
users checkbox. This can be used to set-up galleries that can t be browsed but contain files that you
will make available for downloading in your site using direct links to download the file.

If you want to allow uploads to this gallery from other user check the checkbox above the
edit/create button. If the checkbox is not checked then only the gallery creator or admins can upload
files to the gallery.

4.5.1.3. Uploading files

To upload a file you use the following form:

In this form you enter a title and description for the file, the gallery where the file will be stored and
then the file from your local disk to upload. If everything goes well you will see a message
indicating that the file was uploaded.

274 Back to TOC

 Tikiwiki Documentation 1.9+

4.5.1.4. Batch uploads

If you have the right permission to batch file uploads then you will be able to make a batch upload
of files by uploading a .zip file to the gallery and checking the batch-upload checkbox (if you don't
check it the zip is uploaded as a single file).

Note that you must only give batch uploading permissions to admin since if users can make batch
uploads the results can be unpredictable.

Once you have some files uploaded to the gallery you can visit the gallery from the gallery listing
menu and see the uploaded files:

4.5.1.5. Listing file galleries and downloading files

From this screen you will see the gallery description and the files uploaded to this gallery (the
number of files per page varies), you can order the list by any of the columns in the listing. Clicking
the get link in the actions column will download the file to your local disk.

Back to TOC 275

 4.5.1.6. Permissions

The following permissions can be set for the file galleries section:

The tiki_p_admin_file_galleries is a master permission that automatically includes the other 4

permissions.

4.5.2. File Galleries Config

Admin Access
To access administration, go to Home Page and, on the Menu, click on "Admin (click!)".

Sections: Tiki Admin Panel

You will access the Sections Tiki Admin Panel , as shown in this graphics:

276 Back to TOC

 Tikiwiki Documentation 1.9+

Figure 4.A.:

4.5.2.1. File galleries

File galleries

From the Tiki Admin Panel, click the File galleries icon to display its settings panel, the top of
which appears like so:

Clicking the File Galleries icon on the Admin Panel (see TikiAdminSettings ) takes you to the File
Galleries settings.

Back to TOC 277

This panel is almost identical to the image galleries panel. Select the home file gallery, the comment
settings for file galleries and if rankings/comments are used or not for file galleries.

There's an important setting for the file galleries: the storage strategy for files. You can choose one
of two options to store file gallery files:
• Store files on the database
• Store files on a directory

The differences and settings needed for each option are explained below:

Storing files on the database:

278 Back to TOC

 Tikiwiki Documentation 1.9+

If you decide to store files on the database then each file data will be stored on a database column
(field) this has the following advantages and disadvantages:
• You don't need to configure anything else.
• You may have problems if you plan to store large files
• The database can grow a lot making more difficult to make backups/dumps

Storing files on a directory

If you decide to store files on a directory you must indicate the path to a directory where you will
store files. The directory can be absolute or relative to the Tiki directory for example:
files/
/www/tiki/files/
/home/tiki/files/
files/uploads/
can be configured as directories.
Before 1.8.1, ending "/" was mandatory.

Storing files on a directory has the following advantages and disadvantages

• You must configure properly a directory to store files
• You can upload files of any size (if you have space)

You must ensure that:

• The configured directory exists and PHP (Apache) can read/write it
• For security, only Tiki can read or access the contents of that directory. Do that with one of
the two following options.
[+]
• Use a directory outside the webserver DocumentRoot (so the users won't be able to
list the directory)
• Use a directory inside the DocumentRoot (relative to the Tiki dir for example) and prevent
listing the directory using a .htaccess file or other configuration depending on your
webserver.

You may need to ask your ISP/hosting service for an upload strategy and instructions if the
ISP/hosting allows uploads (some PHP's have file uploads disabled for unknown reasons, maybe to
prevent disk space consuming). Since Tiki can be configured to store fles on the database or a
directory if there's a way to handle uploads then Tiki can use it :-) choose the strategy that is best
for you.

Filtering file uploads

You can set up filters for filenames so filenames will be checked and maybe rejected depending on
their filenames. Filters are regular expressions perl-like without the // delimiters.

Back to TOC 279

 Filename must match:

A regular expression that must be matched to accept the file example [A-Za-z]* (filename can only
have a-z letters)

For example, if you want to require that uploads must have a wordprocessing file extension, you
could enter .*\.(odt|sxw|doc|dot|rtf|wpt|frm|wpd|txt|ODT|SXW|DOC|DOT|RTF|WPT|FRM|WPD|
TXT)

Filename must not match:

A regular expression that if matched rejects the file, example \.gif (rejects gif images note that the
period must be escaped since we are using regular expressions) If you don't know anything about
regular expressions just leave the fields blank and all the files will be accepted.

File galleries search indexing

If you want the files content of your files galleries to be accessible by a TikiWiki search, and if you
have a script that extracts the file content into a text, you can associate the script to the Mime type
and the files content will be indexed.

For a Linux server an example is

MIME Type System command
application/msword /usr/local/bin/catdoc %1 -
application/pdf /usr/local/bin/pdftotext %1
application/vnd.ms-excel /usr/local/bin/xls2csv %1
application/vnd.ms-powerpoint /usr/local/bin/catppt %1
text/html strings %1
text/plain strings %1

This requires the programs specified above (catdoc, pdftotext, xls2csv and catppt) to be manually
loaded on the Linux server.

4.5.3. File Gallery Details

280 Back to TOC

 Tikiwiki Documentation 1.9+

4.6. Forums
Forums are one of the more frequently used features in tikiwiki.

Feature Overview
Welcome to one of the most interesting features in Tiki: the forums system, the concepts are very
simple:
• A forum is a collection of topics (also called threads) about a subject. You can have a forum
to discuss a product, movies, sports, the weather; anything you think of.
• A topic/thread is a collection of messages (also called posts) in a particular forum.
• A post/message is a message a user has submitted about a particular topic.

Also see: Forum and List Synchronization, which can be used to to archive messages from a
mailing list into a Tiki forum and back.

4.6.1. Forums User

The forums menu in the application menu displays 2 links, one to the forum listing and another to
the forum rankings. If you are admin you will be able to configure forums from the admin-forums
screen in the administration menu. Let's go to the admin forums screen to create a forum:

Back to TOC 281

 4.6.1.1. Creating/editing forums

The admin forums screen show a list of available forums and a form to create/edit a new forum, the
form has the following format:

The fields are described next:

Name The forum name as it will be displayed in the forum listing
Description A description for the forum
Requires users to wait the specified time between posts. This can be used to prevent a user
Prevent flooding
from flooding the forum with messages/posts.

282 Back to TOC

 Tikiwiki Documentation 1.9+

Name The forum name as it will be displayed in the forum listing

The number of threads/topics that will be displayed in one page when listing the forum
Topics per page
threads/topics.
Forums can be organized into sections, you can assign an existing section to a forum, create a
Section
new section or don't use a section. When listing forums they will be grouped by section.
Defines a single user to be set as forum moderator. When a user is set as moderator he/she will
Moderator user
be granted all the permissions for this forum.
Moderator group Same as Moderator user but this time for a whole usergroup.
Specifies how threads/topics will be orderded in the thread list by default. Options are: Date:
Default ordering for Creation date of the topic; Replies: Number of replies (messages) the topic has; Reads:
topics Number of times the topic has been read; Last post: Date of the last post in the topic. (the last
message posted); Title: topic title.
Determines how messages/posts of a thread/topic will be ordered by default when viewing an
Default ordering for
individual thread/topic. The options are: Date: message date; Title: message title; Score:
messages
Message score.
Send this forum posts You can configure an email address that will receive all the topics and messages posted to the
to this email forum
Prune unreplied If enabled threads/topics that do not have any replies will be automatically removed after the
messages after amount of time indicated
Prune old messages If enabled threads/topics and posts/messages will be automatically removed when they are
after older than the indicated amount of time .
Topic list
Specifies which thread/topic properties should be displayed when viewing the thread list
configuration
Threads can be voted Allows users to vote on a thread by assigning points from 1 to 5
Forward messages to
Allows you to have all new messages in a forum to be copied by email to the specified email
this forum to this
address
email
This option configures the so-called mail-in feature that allows anyone to post a message on
Add messages from the forum by means of sending an email with the desired post content to the specified email
this email to this address. It is required to have a valid POP3 mail account on a server from which Tiki can
forum check and retrieve the email messages. By specifying the username and password for the email
account all messages will be downloaded automagically.
Use topic smileys Allows you to specify a smiley when posting a new thread or topic
Show topic summary Displays the short description underneath the thread/topic title of the thread/topic summary
User information
Specifies which user details should be shown when viewing a thread
display
Specifies whether or not you wish to work with a moderator queue. By selecting All posted
no approval is required. When selecting Queue anynomous posts only posts from non forum
Approval type
members will be queued for approval. Finally when opting for Queue all posts any new posts
in the forum will not be displayed until it has been approved.
Specifies whether you want to allow users posting attachments with their posts/messages and
whether these should be stored in the Tiki database or on the local file system. By defining a
Attachment
max attachment size you can avoid users from posting attachments that are larger than the
specified threshold.

Once a forum is created you can see it displayed in the listing:

Back to TOC 283

The edit link can be used to edit the forum while the perms link can be used to set-up individual
permissions for the forum.

4.6.1.2. Using the forum

As a user you can enter the forums section clicking the forums link in the application menu.

You can order the forum listing as you want and you can click on the forum name to enter the
forum.

When you enter to a forum a list of topics will be displayed:

284 Back to TOC

 Tikiwiki Documentation 1.9+

Topics are listed using the default ordering for topics set for the forum, as a user you can order the
topics by any of the fields in the topic listing. The type is used to classify topics (more on this later).
When the type icon is shown reddish (as in this case) the topic is new for the user. If you have the
permission to post a topic you will see a link to display/hide the form to post a new topic. This is the
form when displayed:

Back to TOC 285

You will have to enter the title for the topic, the type and the comment (the topic text), you can use
some smileys shown at the right if you want. The topic-type that you can set will be normal unless
you are an admin for this forum, in which case you can use any type. Topics type are described
next:
Type Icon Description
Normal A normal topic
Hot A hot topic, a topic that is very important or polemical or anything you consider hot

Announce An announcement
A sticky topic will be displayed on top of the list of topics regardless of the ordering selected for
Sticky
topics.
A locked topic is a topic where users cannot post messages, admins can lock a topic by changing
Locked
the type of any topic to locked

If you click on the topic name for any topic a list of topic messages will be displayed:

286 Back to TOC

 Tikiwiki Documentation 1.9+

From this screen you can post new messages (if you have the permission), edit or remove messages
(again if you have the permission) and quote a message if you want. The form to post a message for
a topic is almost indentical to the form used to post a new topic.

The toolbar can be used to sort messages by date, score or title, limit the minimum score for a
message to be displayed (threshold) or find messages containing some word.

4.6.1.3. Setting Global forum permissions

From the admin groups screen you can set up the global permissions for the forums:

Back to TOC 287

 4.6.1.4. Setting Individual permissions for a forum

From the admin forums screen you can click on the perms link to set up individual permissions for a
forum.

Setting individual permissions can be used to have private forums, to control who can post new
topics in some special forums, to give admin privileges to a group of user only for some forums,
etc. As usual when individual permissions are set for a forum global permissions don t apply.

4.6.1.5. Forum Rankings

The forum rankings screen can be used to display rankings for the forums.

For more information

288 Back to TOC

 Tikiwiki Documentation 1.9+

4.6.2. Forums Admin

4.6.2.1. Admin Access #1

To access administration, go to the Home Page and, on the

Menu, click "Admin (click!)".

Sections: Tiki Config Panel

You will access the Sections Tiki Config Panel (see Tiki Config ), as shown in this graphics:

Forums

Forums

From the Tiki Config Panel, click the Forums icon to display its settings panel.

From this panel you can control which forum will be used as the Home forum, if rankings will be
used or not for the forums and the default ordering for forums in the forum listing.

Back to TOC 289

 4.6.2.2. Admin Access #2

To access administration, go to this page:

http://www.yoursitename.org/tiki-admin_forums.php

4.6.2.3. Perms on forum posts and topics

- to view a post, you need tiki_p_forum_read

- to post a topic, you need tiki_p_forum_post_topic
- to post a post (answer to a topic), you need tiki_p_forum_post
- to edit a topic or a post, you need tiki_p_forum_post and to be the author
- to remove a topic or a post, you need tiki_p_admin_forum

Of course a tiki_p_admin_forum or tiki_p_admin can do whatever he wants

4.6.3. Forums Details

This page needs review
Database Tables

MySQL
tiki_forums

290 Back to TOC

 Tikiwiki Documentation 1.9+

tiki_forums_queue
tiki_forums_reported
tiki_forum_attachments
tiki_forum_reads
PHP Modules

/tiki-admin_forums.php
./tiki-forum_rss.php
./tiki-download_forum_attachment.php
./tiki-forum_queue.php
./tiki-forums_rss.php
./modules/mod-forums_most_read_topics.php
./modules/mod-forums_last_topics.php
./modules/mod-forums_last_posts.php
./modules/mod-forums_best_voted_topics.php
./modules/mod-forums_most_visited_forums.php
./modules/mod-forums_most_commented_forums.php
./modules/mod-top_forum_posters.php
./tiki-forums_reported.php
./tiki-view_forum.php
./tiki-view_forum_thread.php
./tiki-forum_rankings.php
./tiki-admin_include_forums.php
./tiki-forums.php

Templates
./templates/mail/forum_post_notification.tpl
./templates/tiki-admin_forums.tpl
./templates/tiki-forum_queue.tpl
./templates/modules/mod-forums_most_read_topics.tpl
./templates/modules/mod-forums_last_topics.tpl
./templates/modules/mod-forums_last_posts.tpl
./templates/modules/mod-forums_best_voted_topics.tpl
./templates/modules/mod-forums_most_visited_forums.tpl
./templates/modules/mod-forums_most_commented_forums.tpl
./templates/modules/mod-top_forum_posters.tpl
./templates/tiki-forums_reported.tpl
./templates/styles/simple/modules/mod-forums_last_posts.tpl
./templates/tiki-admin-include-forums.tpl
./templates/tiki-view_forum.tpl
./templates/tiki-view_forum_thread.tpl
./templates/tiki-forums.tpl

4.6.3.1. Forum and List Synchronization

This page describes how to set up a Tiki forum such that all mails from the forum go to a mailing
list, and all mails from that mailing list (assuming people respect the Reply-To header) go back to

Back to TOC 291

the forum. It preserves e-mail threading, even on posts to the forums!

Basic Setup
The portion of the forum administration page we are using looks like this:

Option Description
You should set here the name of the mailing list that people will be subscribing to to see the
messages in this forum. This is the forum-to-email part of the gateway. In this example, we
"Forward messages to
are using: [email protected]
this forum..."
Tip: Please note that using "Send this forums posts to this email" will not do the right thing,
as the emails that that feature sends are not in the right format, nor sent from the right user.
"Send mails even when
the post is generated If you enable this option, you will may have some kind of loop (not desired in most cases)
by inbound mail"
"Append a reply link
If checked, mails sent to the list will include a link to post a reply in the forum also.
to outbound mails"
It should be set to whatever full address the third part ends up corresponding to. Also for the
"Originating e-mail forum-to-email part of the gateway, this is for the mailing list to have an identifier of who
address..." (the forum) is sending a message. In this example, we are using:
[email protected]
It should be set to the server, user and password of a POP3 account that is solely for
receiving mail for this forum. This is for the email-to-forum part of the gateway. You should
have this user (in the form user@domain) subscribed to the mailing list.
"Add messages from
this email to the In this example we are using:
forum" POP3 server: mail.email.com
User: [email protected] (the same as before for the "Originating email
address..."), and
Password: (the password for that email account).

Tiki checks the mail server and gets new emails each time the forum is accessed.

Mailing List Setup

The tricky part is to avoid mail loops once this has all been set up, just FYI.

292 Back to TOC

 Tikiwiki Documentation 1.9+

Here's how you are recommended to set up the mailing list.

Make the list be moderated, first of all, until you're sure that everything is working OK, and maybe
even then. That's important to control the mail. Make the reply-to for the list be the list itself.

Have the user the comes from and goes to ([email protected] in the example above)
subscribed to the list, with its posts having pre-approve status (so they don't need to be moderated).
This means that new posts to the list will go to the forums, as they end up being sent to this user.

Depending on the list engine, a user may have to select a little bit different opcions.

Using "Yahoogroups"
For yahoogroups (http://groups.yahoo.com ), it is recommended that you set:

Step 1: contact details

Yahoo Profile: your profile name in yahoo (something like [email protected]),
Email address: Select the email address that you want the messages to be set to. Here you have to
add the same email address used before: [email protected]

Step 2: Messages delivery

Select Individual messages only (don't select "Daily digest", or "Special announcements", or "Only
Web").

Step 3: Mail preferences

Select Traditional (instead of "Complete (New and Improved)"), for easier viewing in your Tiki
(all ads come below the text message).

Press Save changes when done, and that's it.

Using "Mailman"
Mailman ("The" GNU Mailing List Manager) is free software for managing electronic mail
discussion and e-newsletter lists, and is used all around the globe.
More information: http://www.gnu.org/software/mailman/

How to configure it?

That's pretty easy... :-)

Follow a similar approach as in the previous list server case, and if needed, request some help in
http://doc.tikiwiki.org/Forums ;-)

Back to TOC 293

4.7. Directory
The Directory is used to collect and display web site links categorized by topic for browsing by
users. It is similar to the DMOZ Open Directory Project and Google's Directory (see Useful Links,
below).

The user can browse through categories, making use of category and link descriptions, and navigate
to increasingly specific subcategories. A search form can also be used to locate a link in the
Directory.

Users can submit links to be added to the Directory. The submitted links can be subject to validation
by admins or designated editors before they are added.

Any number of categories can be created and each can be indicated as related to one or more other
categories. Tiki tracks the addition of new links and the number of visits to each link, as well as the
number of searches made. Users can also view "new sites" and "cool sites" (most-visited sites).

Directory information can also be displayed as modules in Tiki's side columns or wiki pages, and
new Directory links can be reported in Tiki's Calendar.

Feature Overview
TikiWiki's Directory feature enables:
• Organization of Web site links into categories
• Searches for links
• Submission by users of link suggestions for approval by admins
• Appointment of editors to moderate specific categories
• Caching of linked Web sites to avoid the problem of dead links or temporarily unavailable
servers
• Display of top-ranked sites in terms of hits
• Display of most recently added sites
• Indication of top-ranked and recently added sites in a Tiki module
• Association of Directory categories with one another and/or with one or more global Tiki
Categories

More Documentation
• Directory User How to use the Directory once it has been activated and configured.
• Directory Admin How to activate and configure the Directory, including determining its
organization and page display, and setting appropriate permissions.
• Directory Details Details on Directory internals, including information on related files,
permissions, database tables and CSS selectors.

• Directory TikiMovie: Flash movie on how to set up and use the Directory, click by click
http://www.teluguvaariki.com/sri-addons/tikiwiki_videos/Directory/

294 Back to TOC

 Tikiwiki Documentation 1.9+

Useful Links
These are other examples of and information about Web directories.
• DMOZ Open Directory Project
http://www.dmoz.org
• Google Directory
http://directory.google.com/
• Wikipedia "Directory" entry
http://en2.wikipedia.org/wiki/Directory

4.7.1. Directory User

4.7.1.1. Accessing the Directory

The Directory at a TikiWiki Web site is at the URL tiki-directory_browse.php , generally accessed
via the Directory menu item.

Browse_Directory

Menu

4.7.1.2. Browsing the Directory

At the top of the Directory page is a navigation bar that offers options for using the Directory. The
navbar contains these links:
• new sites - These are recently added links, in descending order.
• cool sites - If this option is activated by the admin, these are links that have received the
most visits, in descending order.

Back to TOC 295

 • add a site - This will be displayed if the user has the permission to submit sites for the
Directory.

Click a navbar link to browse categories of links, see new sites or cool sites or add a site (submit a
suggestion for a new site).

Navbar_links

Category
Below the navbar is the name of the current category. The Tiki Directory is organized into a
hierarchy of link categories, each of which may have categories within it. The uppermost category,
displayed just below the navigation bar, is the Top category.

Subcategories
The categories under Top are indicated below it. Appearing along with each category name can be
a category description, names of the most-visited subcategories, or names of random subcategories.
(The term "subcategory" is used simply to indicate a category below (within) another category.)
The number of web site links in the category may be shown in parentheses. A category may contain
either links itself or subcategories that contain links, or both. The information accompanying each
category name on the Browse Directory page is determined by the admin.

Categories

As the user navigates down through the categories, the current category is displayed beneath the
navigation bar at the end of a "breadcrumbs" path of categories down from Top. For example:
• Top >> Tiki CMS - The category names are links to the respective parent categories.

The search form — Find: — can also be used to search for sites throughout the Directory or only in
the current category. Site names, descriptions, and URLs are included in searches.

296 Back to TOC

 Tikiwiki Documentation 1.9+

The screenshot below shows the Directory browser in the category TikiCMS category, under the
Top category. Note the path of live category links at the top and the list of links in the TikiCMS
category.

Links
The links section of a Directory-browsing page includes a drop-down list and the links themselves.
The drop-down list can be used to sort the links list in ascending (A to Z) or descending (Z to A)
order and by:
• hits - Number of times the linked page has been visited
• name - The site link name
• creation date - When the link was added to the directory
• last updated - When the link information was last updated

The information for each link includes:

• Nation - The national flag may reflect the language of the site or site content, etc., as
determined by the admin.
• Web site name
• Site description - The description as entered by the admin.
• Category or categories - The site may be in one or more categories; in the case of a
subcategory, the full category path is indicated.
• Date added to the Directory
• Date last updated

Click on a site's name to access the page. If the site is down or there is some other error, try the
cache link. Tiki saves, or caches, a copy of each linked page in its Directory. This enables viewing
a page even if the original is not available. In addition to providing its own cache, Tiki also links to
the Google cache (see http://www.google.com/help/features.html#cached ) for each page.

Beneath the list of site links is a list of categories related to the current category, if any, as
determined by the site admin or other link submitter.

Categories_and_links

Statistics
Finally, statistics about the Directory, its content and activity, are displayed:
• Total categories
• Total links
• Links to validate (i.e., links that have been suggested, but not yet approved, or that have
been made inactive for some reason)
• Searches performed
• Total links visited

Back to TOC 297

 Statistics

4.7.1.3. New Sites - Cool Sites

The new sites and cool sites links open a Directory Ranking page and display rankings of the
latest sites added to the directory and the directory's most-accessed sites.

These rankings include, for the linked sites, this information:

• name
• url
• country
• hits
The column headings are links and can be clicked to re-order the listings.

Rankings

4.7.1.4. Adding a site

Consistent with the collaborative ethos underlying Tiki, users can submit site link suggestions,
depending on the permission granted by the admin. To suggest a site, click the add a site link and
use the form to enter the site information.

Enter the site's Name, Description, and URL (Web address), pick an appropriate directory category
for it, and indicate its Country — national orientation or language. You may select more than one
category by control-clicking your choices — hold down the Control key on your keyboard while
clicking (Command key on Macintosh). If you select a Country for the site, a country flag will
appear in its directory listings.

Click save to submit the link. The site link may not immediately appear if the Directory has been
configured to have new link submissions first validated by an editor or the site admin.

298 Back to TOC

 Tikiwiki Documentation 1.9+

Adding_a_site

4.7.1.5. Directory-Related Modules

A Tiki site may also have side-column or in-page modules activated to display Directory Last
Sites (sites most recently added), Directory Top Sites (most-visited sites), or Directory Stats
(numbers of sites, sites to validate, site categories, searches, and visited links).

Modules

Back to TOC 299

 4.7.1.6. Calendar Reporting of New Sites

New sites added to the Directory are also reported in Tiki's Calendar, for users who have Calendar-
viewing permission. The Calendar is accessed by clicking the date at the top of the page, or via the
menu.

Calendar_and_site_additions

Tips
• When putting a link in a wiki page, if the link warrants greater exposure, consider first
adding the link to the site Directory and then using the Directory's redirect link in the wiki
page. That way, the Directory provides another means for users to know about the site, and
the Directory also keeps track of the number of hits the link receives.

More Documentation
• Directory - Overview of the Directory.
• Directory Admin - How to activate and configure the Directory, including determining its
organization and page display, and setting appropriate permissions.
• Directory Details - Details on Directory internals, including information on related files,
permissions, database tables and CSS selectors.

4.7.2. Directory Admin

4.7.2.1. Activating the Directory feature

The Directory feature is activated on the Admin > Features page (tiki-
admin.php?page=features).

300 Back to TOC

 Tikiwiki Documentation 1.9+

To enable the Directory, check (tick) the box for Directory and click Change preferences.

4.7.2.2. Directory Configuration

The overall Directory configuration is set on the Admin > Directory page (tiki-
admin.php?page=directory). These are the settings to specify:
• Number of columns per page when listing categories - The options are from 1 to 6. The
Directory categories can be displayed in one long list, or in up to six columns displaying
side-by-side.
• Links per page - Any number can be specified. After Tiki displays the specified number of
links on the first page, it will direct the user to additional pages of links.
• Validate URLs - This is enabled to require links submitted by users to be validated
(approved) by an admin or editor prior to being added to the Directory. If submitted links are
to be immediately entered in the Directory without first being validated by an admin or
editor, this should be left unchecked.

Back to TOC 301

Like other Tiki permissions, the authority to validate Directory links is given on a group basis. To
enable others to validate links, the appropriate permission — tiki_p_validate_links — must be given
to a Tiki user group on the Admin > Groups page (tiki-admingroups.php) (see Permission). This
group is then indicated when the Category is added or edited.
• Enable cool sites - This puts the cool sites link on the Directory navbar and activates the
"Directory ranking" page, which lists the most-visited sites in the Directory in descending
order.
• Method to open directory links - The options are:
• replace current window - to close the Tiki window and open the linked site in its
place
• open new window - to put the Directory page in the background, but keeping it open
• inline frame - to display the linked web page in Tiki's center column

4.7.2.3. Directory Administration

To open the Directory Administration page (tiki-directory_admin.php), go to the Application

Menu and select Admin directory from the Directory menu items. (See screenshot below.)

The top navigation bar of the Directory Admin page contains these links:
• browse - Browse the Directory.
• admin - Admin the entire Directory.
• categories - Admin Directory categories.
• related - Admin Directory category relationships.
• sites - Add, delete or edit sites.
• validate - Validate links submitted by users.
The admin links in the navbar (which is displayed on all Directory pages) are repeated in the admin
menu at the bottom of this page, perhaps with a settings link to the Tiki Admin > Directory page
(tiki-admin.php?page=directory), depending on the viewer's permissions.

302 Back to TOC

 Tikiwiki Documentation 1.9+

Tiki maintains several Directory statistics:

• There are _ valid sites - The number of valid (approved) site links. These are the links that
are active in the Directory. ("Valid" doesn't necessarily mean that a link works without
errors, but just that it has been accepted for use in the Directory.)
• There are _ invalid sites - The number of links that have not been validated (approved) by
an admin or editor.
• There are _ categories - The number of categories. These are specific to the directory and
are not the same as Tiki Categories (see Category), though they can be "Categorized" and
thus come under one or more global Tiki Categories. This stat contains a link to the Admin
directory categories page.
• Users have visited _ sites from the directory - The number of clicks by users on Directory
links to other Web sites.
• Users have searched _ times from the directory - The number of searches made in the
Directory

4.7.2.4. Category management

Clicking on categories opens the Admin directory categories page, which displays the Parent
category (a drop-down list), a form to add a new category, and a list of subcategories under the
current parent category.

Note that categories are arranged as parents and children. Above all the child categories is the Top
category. You can create subcategories under the Top category or any other category by first
selecting the category as the Parent category, using the drop-down menu. Then, complete and
submit the Add a directory category form to make a new child category under this parent.

The options are:

• Name - Category name

Back to TOC 303

 • Description - Category description
• Children Type- When browsing the category tree a line of text will be displayed below the
category name. You can choose what goes in this line: the most-visited subcategories, the
category description, or random subcategories.
• Maximum number of children to show - Once you decided what will be displayed below
the category you can set up how many items will be displayed. You can choose none to
eliminate the line below the category name. Note that if you decide to show the category
description this option has no effect.
• Allow sites in this category - Whether sites can be added to this category or not. You might
prohibit sites in a category if you only want to use it to contain other subcategories.
• Show number of sites in this category - If enabled the number of sites in the category will
be displayed next to the category name.
• Editor group - You can indicate a Tiki group that will have admin permission for this
category. These editors will be able to validate sites.
• categorize - In addition to the categories of the directory, Tiki also uses global categories
that apply to all objects within it. This option allows you to put your directory category
within a Tiki category. To do so, first click show categories to see which Tiki categories are
available (as has already been done in this screen shot). Select the appropriate categories and
check categorize this object. See Category for more information on Tiki categories.

At the bottom of the Admin directory categories page is a list of directory subcategories for the
parent category indicated by the drop-down menu at the top of the page.

304 Back to TOC

 Tikiwiki Documentation 1.9+

Its columns indicate how a sub-category was configured with the Add a directory category form:
• name -In this example, four names are shown.
• cType -Children type (d = description in this example).
• view -Maximum number of children to show.
• allow - Allow sites in this category.
• count - Show number of sites in this category (number of sites in parenthesis).
• editor - Editor group. In this example, a group named editor has been used.
• action - Buttons to relate, edit, and delete categories, respectively.

4.7.2.5. Related categories

In addition to a category being able to contain other categories, it can also be directly related to
another. This is useful when, for example, there is some logical connection between categories and
a person browsing one category would benefit from seeing the other. The related category link
functions as a "See also..." reference.

Clicking on related displays the Admin related categories page.

To create a relationship between two categories:

1. Select a Parent category from the drop-down list. In this instance, "Parent category" is
rather a misnomer here; it simply means the category for which a relationship is to be
assigned.
2. Select the to-be-related category from the Add a related category drop-down list.
3. Check mutual if the relationship is to be indicated from both categories (A=>B, B=>A) or
leave it unchecked for an unrequited bond.
4. Click the save button to create the relationship.

Back to TOC 305

Under Related categories, you will see a drop-down list of the categories that are related to the
selected "parent category". Relationships can be updated or removed here.

4.7.2.6. Admin sites

Click on sites to display the Admin sites page.

The Parent category drop-down menu includes all categories in the Directory that can contain sites
directly. (A category for which "contain sites" was not checked will not appear in this list.)
Selecting "all" displays all sites, in the table below; selecting one of the categories displays the sites
in that category.

306 Back to TOC

 Tikiwiki Documentation 1.9+

To add a site, enter the appropriate information for the site in the Add or edit a site form. To edit a
site, click its edit icon. Note that a site can be added to more than one category by control-clicking
each desired category. (The Parent category selection at the top of the page determines what appears
in the Sites section of the screen. This selection has no effect on the information input when adding
a new site.)

4.7.2.7. Site Validation

Clicking on validate will display the Validate sites page, where user-suggested sites are
"validated" (approved for inclusion in the Directory — "valid" here doesn't refer to the actual
validity of the linked URL).

To validate one or several sites, check the appropriate box(es) and click the validate button. A
similar technique will do mass "invalidations" (removals from the Directory). Click the edit icon
to edit a site or the delete icon to remove one.

Back to TOC 307

 • Directory TikiMovie: Flash movie of how to use the Directory, click by click
http://www.teluguvaariki.com/sri-addons/tikiwiki_videos/Directory/

4.7.3. Directory Details

4.7.3.1. Modules

Module Name Module Title (English) Description

directory_last_sites Last Sites sites most recently added
directory_top_sites Top Sites most-visited sites
numbers of sites, sites to validate, site categories, searches, and
directory_stats Directory Stats
visited links
since_last_visit Since your last visit New sites are included along with other Tiki additions
Shows changes in various features since last login, showuser
since_last_visit_new Since your last visit
,showtracker

4.7.3.2. Permissions

Permission Name Description Default Level

tiki_p_admin_directory Can admin the directory editors
tiki_p_admin_directory_cats Can admin directory categories editors
tiki_p_admin_directory_sites Can admin directory sites editors
tiki_p_autosubmit_link Submited links are valid editors
tiki_p_submit_link Can submit sites to the directory basic
tiki_p_validate_links Can validate submitted links editors
tiki_p_view_directory Can use the directory basic

4.7.3.3. Preferences

Preference Item (en) Pref name in tiki_preferences table Default value

Number of columns per page when listing categories directory_columns 3

308 Back to TOC

 Tikiwiki Documentation 1.9+

Links per page directory_links_per_page 20

Method to open directory links directory_open_links n
Validate URLs directory_validate_urls n
Enable cool sites directory_cool_sites y
Feature - Directory feature_directory n

4.7.3.4. Database Tables

Table Name Columns Description

categId
parent
name
description
childrenType
Directory category information as set by configuration, and
tiki_directory_categories sites
accumulated
viewableChildren
allowSites
showCount
editorGroup
hits
term
tiki_directory_search Search terms used and number of hits
hits
siteId
name
description
url
country
Directory link information as submitted in new site addition, and
tiki_directory_sites hits
accumulated
isValid
created
lastModif
cache
cache_timestamp
categId
tiki_category_sites Category to directory link information
siteId
Directory-related information is also stored in tiki_preferences and tiki_permissions (see above),
tiki_live_support_modules, tiki_menu_options and users_permissions tables.

4.7.3.5. Files Used

File Name Location Description/Purpose

tiki-admin_include_directory.php / Admin Directory page (tiki-admin.php?page=directory)
tiki-directories_rss.php / Displays Directory RSS Feed
tiki-directory_add_site.php / Site submit form
Specifically for adding a TIki site (but how is this
tiki-directory_add_tiki_site.php /
accessed/used?)

Back to TOC 309

 File Name Location Description/Purpose
tiki-directory_admin.php / Directory Administration page
tiki-
/ Admin directory categories page
directory_admin_categories.php
tiki-directory_admin_related.php / Admin related categories page
tiki-directory_admin_sites.php / Admin sites page
tiki-directory_browse.php / Browse Directory page
tiki-directory_ranking.php / Directory ranking page
tiki-directory_redirect.php / Redirects link request to external site
tiki-directory_rss.php / Displays specific Directory RSS feed
tiki-directory_search.php / Displays search results
tiki-directory_validate_sites.php / Validate sites (by admin or editor)
mod-directory_last_sites.php /modules Displays sites most recently added, in module
mod-directory_stats.php /modules Displays Directory stats in a module
mod-directory_top_sites.php /modules Displays most-visited sites in a module
mod-since_last_visit.php /modules Displays Tiki site additions since user's last visit
mod-since_last_visit_new.php /modules Displays Tiki site additions since user's last visit
tiki-admin-include-directory.tpl /templates (tiki-admin.php?page=directory) Directory config
tiki-directory_add_site.tpl /templates Layout for Admin sites page
tiki-directory_admin.tpl /templates Layout for Admin sites page
tiki-directory_admin_bar.tpl /templates Layout for Admin navbar
tiki-directory_admin_categories.tpl /templates Layout for Admin sites page
tiki-directory_admin_related.tpl /templates Layout for Admin sites page
tiki-directory_admin_sites.tpl /templates Layout for Admin sites page
tiki-directory_bar.tpl /templates Layout for navbar
tiki-directory_browse.tpl /templates Layout for Browse Directory page
tiki-directory_footer.tpl /templates Layout for page-bottom stats
tiki-directory_ranking.tpl /templates Layout for Directory ranking page
tiki-directory_search.tpl /templates Layout for Search Results page
tiki-directory_validate_sites.tpl /templates Layout for Admin sites page
mod-directory_last_sites.tpl /templates/modules Layout for Last sites module
mod-directory_stats.tpl /templates/modules Layout for Directory stats module
mod-directory_top_sites.tpl /templates/modules Layout for Top Sites module
mod-since_last_visit.tpl /templates/modules Layout for Since your last visit module
mod-since_last_visit2.tpl /templates/modules Layout for Since your last visit2 module
tiki-calendar.php / Calendar also can display Directory link additions.
tiki-calendar.tpl /templates Layout for Tiki Calendar
In general, the .php files supply the logic, the .tpl files the layout.

310 Back to TOC

 Tikiwiki Documentation 1.9+

4.7.3.6. CSS Selectors

Applies to/
Selector Template file Page file
description
tiki-directory_browse.tpl
tiki-directory_ranking.tpl
tiki-directory_search.tpl
(The page the selector is used on is
tiki-directory_validate_sites.tpl
a php file with same name as the
a.pagetitle page title tiki-directory_add_site.tpl
respective template except as
tiki-directory_admin.tpl
indicated below.)
tiki-
directory_admin_categories.tpl
tiki-directory_admin_related.tpl
div#pageheader breadcrumbs tiki-directory_browse.tpl
category path links
a.dirlink related-category path tiki-directory_browse.tpl
links
table containing
div.dircategs tiki-directory_browse.tpl
subcategories
tiki-directory_browse.tpl
a.dirsublink subcategory links
tiki-directory_search.tpl
tiki-directory_browse.tpl
div.dirlistsites list of site links
tiki-directory_search.tpl
individual site tiki-directory_browse.tpl
div.dirsite
information tiki-directory_search.tpl
a.dirsitelink link tiki-directory_browse.tpl
tiki-directory_browse.tpl
span.dirsitedesc site description
tiki-directory_search.tpl
tiki-directory_browse.tpl
span.dirsitecats site category
tiki-directory_search.tpl
Added, updated, hits, tiki-directory_browse.tpl
span.dirsitetrail
etc. info tiki-directory_search.tpl
tiki-directory_browse.tpl
tiki-directory_search.tpl
tiki-directory_ranking.tpl
Page number, prev,
div.mini tiki-directory_validate_sites.tpl
next links
tiki-
directory_admin_categories.tpl
tiki-directory_admin_related.tpl
tiki-directory_browse.tpl
tiki-directory_search.tpl
tiki-directory_ranking.tpl
Page number, prev,
a.prevnext tiki-directory_validate_sites.tpl
next page links
tiki-
directory_admin_categories.tpl
tiki-directory_admin_related.tpl
Related categories
div.dirrelated tiki-directory_browse.tpl
info
div#page-bar navigation bar tiki-directory_bar.tpl tiki-directory_browse.php
tiki-directory_search.php

Back to TOC 311

 Applies to/
Selector Template file Page file
description
tiki-directory_ranking.php
tiki-directory_add_site.php

tiki-directory_admin.php
tiki-directory_admin_categories.php
tiki-directory_admin_bar.tpl
tiki-directory_admin_related.php
tiki-directory_admin_sites.php
tiki-directory_validate_sites.php
tiki-directory_browse.php
tiki-directory_search.php
tiki-directory_ranking.php
tiki-directory_bar.tpl
tiki-directory_add_site.php

div.button2 navbar item tiki-directory_admin.php

tiki-directory_admin_categories.php
tiki-directory_admin_bar.tpl
tiki-directory_admin_related.php
tiki-directory_admin_sites.php
tiki-directory_validate_sites.php
tiki-directory_browse.php
tiki-directory_search.php
tiki-directory_ranking.php
tiki-directory_bar.tpl
tiki-directory_add_site.php

a.linkbut navbar link tiki-directory_admin.php

tiki-directory_admin_categories.php
tiki-directory_admin_bar.tpl
tiki-directory_admin_related.php
tiki-directory_admin_sites.php
tiki-directory_validate_sites.php
div.dirfooter page-bottom statistics tiki-directory_footer.tpl tiki-directory_browse.php
td.dirfooter individual stat items tiki-directory_footer.tpl tiki-directory_browse.php
tiki-directory_ranking.tpl
tiki-directory_validate_sites.tpl
contains the site tiki-directory_add_site.tpl
table.normal
listings tiki-
tiki-register_site.php
directory_admin_categories.tpl
tiki-directory_admin_related.tpl
tiki-directory_ranking.tpl
tiki-directory_validate_sites.tpl
td.heading column heading cell
tiki-
directory_admin_categories.tpl
link tiki-directory_ranking.tpl
tiki-directory_validate_sites.tpl
a.tableheading column heading tiki-
directory_admin_categories.tpl
tiki-directory_admin_related.tpl
td.even, td.odd alternating link rows tiki-directory_ranking.tpl
tiki-directory_validate_sites.tpl
tiki-

312 Back to TOC

 Tikiwiki Documentation 1.9+

Applies to/
Selector Template file Page file
description
directory_admin_categories.tpl
tiki-directory_ranking.tpl
links to sites
tiki-directory_validate_sites.tpl
a.link tiki-directory_admin.tpl
tiki-
link to categories
directory_admin_categories.tpl
tiki-directory_validate_sites.tpl
tiki-directory_admin.tpl
a.tikihelp help link tiki-
directory_admin_categories.tpl
tiki-directory_admin_related.tpl
tiki-directory_add_site.tpl
tiki-
td.formcolor form table cells tiki-register_site.php
directory_admin_categories.tpl
tiki-directory_admin_related.tpl
span.highlight message tiki-directory_add_site.tpl tiki-register_site.php
Calendar Directory
div.Caldir div.calId tiki-calendar.tpl
link
Calendar Directory
span.calprio tiki-calendar.tpl
link
Calendar Directory
a.linkmenu tiki-calendar.tpl
link

4.7.3.7. Others

Name Specification Description

Tiki section feature_directory Used in menu item description

More Documentation
• Directory - Overview of the Directory feature.
• Directory User - How to use the Directory once it has been activated and configured.
• Directory Admin - How to activate and configure the Directory, including determining its
organization and page display, and setting appropriate permissions.

Back to TOC 313

4.8. FAQs
Feature Overview

Frequently Asked Questions (FAQs) date back to the earliest days of the internet, when usenet
operators attempted to gather the answer to frequently asked questions in single place to cut down
on traffic in the newsgroups. Tiki's FAQ feature allows you to group the questions by type and
associate a FAQ with a Tiki Category. The FAQ administrator can also allow users to suggest
questions that should be included in the FAQ. Items added in the FAQs are fully searchable by
users (with tiki_p_view_faqs permission ).

4.8.1. FAQs User

Users with tiki_p_view_faqs permission can view the FAQs.
1. To view the available FAQs, select FAQs > List FAQs from the main menu. The FAQs
page (tiki-list_faqs.php) appears. The Available FAQs section shows a list of the FAQs to
choose from.

Available FAQs area of the FAQs page.

Field Description
Title Name of the FAQ section. Click the title to display the individual FAQs in each section.
Description Description of each FAQ section.
Visits Number of views (hits) to each FAQ section.
Questions Number individual FAQs (and suggested questions) in each section

2. Click an FAQ section to display its individual FAQs on the tiki-view_faq.php page:

314 Back to TOC

 Tikiwiki Documentation 1.9+

List of FAQ Questions.

4.8.1.1. Creating new FAQ sections

FAQs are grouped into sections. Each specific FAQ must belong to at least one section. Users with
tiki_p_admin_faqs permissions can create new FAQ sections:
1. From the main menu, select FAQs > Admin FAQs. The FAQs page (tiki-list_faqs.php)
appears.
2. Complete the fields in the Create New FAQ form to create a new FAQ section:
Field Description
Title Name of the FAQ section.
Description Description of the FAQ section.
Categorize Click Show categories to select a category for this FAQ section.
Users can suggest Specify if users with tiki_p_view_faqs permission can suggestion new FAQs for this
questions section. This is useful to allow users to provide feedback to your site's FAQs.

3. Click Save. Tiki adds the FAQ section to the list of FAQs.

4.8.2. FAQs Admin

Back to TOC 315

 Admin Access
To access administration, go to Home Page and, on the (Main) Menu, click on "Admin (click!)".

Sections: Tiki Config Panel

You will access the Sections Tiki Config Panel (see Tiki Config ), as shown in this graphics:

4.8.2.1. FAQs settings

FAQs

From the Tiki Config Panel, click the FAQs icon to display its settings panel, the top of which
appears like so:

316 Back to TOC

 Tikiwiki Documentation 1.9+

Will comments about your questions/answers be allowed? If so, they'll appear at the
Comments:
bottom of the page.
Default number of
How many comments should display on the page? Users may override this number.
comments per page:
Should comments be ordered by the date they were made or by points. Comments earn
Comments default
points when users read them and vote on their usefulness. Users may override this
ordering
ordering.

4.8.3. FAQ Details

There are a couple of modules related to FAQ's:
• Module top_visited_faqs
• Module last_created_faqs

Back to TOC 317

4.9. Quizzes
Content Below This Line is Under Construction. Please use the links above.
The Quizzes feature allows you to build sets of questions for contests, e-learning, or just plain fun.
Quizzes have several available controls:
• Points per question
• Points per answer
• Passing Grade
• Time Limits
• Repeat the Quiz
• Randomize Order of Questions
• Randomize Order of Answers
• Results Storage and Analysis

4.9.1. Quizzes User

If you have permissions to take and view quizzes, you will see an menu item for them.

Clicking on the "List Quizzes" menu will take you to a list of quizzes that you have permission to
take or to view.

To take the quiz, click on the quiz name. To view the stats for the quiz, click on the stats link next
to the quiz name. The list is sortable by clicking on the headings at the top of the list.

This is a view of our sample quiz, "Presidential Knowledge". Since this quiz has a 20 minute time
limit, you will see the limit displayed above the first question. Questions are answered by clicking
on the radio buttons

318 Back to TOC

 Tikiwiki Documentation 1.9+

When you have completed all the questions, you submit them with the send answers button at the
bottom of the page. Be sure you have answered all the questions. Unanswered questions will not
stop the your quiz from being submitted, but no points will be counted for them.

Now it's time to check your results. From the Quizzes menu, click on "Quiz Stats"
This is a list of quiz results that you have permission to view. Click on the quiz name to see the
results.

Unfortunately, user "quiztaker" did not not pass their quiz. By clicking on their name in the quiz
statistics display, they are shown their individual results.

Back to TOC 319

From here, the user can click on links above the results to navigate back to the quizzes page, or
click on the menu to continue to other parts of the tiki.

4.9.2. Quizzes Admin

Quizzes

4.9.2.1. Create/edit quizzes

Content below this line is in progress

Enabling Quizzes
Select Admin------->Features, and then click the checkbox next to the Quizzes option

320 Back to TOC

 Tikiwiki Documentation 1.9+

Creating Quizzes
Click on the Quiz Admin option of the Quizzes menu, The Create/Edit Quizzes page will be
displayed:

Setting Quiz Options

Let's walk through all of the options on the admin form above:
Option Explanation
Name Name of the Quiz. This name will be used to track the quiz and it's results
Description This is where you can describe the questions and/or the testing goals of the quiz.
Categorize Allows you set associate the Quiz with a set of content using Tiki's Category system
Publish Date The first date will be available to users (users must have correct permissions, see below
Expiration Date The date the quiz is no longer available to users. Default value is 1 year from publish date
User is allowed to take the quiz more than once. If this is not enabled, the user will get an error
Quiz can be message when they attempt to take the quiz a second time. Please note that there is no way to
repeated prevent anonymous users from taking a quiz more than once. If you absolutely need to enforce the
one-time rule, limit quiz permissions to registered users.
f you check this option then the results of the Quiz will be stored each time a user takes the quiz and
Store Quiz you will be able to see the answers of each particular quiz instance. If you don't check this option
Results only general stats about the quiz will be stored (percentage of times for each option in each
question, average score for the Quiz, score for each Quiz result etc)
Immediate Not implemented yet

Back to TOC 321

 Option Explanation
Feedback
Show Correct
Not implemented yet
Answers
Shuffle
Not implemented yet
Questions
Shuffle Answers Not implemented yet
If this option is checked, then you can specify a time limit for the quiz in the Maximum TIme
Quiz is Time
dropdown box immediately below this option. The time limit is effective for users who are only
Limited
allowed to take the quiz once. The limit is not enforced when the quiz can be taken multiple times.
The maximum time in minutes that a user can work on the quiz. At the end of this time limit, the
Maximum TIme
current answers are automatically submitted.
This is calculated by counting the percentage of points scored out of the maximum points available.
Passing
Each question can be assigned a different point total (see Creating Questions below), so it's
Percentage
possible to make questions more important to the final score.

Creating Quiz Questions in the Web Interface

To create questions one at a time from the web interface, go to the Quiz Admin page and click on
"questions" for the quiz you wish to build. You'll open the Edit Quiz Question page:

Uploading Quiz Questions

4.9.2.2. Viewing Results

4.9.2.3. Editing Quizzes

322 Back to TOC

 Tikiwiki Documentation 1.9+

4.9.3. Quiz Details

Back to TOC 323

4.10. Trackers

What are Trackers?

Using Trackers, you can create forms? for collecting data and make reports? from that data.
Trackers can combine structured information collected from users the feature is a powerful, flexible
tool. Originally, trackers were used to collect and manage bugs? in tikiwiki. They evolved into an
open ended system where you can track any kind fo user input in a customizable form. Each tracker
has its own mini database. Users with the appropriate permissions can devise trackers to collect any
kind of information that you want.

Related pages
Creating a Tracker, Adding fields to a tracker,
related plugins:PluginTracker, PluginTrackerList, PluginTrackerFilter, PluginTrackerItemField,
PluginTrackerStat, PluginVote

Four Steps to make a Tracker

Step Details Help Page
Admin names the tracker, and assign overall parameters and
1. Create the Tracker Creating a Tracker
permissions
2. Add fields to the
Admin defines the columns and type of information collected Adding fields to a tracker
Tracker
3. Add items to the
Users fill out the forms to create items in the tracker Adding items to a tracker
tracker
4. View or List the results Use plugins to view a customized tracker output in a page Viewing Tracker Results
5.Assign Trackers to Assigning Trackers to
optional - trackers can also be used upon registration.
Groups groups

What can Trackers be used for?

Trackers can recreate online any kind of table or spreadsheet, not including the fancy formatting or
calculations.
• support tickets
• contact managers
• feature requests
• purchase orders
• bug reports
• feedback reports
• news submissions
• project management

324 Back to TOC

 Tikiwiki Documentation 1.9+

Trackers can:
• be used to collect additional data from users upon registration?.
• be used like a customizable articles feature with admin definable forms
• assist workflows by tracking tasks.
• act as expanded polls?, surveys? or quizzes
• import and export their settings and data.

Trackers can't:
• do calculations (like a spreadsheet program)
• handle large (1000's) of items. see Tracker Performance?

Next Page . . .
• Creating a Tracker
• Adding Fields to a Tracker
• Adding Items to a Tracker

Example: Department Staff

Demos of Trackers used for production

Visit http://tikiwiki.org/Trackers to see a list of some Tiki sites (as examples) using them at
production level.

4.10.1. Trackers User

When Trackers are enabled and you have the right permissions, a Trackers menu is visible, and can
be clicked open. From here you will be able to create and administer your Trackers data collections.

Creating a Tracker

Back to TOC 325

 From the Admin Menu
Collapsed and Expanded Menu:

There are usually two options in the menu — List Trackers and Admin Trackers — and the options
may change depending on your permissions. In this section, let's examine each option in detail.

Prior to Tracker Creation

Prior to creating a Tracker, clicking on the Trackers menu displays an empty center panel, as shown
here:

4.10.1.1. Creating a New Tracker

see: Creating a Tracker

Once Tiki creates the Tracker, it will be listed like so in both Admin Trackers and List Trackers:

Actions
If you hover your mouse above each of the Actions icons, you can infer that they link to tools
including:
• Edit: edit the Tracker information using the same form you used to create the Tracker. Here,
you can change Tracker information, its categories, or how to handle comments.
• Fields: edit the Tracker's collection of fields.
• Perms: configure permissions for the Tracker (if you are an admin).
• Remove: remove the entire Tracker and its data. Use this with care, as it is a permanent
operation.

326 Back to TOC

 Tikiwiki Documentation 1.9+

4.10.1.2. Adding Fields to a Tracker

To make a Tracker useful and usable, you add some fields to it to capture the data you want to
collect. You can administer fields by going to the the Trackers list, and clicking the Fields Action.

To add a field, click the Fields action from the Trackers list, then fill in the form that appears
indicating the field name, field type, and any applicable options. You can use the following field
types:
• Text input
• Textarea input
• Drop down combo (enter options separated by commas)
• Checkbox ("boolean" on/off yes/no true/false fields)
• Date/time field
• User (selectable user from the list of site's users)
• Group (selectable group from the list of site's groups)

At least one of the fields in your Tracker must be the "main" field, which links to the item's details
from the Tracker listing. This attribute is controlled by the "Column links to edit/view item?"
checkbox. You can also indicate if the field is visible or not in the Tracker item list using the "Is
column visible when listing tracker items?" checkbox. If a Tracker has a lot of fields you may want
to use this checkbox to remove some of them from the item listing, for easier viewing.

Some Tracker field types have options you can set. For example, the drop-down field's items are
entered separated by commas. In this graphic, you can see this Tracker will track movie reviewers'
ratings using a drop-down field, with five "star" rating entries: *,**,***,****,*****. It is easy to
think of various creative uses for this powerful tool - problem severity or impact levels, task

Back to TOC 327

priority, status, or a client's credit rating.

Once you have entered several fields, defining their type, options and visibility, you will see a list
similar to this one:

Note in this graphic the "is main" column. A "y" or yes, means you have checked the "Column links
to edit/view item?" checkbox. The list also indicates whether a field will be visible in the item
listing, and allows you to edit or remove fields accordingly using this list's Actions.

Hint: One default field in any tracker is the "Status" field, which tracks whether an item is open or
closed. This field is not visible in the Fields listing.

4.10.1.3. Using Trackers

You can view a list of your Trackers by clicking Trackers from the menu. The center panel will
change as such:

Clicking on a Tracker's name (here, Movie Reviews) will take you to a screen in which you can

328 Back to TOC

 Tikiwiki Documentation 1.9+

add, modify, delete, filter and sort items, and, toggle email monitoring on changes to the Tracker.

4.10.1.4. Adding a Tracker Item

To add an item into your Tracker, enter the information into the fields on the form at the top of the
screen, and click Save when you are finished:

After saving, our movie review Tracker now has one review - for the movie Mystic River. In the
item list part of the screen, you can see all the visible columns contained in your Tracker, as well as
sort by create date, modification date, status, or any other available field.

4.10.1.5. Item Details

If you have the right permissions, you can click an item's title to bring up a "details screen" for the
item, to modify it, or add attachments or comments.

Hint: If its title is not "clickable" then you can go to the admin screen and make some field the
"main" field by checking the "Column links to edit/view item?" checkbox.

Click the title to display the item details:

Back to TOC 329

If attachments or comments are enabled, you can add them to your Tracker's items.

4.10.1.6. Assigning Items to Specific Tiki Users or Groups

If you set up your Tracker with fields of type "user selector" or "group selector," you will be able to
easily select from a drop-down list the users or groups registered on your Tiki site. First, we must
change the Reviewer field in our Movie Review Tracker to be of type "user selector".

330 Back to TOC

 Tikiwiki Documentation 1.9+

Once that is done, we can choose from the users on the site while editing the item.

Tracker Items are always added with their built-in status field set to "open." Items with "open"
status, which have been assigned to either your user account or your group, will be displayed in
your My Tiki screen.

Back to TOC 331

 4.10.1.7. Monitoring Tracker Items

In the details screen, users can choose to monitor a Tracker, so that an email is sent by Tiki to the
user, whenever the item is modified. Click the "Monitor" button to toggle monitoring off and on.

4.10.1.8. Setting Tracker Permissions

Permissions can be set to control access to Trackers. Note that you can set permissions globally or
on a per-Tracker level. Assign permissions by clicking the "perms" link from the Tracker listing in
the Tracker admin screen.

More documentation

Related Information
• To enable Trackers for your site, see General Admin.
• For more information on My Tiki functionality, see MyTiki.
• To specify permissions for Tracker users, see Permission for the general procedure.
• To administer Trackers, see Tracker Admin.
• For technical details, see Tracker Details.

332 Back to TOC

 Tikiwiki Documentation 1.9+

Useful Links

4.10.1.9. Editing Tracker Fields

After you have created a tracker you can:

• Enable or disable the Trackers feature.
• Set display of Trackers fields, such as status or create and modify dates.
• Enable and disable comments.
• Sort by name, dates or number of items.
• Categorize your Trackers.

4.10.1.10. Entering Tracker Items

Back to TOC 333

 Related Links:
• To enable Trackers for your Tiki site, see General Admin.
• To read the user manual for Trackers, see Trackers User?.
• To learn about administering Trackers, see Tracker Admin and Trackers User?.

4.10.1.11. Other information

Terminology
(Sorry, this section is woefully incomplete)
Tracker
A colletion of "forms". Administrators setup a fill-in-form to capture whatever information
they want (typical uses include support calls, bug reports, movie reviews etc). As these forms
are filled in and saved, the tracker provides lists of them and of course a means to view each
one.

334 Back to TOC

 Tikiwiki Documentation 1.9+

Tracker Item
A form submitted by an end user resulting in an entry within a tracker. Tracker Items are
typically support calls, bug reports, movie reviews (see example!) etc.

Tracker Admin
The person who sets up the forms and displays of a tracker. Clearly this person decides what
application they are going to create with a tracker, be it support calls, product registration,
movie reviews or whatever. They then design a fill-in-form and a list view that meets those
requirements.

End user
A person who probably can't adjust the forms, but fills them in, creating Tracker Items.

Please click here to search tikiwiki.org for all instance of trackers.

What it is and what it isn't

The word tracker is probably a misnomer, form creator is probably better. This Tiki is running, at
the time of this writing, 1.9 pre-release (CVS). These docs are geared for the 1.9 trackers but may in
part be applicable to 1.8.2.

Trackers are really really cool. They are not perfect but getting better all the time. A huge issue is
being able to convert other forms into the tracker interface. Simple text conversions are now
possible with the import/export but that doesn't yet work for the tracker items. Please help us finish
that part of the trackers!

Here's some new stuff for you folks who are just discovering trackers:

tiki-list_trackers.php
All below can be sorted:
name
description
created
last modif
items

• list all of your trackers or forms.

Admin trackers
edit name perms description edit fields created last modif items delete

Back to TOC 335

 tiki-admin_trackers.php
• needs a category sort, large number of trackers renders the trackers almost unusable

tiki-admin_tracker_fields

Tips and Tricks

If you've created trackers in series then use the URL / number to navigate large tracker dbases. The
sorting by name can be frustrating, search can be unpredictable. Until there is a sort by category,
and you've a large dbase of trackers, then plan to experience navigation issues.

import/ export
Very exciting, very beta right now... take this data and import it into your tracker and report back...
[TRACKER]

trackerId = 187
name = To Kill a Mockingbird Chapter Twenty-six
description = You need to create a total of five questions for each chapter. The questions should
focus on elements like the one found in the category > literary terms. Focus on the key themes of
the story; use the web to help you in your research for good questions. Good questions are thought
provoking, insightful, and interesting.
showStatus = y
defaultStatus = o
showStatusAdminOnly = n
newItemStatus = o
modItemStatus =
writerCanModify = y
writerGroupCanModify = n
showCreated = y
showLastModif = y
defaultOrderKey =
defaultOrderDir = asc
useComments = n
showComments = n
useAttachments = n
showAttachments = n
attachmentsconf = 1,2,4,0,3,0,0,0
categories = 39

On import the tracker is not created and the checkboxes are not ticked. But as a way of ramping up
organizations with importing forms... this is very powerful collaboration tool.

336 Back to TOC

 Tikiwiki Documentation 1.9+

Trackers FAQ

• Can you allow for voting of tracker item

• Allow creation of a "find similar" field that can hold keywords, or identify which fields are
to be included in "find similar." Example: a tracker is created to contain book descriptions.
Each book has been tagged with a number of keywords, e.g. action, fantasy, kids, etc. This
feature would allow someone to find new books similar to books they already like. See
http://www.otakuworld.com/guide for an example of how anime are categorized and can be
found this way. Probably code similar to the "Find Similar" wiki action button could be
used. - edalton

• Embedded Link: this field option would take the contents of a field, plus some other code
(which could be a value drawn from a user profile or another tracker) and constructs a link.
Example: In the book tracker above, the tracker creator enters a book's ISBN number into a
field. The field combines that ISBN number with the creator's Amazon affiliate number
(drawn from another Tracker) and creates an Amazon affiliate URL link. Extra nice: be able
to specify a graphic to appear next to the URL. - edalton

tiki-view_tracker.php
"View Inserted Item" checkbox: This is an "end user" item. If checked when a tracker item is saved
then the saved tracker is shown to the user, otherwise the list of items in that tracker is shown.

tiki-view_tracker_item.php

list trackers
goes to tiki-list_trackers.php

Monitor
links to the monitor option for the current tracker

Admin trackers
goes tiki-admin_trackers.php

Edit this tracker

goes to tiki-admin_trackers.php

Back to TOC 337

 tab: name of tracker

tab : insert new item

This is where you click to add a new item
• When editing there needs a link to the owner of the item so to facilitate rapid comms with
collaborators.
• When viewing we admin needs to see the description of the tracker to make sure that the
client has met the goals of the tracker.

More Information
See Trackers (on doc.tw.o)
See TrackerExamples - this is a collection of exported trackers that might help (or hinder) a new
admin setting up trackers

4.10.2. Trackers Admin

Trackers Settings Panel

To administer Trackers, first click the "Admin (Click!)" menu to display the Tiki Admin Panel, as
shown in this graphic:

Trackers

From the Tiki Admin Panel,

338 Back to TOC

 Tikiwiki Documentation 1.9+

click the Trackers icon to display its settings panel, the top of which appears like so:

4.10.2.1. Configure Trackers

Trackers can have attached files. In this panel you can set up where to store attached files (if a
tracker allows it). You can store attachments in the database or a directory. The directory path can
be absolute (example: /foo/bar/uploads/) or relative to the Tiki directory (example: files/). The
trailing slash is mandatory.

Here you can:

• Set the file storage location to either the Tiki database or a directory on your web server's
hard disk.

Back to TOC 339

 Use database to store files

Use a directory to store files

Tracker Attachment Storage

Trackers can be set up to allow file attachments, which will be stored in the either the Tiki database
or in a directory on your webserver's hard disk. Storing files inside your database is OK for small
files or a low volume of files, but a folder is recommended for a high volume site or when your files
are relatively large.

Note the mandatory trailing forward slash on the path, shown here in red. The path you specify can
be absolute:
/home/cogley/www/uploads/tikiimg/rm/

... or relative to your Tiki's install directory:

trackeruploads/

Path characteristic checklist:

• Has a trailing slash.
• For best security, is specified from the root, and is in a separate folder from Tiki.
• Has its permissions set (e.g. via the chmod command from the command line or in your FTP
client software) to allow uploads by the webserver user.
• Has enough space to allow storage of your expected file volume.

If you take a look at your folder after uploading some images, you can see that Tiki randomizes the
filenames, as shown in this graphic:

Troubleshooting Tip: If you are having trouble with file uploads, you can edit settings in your
php.ini, or, place an .htaccess file in the root of your tiki installation.
# Partial .htaccess file sample.
#
# Override PHP.ini variables, which can be viewed using phpinfo:

340 Back to TOC

 Tikiwiki Documentation 1.9+

<IfModule mod_php4.c>
# If you are using Apache 2, you have to use <IfModule sapi_apache2.c>
# instead of <IfModule mod_php4.c>.

php_value max_execution_time 300

php_value upload_max_filesize "10M"
php_value memory_limit "32M"
php_value session.cache_expire 20000
php_value session.gc_maxlifetime 20000
php_value session.cookie_lifetime 20000
</IfModule>

# Zero means unlimted request body size:

LimitRequestBody 0

4.10.2.2. Trackers with Mirror Tables

Introduced in Tiki 1.9.1. Pending to be translated to English...

1. Explications

Le rôle de cette bibliothèque est de pouvoir manipuler les données des formulaires avec des
instructions SQL simples en dehors de TikiWiki. Donc sans passer par la bibliothèque des trackers
et sans avoir à en comprendre le fonctionnement.

Actuellement, les données des champs des formulaires se trouvent dans une seule table qui associe
l'id d'un champ, l'id d'un formulaire et la valeur du champ. Cette table n'est pas aisément exploitable
hors de TikiWiki.

Voila à quoi ressemble la table remplie :

table : tiki_tracker_item_fields
+-------+---------+-----------------+
|itemId | fieldId | value |
+-------+---------+-----------------+
| 42 | 7 | a kind of magic |
+-------+---------+-----------------+
| 42 | 5 | 1986 |
+-------+---------+-----------------+
| 42 | 8 | artist08 |
+-------+---------+-----------------+
| 42 | 11 | rock |
+-------+---------+-----------------+
| 42 | 17 | 0 |
+-------+---------+-----------------+
| 43 | 7 | mon bel album |
+-------+---------+-----------------+
| 43 | 5 | 2005 |
+-------+---------+-----------------+
| 43 | 8 | artist08 |

Back to TOC 341

+-------+---------+-----------------+
| 43 | 11 | rock |
+-------+---------+-----------------+
| 43 | 17 | NULL |
+-------+---------+-----------------+

Les formulaires avec tables en mirroir utilisent des tables de la forme suivante :

table : tiki_trk_n
+--------+---------+---------+---------+...+---------+
| itemId | field_1 | field_2 | field_3 |...| field_n |
+--------+---------+---------+---------+...+---------+

On peut également utiliser des tables avec les nom des champs en clair si on respecte les
conventions suivantes :
• Les noms doivent être valide en SQL
• Le nom du tracker doit être unique
• Le nom d'un champ doit être unique pour un tracker donné

Les tables ressemblent alors à ça :

table : tiki_trk_nom_tracker
+--------+------------+------------+------------+...+------------+
| itemId | nom_champ1 | nom_champ2 | nom_champ3 |...| nom_champn |
+--------+------------+------------+------------+...+------------+

Par exemple, voila à quoi ressemble la table pour un formulaire créé avec des noms en clair :
mysql> select * from tiki_trk_album;
+--------+-----------------+------+----------+-------+--------+
| itemId | name | year | artist | genre | Rating |
+--------+-----------------+------+----------+-------+--------+
| 42 | a kind of magic | 1986 | artist08 | rock | 0 |
| 43 | mon bel album | 2005 | artist08 | rock | NULL |
+--------+-----------------+------+----------+-------+--------+

Comparé à l'exemple d'en haut, c'est beaucoup plus facilement exploitable hors de TikiWiki.

342 Back to TOC

 Tikiwiki Documentation 1.9+

2. Mise en oeuvre

Pour utiliser les formulaires avec tables en mirroir, il faut d'abord activer leur utilisation. Sur la
page d'admin, cliquer sur l'icone "Formulaires". Parmis les options disponibles, celle-çi nous
intéresse :

On ne peut actuellement pas mélanger les deux types de trackers car il faudrait convertir les tables.

Pour utiliser les noms en clair dans les tables, il faut cocher l'option suivante quand on créé un
formulaire :

3. Améliorations

Pour être pleinement utiles, les formulaires fonctionnant de la sorte devrait pouvoir utiliser des
tables provenant d'autes bases que celle de TikiWiki , probablement avec les DSN. De plus, il serait
bien de pouvoir les utiliser conjointement avec les formulaires classiques.
More documentation

Related Information
• To enable Trackers for your site, see General Admin.
• To specify permissions for Tracker users, see Permission for the general procedure.
• For information on using Trackers, see Tracker User.
• For technical details, see Tracker Details.

Useful Links
• Apache WWW Server htaccess tutorial:
http://httpd.apache.org/docs/howto/htaccess.html
• PHP htaccess information:
http://jp2.php.net/configuration.changes
• Absolute Path Glossary Entry
http://linux.about.com/cs/linux101/g/absolute_path.htm

Back to TOC 343

4.10.3. Trackers Details
As you have certainly read, the Trackers feature is a powerful, flexible tool for recording
information about a collection of items.
One of this power is the use and the definition of several "field types".

4.10.3.1. Field types Overview

The following is a short list of Trackers field types and their uses (as far as i have understood them
and as seen in 1.9):
Name Type SQL Type Uses
text field t VARCHAR 255 Alphanumeric
text area t VARCHAR * Alphanumeric

4.10.3.2. Field types options

text field: 1,size,prepend,append,max with size in chars,

prepend will be displayed before the field append will be displayed just after, max is the maximum
number of characters that can be saved, and initial 1 to make that next text field or checkbox is in
same row. If you indicate only 1 it means next field is in same row too.

text area: quicktags,width,height,max,listmax

Use Quicktags is 1 or 0, widthis indicated in chars, height is indicated in lines, max is the maximum
number of characters that can be saved, listmax isthe maximum number of characters that are
displayed in list mode.
From Here

Useful Links

4.10.4. Creating a Tracker

This page explains the options available when you create trackers.
see also: Tracker, trackers user?, trackers admin?

Once you have activated Tracker in your Tiki installation, you can set up a tracker. To create a new
Tracker, click "Admin Trackers" in the Tracker menu to bring up a center panel like the following
one.

Create your Tracker by first entering basic information about your Tracker into the form.

344 Back to TOC

 Tikiwiki Documentation 1.9+

In tikiwiki, the columns of this table are fields and rows are items. Tracker can have any set of
fields and any number of items. The columns, or fields, will contain the data about each row, or
item, in the table. You can add, remove and list items that you want to track. You can add
comments or attach files to each item tracked. You can assign users and groups to each item and,
when the item is opened, it will appear in the user-preferences screen. You can monitor Tracker by
email. Simple workflows can be modeled using one or more Trackers.

The fields are explained in the following table:

Page: Create/edit trackers Local URL: tiki-admin_trackers.php

Back to TOC 345

 Option Choices Explanation
Any alpha-
Name
numeric text
Description Any text Longer description of the tracker or its purpose.
all available places this tracker withing a category for searching and permissions
Categorize:
categories purposes

all selected
Selected allows multiple caltegories to be selected
categories
Show status Yes/No Displays the status of an item to anyone viewing it.
check each
Default status displayed in
(open, pending, toggles the display status when an item is viewed
list mode
closed)
Show status to tracker
yes/no toggles viewability of status by permission
admin only
Send copies of all activity
any email
in this tracker to this e-mail
address
address
The sent email will have for subject the content of the field subject if
Use simplified e-mail exists (otherwise the default one), The from header will be the user
yes/no
format email of for an anomymous the content of the first email field if
exists(tw > 1.9.7). The message will not be sent if the fron is empty
New items are created with
status open pending closed
Authoritative status for
modified items No change
open pending closed
Item creator can modify his
items?
The tracker needs a user
field with the option 1
Only one item per user or IP
The tracker needs a user or
IP field with the option 1
Member of the default
group of creator can modify
items?
The tracker needs a group
field with the option 1
Show creation date when
listing tracker items?
Show lastModif date when
listing tracker items?
What field is used for
default sort?
What is default sort order in
list? ascending descending

346 Back to TOC

 Tikiwiki Documentation 1.9+

Option Choices Explanation

Tracker items allow
ratings?
. . .with values
. . .and display rating results
in listing?
Tracker items allow
comments?
. . .and display comments in
listing?
Tracker items allow
Allow attachments, or not?
attachments?
. . .and display attachments
checkbox adds the attachments column to the List view
in listing?
selects the data columns to include when displaying attachments, in
Attachment display options rank all options
which order.

4.10.5. Adding fields to a tracker

Step Two in: Four Steps to make a Tracker

Step Details Help Page
Admin names the tracker, and assign overall parameters and
1. Create the Tracker Creating a Tracker
permissions
2. Add fields to the
Admin defines the columns and type of information collected Adding fields to a tracker
Tracker
3. Add items to the tracker Users fill out the forms to create items in the tracker Adding items to a tracker
4. View or List the results Use plugins to view a customized tracker output in a page Viewing Tracker Results
5.Assign Trackers to Assigning Trackers to
optional - trackers can also be used upon registration.
Groups groups

In tikiwiki, the columns of this tracker are called fields and rows are items. Trackers can have any
set of fields and any number of items. The columns, or fields, will contain the data about each row,
or item, in the table. You can add, remove and list items that you want to track. You can add
comments or attach files to each item tracked. You can assign users and groups to each item and,
when the item is opened, it will appear in the user-preferences screen. You can monitor Trackers by
email. Simple workflows can be modeled using one or more Trackers.

To make a Tracker useful and usable, you add some fields to it to capture the data you want to
collect. You can administer fields by going to the the "Admin Trackers" list, and clicking the Fields
icon ( ).

Back to TOC 347

To add a field, click the Fields action from the Trackers list, then fill in the form that appears
indicating the field name, field type, and any applicable options. You can use the field types listed
at the end of this page.

At least one of the fields in your Tracker must be the "main" field, which links to the item's details
from the Tracker listing. This attribute is controlled by the "Column links to edit/view item?"
checkbox. You can also indicate if the field is visible or not in the Tracker item list using the "Is
column visible when listing tracker items?" checkbox. If a Tracker has a lot of fields you may want
to use this checkbox to remove some of them from the item listing, for easier viewing.

Some Tracker field types have options you can set. For example, the drop-down field's items are

348 Back to TOC

 Tikiwiki Documentation 1.9+

entered separated by commas. The default value for a drop-down field is set by entering the value
twice consecutively, separated by comma. The default can be set to any item in the list, no matter
what position the item is placed in the list. In the screenshot below "Academic Staff" has been set as
the default by entering it twice.

Once you have entered several fields, defining their type, options and visibility, you will see a list
similar to this one:

Back to TOC 349

Note in this graphic the "is main" column. A "y" or yes, means you have checked the "Column links
to edit/view item?" checkbox. The list also indicates whether a field will be visible in the item
listing, and allows you to edit or remove fields accordingly using this list's Actions.

Hint: One default field in any tracker is the "Status" field, which tracks whether an item is open or
closed. This field is not visible in the Fields listing.

4.10.5.1. Explanation of Fields

Local URL: tiki-admin_tracker_fields.php?trackerId=2

Each form includes a number of different fields:

OPTION CHOICES EXPLANATION
This field name is placed above the button or text field, it should be phrased
Name any text
as a query. e.g. (use Role: or "what is your role")

350 Back to TOC

 Tikiwiki Documentation 1.9+

OPTION CHOICES PARAMETERS EXPLANATION

Type Text input size
prepend will be displayed before the field
append will be displayed just after
max with size in chars
max is the maximum number of characters that can be saved
1 to make the next text field or checkbox is in same row
If you indicate only 1 it means next field is in same row too
Textarea quicktags 1 for on, 0 for off
width(in characters) width=
height(in characters) height=
max(characters saved) max=
listmax (number of characters
listmax=
displayed in list mode)
Drop down
a "choose one" input, enter text options separated by commas (example)
combo
a "boolean" on/off yes/no
Checkbox put 1 if you need that next field is on the same row.
true/false field
Radio buttons a "choose one" input, text options separated by commas.
Date/time Date & time picker
User allows a selection from the list of site's users ( more information )
1 Uses the item creator's login
2 Uses the last modifier's login
Group select a group from the list of site's groups ( more information )
1 Uses the item creator's group
2 Uses the last modifier's group
IP Selector records an IP adress ( more information )
1 Choose the item creator's IP
2 Displays the last modifier's IP
Country Selector A dropdown of all countries
1 Displays only country name
2 Displays only country flag
(none) Displays both name and flag.
Numeric
1 display the next field in the same row
size in characters
prepend' text displayed before the field
append will be displayed just after
Image Allows user to upload an image

Back to TOC 351

 OPTION CHOICES PARAMETERS EXPLANATION
size in pixels of the horizontal axis in "List View"
xListSize mode (automatically rescaled if the upload image is
larger)
size in pixels of the vertical axis in "List View"
yListSize mode (automatically rescaled if the upload image is
higher)
size in pixels of the horizontal axis in "Item View"
xDetailsSize mode (automatically rescaled if the upload image is
larger)
size in pixels of the vertical axis in "Item View"
yDetailsSize mode (automatically rescaled if the upload image is
higher)
maximum size of a picture. If the image is larger or
uploadLimitScale higher, the uploaded image will be rescaled
automatically- the initial image will not be saved
Creates a new section in create tracker item view (divides the form into sections), Field
Header
title is displayed as heading 2, description below.
Action Label,post,tiki-index.php,page:fieldname,highlight=test
Category applies a category to the tracker item (example)
parentId applies the same category as the tracker
lists the available categories so the user can choose
radio
one
(default) lists the available categories so that the user
checkbox
can check all that apply
Item Link Links (related) items from one tracker to another (example )
trackerId enter the tracker ID number to be linked to.
fieldId enter the corresponding field ID
links to item from trackerId whichever fieldId
linkToItem
matches the content of that field.
to create a link to items in view mode and listing
1
linkToItems
0 to create a link to the item in view mode
0 to create a link to the item in listmode
displays the list of displayFieldIdThere from item in tracker trackerId where
Items list
fieldIdThere matches fieldIdHere. linkToItems 1|0
trackerId
fieldIdThere
fieldIdHere
displayFieldIdThere
Email address
0 displays the address as plain text
displays a hex encoded mailto link (more difficult for
1
web spiders to pick it up and spam)

352 Back to TOC

 Tikiwiki Documentation 1.9+

OPTION CHOICES PARAMETERS EXPLANATION

2 displays the normal href mailto.
Set up a counter and allow users subscription to an event that is the tracker item. (more
Subscription
information)
Refresh "dynamically" a list based on another list. For example, when i select "Solaris"
in the first list "Solaris, Windows, Linux, ...", the dynamic list does a request to obtains
Dynamic Items
its items like "Solaris 2.9, Solaris 2.10, ...". If i select "Windows" in the first list, the
list
second list change "dynamically" its content to "Windows 2000, Windows XP, ...". (In
Tikiwiki 1.10)

For more detail Tracker Field Type

OPTION CHOICES EXPLANATION
Is column visible
when listing tracker tick/untick Adds/removes the column from the list view.
items?
Column links to
tick/untick links from list view to item view, normally only the leading column should link
edit/view item?
Column is
tick/untick makes column data searchable by . . .
searchable?
Field is public? tick/untick hides/reveals columns displayed using the trackerlist plugin.
Field is hidden? tick/untick
User must complete this field to save the item. Usually to be mandatory means
that the value must not be empty. But a mandatory checkbox has no sense,
Field is mandatory? tick/untick
because a checkbox has always a value y or n (yes/no). If you want a behavior
like for a disclaimer, please use a mandatory radio button (accept/do not accept)
Order: integer Row order of the field
Description: descriptive text which is (sometimes) included in the cell with the input field

4.10.6. Tracker Field Type

Some of the field types have some more documentation including examples, etc:

4.10.6.1. User / Group / IP Selector Tracker Field

User, Group, IP selectors are used in the trackers feature to attribute items? to specific users.
Adding a name to a tracker item is necessary but not sufficient to create special viewing and editing
priviledges

The page Adding fields to a Tracker explains how the fields, (columns or questions) of a tracker are
set up.
User Selector attibutes the item to a user by login name.
an open selection from the whole list of usernames. N.B. do not use this feature if the user list is
default
private.

Back to TOC 353

User Selector attibutes the item to a user by login name.
assign item to its creator - This option is necessary if you want to limit the modification of the item to
1
it's creator and administrators.
2 assign item to "last modified by" - the is filled up by the item creator or editor user name.

The Group Selector

This option works exactly like the User Selector except that instead of the user name, it uses the
default group? of the user.

IP Selector
(new in Tikiwiki1.10)
This option works exactly like the User Selector except that instead of the user name, it uses the IP
of the user.

4.10.6.2. Image Tracker Field

This tracker field type allows you to add image in a tracker. The image can be see in the tracker
items list or in a item view.
pixels maximum width of the image in tracker items list
xListSize optional
number ( automatically rescaled if the upload image is larger)
pixels maximum heigth of the image in tracker items list
yListSize optional
number ( automatically rescaled if the upload image is higher)
pixels maximum width of the image in item view (automatically
xDetailsSize optional
number rescaled if the upload image is larger)
pixels maximum width of the image in item view (automatically
yDetailsSize optional
number rescaled if the upload image is higher)
maximum size of a picture. If the image is larger or higher,
pixel
uploadLimitScale optional the uploaded image will be rescaled automatically- the
number
initial image will not be saved

administration
The images are store in the sub directory img/trackers. The filenames are encoded at the upload.

4.10.6.3. Drop Down Tracker Field

This page needs a screenshot to showing the setup and result

This tracker field allows you to create a drop down list of values

You have to give each value in the parameter line. Each value is separated with a comma.
Ex:Yes,No

Tikiwiki > 1.9.7: If you repeat a value, this value will be the default
Ex: Yes,Yes,No will display yes and No in the list with Yes preselected

354 Back to TOC

 Tikiwiki Documentation 1.9+

If The field is optional, an empty value will be automatically added at the top of the values

4.10.6.4. Items List and Item Link Tracker Fields

Example: You want to display the list of products of a company

• tracker Company (id 6)
• id 14: Company name - text field
• id 16: Product list - items list = 5,15,14,12
• tracker Products (id 5)
• id 12: Product name - text field
• id 15: Company name - item link 6,14

PS: if the Company tracker is not know before you enter the products, you will have not to use the
itemlink type for the field 15 but a simple text field

4.10.6.5. Category Tracker Field

The field type enables you to assign one or more categories to a tracker item.
The categories that are displayed are the children of one category. This parent category must be
identified by its category ID.

Options
Option Value Description TW version
parentId Numeric Category ID of the parent category
radio 1 or 0 If 1 will displays radio buttons, if 0 (default) will display checkboxes 1.10
1 will display a checkbox 'select all' that will give the opportunity to
selectAll 1 or 0 1.9.8
select/deselect all the categories in one click

The option are separated with coma.

In 1.9.8, even if radio is not available, you must still "reserve" the space.

Ex.:
6,,1

Is:
Use category #6 and add "select all" option

Style
The div that contains the selec all button has a class .categSelectAll

Back to TOC 355

 Category Browsing
The main field of the tracker item will be displayed in the categories browsing.

4.10.6.6. Subscription Tracker Field

In Tikiwiki >= 1.10

This tracker field type is used in a tracker used for an event. The field allows you to set up a counter
and to have user subscribing to the event. The administrator can set the maximum number of
subscriptions. Each time, a user subscribes the number will decrease. A user can not anymore
subscribe if the number is null. The lit of users who have subscribed can be see by the administrator
in the field value.

For instance, create a tracker concert with a subscription field.

Now create items in this tracker. For each item, set a maximum number of places. You need to
format this value as a number followed by # (ex: 50# means that the concert has 50 places)

Then when you view this tracker item, you will see a box with a Subscribe button and the number
of place you want to reserve. You will see an unsubscribe button if you already subscribe and you
will see the list of users who already subscribed

When the administrator edit the item field, he will see a value like that:
50#210[3],333,455[2]

That means there is 50 places available, the user (userId=210) has reserved 3 places, the user 333
has reserved 1 place, the user 455 has reserved 2 places

4.10.6.7. Dynamic items list

If somebody can figure out from the info I found - thanks to put an example

So far I understand
tracker 57 State
with 2 fields
• field 193 Country, type drop down list, option: USA,Canada
• field 194 State, type text
The items are
USA MA
USA CA

356 Back to TOC

 Tikiwiki Documentation 1.9+

Canada Québec

tracker 60 Customer
• field 186 Country, type drop down list, option: USA,Canada
• field State, type dynamic items list , option : 57,193,186,194

If I select the country USA, the state drop down is populated with CA and MA
If I select the country Canada, the state is populated with Québec.

Documentation
dynamic items list options: trackerId, filterFieldIdThere, filterFieldIdHere, listFieldIdThere,
statusThere insert the list of listFieldIdThere from item in tracker trackerId where filterFieldIdThere
matches filterFieldIdHere where status is statusThere.

fr_rodo on devel list

dynamic items list (bad name ?) is to refresh "dynamically" a list based on
another list. For example,
when i select "Solaris" in the first list "Solaris, Windows, Linux, ...",
the dynamic list does a request to obtains its items like "Solaris 2.9,
Solaris 2.10, ...". If i select "Windows" in the first list, the second list
change "dynamically" its content to "Windows 2000, Windows XP, ...".

mose on IRC
03:52:41 PM) sylvieg: does somebody know how dynamic item list (field type) work?
(04:07:03 PM) mose: yes
(04:07:08 PM) mose: it works nicely
(04:07:17 PM) mose: but it's not adapted to every case
(04:07:44 PM) mose: actually it changes a select menu depending the value given to another field
(04:07:58 PM) mose: with a js thing
(04:08:09 PM) mose: the code stinks, but it works
(04:08:54 PM) mose: I tried it and had it working surprisingly the first try
(04:10:49 PM) sylvieg: :-( I just sent a mess on devel
(04:11:12 PM) sylvieg: .... do you have an example?
(04:11:54 PM) sylvieg: I am not so lucky - it does not work the first time
(04:12:18 PM) marclaporte: select menu depending the value given to another field -> ex.>
province list after choosing from country list
(04:13:24 PM) sylvieg: province and country are in the asme tracker?
(04:13:27 PM) sylvieg: same
(04:16:33 PM) marclaporte: I don't know
(04:16:52 PM) marclaporte: I have never used
(04:17:03 PM) marclaporte: but that's the goal, I think
(04:25:06 PM) Caarrie is now known as Caarrie|away
(04:36:24 PM) sylvieg: I am either too stupid, or dynamic list is broken
(04:37:17 PM) mose: I don't find where I tried it actually, but I saw it work
(04:37:24 PM) mose: I got to many tikis :/
(04:37:52 PM) sylvieg: What is the value of such a field ... a text?

Back to TOC 357

(04:38:25 PM) mose: yes, and a select menu in edit mode
(04:38:26 PM) sylvieg: I am able to have a slect with different nb of elts - but each elt is empty
(04:38:50 PM) mose: the options are numerous
(04:39:02 PM) mose: maybe you miss one or one is not correct
(04:39:44 PM) sylvieg: dynamic items list options: trackerId, filterFieldIdThere, filterFieldIdHere,
listFieldIdThere, statusThere
(04:40:00 PM) mose: the 4th is what field is displayed
(04:40:11 PM) mose: take the french version, it's more explicit imho
(04:40:29 PM) mose: IdFormulaire, ChampFiltreLàBas, ChampFiltreIci, ChampListéLàBas,
statutLàBas
(04:41:10 PM) marclaporte: multimose!
(04:41:54 PM) sylvieg: I thought that if the options work for item list, they must work for dynamic
items list
(04:42:08 PM) sylvieg: except that you can display more fields
(04:42:24 PM) mose: no it's not the same I think
(04:43:15 PM) mose: ChampFiltreIci can be an item link, I think that's what I tested

4.10.7. Add items to the tracker

Step Three in: Four Steps to make Tracker
Step Details Help Page
Admin names the tracker, and assign overall parameters and
1. Create the Tracker Creating a Tracker
permissions
2. Add fields to the
Admin defines the columns and type of information collected Adding fields to a tracker
Tracker
3. Add items to the
Users fill out the forms to create items in the tracker YOU ARE HERE
tracker
4. View or List the
Use plugins to view a customized tracker output in a page Viewing Tracker Results
results
5. Assign Tracker to Assigning Tracker to
optional - trackers can also be used upon registration
Groups groups?

Once you have created the fields? in trackers, you have defined what kind of data you want to
collect - with items? you are now collecting that data.

Creating the tracker and defining the fields are generally part of the configuration? of a site,
performed by the site admins - items, on the other hand are what you want the users (ok, who may
also be the admins) to do. Therefore you may want to revisit how the assign permissions to groups?
settings are established, to ensure that the permissions create tracker items is given to the groups
you intend to have using the tracker.

Once designed, the tracker can now be inserted into any wiki page (or article or blog?) using the
PluginTracker. By default each tracker can be viewed at its own unique url, from the list trackers?
page. But if you want users to find it, better use the plugin.

Items can be inserted into a tracker either directly from the visualization of the tracker (tiki-
view_tracker.php?trackerId=N), being N the identification number of the tracker (trackerId)

358 Back to TOC

 Tikiwiki Documentation 1.9+

or from a Wiki page where PluginTracker has been included with appropriate syntax. For instance:
{TRACKER(trackerId=>2, fields=>5:8:11:30:12:35:36:39, action=>Add to Staff,
showtitle=>y, showdesc=>y, showmandatory=>y, embedded=>y)}
The item was added successfully. ''(Click to another link to continue, or go to
[index.php|Home Page])''{TRACKER}

Would produce:

Back to TOC 359

After inserted an item, this message would be show at the wiki page where the tracker plugin was
placed:

Keep in mind that fields with an asterisk on their right hand side are compulsory. See for instance
the "Name and surnames *" field from the example above:

This means that, if they are not filled, or they don't contain the proper data type (depending on how
the tracker has been configured), when you want to insert the item in the tracker a message will
appear showing which fields are missing to be properly completed, in order to submit your item to
the tracker successfully.

4.10.7.1. Massive addition of items to a tracker

If you want a massive addition of items into a tracker, you can use the "Import CSV data" feature.
It can be found at "Admin Tracker (i.e. tiki-admin_trackers.php?trackerId=1, for instance) >
Import/Export (tab) > Import/Export CSV Data (bottom of page)":

360 Back to TOC

 Tikiwiki Documentation 1.9+

In order to successfully import data, you'd better export, first, some items manually added to the
tracker through tiki interface out to a spreadsheet program. To do so, you can click on "Download
CSV export | tracker_1.csv" (see the image above).

Then, open that file in your favorite spreadsheet program (such as OpenOffice.org Calc - OOo
Calc -), add some rows, and save the file back to csv format. You'd better manually select the CSV
settings; in OOo, through clicking on the "Edit filter settings" checkbox, and thus, selecting utf-8
encoding for the character set, "," (comma) as field delimiter, and '"' (double quotation mark) as text
delimiter:

Nowadays, you can import your data file in the tracker through "Admin Tracker > Import/Export
(tab) > Import/Export CSV Data (bottom of page) > Import file > Browse the file > hit save"

Take note that the items will be added to the tracker, and if some of them were already present, they
will be duplicated. So if you don't want to this to happen, remove the rows that you don't want to be
duplicated.

4.10.8. Searching tracker items

There are two ways or searching items on a tracker:
1. Default and simple search, through the built in "filter" feature included by default in the
interface when viewing tracker items ("tiki-view_tracker.php?trackerId=1"),
2. Customized and more advanced search, through the PluginTrackerFilter within a wiki page.

4.10.8.1. (1). Default and simple search

This way allows searching for one single field each time.

Once you have created a Tracker, and added some items to it, you can search the tracker for some
words of its fields. This action is called "filter" tracker items, in Tiki nomenclature, and that's what
you'll probably see in the tracker interface when listing tracker items ("Choose a filter" drop down

Back to TOC 361

box and "filter" button next to it).

To search items for a specific name in this example tracker, for instance, select "Name and
surnames" field in the "Choose a filter" drop down list, then write the keyword or name that you
want to use as the search term in the filed on the left that will show up, and press on the "filter"
button. In this example, we will search for any person of the staff called "Aytor" (or any name
including "Aytor"):

This will find the two out of four people in the list which have that name.

4.10.8.2. (2). Customized and more advanced search

This way allows searching for several fields at the same time

You can search trackers also using the extended features of the Wiki plugins related to trackers. In
this case, you can use the PluginTrackerFilter to perform such a more advanced search.

See more information in PluginTrackerFilter.

4.10.9. User tracker

unfinished documentation
http://fr.tikiwiki.org/tiki-index.php?page=Formulaires%20utilisateurs%20et%20groupes

A tracker can be used to add some information to a user

362 Back to TOC

 Tikiwiki Documentation 1.9+

1) Create the tracker

tiki-admin_tracker.php
The tracker must contain a field of type user tracker - option 1
If you want the items to be seen only by his user, you must set special perm on the tracker, as
tiki_p_admin_trackers for the admin group.
Even if there is no tiki_p_create_tracker_items for the tracker, the user will be able to create his
item and to modify it.

2)Associate the tracker with a group

the user can see his tracker with

tiki-view_tracker_item.php?view=+user
If he has no tiki_p_create_tracker_items, he will not be able to see the tracker with
tiki-view_tracker_item.php

Back to TOC 363

4.11. Spreadsheet
TikiSheet allows to present numeric data inside TikiWiki and perform calculations on them. Data
tables and graphical charts can be included in wiki pages. The documentation will present the
different components of the Spreadsheet feature. The current version of the documentation ignores
the permission issues.

Used icons

Graph Create graphics and charts

History View spreadsheet modification history
Export Save the spreadsheet data in an other format
Import Load data from an other data source
Edit Modify the parameters of the spreadsheet
Delete Deletes the spreadsheet

4.11.1. Basic Functionality

4.11.1.1. Create a New Spreadsheet

From the main screen, a "Create new Sheet" link is available. (see Fig. 1)

Fig. 1: Main page of the Spreadsheet feature

The link leads to a form to create a new spreadsheet (see Fig. 2). The "Title" and "Description"
fields are only informative. "Class Name", "Header Rows" and"Footer Rows" affect the rendering
of the sheet in the browser when being viewed. The class name is the name of the CSS style that
will be applied on the table. The "default" style displays borders and places emphasis on the fields
in header rows and footer rows.

364 Back to TOC

 Tikiwiki Documentation 1.9+

The header and footer rows fields require a numeric value, which is the number of rows that should
be considered as part of the header and footer. Most web browsers will repeat the header and footer
rows on every page when printing a large table. In a table where the first row represents the column
names, a "Header Rows" value of 1 would be recommanded.

Fig. 2: New sheet form

4.11.1.2. View Revision History

Link for revision history is available from the spreadsheet view page and spreadsheet list. All
revisions are listed from newest to oldest. Clicking on the revision will lead to the view page. From
the view page, the spreadsheet can be edited at the selected state. Changes made will create a new
revision, ignoring any revision made in between.

4.11.2. Edit Interface

To edit the content of the spreadsheet from your web browser, click on the title of the spreadsheet in
the list and then on edit when the spreadsheet page is being displayed. If the spreadsheet is new, it
will appear with a single cell (see Fig. 1).

Back to TOC 365

 Fig. 1: Blank spreadsheet

4.11.2.1. Modify the Spreadsheet Structure

Multiple options are available to change the structure of the spreadsheet. Here is a summary table.
Insert Row Insert one or multiple rows at a specified location
Insert Column Insert one or multiple columns at a specified location
Remove Row Delete a single row
Remove Column Delete a single column
Merge Cells Merge the selected cells into a single cell
Restore Cells Unmerge the selected cell to the original state
Copy Calculation Copy the calculation to an adjacent cell
Format Cell Applies formatting to a cell (ex.: currency)

Columns and rows can be added using the "Insert Row" and "Insert Column" options (see Fig. 2
and Fig. 3). Both will present radio buttons to select if the cells should be added before or after the
selected reference. The reference is selected from a combo box listing the row numbers or column
letters. A text field is used to specified the amount of items to add.

Fig. 2: Insert row form

366 Back to TOC

 Tikiwiki Documentation 1.9+

Fig. 3: Insert column form

Note: If you add new rows or columns and save the sheet before entering data into them, Tiki will
actually delete the empty rows or columns__.

Columns and rows can be removed one at a time using the "Remove Row" and "Remove Column"
options (see Fig. 4 and Fig. 5)

Fig. 4: Remove row form

Fig. 5: Remove column form

Calculations can be copied across multiple cells using the "Copy Calculation" option (see Fig. 6).
Before the direction is selected, the affected cells must be selected. To do so, first select a cell, hold
shift and select the last cell. The selected range will be highlighted. In a vertical range where the
calculation is written in the first cell, using the "Down" option will copy the calculation in every
cell until the end of the range based on the first row.

When the calculation is being copied, the references to other cells are modified to suit the new
location. In the example above, the row numbers would increment on every row. Elements in the
calculation can be made static. For more information about calculations, see the section on
"Calculations and Formulas".

Back to TOC 367

 Fig. 6: Copy calculation form

Cell formatting is used to display the numeric values in a different format, such as replacing *2.5*
for *$2.50* when displaying currencies. Applying format on a cell does not affect the real value,
allowing to perform calculations. The cell formatting can be applied on a range of selected cells
using the "Format Cells" option (see Fig. 7).

Fig. 7: Format cells form

Here is a summary of the available formats available.

currency Displays the numeric value with 2 digits precision (ex: 2.00)
currency_us Displays the numeric value as currency, preceded by dollar sign (ex: $2.00)
currency_ca Displays the numeric value as currency, apended by dollar sign (ex: 2.00$)

4.11.2.2. Calculations and Formulas

Formulas in TikiSheet work in a similar way to those in Excel or OpenOffice.org Calc. Once a cell
is selected, a formula can be entered by clicking in the text bar above the spreadsheet and typing
*=*, which is the character to indicate the entered value is a formula. Figure 8 contains an example
formula.

Note:_ Entering a formula directly into the cell will not work. You need to enter the formula in the
text bar located at the top of the spreadsheet (the one that displays the content of the currently
selected cell).

368 Back to TOC

 Tikiwiki Documentation 1.9+

Fig. 8: Example sheet containing a formula

Values from other cells can be included in a formula using the column letter and the row number.
The example above substracts the Member discount from the regular price to produce the member
price. Most common operators are supported.
Note: Formulas are interpreted as JavaScript after a few transformations. Most constructs and
functions of the language can be used. This documentation describes the elements required for
common use and customized elements

Functions can also be used in formulas. Most functions are applied on a range. Ranges can be
obtained using A1:Z99 syntax, where the part before the colon is the top left corner of the selection
and the part after the colon is the bottom right corner.

Back to TOC 369

 Fig. 9: Spreadsheet not in edit mode

Figure 9 is a sample spreadsheet result. The following formulas have been used to obtain these
results:
Student total =B7/100*B$2+C7/100*C$2+D7/100* Sum of the obtained results with
result D$2 ponderation
Column average =AVG(B3:B18) Average of all results in the column
Column min =MIN(B3:B18) Lesser value in the column
Column max =MAX(B3:B18) Highest value in the column

In the student total result, a dollar sign has been added (D$2) in the reference to the field at the top
of the page. The dollar sign symbol indicate the value should not be incremented when the
calculation is being copied to other cells. Using $D2 would lock the column to D while the row

370 Back to TOC

 Tikiwiki Documentation 1.9+

number could increment. Both can be used together ($D$2).

A range can also be created using brackets. For example, a range containing cells from A1 to A4,
excluding A2 could be created using: [ A1, A3, A4 ] .

Here is a list of the functions available:

SQRT( val ) Square root of val
MIN( range ) Finds the lesser value in range
MAX( range ) Finds the largest value in range
SUM( range ) Sums all values in range
AVG( range ) Average value in range
SUMIF( testRange, val or Sum of elements in sumRange if matching value in testRange is
range, sumRange ) equal to val or any value in range

4.11.3. Graphics and Charts

Graphics can be created using the Graph icon in the spreadsheet listing. Two simple forms are
presented to select the parameters of the graphic.

4.11.3.1. Select the Graphic Type and Output Format

Fig. 1: First form

The radio buttons select the type of graphic to be generated. A first example will be made with the
Pie Chart and a second one with Multibar. Multiline and Bar Stack use the same parameters as Bar
Stack.

Multiple output formats are available. Depending on the installed extensions on the server, some

Back to TOC 371

elements might not be available. PDF and PostScript are printable format and require the paper size
and orientation parameters. PNG and JPEG are images and require height and width parameters in
pizels.
If the objective is to include the graphic in a wiki page, the selected format will only be used for the
preview.

4.11.3.2. Parameters

Figure 2 presents the parameters entered to obtain a pie chart from the speadsheet and Figure 3 is
the result obtained. The page is divided in three sections:
1. Parameter form
2. Spreadsheet
3. Wiki Plug-in

The parameter form is used to select the elements that will be displayed in the graphic. All
parameters under the series label are value ranges from the spreadsheet in A1:Z99 format or comma
seperated list of elements (ex: Blue, LightBlue, LightGreen). The color and style series require
special values:

Color
• Red
• Green
• Blue
• Yellow
• Orange
• LightBlue
• LightGreen

Style
• Thin-LineStroke
• Thin-FillStroke
• Normal-LineStroke
• Normal-FillStroke
• Bold-LineStroke
• Bold-FillStroke
• Bolder-LineStroke
• Bolder-FillStroke

The spreadsheet is available as a reference to select the ranges.

The wiki plug-in is updated as the parameters are changed in the form. The code displayed can be
pasted in a wiki page to display the graphic. The plug-in does not consider the selected output
format. Instead, it will automatically select the best format available. If possible, it will display an
image and link to a printable format. Prefered image format is PNG and prefered printable format is

372 Back to TOC

 Tikiwiki Documentation 1.9+

PDF.

Pie Chart Parameters

The following table presents the different field of the form, what they are used for and the behavior
if left empty.
Title Used as the title of the graphic No title
Label Caption in the legends No legend
Value Values used in the chart Required
Color Colors used for the elements Automatically selected
Style Change border type Normal-FillStroke

The amount of elements in every range must be the same.

Back to TOC 373

 Fig. 2: Parameters for the pie chart.

Fig. 3: Resulting pie chart.

Multibar Parameters
Figure 4 presents the parameters used to create the graphic in Figure 5. Note that different size
parameters have been used to suite the large amount of data. Here is the table presenting the
different parameters.
Title Title of the graphic No title
Independant Scale Determines if the graphic is vertical or horizontal
Horizontal Scale Location of the horizontal scale
Vertical Scale Location of the vertical scale
Label Caption of the different elements in the legend No legend
Color Colors used in the legend Automatically selected
Style Border type used Normal-FillStroke
X Independant scale range Required.
Y0 First dependant range Required.
Y1-Y4 Additional dependant range

The amount of elements in the Label, Color and Style ranges must be equal to the amount of Y
ranges used. The amount of elements in the X range and all Y ranges must be the same.

374 Back to TOC

 Tikiwiki Documentation 1.9+

Fig. 4: Parameters for the multibar graphic

Back to TOC 375

 Fig. 5: Resulting multibar graphic

376 Back to TOC

 Tikiwiki Documentation 1.9+

4.12. Surveys
Tikiwiki has several features for gathering feedback from site visitors. Poll, are a simple one
question "straw vote". Surveys can be viewed as "extended" polls, and Tracker are a do pretty much
anything "forms" kind of feature, which includes much more powerful and customized surveys
based on trackers. Which do you want to use? For some simple surveys, a poll may be enough.
When you want to be more precise about your users' opinions and still an easy way to create and
view their results and statistics, you need to create a survey. When survey feature is limited for your
needs, then you can make your very customized survey using Trackers and their Plugins.

A survey is a collection of several questions. Statistics based on the answers are stored and may be
viewed later.

Uncertainly: While polls and trackers can both be inserted into wiki pages with plugins - it is
apparently not possible to view surveys except at their own "home page" which is accessible only
from the "List Surveys" page in the application menu, or by an internal link if you create one.

4.12.1. Surveys User

Needs review.

4.12.1.1. Listing surveys

Surveys can be listed by clicking Surveys in the Application menu (which would lead you to tiki-
list_surveys.php)

Surveys that the user can take are displayed in bold and the title links to the survey form. If the user
already took the survey or cannot take it, the survey title won't be a link.

Back to TOC 377

Note that users can take each survey only once but admin can take a survey as many times as he or
she wants. If you allow anonymous users to take surveys, users will be able to take a survey many
times if they clear their cookies. If you want to enforce only one vote per user, make surveys
available to registered users only.

4.12.1.2. Taking a survey

When you click on a survey name in the listing (or at this icon ), you will be able to fill out the
survey form (tiki-take_survey.php?surveyId=1 , for survey 1, for instance).

378 Back to TOC

 Tikiwiki Documentation 1.9+

4.12.1.3. Survey stats

If you have the right permissions, you can see stats for a survey. Under the survey listing, clik on
the lens icon ( , tiki-survey_stats_survey.php?surveyId=1):

4.12.2. Survey Admin

Needs review.

Back to TOC 379

See also: Survey - feature overview

4.12.2.1. Create a Survey

Enable the Feature:

Administration-->Features-->Survey (check)

Goto the Admin Survey page

If you have the appropriate permission, you can create a surveys by clicking the Admin surveys
link in the Surveys section of the application menu.

If you don't see a Surveys section, enable surveys from the Features section of the main Admin
Panel?.

The following form is used to create a survey:

Fill in the information and save it. Until you survey is not ready, you can leave it as "closed" in the
status drop down field.

380 Back to TOC

 Tikiwiki Documentation 1.9+

In this example, we are using html tags in the description of the survey, so that there will be some
more markup in the description of the survey when users view it in order to fill their answers.

Click the Questions link ( ) to add questions to a survey.

If the survey status is closed ( ) then users won't be able to take the survey. Leave the status field
as "open" ( ) when you are ready to allow your users to fill the survey, and you can set it to close
after a certain period of time.
.

4.12.2.2. Survey questions

Once you click on the question link ( ), you will be able to add questions (tiki-
admin_survey_questions.php):

Back to TOC 381

You can use several question types when creating a survey:

• Short text questions

• Single choice questions
• Multiple choice questions
• Rate 1..5 questions
• Rate 1..10 questions

Select the question type and enter the question text. If the question has options, such as with single
or multiple choice questions, enter the options separated by commas. The options will appear as
possible answers to the questions.

When some questions are inserted, you can see them listed below at the same page of
administration of questions (tiki-admin_survey_questions.php):

382 Back to TOC

 Tikiwiki Documentation 1.9+

Short text questions

A short text question will be displayed as an input text box where users can enter text. Tiki will
store all the user answers to the question and list them in the stats (if two users enter the same text it
will be displayed only once indicating the number of users that entered the text). This type of
question can generate fairly long stats since it is unlikely that two users will type the same text.

Single choice questions

A single choice question will display the options as radio buttons and the user must select only one
of the options.

Multiple choice questions

In a multiple choice question options will be displayed as checkboxes and the user will be able to
click one, some or all the options.

Rate 1..5 questions

The user will be asked to rate the question topic from 1 to 5 using radio buttons.

Rate 1..10 questions

The user will be asked to rate the question topic from 1 to 10. Once a question is created as admin
you can practice taking the survey and checking the stats, then you can clear the survey stats and get
it ready to be used.

4.12.3. Survey Details

Needs review.

Permissions

Name type description

tiki_p_admin_surveys surveys Can admin surveys
tiki_p_take_survey surveys Can take surveys
tiki_p_view_survey_stats surveys Can view survey stats

See Survey for more information.

Back to TOC 383

4.13. Newsletters
The Tiki newsletter feature allows you to send a newsletter via email to a list of subscribers. The
email can be sent in HTML format, plain text format, or both. Other newsletter features include:
• user controlled subscribe/unsubscribe
• Admin can restrict subscription to the users email address of record, or allow any address to
be used.
• Admin controlled subscribe/unsubscribe
• email address validation
• include unsubscribe instructions in the newsletter
• granular object permissions for viewing, sending, etc

This document needs review

4.13.1. Newsletters User

4.13.1.1. Listing newsletters

Clicking the newsletters link in the application menu lists the available newsletters. The user can
subscribe to a newsletter by clicking it. If the user has the permission and the newsletter admits it
the user can subscribe an email address different than the one he is using on the site, sometimes
users with many email accounts want to deliver newsletters to a specific account instead of his main
email account.

insert graphic

Once subscribed the user will NOT receive the newsletter until he confirms his subscription. Tiki
will send the user email a message asking him to click a link to enable the subscription. This
prevents users or admins from spamming users by adding them to the newsletter.

4.13.1.2. Subscribing and unsubscribing

The emails that tiki send to newsletter users to confirm a subscription, welcome a user or say bye
bye are in the directory templates/mails, you can edit them as you want.

Once a subscription is confirmed the user will be able to unsubscribe by following a link that is
automatically sent when a newsletter is sent to the user.

4.13.2. Newsletters Admin

384 Back to TOC

 Tikiwiki Documentation 1.9+

4.13.2.1. Enabling the Newsletter Feature

Logged in as Admin, select Admin Home, and click on Features

Select the Newsletters checkbox and click on the Change Preferences button at the bottom of the
page. You should now see Newsletters as an item on your Application Menu, like this:

4.13.2.2. Creating newsletters

You can create a newsletter from clicking the Admin Newsletters link in the newsletters section of
the application menu. This opens the Admin Newsletters screen. Here's a view of that screen:

The options below the Newsletter name and description control how the newsletter is distributed.

Back to TOC 385

 Checkbox Effect
Users can subscribe/unsubscribe If this box is checked,users can subscribe and unsubscribe withour admin
to this list intervention. If it's not checked, the admin controls the subscriptions to this list.
Users can subscribe any email If this box is checked, the user can use any email address for their subscription. If
address it's not checked, the user must use the address from their Tiki user record
Add unsubscribe instructions to If this box is checked, a block of text with instructions on unsubscribing is included
each newsletter in each newsletter
If this box is checked, an email will be sent to each new subscriber containing a
Validate email addresses
special link that must be clicked to complete the subscription
If this is checked, you will be able to add a custom block of code that appears in
Allow customized text message
each newsletter. This can be used for marketing messages or other boilerplate text.

4.13.2.3. Changing Existing Newsletters

The area below the creation section shows a list of newsletters already created. The icons on the far
right allow you to change each newsletter's settings:
Change newsletter permissions
Edit Newsletter Information
Subscriptions
Send Newsletter
(insert icon here) Newsletter Archive

The screenshot above needs the archive icon added.

You can define templates for newsletters using the content templates system and then selecting the
template from the send newsletters screen.

The From name is defined by the field "Sender Email" in the admin panel.

4.13.3. Newsletter Details

Newsletters Technical Reference

Database Tables
MySQL
tiki_newsletters
tiki_newsletter_groups
tiki_newsletter_subscriptions
PHP Modules
tiki-admin_content_templates.php

386 Back to TOC

 Tikiwiki Documentation 1.9+

tiki-admin_include_features.php:
tiki-admin_newsletters.php
tiki-admin_newsletters.php
tiki-admin_newsletter_subscriptions.php
tiki-admin_quicktags.php
tiki-newsletter_archives.php
tiki-newsletters.php
tiki-send_newsletters.php
Templates

sent_newsletters.tpl
tiki-admin_calendars.tpl
tiki-admin_content_templates.tpl
tiki-admin_newsletters.tpl
tiki-admin_newsletter_subscriptions.tpl
tiki-calendar_calmode.tpl
tiki-newsletter_archives.tpl
tiki-newsletters.tpl
tiki-send_newsletters.tpl
Known Bugs

View Newsletter Bugs Here

Permissions
Permission Effect
tiki_p_admin_newsletters Can admin newsletters
tiki_p_batch_subscribe_email Can subscribe many e-mails at once (requires tiki_p_subscribe email)
tiki_p_send_newsletters Can send newsletters
tiki_p_subscribe_email Can subscribe any email to newsletters
tiki_p_subscribe_newsletters Can subscribe to newsletters

Development Roadmap

No changes planned at this time

External Links

Back to TOC 387

4.14. Ephemerides
Ephemerides are content that varies by date. They are used for several different purposes:
• Display a message that is only valid for a specific day. (Happy Birthday Bono!)
• Stage content so that something new appears on the site every day, or on specific days
• Countdowns to important events (Only 7 days left to register for the Installfest!)

Useful Links
http://en.wikipedia.org/wiki/EphemeridesWikipedia Definition

4.14.1. Ephemerides User

4.14.2. Ephemerides Admin

Default version 1.9

Ephemerides have been discontinued as of version 1.10.

4.14.3. Ephemerides Details

Ephemerides Technical Reference

Please leave this warning on all dev pages.

This page may not be complete. Please correct as needed

Database Tables

List all database tables here, with a listing for each database management system (MySQL,
PostgreSQL, Oracle, etc).
MySQL
PHP Modules

List all the php modules that have to do with the feature.
Templates

List all the templates that are used for this feature.
Known Bugs

Create a tracker search that filters on "feature" and then create a link here. This should create an up
to the minute list of bugs.

388 Back to TOC

 Tikiwiki Documentation 1.9+

Here's an example for "Forums"

View Forum Bugs Here

See Ephemerides Bugs Here

Permissions
Put a list of relevant permission settings here
Development Roadmap

Any planned changes to API, tables, or other key developer info about the feature can be left here.
External Links

Any external link that you think might be relevant to the feature goes here.

Back to TOC 389

4.15. Charts

Feature Overview

4.15.1. Charts User

4.15.2. Charts Admin

Charts

To administer Charts, go to Main Menu and click on the "Charts" ,"Charts Admin" submenu.

Charts Admin

Charts

4.15.2.1. Add or edit a chart

4.15.3. Charts Details

390 Back to TOC

 Tikiwiki Documentation 1.9+

4.16. Stats
Users with the tiki_p_view_stats permission can view several site statistics (stats) from the stats
screen, the stats section can be accessed from the main application menu.

4.16.1. Stats User

This screen will display a number of useful statistics for the site, including panels with statistics for
different sections of the site, since the stats screen will be enhanced in future versions of Tiki will
recommend you to examine your stats screen to check what stats are available in your installation.

Some more sections of the stats page could be like the ones in this example:

Back to TOC 391

And finally, there is a couple of table with the most viewed objects in total:

or in the last 7 days:

392 Back to TOC

 Tikiwiki Documentation 1.9+

There're some charts that can be displayed when you click on the "Usage chart" link at the bottom
of the page (which will open this page: tiki-stats.php?chart=usage):

Usage chart by sections:

And Daily Usage chart for all sections in global:

Back to TOC 393

4.16.2. Stats Admin

4.16.2.1. Site stats

They can be set at: "Admin home > Features > Administration Features > Stats", for the site
statistics.

4.16.2.2. Referer stats

There is the option to view the Referer stats, through "Admin > Referer stats" (which will lead you
to "tiki-referer_stats.php")

You will be able to see the domain from which the users came from when viewing your site:

394 Back to TOC

 Tikiwiki Documentation 1.9+

They can be set at: "Admin home > Features > Administration Features > Referer Stats", for the site
statistics (see previous figure in Stats Admin).

4.16.2.3. Search stats

If you enabled the Search feature, you can also enable the search statistics at "Admin home >
Search > Search features > Search stats".

See Search Stats for more information.

4.16.3. Stats Details

Back to TOC 395

4.17. Games
Tiki has a games section where users can play flash/shockwave games

Games downloadable from http://www.miniclip.com

Useful Links

These are sources of games that can be installed at the Tiki site:
• miniclip.com
• (coming)

4.17.1. Games User

The Games feature is found at tiki-list_games.php. Any site visitor/user can play games if the
tiki_p_play_games permission is given to the appropriate group.

There many games that you can play at.

To play, press the thumbnail image of the game from the list at "Games" in the main application
menu.

Admins can add new games from http://www. miniclip.com , and special interest have the
multiplayer games for Tiki col·laborative sites, to allow having some spare time among people of
the site community when they cannot meet in person as frequently as they wish:

396 Back to TOC

 Tikiwiki Documentation 1.9+

wish:

Several multiplayer games downloadable from http://www.miniclip.com

4.17.2. Games Admin

4.17.2.1. Activating the Games feature

The Games feature is activated on the Admin > Features page (tiki-admin.php?page=features). To
enable the feature, check (tick) the box for Games and click Change preferences.

As of Tiki 1.9.7, this feature hasn't been actively maintained and seems to have lost some
functionality as Tiki has evolved. Specifically, the web-based game upload form apparently doesn't
work properly, and the game description isn't saved or displayed. However, if games are uploaded
with ftp, the feature can be used normally except that there will be no description text for each
game. They have to be enabled from the admin screen.

The games section can be accessed from the application menu and it will display the available
games as in this screen:

Back to TOC 397

To administer Games, go to Main Menu and click on the "Games" menu.

4.17.2.2. Games configuration

There are no configuration options for this feature. Once it is activated and the necessary files
uploaded, it can be used.

Permissions
Permission to play games must be assigned. Like other Tiki permissions, access to the Games
feature is given on a group basis. To enable users to play the games, the appropriate permission —
tiki_p_play_games — must be given to a Tiki user group on the Admin > Groups page (tiki-
admingroups.php) (see Permissions). To allow a group to administer the Games feature, the
permission tiki_p_admin_games should be given to that group.

398 Back to TOC

 Tikiwiki Documentation 1.9+

4.17.2.3. Management of games

Users with permission to admin games can upload new games and remove games. (The game
description editing/uploading doesn't seem to work so should be ignored for now.) Tiki maintains
stats of the number of times each game is played and automatically displays games from the most-
played to the least-played. Games are stored in the "games" directory so users may download the
binary game if they want.

Adding new games

The upload screen (tiki-list_games.php?uploadform=1) seems to be nonfunctional at this time, so
games can be added to the site by uploading them directly to the games directory (ftp, etc.). For
each game there are normally three files: the binary (.swf), the description (.txt) and the thumbnail
(.gif or .jpg — .png not tested but may work). (Normally, if a description file isn't uploaded, it can
be edited later within Tiki, but as of Tiki 1.9.7, this edit isn't being saved.)

Upload screen previously used to add games (currently out of order):

You have to upload the game binary, a thumbnail and the description, the thumbnail must be named
as the game adding the image extension, for example if the game is foo.swf the thumbnail can be
foo.swf.png or foo.swf.gif.

Game and thumbnail file formats and upload directory locations

The upload form indicates "Flash binary (.sqf or .dcr)". The .sqf format is FreeMotion Flash Movie
(Namo Inc.), and .dcr is a Shockwave Movie (Macromedia Inc.) file. Maybe these were more
common when this feature was created, but .swf ( Macromedia Flash Movie) files work fine.

For a game named foo.swf:

• Copy/transfer foo.swf to games/flash/
• Copy/transfer foo.swf.gif or foo.swf.jpg to games/thumbs/
• Copy/transfer foo.swf.txt to games/thumbs/ (Not functional at this time so this step can be
skipped.)

Back to TOC 399

4.17.3. Games Details
Originally, miniclip.com provided game downloads as zip files that could be extracted and
uploaded/copied to the Tiki site. Now the web site user is instructed to copy HTML from
miniclip.com and paste it into his/her web page. This causes the game to load from miniclip.com.
The terms of use don't explicitly state that this method must be used, so it seems to be permissible
to read the HTML code for the .swf source, save the source file and associated thumbnail and so on,
and put them in the Tiki Games gallery as before.

You can also download prepared game packs containing the binaries, thumbnails and descriptions,
the tiki-game-pack1 can be downloaded as a Tiki add-on containing some nice flash games that
you can add directly to tiki by copying the contents of the games directory to your tiki games
directory.

Alternatively, there are other web sites that allow downloads of zipped Flash games, and these will
be added to the information here.

Known Bugs

http://dev.tikiwiki.org/tiki-index.php?page=Game
(Preliminary info — 1.9.7: The feature worked when the files were transferred with ftp to the
server. The game upload form didn't successfully transfer the files.)

Permissions

tiki_p_admin_games For games administration

tiki_p_play_games For playing games

References
• tiki-game-pack1 as a Tiki add-on:
http://downloads.sourceforge.net/tikiwiki/game-pack1.zip

External Links
• http://miniclip.com
• Other game sources coming

400 Back to TOC

 Tikiwiki Documentation 1.9+

4.18. Calendar
This feature is being re-written. New documentation is needed for 1.10

There are several time/date & calendar-related features:

• The Mini Calendar: MyTiki's personal calendar. A simple appointment list.

• The Calendar: Tiki's main calendar. This can display:

• The Tools Calendars which report system-created lists of changes/additions, such as

the creation or edit of a wiki page, upload of a file, including date and time, user, and
description. This requires the permission tiki_p_view_tiki_calendar.

• The Event Calendars which show user created information such as events or
appointments, and requires the permission tiki_p_view_calendar. Different calendars
can be created, with distinct permissions for each. It is also possible to setup a
Personal calendar here. This duplicates the mini-calendar feature but with integration
with the other calendars (so you can see in one view both your personal events and
the other events).

• The feature jscalendar adds a nifty date picker to Event Calendars. (and trackers)

Key Function and Sub-features

• Calendar tab provides view of appointments for a time period set by administrator
• Event tab allows for event scheduling

Related Links
• Calendar User
• Calendar Admin
• Calendar Details
• Tiki event management system

Back to TOC 401

4.18.1. Calendar User
The calendar is a feature-rich resource to help track site modifications as well as organize, and
collaborate with individuals & groups around the world using the user-friendly architecture of
TikiWiki. TikiWiki's Calendar feature makes use of practically all of the features you might find in
other web calendars, while also fully integrating the other features of TikiWiki such as categories,
wikis, blogs, galleries, and many others!

Depending on how the TikiWiki administrator has configured the TikiWiki site you're using, you
may be able to do some or all of the following:
• View a list of all available calendars on your TikiWiki site
• View a calendar
• Create a calendar
• Add a new event to a calendar
• Edit or delete a calendar event
• Print a calendar

The following sections explain how to perform these actions.

4.18.1.1. Navigating the Calendar

The navigation bar

• Viewing ___ date
• Today's date (jump to today in calendar)
• Zoom Level/Views

Calendar Navigation Bar

The Mini-Navigation Calendar

• ?
• x / clicking anywhere outside the mini-nav calendar
• << | >>
• <|>
• Today
• Week #
• Selecting the date you wish to view

402 Back to TOC

 Tikiwiki Documentation 1.9+

If you click on the focus date, and Js Calendar is enabled, then a pop up graphical navigator will
show up. See Js Calendar for more details.

4.18.1.2. Special Features

The Calendars Panel

Calendars Panel

The Events Panel (brief note)

Events Panel

Back to TOC 403

 The Hide tab

Zoom Levels/Views

Day
• Time
• Events
• Assigned tool calendar(s)
• Exact time
• Linked page name (if applicable)
• Who made the modification

404 Back to TOC

 Tikiwiki Documentation 1.9+

Day View

Week
• Date format
• Week #
• Days of the week
• Events
• Basic Information
• Meaning/Definition
• Assigned tool calendar(s)
• Linked page name (if applicable)

Week View - Basic Information

• Detail Information
• Meaning/Definition
• Exact time

Back to TOC 405

 • Assigned tool calendar(s)
• Event description
• Who made the modification

Week View - Detailed Information

406 Back to TOC

 Tikiwiki Documentation 1.9+

Month
• Date format
• Week #
• Days of the week

Month View

4.18.2. Calendar Admin

With administrative privileges, click Admin, then the Features icon. Under the Tiki Sections and
Features heading, find and check the Tiki Calendar checkbox, then save your changes. You now
should see a Calendar item when you expand the Admin menu.

4.18.2.1. Calendar settings

You can select the Calendar settings through the Main Application menu "Admin home > Calendar

(icon)" (which will lead you to tiki-admin.php?page=calendar)

Back to TOC 407

 4.18.2.2. Create or edit calendars

Click on "Admin > Calendar" to go to Calendar Admin (tiki-admin_calendars.php).

There are two sections (tables) to this screen:

408 Back to TOC

 Tikiwiki Documentation 1.9+

4.18.2.3. Assigning permissions

4.18.2.4. Personal calendar

The personal calendar is a calendar where an event is only visible by the user that creates it.
Physically it is a big unique calendar in the database that contains all the events. An event is
displayed only for his creator. A personal calendar has special perms that needs to be reserved to

Back to TOC 409

work correctly. The admin can choice a name for a personal calendar. You can have more than one
personal calendar.

4.18.2.5. Urls

• The url to display one calendar is

tiki-calendar.php?calIds[]=5, if 5 is the id of the calendar you want to display
• To display more than one calendar
tiki-calendar.php?calIds[]=5&calIds[]=1, if 5 and 1 are the calendar ids
• To display all the calendars (> tikiwiki1.10)
tiki-calendar.php?allCals=y

4.18.3. Calendar Details

Since Tiki 1.9.7, calendars also allow syndicating their content through RSS feeds.

4.18.4. Js Calendar
Js Calendar is a feature that, when enabled, allows using some pop up visual small calendar for
selecting dates in several places.

This feature is to make use of http://sourceforge.net/projects/jscalendar

410 Back to TOC

 Tikiwiki Documentation 1.9+

4.19. Workflow
Introduction and concepts
Galaxia is an “activity based” workflow. Workflow processes are implemented as a set of activities
that must be completed to achieve some result.
In Galaxia activities are represented as PHP scripts. Galaxia provides 3 big modules called:
“Process Manager”, “Process Controller” and “Workflow”.

Definitions

Process
A process is defined as a set of activities that must be done to achieve some goal. Business circuits
are mapped to processes to automate them. Process activities are connected using transitions
defining what has to be done after each activity is completed.

Activity
An activity is something that has to be done as a part of a process. In Galaxia activities are mapped
to PHP scripts so an activity can do anything that can be done from a PHP script.

Role
Activities are associated to roles defining who can perform activities. Roles are defined at a per-
process level.

Instance
An instance is a process being executed. An instance is created when a process is started and the
instance passes through the process activities until the process is terminated.

Workitem
When an activity is completed a workitem is added to the instance. Workitems thus represent
completed activities.

... see http://workflow.tikiwiki.org/ ...

4.19.1. Workflow User

Modules
The workflow engine contains 3 modules: The Process Manager, The User
Interface and the Process Monitor.
• Process Manager
• User interface
• Process Monitor

Back to TOC 411

Behind these modules is the “engine”, a set of PHP classes and scripts that execute the workflow
processes.
The Process Manager is used to map a business process to a workflow process. It is used to “
design” processes.
The User Interface presents a set of screens and interfaces to let users start a new instance of a
process, execute process activities, see what activities they have pending
and manage their workload.
The Process Monitor is used to track what the users are doing, what instances of what processes are
being executed and the status of each process in execution. It is used to “track” processes.

4.19.1.1. The Process Manager

The Process Manager (PM from now on) is used to design processes and make them available to
your users. A process can be very simple or very complex depending on the business process being
modeled. Galaxia processes can be used to map internal process in your company so they are
automated. They can also be used to extend TikiWiki? adding features particular to your
implementation.
The creation of a process can be divided in the following tasks:
• Creating a new process
• Editing process activities

• Editing and mapping process roles

• Editing process activity source code and templates

Creating a new process

Enter the Process Manager clicking on the “Admin processes” link from the Workflow section of
the application menu. You should have the tiki_p_admin_workflow permission to use this feature.

412 Back to TOC

 Tikiwiki Documentation 1.9+

You can create a new process in 3 different ways:

• Creating a new process from scratch
• Importing a process
• Branching an existing process

Creating a new process from scratch

Back to TOC 413

You can create a new process from scratch clicking the “new” link next to the form to edit a process
name and description. Enter a name for the process and a description, a new process will be created
with version 1.0.
Once the process is created you can edit its activities, roles and so. Note that upon creation the
process cannot be set to “active” because only valid processes can be “active” and a recently created
process is invalid.

Importing a process
The Workflow engine can be used to “export” a process to an XML file. This file will contain all
the process activities, transitions, roles and source code. You can then distribute the process in its
XML format so other applications can use it. You can upload a process using the import feature in
the process manager:

When a process is imported you will have to map the process roles to your site users/groups
depending on what users/groups will be able to execute the process activities on your site. Once
roles are mapped the process will be ready to use as it was in the installation where it was created.

Branching an existing process

Once you have a process created you can define new “versions” of the process. This can be useful
in many situations. If you want to change a process that is active you may need to create a new
version so you don’t make unexpected changes to process instances already in execution. You can
also “version” a process if you want to create a new process that will be very similar to an existing
process.
You can create a new version defining a new “major” version or “minor” version being the
difference how the new process version number is created.

414 Back to TOC

 Tikiwiki Documentation 1.9+

To change an active process:

1. Create a new version of the process.
2. Edit the new version
3. Make the old process “inactive”

4.19.1.2. Editing process activities

Once a process is created click on the “activities” link in the action menu to edit or create process
activities.

The activities manager is a module of the process manager used to edit or create activities. This is
the most important and crucial part of the process creation. You may want to design your process
using a tool like OpenOffice.org Draw before using this tool to define your process.
The activity editor screen should be similar to the following one:

Back to TOC 415

416 Back to TOC
 Tikiwiki Documentation 1.9+

The screen is divided in different sections that will be explained in detail:

• The process toolbar
• The add/edit activity form
• The activity listing
• The transition listing and form

4.19.1.3. The process toolbar

The process toolbar can be used to quickly jump to different modules of the Process Manager. The
icons are explained below:
Icon Meaning
Invalid process. This icon indicates that the process is invalid. A list of errors will be displayed at the top of the
screen.
Configure activities. The activity manager for the process.
Process code. Used to edit the source code and display template of the activities.
Process graph. Used to display the current graph of the process. Whenever you add, edit or remove activities
and/or transitions, the graph is updated accordingly.
Process roles. Used to define roles and map users to roles for this process.

Back to TOC 417

 Icon Meaning
Admin processes. Goes to the admin processes screen where you can edit the process name and description.
Save process. Exports the whole process as an XML file.
Monitor processes.
Monitor activities.
Monitor instances.

When the process is valid (i.e. contains no errors), the following icons are also available:
Icon Meaning
Valid process. This icon indicates that the process is valid.
Stop process. If the process is active you can use this icon to “stop” the process. Once stopped no new instances
of the process can be created. Already created instances will remain in execution.
Activate process. If the process is valid but the process is not active, this icon will be displayed. Click it to
activate the process.

4.19.1.4. The add/edit activity form

This form is where you can edit process activities or add new activities to the process. You have to
select the activity name and a description for the activity. Then select the activity type, select if the
activity is interactive and select if the activity is auto-routed.

Tip: Use the link to the process graph ( ) frequently to display the graph of your process and check

418 Back to TOC

 Tikiwiki Documentation 1.9+

if the activites are correctly linked.

The next boxes can be used to add transitions from existing activities to the activity being
edited/created and to create transitions from the activity being edited/created to existint activities.
Then you can define roles for the activity adding already existing roles or create a new role. Later
roles will have to be mapped using the admin roles module.

4.19.1.5. The activity listing

This section lists your process activities. You can use the filter bar at the top to select the activities
that you want to see.
Activities are displayed in “flow” order from the start activity to the end activity. You can re-sort by
other fields clicking on the column titles.
This listing can be used to set if activities are interactive or automatic and if activities are auto-
routed or manually routed, just set the checkboxes accordingly and press the update button at the
bottom of the listing. Activities can be removed marking the activities with the checkboxes on the
left and the pressing the “x” button.

4.19.1.6. The transition listing and form

The last section of the activity manager shows the list of transitions for the process. You can
remove transitions using the checkboxes and the “x” button.
You can also add transitions selecting the From and To activities and clicking the “add” button. As
you can see there is more than one way to add transitions or remove transitions from/to activites.

Back to TOC 419

 4.19.1.7. Understanding activities

The table below describes the several activity types available in Galaxia.
Inbound Outbound
Icon Type Description
Transitions Transitions
The start activity. A process must have at least one start
activity, and can have two or more. Start activities can be
executed without the presence of an instance of the process
Start 0 1
because start activities create a new process instance. Start
activities are usually interactive and require some kind of
user input to start a new process.
The end activity terminates a process instance. All the
processes must have one and only one end activity. The end
activity should be reachable from the start activity. Make
End N 0
sure all your process “paths” of execution lead to the end
activity or you will have “dangling” instances of your
processes.
A normal activity. Used to perform a tasks. It can be
Activity N 1
interactive or automatic.
A switch activity is like a normal activity, but can be used to
send the process instance to different activities depending on
some condition. This type of activity is used to choose
Switch N N
alternate paths of execution in a given instance (i.e. If
condition “a” is true then go to activity “x”, else go to
activity “y”).
A standalone activity can be executed without the presence of
a process instance. Standalone activities are used to model
Standalone activities independent of the process flow (e.g. queries and 0 0
tracking). You can even create a process featuring only
standalone activities.
A split activity is used to send an instance to two or more
different activities in parallel. If your process features
Split N N
activities that can be executed in parallel then you can use a
split activity.
Join A join activity is used to re-group an instances that has been N 1
split by a split activity. When an instance reaches a join
activity, the engine checks if the instance is still running

420 Back to TOC

 Tikiwiki Documentation 1.9+

Inbound Outbound
Icon Type Description
Transitions Transitions
other preceding activities. If this is the case, the instance will
wait for the other activities to be completed and only then
make the join activity available.

Note: When an activity is interactive the icon is displayed in a blue-grey background. Automatic
activities have a light-grey background. In the process graph interactive activities are displayed
using a blue border. Automatic activities have a black border.

Interactiveness
Activities can be either interactive or automatic. Interactive actvities require some kind of user
interaction, normally a form is presented to the user and the user can fill/change values submitting
the form as many times as needed until the activity decides that the activity is completed. Automatic
activites don't require user interaction and are executed by the workflow engine.
Note: In order for Galaxia to run automatic activities, PHP needs to have the allow_url_fopen
directive in PHP.INI set to On.

AutoRouting
An activity can be routed automatically (auto-routed) or manually. When an activity is auto-routed
instances are automatically sent to the next activity in the process once the activity is completed. If
the actvity is not auto-routed a user will have to manually “send” the instance to make the instance
flow to the next activity.

4.19.1.8. Editing and mapping process roles

The Role Manager is the module of the process manager used to admin process roles and map roles
to tiki users or groups. The role manager screen is similar to the following one:

Back to TOC 421

The screen can be divided in sections that will be explained next:
• Role editing and listing
• Role mapping and listing

Role editing and listing

The first section of the Role Manager module can be used to add new roles to the process, edit
existing roles names and descriptions and remove roles as needed. Please note that roles are defined
per-process. The “user” role can be absolutely different in Process A and Process B.

422 Back to TOC

 Tikiwiki Documentation 1.9+

Role mapping and listing

In the first section you can map user to roles you can select many users and many roles and all the
mappings will be executed. So you can use it to map a user to many roles, a role to many users or
many roles to many users at the same time. Next you can add or remove all the users in any tiki
group to some role, this can be used to “batch” map users in a group to some role. Note that roles
are mapped to individual users not groups, this is different to tiki permissions that are handled at
group levels.
The last section of the screen lists all the mappings defined, you can filter the list and remove
mappings if you want.
Note: in this example, we added the role "user".

Back to TOC 423

 Understanding roles
Roles are used in processes to control who can do what. Roles provide an abstract representation of
what users will be able to execute process activities. Since user names and even group names can be
very different in different Tiki installations, roles are used to abstract permission to execute process
activities so processes can be shared in different Tiki installations just by remapping the process
roles.
Roles can also be used to control what each activity can do, since special variables will be created
to indicate if the user executing some activity is mapped or not to some role. You can for example
let roles “a” and “b” execute some activity but only users with role “b” can see some information.

4.19.1.9. Editing process activity source code and templates

424 Back to TOC

 Tikiwiki Documentation 1.9+

Introduction

The workflow engine maps activities to PHP scripts. This is where the power of the engine resides.
An activity can do anything that a PHP script can do. Usually you can design processes without a
deep knowledge of PHP, creating forms to interact with the user and setting “instance” properties
depending on those values.

Interactive activities and automatic activities

When editing activities code there is a very important distinction between automatic activities and
interactive activities. Automatic activities are represented by a PHP script only, whereas interactive
activities are represented by a PHP script and a Smarty template. The PHP script provides the logic,
and the Smarty template provides the presentation.
When coding interactive activities you should not output anything from the PHP script. Instead,
assign whatever you want to display to Smarty template variables and then display the variables in
the template. The template will also contain all the forms, tables and other HTML elements that you
want to use. We’ll see examples in a few paragraphs.

Example: A simple interactive activity and its template

<?php
if (isset($_REQUEST['save'])) {
$instance->set('name', $_REQUEST['name'];
$instance->complete();
}
?>

PHP code
<form method=”post”>
Name: <input type=”text” name=”name” />
<input type=”submit” name=”save” value=”save” />
</form>

Smarty template

The Instance object

When coding the PHP code for any activity you can use the $instance object to get/set instance
properties and other important actvities related to the instance. The most relevant method of the
$instance object are listed next. If you want to get a deeper understanding of a methods, please read
the PHP source for the class for a complete description of its usage.
Method Description
get($property) Gets the value of an instance property.
set($property, $value) Sets the value for an instance property.
For interactive activities only. Declares the activity as completed. If the activity is
complete()
autorouted the engine will route the instance to the next activity automatically.
setStatus($status) Sets the status of the instance. Possible values are 'active', 'aborted' and 'exception'.

Back to TOC 425

 Method Description

setNextActivity($
Indicates the name of the next activity to be executed. This is needed in switch activities.
activity_name)
Indicates the name of a user to assign the instance to. The next activity must be
setNextUser($user)
performed by the indicated user.

Instance properties
Instances are processes in execution. They have “properties” that you can “get” and “set” in process
activities. This is how you can pass information from one activity to another one. A typical way to
code activities is to present a form and then set instance properties based on the form values. The
following activities can “display” or “get” properties to perform some action.

Switch actvities
In a switch activity, the activity must decide the next activity for the instance because there is more
than one possible path of execution. This is generally decided examining the instance properties
and/or user input if the switch activity is interactive. In order to set the next activity the method
setNextActivity($actName) must be used indicating the name of the next activity.

Example
<?php
if ($_REQUEST['amount'] > 1000) {
$instance->setNextActivity('approve loan');
} else {
$instance->setNextActivity('process loan');
}
// We use complete() because this was interactive
$instance->complete();
?>

4.19.1.10. Roles

Roles are used to determine who can execute an activity. When the process is defined one or more
roles must be asociated with interactive activities. To make the process valid, an administrator has
to map process roles to Tiki users using the role manager tool. When an instance enters an activity,
the engine checks the roles that are associated to the activity. If there is only one user that can
execute the activity the engine assigns that user as the “activity user” and only he will see the
instance in his User Interface. If there’s more than one user allowed to execute the activity the
engine will show the instance to all the users that can execute the activity, a user can then “grab” an
instance so only he can execute the activity, if the user can’t complete the activity he can “release”
the instance so other user with the proper role can execute the activity. Note that executing the
activity automatically “grabs” the instance but the instance can also be grabbed first and the activity
executed later.

426 Back to TOC

 Tikiwiki Documentation 1.9+

4.19.1.11. Setting the instance user for the next activity

The instance object has a method to let an activity determine who will be assigned to execute the
next activity.
<?php
$instance->setNextUser('john');
?>

In the example we are indicating that the next activity can only be executed by the user ‘john’.

4.19.1.12. The User Interface

The User Interface (UI) is used by the users to launch new instances of processes and execute
process activities of existing instances.
Enter the UI by clicking the “User processes” link from the Workflow section of the application
menu:

In this screen you will see process that he user can start or where the user has pending activities to
execute. In this example the “CD loans” process that will be created in one of the tutorials is used as
an example. Clicking the process name will
take you to the “User activities” view.

Back to TOC 427

In this screen you can see activities of the “CD loans” process and the instances present in each
activity. The activities with an arrow can be executed without an instance present (the start activity
and a standalone activity). The “approve loan” activity can be clicked to display instances in this
activity. The “User instances” screen is as follows:

The buttons are explained as follows:

Icon Meaning
Declare the instance in “Exception status”
Execute activity. When the user executes a start activity, she will be prompted to supply an alphanumeric name,
like "Request CD 1", for the instance.
Abort the instance.
“Grab” the instance. Assigns the execution of the instance in this activity to the user.

428 Back to TOC

 Tikiwiki Documentation 1.9+

Icon Meaning
“Release” the instance. Lets other users execute this activity for the instance.

4.19.1.13. The Process Monitor

The Process Monitor is used to track what the users are doing, what instances of what processes are
being executed and the status of each process in execution. It is used to “track” processes.
To get a general view of how each process is doing, click the “Monitor processes” link in the
Workflow section of the application menu. You will see how many activities a process contains,
whether the process is activated and valid, and the most important: how many instances of the
process are running and in what state they are.

Click the number of activities on the “Activities” column to see the data about activities that belong
to a particular process:

Back to TOC 429

When you want to see the details about a particular instance, click the “Monitor instances” link.
You will be presented with a list of all instances and the relevant data about them.

Click the Id or Name of an instance to see its details.

430 Back to TOC

 Tikiwiki Documentation 1.9+

The buttons are explained as follows:

Icon Meaning
Takes you to the Monitor Processes screen.
Takes you to the Monitor Activities screen.

Back to TOC 431

 Icon Meaning
Takes you to the Monitor Instances screen.
Takes you to the Monitor Workitems screen.

In this screen you can rename the instance, change its status, owner, and send it to an arbitrary
activity. You can also edit the value of existing instance properties, and add new properties.
When you manually send the process to an activity, the history is lost. Do this only when absolutely
necessary.

Click a particular activity in the history to see its details.

To see details about all workitems from all instances, click the Monitor Workitems icon ( ):

432 Back to TOC

 Tikiwiki Documentation 1.9+

4.19.1.14. Summary

This document is the official manual to Galaxia, a PHP-based workflow engine that can be used in
any PHP project and will be initially released with modules created for Tiki. Galaxia can be used to
create new "features" in any PHP application defining processes, where all the activities related to
the feature are grouped. If necesary, Galaxia can define the flow of activities for some process
allowing the definition of "Workflows". The flexibility and extensibility of the engine open a lot of
interesting new areas to any PHP project using this product.

4.19.1.15. Acknowledgements

• Galaxia is based on OpenFlow

• Marc Laporte? was the first member of the Tiki team to suggest adding a Workflow engine
to Tiki.
• This wikified version was originally a copy/paste from the PDF Galaxia introduction on
SourceForge. This document was originally produced by Garland Foster, Richard Moore
and Eduardo Polidor, and edited by Georger Araujo to be included in workflow.tw.o.

4.19.2. Workflow Admin

4.19.3. Workflow Details

Back to TOC 433

4.20. Integrator
Some screenshots are needed

Overview
Tiki Integrator is a feature to allow easy integration of third party pages into the Tiki (with look
and theme of Tiki page). Integrator may have several repositories. 'Repository' is just a path on the
local filesystem where a set of files is stored. The files can be stored in the Tiki file gallery. These
files will be processed later by integrator's rules. Such rules usually do two actions:
1. remove all before HTML <BODY> and after </BODY> tags
2. fix hyperlinks and reference to images so they will point to the Tiki Integrator wrapper to be
correctly displayed from inside Tiki Integrator does not do it by itself — all rules and
repositories must be configured by admin. To process the file (note that it works with local
HTML files by opening and processing them) just apply configuration rules for a given
repository and insert the result inside tiki-center div to integrate a page into tiki.

inser graphic

Origins of this idea

Originally this feature was developed to access and view doxygened pages from inside Tiki. After
some time, the following idea came into my head... :) As many other programmers I have a lot of
repositories (directories) with third party documentation (usually static *.html files) which I need to
have fast access to from one point — my intranet Tiki site which is used as a team groupware tool.
So Tiki Integrator should help me to do this :)

For more information...

Please go to http://tikiwiki.org/tiki-index.php?page=TikiIntegrator for more information.

4.20.1. Integrator User

Some screenshots would be very welcome here....

4.20.1.1. How to use Integrator

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

1. at first you need to produce it (:razz:) and to put it into your document root... let it be
/var/www/html/mydoxydoc. Also consider to fix background of generated pictures — to
make it transparent (not all themes in Tiki have white background). :) You may do this by
one simple command:
cd /var/www/html/mydoxydoc;
find . -name '*.png' -exec convert -transparent '#FFFFFF' '{}' '{}' ';'

434 Back to TOC

 Tikiwiki Documentation 1.9+

As you may noticed, ImageMagick needs to be installed on your system.

2. Next you need to define the repository using Admin tool . Specify the following
[-]
• Name — name of your repository. Type My Doxygened Documentation
3. Path — type /mydoxydoc
4. Start Page — index.html (In case of remote files/scripts here should be file name with
parameters: tiki-index.php?page=TikiIntegrator for example)
5. CSS File — doxygen.css. Currently only Notheme series themes have redefined styles for
doxygened docs. All others use little adopted default (got from doxygen) CSS. Tiki
Integrator search CSSes in the following way:
• directories to scan
[-]
1. $tiki_root/styles/$style_base
6. $tiki_root/styles/integrator
7. configured repository path
• files to search for in every directory (for example assume that current theme
is Matrix (matrix.css) and configured repository CSS file is doxygen.css:
[-]
1. matrix-doxygen.css
8. matrix.doxygen.css
9. matrix_doxygen.css
10.doxygen-matrix.css
11.doxygen.matrix.css
12.doxygen_matrix.css
13.doxygen.css
• Check Visibility box
14.Type something in Description — for example Doxygened documentation for my MEGA-
Project :)
15.Press Save
16.OK your first repository has been created. Now it's time to define some integration rules.
Click on your repository in the table below ...
17.... and on the new page (Edit Rules for Repository) press copy rules link...
[-]
• Currently only 'Notheme' themes have rules copying dialog hidden by default, in
other themes no need to press/click something here — dialog is already visible... but
in author's plans it should be hidden :)
18.Choose Doxygened (1.3.4) Documentation and press the Copy button
• here is a small cheat: by default (just after install) Tiki Integrator already has rules
for doxygened repositories (as most usual type of programmer documentation)... in
other cases you will need to make such rules for your repository by yourself... but
fortunately it is easier than you may think :)
19.Press/click view repository and enjoy :)
• it's recommended to use one of the Notheme themes :)
20.... also you may ask the author of your preferred theme to provide doxygen.css file too :)

Back to TOC 435

4.20.2. Integrator Admin
This is a kind of stub

Those are the features of Integrator feature, from an admin poit of view:
• Easy rules copying among repositories
• Every rule may be enabled/disabled
• Predefined set of rules for doxygened documentation (just copy it into your repository :)
• Rule preview — allows to play with rules and see results
• HTML code view panel
• Results view panel
• Can intergate remote pages (http(s)://...). This will allow also to integrate locally located
scripts (i.e. they should get interpreted by web server before processed by wrapper)
• Special meta-variables, I don't know how to name this (:rolleyes:), may be used in replace
field
• {repID} — ID of current repository (very helpful for links fixing :)
• {path} — path of configured repository (very helpful for images/scripts fixing :)
• Intergated pages can be cached. This helps to avoid processing repository pages each time
they accessed, after 1st touch page will be cached and used all next times. Sometimes it
helps to reduce CPU load at processing pages... UserPagemose hopes that it will help him :)
• Allow to refresh individual pages
• Admin can clear whole repository cache
• It also clear automaticaly on rules change or repository removing
• Per-repository cache timeouts — useful when repository periodicaly regenerated.
Typical usage: web stats of any kind or doxygened API documentation of highly
active project (like Tiki :)
• ... so the best value of cache expiration will be regeneration interval in
seconds :)
• Tiki Integrator utilize cache related functions of TikiLib MEGA-class but, do not
call refresh_cache() (this method also used in cache control admin panel) for
integrataed pages! URLs associated with cached data actualy can't be accessed for
that data by that methods! — Use refresh button below of integrated page or clear
cache link on repository edit form.
• You may see integrator in action here: http://tikiwiki.org/tiki-list_integrator_repositories.php

4.20.3. Integrator Details

Requirements
1. In php.ini track_errors should be On to be able to show integration error messages in a
convenient way ($php_errormsg PHP variable used).
;Store the last error/warning message in $php_errormsg (boolean).
track_errors = On

2. tiki_p_view_integrator (see general permissions) needed to view configured

436 Back to TOC

 Tikiwiki Documentation 1.9+

repositories
3. tiki_p_admin_integrator (see general permissions) needed to configure
repositories and rules

Back to TOC 437

4.21. Categories
General Description
Categories are a way to classify Tiki objects, including blogs, image galleries, articles, polls,
forums, wiki pages, file galleries.

For categories in use at doc.tikiwiki.org see Documentation Categories

Those with appropriate permissions can define an unlimited, hierarchically organized set of
categories which can function like a table of contents for the whole site. Any Tiki object can then be
added to one or many categories.

Users can then browse by category. Depending on the settings, category listings can be displayed in
a side module, above or below the content.

Permissions can be applied to categories so that objects in a certain category can only be seen by
designated user groups.Applying permissions to categories is relatively new to tikiwiki, and in the
process of documenting these pages, i'm going to find out all you need to know about that. :)

By changing the theme from one category to the next it is possible to create visually distinct
"zones" in a tikiwiki site.
NB: Categories are only one way Tikiwiki sorts content. other means include:
Structure - are similar to and mostly replaced by categories, but still exist as a feature.
Topics? - are like categories specific to the articles feature.
Module - are the customizable boxes on the left and right of the main content area in tikiwiki, that
can hold content that stays the same as users navigate the site.
Menus? - are usually placed in modules and are a separate feature from categories. (although you
can get categories to display as a menu using plugins)

Key Functioning and sub-features

• Organize categories in a tree hierarchy with unlimited subcategories.
• Assign objects to one or many categories
• Administrators can apply different permissions to different categories.
• Administrators can apply different themes to different categories.
• Deep search into subcategories from the category browser

Related Plugins
• PluginCategory? - creates a table of contents using categories.
• PluginCatpath? - creates a "breadcrumbs" trail
• PluginCatorphans? - displays uncategorized pages.
• PluginFolksonomy? - ??

Related Links

438 Back to TOC

 Tikiwiki Documentation 1.9+

• Category User - explains how to navigate and search categories

• Category Admin - how to set up categories, and apply themes and permissions
• Categories Details - plugins, tweaks and other technical details.

4.21.1. Categories User

The use of categories in Tikiwiki will vary a lot from site to site. Some sites will use categories
invisibly to show or hide content from specific groups of users. Others will use categories more like
a catalog or index of content.

To use categories, look for a categories entry in the side menu.

This should take you to a page where you can search for categories or content within a category.

Back to TOC 439

Using a deep search does something, i don't know what exactly. :)

Many sites use the "breadcrumbs" plugin to tell you where you are at in the category tree at all
times.

Depending on your permissions you may be asked to help sort pages into categories. When given
the opportunity, be bold and apply the categories you think are appropriate to the page. In most
wikis, categorizing content (not to mention writing it!) is a collaborative effort.

440 Back to TOC

 Tikiwiki Documentation 1.9+

In some sites users will be able to administer categories, by creating them, adding or removing
objects from any specific category.

You can assign many objects at once to a category by using the filter to do a quick search on the
entire list of pages, and then using CONTROL-CLICK (or the mac equivalent) to select a whole
bunch of items from a list. Many sites will use naming conventions? in naming objects or wiki
pages so that related pages will all include the same term in their titles.

When administering categories, be careful not to delete objects entirely rather than just remove
them from a category. Some older versions of Tikiwiki are rather confusing about this. When in
doubt, leave removing/deleting to the administrators. It is possible that careless application of
permissions will enable users to delete whole sections of content.

Back to TOC 441

Adding objects to categories is always safe. Tikiwiki sorts objects by type on this category admin
screen. Wiki pages and articles can often by added to categories from the edit view.

4.21.2. Categories Admin

By administering categories in tikiwiki you can manage large sites with a lot of content being
created on the fly, and make navigation and indexing much easier.

Category can also be used together with permissions to hide objects/pages from specific groups of
users, creating "private" areas that may even look different from the rest of the site.

Tikiwiki is feature rich, and many features overlap, especially when it comes to how many ways
you can orgainze content. In designing a tikiwiki site you have to decide early what kind of
navigation? is most appropriate and then use menus?, hyperlinks, topics?, structures? and themes?
accordingly.
How do you organize your content? A self test:
Are you building a knowledge base with a more or less permanent table of contents? - use
categories.

Are you collaboratively writing documents that need to be viewed in order, or published as a hard
copy (PDF) - use structures?.

Are you hosting discussions, blogs or forums where topics tend to come and go a lot? - use regular
hypertext and wiki links, rather than getting bogged down in creating heirarchies that nobody will
care about tommorrow.

442 Back to TOC

 Tikiwiki Documentation 1.9+

Are you creating objects/pages that a time sensitive status - use trackers.

Are you using Tikiwiki with multiple groups who need access to separate or private areas? - use
structures or groups

4.21.2.1. Creating categories and sub-categories

You can reach administration of categories through "Admin -> Categories" at the main menu.

Then, you can add a new category at top level (for instance: "Status").

Note that you have "Assign permissions automatically: (recommended for best performance)".
Leave it toggled on, for the time being, if you are not sure.

If you click on a pre-existent category (for instance, in the newly created Status category), you'll be
ready to add subcategories to it.

You should see the path to the category you are in, like "Current Category: Top :: Status", in this
case:

Then, you can add a new category (for instance: "1. To Do"), as a child of the parent category

Back to TOC 443

("Status") selected.

Once created, if you click on the the ">>>" at the right of "Status" category, you could see the child
categories below:

After some work, you could have something like:

But imagine that you would like that all content is readable only by registered users of your site,
and only the content categorized as "7.Validated" is readable by anonymous. You could achieve
that using category permissions (see following section).

4.21.2.2. Assigning permissions to categories

Basic functioning
To assign permissions to a category, go to tiki-admin_categories.php and click the appropriate key
icon, which will send you to tiki-categpermissions.php. tiki-categpermissions looks and works very
much like tiki-pagepermissions.php.

The current category permission system follows the following rules.

1. Category are considered objects, just like wiki pages and forums, etc.
2. Permissions assigned to children objects take precedence over permissions assigned to
parent objects.
3. If no permissions are assigned to an object, the permissions assigned to the closest ancestor

444 Back to TOC

 Tikiwiki Documentation 1.9+

object takes precedence.

4. If no permissions are assigned to an object and any of its ancestor objects, the global
permission is considered.
5. In the case where an object belongs to multiple categories, the better-safe-than-sorry
approach is taken. If a user lacks a given permission regarding a particular category, that
category takes precedence when considering if user has that permission.

Example
Following with the example in Categories Admin?, we need to click on the green key ( ) icon at
the left of "Status" category:

which could show as something like:

As stated in the cited example, we want to remove from the anonymous group the permission to
view the category content from all the "Status" subcategories. The easiest way is to click on
"(remove from this category & all its children)":
group permission action
tiki_p_view_categor (remove from this category & all its children) (remove from
Anonymous
ies this category only)

Back to TOC 445

(...)

You might need to confirm the action, depending on your configuration, to end up with a table like
this:

Then, you can go back to "Admin categories", click on the ">>>" sign at the right of Status
category, and click on the green key ( ) at the left of 7. validated (see image above, if needed).
There we can add the permission tiki_p_view_categories for the anonymous group to read the
content from that category, through clicking on "this category only" (or add the permission to that
category and its children using the other button, if we had some child categories inside, and we
would wish to do so).

That's it. :-)

Note that if there is no permission assigned to a category, you will see the yellow key ( ) icon next
to it.

4.21.2.3. Adding content to categories

You can add content to the categories from editting an object itself (see Category User), on a edit an
object by object basis, or in a centralized procedure from "Admin -> Categories".

446 Back to TOC

 Tikiwiki Documentation 1.9+

For instance, we can add some content to the category "1. To Do", from the example above. We can
click on the category name in the list, and we would see the objects which are already assigned to
this category (no one in this example), and add new (existent) objects to this category:

After adding some objects, you will see them listed on the box "Objects in category 1. To Do":

4.21.2.4. Applying themes to categories.

You can assign a basic theme style for you tiki site, but select some other theme site (such a
customized them style similar to the previous but columnless, for instance) for specific objects in

Back to TOC 447

your tiki, or for specific categories. This way you might have, for instance, a homepage without
columns, and after clicking on some links, keep browsing your site with some column/s on the
side/s.

To enable this feature, you need to toggle it on as all the rest of fetures at "Admin -> Features".

The rest of information about how to use this feature can be read at its specific documentation page:
Theme Control
Related documentation pages
• Category
• Category User
• Categories Details

4.21.3. Categories Details

Permissions
Perm Name Default Level Description
tiki_p_admin_categories editors Can admin categories
tiki_p_view_categories registered Can browse categories

Preferences
Pref name in default
comment
tiki_preferences table value
feature_categories
Show Category Objects (displays the objects in the categories in which
feature_categoryobjects
objects of some types are categorized)
Show Category Path (displays the categories in which objects of some
feature_categorypath
types are categorized)

Modules
module name usage

448 Back to TOC

 Tikiwiki Documentation 1.9+

Displays the last objects categorized in the category with specified id, and of default type (default
last_category_o
type is not anything, but Wiki page). The actually displayed objects (and their order) may be
bjects
incorrect if some were progressively categorized in multiple categories.

Files used
Main files categorize.php
templates/categorize.tpl
categorize_list.php
tiki-browse_categories.php
templates/tiki-browse_categories.tpl
tiki-categpermissions.php
templates/tiki-categpermissions.tpl

Admin tiki-admin_categories.php
templates/tiki-admin-categories.tpl

Libs lib/categories/categlib.php
lib/tree/tree.php
lib/tree/categ_admin_tree.php
lib/tree/categ_browse_tree.php

Modules modules/mod-last_category_objects.php
templates/modules/mod-last_category_objects.tpl

Plugins lib/wiki-plugins/wikiplugin_category.php

Database
Table Usage
tiki_categories Categories and information about them (name description, parent, hits)
tiki_categorized_obje Categorized objects (type, objId, description, created (date representing the last time the object
cts was not categorized), date, href (URL to access the object), hits)
Categories (categId) in which categorized objects are categorized. Used with
tiki_category_objects
tiki_categorized_objects with common field catObjectId

Back to TOC 449

4.22. Banners
Banners are a common way for advertisements and notices to be displayed on a Web page. Because
they are a great way to generate traffic, many commercial sites, community sites, blogs, e-zines and
others use and interchange banners with other sites to increase the number of visitors and page
views at their sites. And they are an eye-catching way to make announcements to site users.

The Tiki banners system supports image and HTML banners (used in banner exchange sites) and
text ads. Banners are assigned to "zones" created for the purpose in the Tiki site. There are many
configuration options for banners — such as maximum number of impressions, days of the week
for banner display, hours, etc. Banner clients are selected from the Tiki site's registered users, who
can view banners assigned to them accessing a page where banner stats are displayed. Including
banners in Tiki is easy — using a very simple syntax in any template or user module.

4.22.1. Banners User

Advertising banners are created and activated by the site administrator, so for the non-admin Tiki
site user, normally the only interaction is to view the banners being displayed and click on them if
desired to visit the linked-to web site.

However, the "client" of each Tiki banner is selected from the list of registered site users. The client
can view the banners assigned to him/her by accessing the banner stats page (tiki-list_banners.php).

The site admins should be contacted regarding any requests or comments about banner ads on the
site.

4.22.2. Banners Admin

4.22.2.1. Banner Zones

A banner zone is a defined area in which to display a specific banner. You can define as many
banner zones as needed for your site, then have different banners appear in each zone. For example,
a typical site might have three banner zones:
• A top zone, to display a banner ad at the top of every page
• A side zone, to display an ad in the left column
• A bottom zone, to display another banner at the bottom of the page

4.22.2.2. Creating a banner zone

Before creating a new banner, you must have a banner zone in which to place the banner.

To create a new banner zone:

450 Back to TOC

 Tikiwiki Documentation 1.9+

1. From the Admin menu, click Banners. The Banner page appears, showing the current
banners.
2. Click Create banner to create a new banner zone. The Edit or Create Banner page appears.
3. In the Create Zone field, type a name for the new banner zone (such as TopZone) and click
Create Zone.

4. Tiki adds the new banner zone to the list of existing zones (at the bottom of the page).

Now that you have a banner zone, you're ready to create the actual banner.

4.22.2.3. Banner Types

Tiki can create the following types of banners:

• HTML — Complete HTML/XHTML code of the banner. For example, if you belong to a
banner exchange, you may receive a code snippet to display the banner.
Note: Including a link (<A HREF...>) as part of your HTML will override the banner's
URL to link field.
• Image — You can upload any image (PNG, BMP, or GIF) to be used as the banner.
• Fixed URL — You can link to a banner from a hosted location. For example, if you belong
to a banner exchange that provides dynamic banners, you may have a URL to use (such as
http://bannerserver/mybanner?id=foo).
• Text-- A simple text-only ad. The text will be formatted using the bannertext CSS style.

4.22.2.4. Creating Banner

To create a new banner:

1. From the Admin menu, click Banners. The Banner page appears, showing the current

Back to TOC 451

 banners.
2. Click Create banner to create a new banner. The Edit or Create Banner page appears.

3. Use this table to complete each field on the page:

Field Description
The fully qualified URL click-through for the banner, such as http://www.tikiwiki.org.
The URL will open in a new browser window. If blank, the banner will not be clickable.
URL to link the Notes: If you select an HTML banner type, you must include the URL in the HTML code
banner — not in this field. To track banner clicks, use:
banner_click.php?id=XX&url=http://www.tikiwiki.org, where XX is the banner ID.
The banner ID is shown on the Banner page.
Select a username as the "client" for this banner. Clients can display the stats for a
Client
specific banner.
The maximum number of times the banner will be displayed (default 1000). After
Max impressions reaching this number, the banner will no longer display.
Hint: If you're site has lots of traffic, increase this number.
Select the zone in which to display the banner. To create a new zone, in the Create Zone
Zone
field, type a name for the new banner zone and click Create Zone.

452 Back to TOC

 Tikiwiki Documentation 1.9+

Field Description
To automatically turn this banner on and off at a specific date, select the Use dates option
and then select a From and To date. For example, you can create a banner to display only
Show between
for a specific holiday or event.
dates
If you do not select the Use dates option, the banner will be shown immediately, and
continue to be shown until the Max impressions.
Show between Select the time of the day that the banner will display. By default, the banner will display
hours 24-hours-a-day.
Select the specific days of the week that the banner will display. By default, the banner
Show only on will appear 7-days-a-week. For example, you can create a banner to display only on
weekends.
Banner method Select a banner type: HTML, Image, URL, or Text.
4. Click Save the banner.

Now that you have created a banner and assigned it to a zone, you're ready to display it.

4.22.2.5. Displaying Banner

To display a banner on your Tiki you simply add the following code {banner zone=XXXXX}
(where XXXXX is the name of the banner zone) to:
• A Tiki template (TPL) file
• A module

For example:
• To have a banner appear at the top of every page, add the banner zone to the header.tpl file:
<body {if $user_dbl eq 'y' and $dblclickedit eq 'y' and $tiki_p_edit eq
'y'}...
...
{banner zone=TopZone}
...

• To have a banner appear in the left column:

1. Create a new module.
• Add the banner zone to the module.

Back to TOC 453

 • Assign the module.

4.22.2.6. Viewing banner stats

Once banners are active on your site, you or clients can review the stats.

To create a new banner zone:

1. From the Admin menu, click Banners. The Banner page appears, showing the current
banners.

2. Click Stats for the banner to review. The Banner Stats page appears.

454 Back to TOC

 Tikiwiki Documentation 1.9+

4.22.2.7. Future

Future versions of Tiki will enhance the banner systems even more, new constraints will be added
to the banner creation form (max impressions per week, restriction by group, etc) and new stats and
graphics will be added to the stats page. New versions will be compatible with this version so you
can start using the banners right now. Please let us know what would you add to the banners system
to make it usable and we ll be happy to include ou suggestions in a new version.

4.22.3. Banners Details

Back to TOC 455

4.23. Modules
Modules in Tikiwiki most simply defined as a box of content (not the content itself). The Modules
Config? page explains how modules are created as boxes to the left or right of the main content
window in tikiwiki. Once created, they can be restacked in any order, given permissions so thay
appear only to defined user Group, and, if the site settings allow, can be customized to the
preferences of individual users.

A common use of modules in Tiki is to add custom menus?. Otherwise there is a long (and
growing) list of pre-programmed modules which can facilitate navigation, add speacial features, and
provide custom information to individual users.

The distingtion between modules and plugins is a little blurry - technically speaking, modules are
the containers and plugins are the content, but the set of pre-preogrammed modules (with plugins
already inside) that are native to the tikiwiki are commonly refered to as modules.

Related pages:
Module admin - explains how to create, choose and place modules on the site.
User modules - explains how (if the feature is active) users can choose and place their modules.

(A lot of the documentation about modules is still on tikiwiki.org).

Feature Modules
Specific Params (as
Module Name (as listed Title (as displayed — tw
Short Description indicated by module source
on Admin Modules) English) release
file)
articles Articles title, type, topicId, topic, start
Recently visited Lists recently-visited
breadcrumb maxlen
pages pages.
calendar Calendar-Filter
categories Displays category objects. type, deep, categId, style 1.10
id, shy (show only if page is
change_category
in categ)
comm_received_objects
directory_stats Directory stats
daily text/images set in
eph Ephemerides
Ephemerides feature
featured_links Featured links Displays featured links.
Displays a link to a
random_pages
random wiki page.
Displays a random image
random_images galleryId
thumbnail.
post comments in to the
shoutbox tooltip
module for all to see

456 Back to TOC

 Tikiwiki Documentation 1.9+

Feature Modules
Lists usernames of
who_is_there Online users cluster
logged-in users.
Shows the number of
logged_users Online users
logged-in users.
input_size (since 1.10)=size
login_box The login/logout box in characters of the text input
box
Lists real names of
online_users Online users
logged-in users.

User's Configuration Modules

Module Name Title Short Description Specific Params tw release
switch_lang Switch site language (dropdown list selector).
switch_lang2 Switch site language (select among text links).
switch_theme Allows users to switch site theme

Navigation Modules
Module Name Title Short Description Specific Params tw release
Lists latest sites links added to nonums, absurl ( n] - If not set, default =
directory_last_sites
Directory. [y relative)
directory_stats Shows Directory statistics.
Shows most-visited sites in
directory_top_sites
Directory.
Module
Lists similar? items. - deprecated?
whats_relatedwhats_related

Recent Changes Modules

Titl
Module Name Short Description Specific Params tw release
e
forums_last_posts Lists recent forum posts. nonums
forums_last_topics Lists recent new forum topics. nonums, absurl
since_last_visit Shows changes in various features since last login
wiki_last_comments Most recently added wiki comments moretooltips, nonums
showuser, showdate, nonums,
last_actions Displays latest users' actions.
maxlen
type, topicId. topic, nonums,
last_articles Displays latest articles.
absurl
last_blog_posts display latest blog posts blogid, title, nonums
last_category_objects Recently categorized objects type, id
last_created_blogs Recently created blogs nonums

Back to TOC 457

 Recent Changes Modules
last_created_faqs Recently created FAQs? nonums
last_created_quizzes Recently created Quiz nonums
Last
directory_last_sites Site Recently added links in Directory.
s
Module last_fileslast_files Displays files uploaded since last visit galleryId, nonums
last_file_galleries Displays file galleries modified since last visit
Displays latest Image Gallery
last_image_galleries nonums
modified since last visit
last_images Lists most-recent image uploads. galleryId, nonums
Shows thumbnails of most-recent
last_images_th galleryId
image uploads.
ast_modified_blogs Display blogs modified since last visit. nonums
last_modif_events calendarId, maxlen, nonums
Displays most recently edited wiki minor, maxlen, nonums,
last_modif_pages
pages absurl
Lists the tracker items? added since
last_modif_tracker_items name, trackerId, nonums
last visit
Lists the tracker items? added since
last_submissions nonums
last visit.
last_tracker_comments Lists the last tracker comments trackerId, itemId, nonums
status, name, trackerId,
last_tracker_items Lists the last tracker items?
nonums
last_visitors Lists recent logged-in visitors. maxlen, nonums

"Best of" Modules

Specific
Module Name Title Short Description tw release
Params
Top
forums_best_voted_topics nonums
topics
forums_most_commented_forums nonums
forums_most_read_topics nonums
forums_most_visited_forums nonums
top_active_blogs Lists Images by number of posts nonums
top_articles Lists Articles by number of hits nonums
Lists files? by number of hits (
top_files nonums
downloads?)
top_file_galleries Lists file galleries by number of hits. nonums
top_forum_posters Lists most-active forum posters. nonums
top_games Lists Games by number of hits. nonums
top_images Lists Images by number of hits. nonums

458 Back to TOC

 Tikiwiki Documentation 1.9+

"Best of" Modules

Shows thumbnails of most-viewed
top_images_th
images.
Lists Image Gallery pages by number of
top_image_galleries nonums
hits.
Lists most-viewed objects (pages,
top_objects nonums
galleries, etc.).
top_pages Lists Wiki pages by number of hits. nonums
top_quizzes Lists Quiz by number of hits. nonums
top_visited_blogs Lists Blog by number of hits. nonums
top_visited_faqs Lists FAQs? by number of hits. nonums

Help and Support Modules

Module Name Title Short Description Specific Params tw release
Welcome message to admin of new Tiki
assistant Tikiwiki Assistant
installation.
live_support Starts the live support feature

Search Modules
Module Name Title Short Description Specific Params tw release
google Google Search Web search
search_box Search in entire site or by feature.
search_box_new Search in entire site or by feature.
search_wiki_page Search for wiki page name.

MyTiki Modules
Module Name Title Short Description Specific Params tw release
user_blogs Lists "my Blogs" from the MyTiki feature nonums
user_bookmarks Lists "my Bookmarks" from the MyTiki feature
user_image_galleries Lists "my Pages" from the MyTiki feature nonums
user_pages Lists "my Pages" from the MyTiki feature nonums
user_tasks Lists tasks from the MyTiki feature
messages_unread_messages Displays the number of new user messages

Misc. Modules
Module Name Title Short Description Specific Params tw release
Curren
events t Displays calendar (?)
events
menupage Displays a wiki page's name

Back to TOC 459

 Misc. Modules
content.
num_submissions
old_articles
title, templateId, submit, size,
quick_edit
mod_quickedit_heading, categId
tail (used by devs) file, title, max, reverse, filter
upcoming_events calendarId, maxDays, maxlen, nonums

4.23.1. Modules User

In tikiwiki a module is just a "box" that appears on either the left or right margin of the page.
(doc.tikiwiki.org has several on both sides, like Want to Write at the top left.) Inside the box is
whatever you want to put there - menus?, search fields, chat features, recent changes etc.

Admins can create modules, change in what order or what column they appear, assign permissions
to modules - for example there may be modules that registered users can see but anonymous users
cannot, and modules that appear for only certain groups of users.

For more about how to customize modules, see Module Admin. And see User Modules under
MyTiki section in the main application menu, for more information on how to set which modules
you want to see as a user (provided that admin has allowed users to configure modules - see Module
Admin again, if needed).

4.23.2. Modules Admin

The modules are administered from the module administration screen (Admin Modules menu , tiki-
admin_modules.php).:

The screen is divided in 4 parts:

• User modules
• Assign modules
• Assigned modules
• Create/edit modules

In Admin Modules page you can assign and edit the order and permissions of custom User Modules
and default modules.
Note 1: if you allow your users to configure modules (through "Admin > Features > User Features
> Users can Configure Modules" ) then assigned modules won't be reflected in the screen until you
configure them from MyTiki->modules (see User Modules ).

460 Back to TOC

 Tikiwiki Documentation 1.9+

Click to enlarge

Note 2: If you assign modules to groups make sure that you have turned off the option 'display
modules to all groups always' from Admin > General > General settings

Click to enlarge

To remove an assigned module, click its x on its row under Assigned Modules menu at the bottom.

4.23.2.1. User modules

User modules are modules where the content can be anything you want. You can use text, you can
use HTML code and you can also use Smarty templates special instructions, we ll talk about these
advanced options later.

First let's see how to edit, remove and create user modules. This is the user module listing in the
admin modules panel:

This shows a list of user modules and you have the option to edit or delete a module, user modules
are created or edited in this same screen at the bottom.

User modules are custom modules that can include HTML and Smarty code, there is an excellent
set of Smarty documentation at http://smarty.php.net .

To escape Smarty code you can use {literal}{/literal}

Back to TOC 461

 4.23.2.2. Assign module

This is where you can assign a module to be displayed on the left or right side bar of the
application, you have to select the module name, the position (left or right) and the order, modules
will be displayed in an ascending order way so module 1 goes first then 2, etc. If two modules share
the same order value they will be displayed in random order but never before a module with a lower
number or before a module with a higher order.

Cache Time is the time that the module content can be in the cache (regardelss of this number some
modules are never cached), if a module can be cached then it will be refreshed after the indicated
time passes. Use 0 if you don t want modules to be cached.

Rows are the maximum number of rows a module will display if that makes sense to the module,
modules displaying rankings or listings will use this number.

Groups is used to select which groups will see the module if it is assigned. Note that if you don t
select at list one group no one will be able to see the module. If more than one group is selected
then the module will be displayed if the user belongs to ANY of the groups selected.
Note 1: There s a setting in the main admin panel called display modules to all groups always (see
above). When this setting is checked modules will be displayed always without examining the user
group.

Note 2: If you enable the option to let users configure modules (see above) then when you assign a
new module it won't be displayed until you configure it from your user preferences->configure
modules screen. Admin is a normal user so he must configure the module too! See User Modules.

4.23.2.3. Module Parameters

Some modules have special parameters that change the information displayed. For specific
information about a module, go back to Module and choose the correct module from the list.
Note: We need help with documentation on module parameters. This information may be in the

462 Back to TOC

 Tikiwiki Documentation 1.9+

module .tpl? file itself.

Note: If you need multiple parameters, the syntax is similar to parameters you can sometimes notice
in the address bar of your browser as with lang parameter above, e.g. max=20&lang=fr

lang
You can display a module only for some languages. In the parameters input field you may enter e.g.
lang=fr. That means the module will be displayed only if the current language is French. You may
also enter lang[]=en&lang[]=fr what will display the module only if the current language is
French or English. You can see a list of possible language strings in
http://tikiwiki.org/TikiWikiInternationalizationAndLanguages . See also tip above for custom
modules.

flip
You can make a module shadeable - to toggle the module contents, so that only the titlebar is
displayed - by entering flip=y in the parameter field. This causes the module to display a button on
the title bar that will toggle module contents on and off. The module defaluts to unshaded (contents
shown) and the state is stored in the users' session cookie. Entering flip=yc defaults the module to
shaded. See also the Users Shade Modules feature.

title
To override the title of a menu, add title=Menu. If you have a space in your title, use:
''title="Developer Menu"

decorations
You can suppress module decorations - the titlebar and box that displays the content - for a module
by entering decorations=n in the parameters field. This is unlikely to be useful for most admins (it
is provided to enable module content to be embedded in other CMS sections).

Tiki 1.9.8+ parameters

overflow
If you are using phplayermenu vertical, the menus need to overflow out of the module and into the
middle section. Use overflow=y

4.23.2.4. Advanced editing

If you are not familiar with Smarty the template engine used by Tiki you should skip this section.
User modules are parsed by the Smarty template engine before being displayed, you may have
noticed that dynamic content and banners are included using two special Tiki smarty plugins. So if
you know about Smarty template editing you can use any Smarty tag in your user modules. You can
do loops, if constructions, includes, etc.

If you want to learn about Smarty visit http://smarty.php.net you will find the Smarty
documentation there that you can use in order to check out what can you use in your user modules.

Back to TOC 463

 4.23.2.5. Assigned modules

This part of the screen shows currently assigned modules and their order, cache,groups and number
of rows. There re two tables, one for the modules at the left bar and other for the modules at the
right bar. You can edit (assign) a module, remove it (it will only unassign the module, you can
reassigned later) and you can also move the module up or down one position using the up/down
links.

4.23.2.6. Edit the assignment of a module

If you click on the edit button of a module, in the section of Assigned modules (don't confuse it
with with the edit button at the "User modules" section, explained in the next section), you will be
able to edit that assignment. In this example, we will edit the module "Menu_Precarios" from the
previous example (see above). You can change position, order, cache time, maximum number of
rows shown and parameters (if applicable), and the groups that should see that module.

464 Back to TOC

 Tikiwiki Documentation 1.9+

4.23.3. User Modules

Users Configuring modules

If enabled from the admin screen you can allow registered users to configure the modules they will
see in the side bars of Tiki. The rules are:
• If no configuration is made the user will see modules as configured from the modules
administration screen
• The user can remove modules, change the position and order of modules but they can t
display modules that are not assigned by the admin from the modules admin screen.
• The user can recover the default configuration with a single click whenever he wants

The following screen is used to let the user manage modules:

Back to TOC 465

The user can move the modules up/down they can move a module to the other column and they can
unassign modules (the login box and application menu cannot be unassigned). If the user unassigns
a module he will be able to assign the module to any column in any position if he wants.

Use 'Create New User Module' to create custom modules

Once a user module is created, it can be selected and assigned from the Module Name list, just like
the standard modules available to the site.
When assigning a module you can set optional parameters to it.
Tip: for multilingualism, you can use the following syntax in your custom module to display a
different menu depending of the current language:
{if $language eq 'fr'}
{menu id=44}
{elseif $language eq 'es'}
{menu id=45}
{else}
{menu id=43}
{/if}

The advantage of such code is to allow a default menu (id=43) when a translated version does not
exist.

4.23.3.1. Edit/Create user module

This section allows the creation of a new user module.

466 Back to TOC

 Tikiwiki Documentation 1.9+

You need to indicate the name (used in the select box to assign the module), the title and the data
that will be displayed, the data must be HTML (any since you are admin). The right part of this
panel can be used to help you include some objects that can be used in user modules, you can
include in an user module:
• A poll (it will display the form to vote for the indicated poll) {poll id=n}
• Any poll from the active polls {poll}
• A random image from any gallery {gallery id=-1 showgalleryname=1}
• A random image from a single gallery {gallery id=n showgalleryname=0}
• The current value of a dynamic content block {content id=n}
• A random value from a dynamic content block {rcontent id=n}
• An RSS feed {rss id=n}
• A banner {banner zone=foo}
• A normal menu {menu id=n}
• A menu with layers
• Normal phplayered menu {phplayers id=n}
• Vertical type of layers: {phplayers id=n type=vert}
• Horizontal type of layers: {phplayers id=n type=horiz}
• A structure "table of contents" {wikistructure id=n}

Back to TOC 467

Note that there is a last checkbox to allow parsing the content of the menu, so that, wiki markup can
be recognized and converted to html when showing the module in the browser (HomePage will be a
clickable link then, in the previous example).

Including the current date in user modules

The following syntax can be used to display the current server date on a module:
{showdate mode="d/m/Y h:i"}

Where mode is any valid format for the PHP "date" function (see the date function on the PHP
manual).

Including dynamic content in user modules

You can include dynamic blocks in a user module using a simple syntax:
Today quote: {content id=3}

In the example we are including the current version of the dynamic block 3 . You can create/edit
and program dynamic blocks using the Dynamic Content System (DCS). Read about the DCS in the
DCS section to learn more.

468 Back to TOC

 Tikiwiki Documentation 1.9+

Including banners in user modules

If you want you can include a banner in a user module, using the following syntax:
{banner zone=sidebar}

Where zone must be the name of an existing zone in the banners system and there should be at least
one banner assigned to the zone (or nothing will be displayed). You can learn more about banners in
the banners section.

Including polls in user modules

You can display the form to vote a poll in a user module using the syntax
{poll id=n}

If you want Tiki to display the form to vote some (random) poll from all the active polls you can
use:
{poll}

Displaying a random image from a gallery

You can use the following function to display one random image from an Imagegallery:
{gallery id=n}

Including RSS feeds in user modules

You can display the content of an RSS feed from another site in a user module after you created the
feed (see using external RSS feeds later on this section), the syntax is:
{rss id=n max=m}

It will display the rss feed with id=n and it will display up to m elements from the feed.

For more information, see Module Details.

Back to TOC 469

 4.23.3.2. Module Controls

Module controls are little tools that appear in the top bars of modules, such as the login module. The
controls allow a user to modify the layout he sees for the Tiki by moving the modules up and down,
from the left column to the right, or vice-versa, or even removing the module entirely.

To activate modules controls in your Tiki you need to complete several steps:
1. Login as admin
2. In tiki-admin.php?page=features
1. make sure "Show Module Controls" is active.
3. make sure "Users can Configure Modules" is active.
4. In tiki-admin.php?page=general
1. make sure "Display modules to all groups always" is active.
5. In tiki-assignpermission.php make sure your users have tiki_p_configure_modules

When it works you will see something like this:

4.23.4. Module details

In the following pages you will see the list of modules available for Tikiwiki.

4.23.4.1. Module articles

This is a stub. Some screenshot is needed

4.23.4.2. Module assistant

This is a stub. Some screenshot is needed

4.23.4.3. Module breadcrumb

This is a stub. Some screenshot is needed

4.23.4.4. Module calendar

see also? calendar

insert graphic

The calendar module if enabled can be used to control some aspects of the Tiki application. First of

470 Back to TOC

 Tikiwiki Documentation 1.9+

all it is a normal calendar that can be navigated changing the month and year and you can always
return to the day for today clicking the today link. When you click on a day the calendar will mark
it as the current day for the page you are viewing, if you change the page the calendar will go back
to today .

How the calendar affects articles

For the articles home only articles with a publishing date lower than the day selected in the calendar
will be displayed, this can be used to see the articles home for any previous day. If the date is future
and you are admin you can see future versions of the home using to-be-published articles. If you are
not admin you won t see future articles.

How the calendar affects blogs

For the blogs system any weblog will only display posts with dates equal or lower than the date
selected in the calendar. If the date is future it is the same as today since we don t have posts with a
future publishing date yet in the blogs system.
Note that once you select a date in the calendar it won t remain selected if you change the page you
are viewing it will be restored to the current date.

More information, back on Module Admin.

4.23.4.5. Module categories

This is a stub. Some screenshot is needed

4.23.4.6. Module change_category

This is a stub. Some screenshot is needed

4.23.4.7. Module comm_received_objects

This is a stub. Some screenshot is needed

4.23.4.8. Module directory_last_sites

This is a stub. Some screenshot is needed

4.23.4.9. Module directory_stats

This is a stub. Some screenshot is needed

4.23.4.10. Module directory_top_sites

This is a stub. Some screenshot is needed

Back to TOC 471

 4.23.4.11. Module eph

This is a stub. Some screenshot is needed

4.23.4.12. Module events

This is a stub. Some screenshot is needed

4.23.4.13. Module featured_links

This is a stub. Some screenshot is needed

4.23.4.14. Module forums_best_voted_topics

This is a stub. Some screenshot is needed

4.23.4.15. Module forums_last_posts

Description
Shows the last posts in all the forum inside the site.

In Boxes
This module can be used in the modules boxes with the following parameters :

module name : mod-forum_last_posts

align : (left|center|right)
max : integer
np : (0|1) # (for non-parsed content)
flip : (n|y)
decorations : (y|n) : n => no title
module args : value (depends on module)
nonums: (y|n) : n=> no numerotation
absurl : (y|n)

In a Wiki
{MODULE(module=>forums_last_posts,align=>left,max=>3,maxlen=>22)}
{MODULE}

This would produce something like:

Darrers enviaments al fòrum
1)Author Coffeeshop: Styles and Themes

472 Back to TOC

 Tikiwiki Documentation 1.9+

2)Author Coffeeshop: Styles and Themes

3)Author Coffeeshop: Styles and Themes

4.23.4.16. Module forums_last_topics

This is a stub. Some screenshot is needed

4.23.4.17. Module forums_most_commented_forums

This is a stub. Some screenshot is needed

4.23.4.18. Module forums_most_read_topics

This is a stub. Some screenshot is needed

4.23.4.19. Module forums_most_visited_forums

This is a stub. Some screenshot is needed

4.23.4.20. Module google

This is a stub. Some screenshot is needed

4.23.4.21. Module last_actions

This is a stub. Some screenshot is needed

4.23.4.22. Module last_articles

This is a stub. Some screenshot is needed

4.23.4.23. Module last_blog_posts

This is a stub. Some screenshot is needed

4.23.4.24. Module last_category_objects

This is a stub. Some screenshot is needed

Back to TOC 473

 4.23.4.25. Module last_created_blogs

This is a stub. Some screenshot is needed

4.23.4.26. Module last_created_faqs

This module shows the list of Faq's recently created, ordered by last created first.

You can use this type of syntax:

{MODULE(module=>last_created_faqs)}{MODULE}

to produce:
Last created FAQs
1)Images
2)Users and Groups
3)General Troubleshooting
4)Security
5)Installation and Setup
6)Look and Feel
7)RSS Feeds
8)Wiki Pages

Related pages
• Faq (Frequently Asked Questions)
• Faq User
• Faq Admin
• Faq Details
• Module top_visited_faqs

4.23.4.27. Module last_created_quizzes

This is a stub. Some screenshot is needed

4.23.4.28. Module last_fileslast_files

This is a stub. Some screenshot is needed

4.23.4.29. Module last_file_galleries

This is a stub. Some screenshot is needed

474 Back to TOC

 Tikiwiki Documentation 1.9+

4.23.4.30. Module last_images

This is a stub. Some screenshot is needed

4.23.4.31. Module last_images_th

This is a stub. Some screenshot is needed

4.23.4.32. Module last_image_galleries

This is a stub. Some screenshot is needed

4.23.4.33. Module last_modified_blogs

This is a stub. Some screenshot is needed

4.23.4.34. Module last_modif_events

This is a stub. Some screenshot is needed

4.23.4.35. Module last_modif_pages

This is a stub. Some screenshot is needed

4.23.4.36. Module last_modif_tracker_items

This is a stub. Some screenshot is needed

4.23.4.37. Module last_submissions

This is a stub. Some screenshot is needed

4.23.4.38. Module last_tracker_comments

This is a stub. Some screenshot is needed

4.23.4.39. Module last_tracker_items

This is a stub. Some screenshot is needed

Parameters
trackerId numeric mandatory the Id of the tracker

Back to TOC 475

name text mandatory the name of the field to be displayed
status opc or oc or op or pc or o or p or c optional status

4.23.4.40. Module last_visitors

This is a stub. Some screenshot is needed

4.23.4.41. Module live_support

This is a stub. Some screenshot is needed

4.23.4.42. Module logged_users

This is a stub. Some screenshot is needed

4.23.4.43. Module login_box

This is a stub. Some screenshot is needed

4.23.4.44. Module menupage

This is a stub. Some screenshot is needed

4.23.4.45. Module messages_unread_messages

This is a stub. Some screenshot is needed

4.23.4.46. Module num_submissions

This is a stub. Some screenshot is needed

4.23.4.47. Module old_articles

This is a stub. Some screenshot is needed

4.23.4.48. Module online_users

A screenshot is needed

There are actually couple of Online User "modules". One called "Online Users" shows the number
of users (though I am not sure if it's logged-in users or all people viewing the site at that time). The

476 Back to TOC

 Tikiwiki Documentation 1.9+

other one, curiously also displayed to users with the title "Online Users" is actually the "Who is
There" module which shows who is currently logged in by username (though on my site it never
shows anyone but me no matter how many other users I know are logged in).

To change, add or delete modules you'll need to log in (assuming you are the admin), expand the
Admin folder of the main menu and choose "Modules". You'll get a page of "User Modules", and
further down another list of "Assigned Modules" this time broken up into "left" and "right"
modules. Under "Assign new module" choose, under "module name", either "Online Users" or
"Who is There" from the long list of modules. You can also assign the module to left or right
columns and assign a number to put it with the other modules in the right order. If you only want
some groups to see it choose those groups otherwise it defaults to everyone. Click "assign" and
bingo!

To delete a module find the offending module and under the "action" column (next to "edit, up,
down") click the "x" to remove it from whatever column it's in. That kind of module doesn't really
get trashed -it just 'tain't visible no more.

Be aware that if you edit the "User Modules" you see near the top of the page you will need to
click "assign" in the action column after you save the changes to make the changes active
(otherwise you'll be wondering why your changes didn't show up!)

Example of usage in a Wiki page

{MODULE(module=>online_users)}
{MODULE}

This would produce something like:

Usuaris en línia
Xavi

4.23.4.49. Module quick_edit

This is a stub. Some screenshot is needed

4.23.4.50. Module random_images

This is a stub. Some screenshot is needed

4.23.4.51. Module random_pages

This is a stub. Some screenshot is needed

Back to TOC 477

 4.23.4.52. Module since_last_visit

This is a stub. Some screenshot is needed

4.23.4.53. Module since_last_visit_new

Give a list of events that happens since the last login /visit of a user

Usage
To use this module in a wiki page:
{MODULE(module=>since_last_visit_new,showuser=>n)}{MODULE}

Where:
• showuser: n. If n do not show the new users (optional, default: show the users >=tw1.10)
• showtracker: n. If n do not show the new tracker items(optional, default: show the traker
items >=tw1.10)

Example

Using the since_last_visit_new

module (taken from
doc.tikiwiki.org).

Objects monitored by since_last_visit_new

• Wiki page revisions
• Articles

478 Back to TOC

 Tikiwiki Documentation 1.9+

• Comments
• Blogs
• Blog posts
• Image galleries
• Images
• FAQs
• File galleries
• Files
• Forum posts
• Polls
• Sites (Directory)
• Tracker Items
• Users

4.23.4.54. Module search_box

This is a stub. Some screenshot is needed

4.23.4.55. Module search_new

This is a stub. Some screenshot is needed

4.23.4.56. Module search_wiki_page

This is a stub. Some screenshot is needed

4.23.4.57. Module shoutbox

This is a stub. Some screenshot is needed

4.23.4.58. Module since_last_visit

This is a stub. Some screenshot is needed

4.23.4.59. Module switch_lang

This is a stub. Some screenshot is needed

4.23.4.60. Module switch_lang2

This is a stub. Some screenshot is needed

Back to TOC 479

 4.23.4.61. Module switch_theme

This is a stub. Some screenshot is needed

4.23.4.62. Module tail

This is a stub. Some screenshot is needed

4.23.4.63. Module top_active_blogs

This is a stub. Some screenshot is needed

4.23.4.64. Module top_articles

This is a stub. Some screenshot is needed

4.23.4.65. Module top_files

This is a stub. Some screenshot is needed

4.23.4.66. Module top_file_galleries

This is a stub. Some screenshot is needed

4.23.4.67. Module top_forum_posters

This is a stub. Some screenshot is needed

4.23.4.68. Module top_games

This is a stub. Some screenshot is needed

4.23.4.69. Module top_images

This is a stub. Some screenshot is needed

4.23.4.70. Module top_images_th

This is a stub. Some screenshot is needed

480 Back to TOC

 Tikiwiki Documentation 1.9+

4.23.4.71. Module top_image_galleries

This is a stub. Some screenshot is needed

4.23.4.72. Module top_objects

This is a stub. Some screenshot is needed

4.23.4.73. Module top_pages

This is a stub. Some screenshot is needed

4.23.4.74. Module top_quizzes

This is a stub. Some screenshot is needed

4.23.4.75. Module top_visited_blogs

This is a stub. Some screenshot is needed

4.23.4.76. Module top_visited_faqs

This module shows the list of Faq's that have received visits the most, ordered by higher number of
visits first.

You can use this type of syntax:

{MODULE(module=>top_visited_faqs)}{MODULE}

to produce:
Top visited FAQs
1) Wiki Pages
2) Installation and Setup
3) Users and Groups
4) Look and Feel
5) RSS Feeds
6) General Troubleshooting
7) Images
8) Security

Related pages
• Faq (Frequently Asked Questions))

Back to TOC 481

 • Faq User
• Faq Admin
• Faq Details
• Module last_created_faqs

4.23.4.77. Module upcoming_events

This is a stub. Some screenshot is needed

4.23.4.78. Module user_blogs

This is a stub. Some screenshot is needed

4.23.4.79. Module user_bookmarks

This is a stub. Some screenshot is needed

4.23.4.80. Module user_image_galleries

This is a stub. Some screenshot is needed

4.23.4.81. Module user_pages

This is a stub. Some screenshot is needed

4.23.4.82. Module user_tasks

This is a stub. Some screenshot is needed

4.23.4.83. Module whats_relatedwhats_related

This is a stub. Some screenshot is needed

4.23.4.84. Module who_is_there

A screenshot is needed

There are actually couple of Online User "modules". One called "Online Users" shows the number
of users (though I am not sure if it's logged-in users or all people viewing the site at that time). The
other one, curiously also displayed on the page as "Online Users" is actually the "Who is There"
module which shows who is currently logged in by username (though on my site it never shows

482 Back to TOC

 Tikiwiki Documentation 1.9+

anyone but me no matter how many other users I know are logged in).

To change, add or delete modules you'll need to log in (assuming you are the admin), expand the
Admin folder of the main menu and choose "Modules". You'll get a page of "User Modules", and
further down another list of "Assigned Modules" this time broken up into "left" and "right"
modules. Under "Assign new module" choose, under "module name", either "Online Users" or
"Who is There" from the long list of modules. You can also assign the module to left or right
columns and assign a number to put it with the other modules in the right order. If you only want
some groups to see it choose those groups otherwise it defaults to everyone. Click "assign" and
bingo!

To delete a module find the offending module and under the "action" column (next to "edit, up,
down") click the "x" to remove it from whatever column it's in. That kind of module doesn't really
get trashed -it just 'tain't visible no more.

Be aware that if you edit the "User Modules" you see near the top of the page you will need to click
"assign" in the action column after you save the changes to make the changes active (otherwise
you'll be wondering why your changes didn't show up!)

Example of usage in a Wiki page

{MODULE(module=>who_is_there)}
{MODULE}

This would produce something like:

Usuaris en línia
35 usuaris en línia
Xavi

4.23.4.85. Module wiki_last_comments

This is a stub. Some screenshot is needed

4.24. Chat
The Chat feature is designed to allow users to enter "chat rooms" and hold real time conversations
(via instant message) with other users who are logged in to the same room. Chat is not a heavily
used or heavily developed feature, it is simple but it works. The feature requires extra server power,
and may not be suitable for budget hosting arrangements.

Chat allows for multiple "rooms", and multiple users per room.
• Users can move between rooms
• Rooms with different update times seem to operate at the correct update rates.

Back to TOC 483

The general method for using chat is to select a room, enter the room, and send messages by typing
them in a text box. All recent messages for the room are displayed and updated periodically (period
set by chat administration).

Review of 1.9.4 Chat Operation

* Things that work:

o Rooms:

o Messages
+ Basic messages post on posting users screen in blue
+ Basic messages post on non-posting users screens in black
+ Private messages do not display on posting users screen
+ Private messages display on the recipient's screen in red
+ Private messages do not display on non-recipient's screen
o Purging messages
+ If the purge time is set down from 1440 to something small for testing (15min), the purging seems
to work properly
o Browsers
+ Internet Explorer seems to work
+ Firefox seems to work
* Things that are questionable
o Private messages stay at the bottom of the screen - not chronological with non-private messages.
+ This may be considered a feature - not sure what is typically done with private messages on
chatrooms.
# I don't like this functioning this way. Another box would probably be better, or leave the private
messages in line with the others if possible.
o The messages are currently cleared on a 1440 minute basis - with note to change to preference
setting
o Not sure what criteria is being used to update screens - how many messages? how old?
+ It seems that all messages for a given room are displayed to users that enter the room. (last 24hrs
with current purge setting of 1440)
+ It appears that there was an attempt at some logic to only send messages since lastmessage. Not
sure how this was supposed to work. This may have required the javascript coding that appears to
have been abandoned in favor of direct print statements.
o Users display
+ Current users in room does not always seem to be correct.
# This needs checked with multiple machines - I'm using multiple browser windows on one
machine to test.
* Things that could be added:
o Timestamps on messages
o Room entry notifications when new users enter rooms.
o Room exit notifications when users exit rooms.
o block out users selectively
o assign colors to users
o Logging - there are references to this in the code, but I don't think it is functional.
* Very Strange
o Clicking on a username in the active users causes the whole tiki site to try to display in the user

484 Back to TOC

 Tikiwiki Documentation 1.9+

pane - on the user's information screen. (Firefox, IE)

o Notice: Undefined index: lastMessage in /var/www/html/tikiwiki-1.9.2/tiki-chat_loader.php on
line 83
+ I think there may be some problem with the lastMessage logic that should be used to determine
which messages to display for each user session. This message appears the first time a user logs in
to a room. As soon as the chatroom updates once the message goes away. maybe lastMessage is not
properly initialized.

See the current developers notes on this feature. Chat

4.24.1. Chat User

The Chat feature allows users to conduct online chat sessions with other users. From the main menu
the user selects the chat feature. The Chat menu appears, and the user selects a room from the ones
available in a pulldown list. The user then enters the selected room by clicking the 'Enter Chat
Room' button.

Once in the chatroom, the User can type messages in the chat box near the bottom of the screen.
When the message is complete, hitting the enter key sends the message. As users send messages,
they are displayed to all users in chronological order.

Understanding Chat rooms

In brief, a Chatroom is a computer-based conversation system based on users typing in messages,
which get displayed for all other users in the Chatroom to view. Each user can read the conversation
as it progresses, and send messages to contribute to the conversation.

Feature Overview
• The Chat feature allows for multiple Chatrooms to be configured by Chat administrators.
• Users can move from room to room once they have entered the Chatrooms by selecting from
the available rooms, which are displayed on the Chatroom screen.
• All users in the current room are displayed.
• Private messages can be sent to other users in the room.

4.24.2. Chat Admin

Purpose
• Create chat channels
• Delete chat channels
• Modify chat channel settings

Back to TOC 485

 4.24.2.1. Chat Channel Settings:

Name
Specify the name of the Chatroom. This name will be displayed in the pulldown list when entering
the Chatroom area, and the name displayed in the Chatroom where the "Active channels" are
displayed.

Description
This description has no function in the operation of the chatrooms. It can be used to describe the
room for administrative purposes, and may be used in the future for other purposes.

Active
If the Active checkbox is checked, the Chatroom will be enabled for selection from the main menu,
or from within the chatrooms.

Refresh rate
This setting determines how often the user screen is updated while in the chat rooms. The setting is
in seconds. The default rate is 3 seconds. The fastest update rate is 1/2 second, and the slowest rate
is 10 seconds. The rate is set by selecting from a pulldown list.

4.24.2.2. Accessing Chat Admin

• User must have chat admin privileges

• Expand the Admin menu
• Select Chat under the Admin menu

4.24.2.3. Adding a chatroom

• Enter a name for the chatroom in the Name box.

• Enter a description for the chatroom in the Description box.
• Make sure the active box is checked if you want to be able to use the chatroom after adding
it.
• Change the Refresh rate if desired.
• Click the Save button.

4.24.2.4. Deleting a chatroom

• Under the Chat Channels list, click the red X to the right of the room to be deleted.
• Click on the "Click here to confirm your action" button to confirm the deletion.

4.24.2.5. Editing a chatroom

• Under the Chat Channels list, click the Edit Icon (far right icon) next to the channel you
wish to edit.
• Change the desired settings at the top of the screen.

486 Back to TOC

 Tikiwiki Documentation 1.9+

• Click Save to save the changes.

4.24.3. Chat Details

Back to TOC 487

4.25. Live Support
Live support puts you on-call when your users need you. With the click of a button, a user may
request help from a live support operator. The live support module automatically opens upon
acceptance a chat window between the user and operator.

4.25.1. Live Support User

(See Live Support for a general overview on this feature)

When there is no operator available for live suport, the live support module shows OFFLINE with
the bulb off (grey):

When Any operator is online, the icon changes to show ONLINE in blue and the bulb is on
(yellow):

A user wanting Live Support, can click on the now Online image button.

A new window will open asking for user name, email (only if they aren't logged into the site!) and a
Request Reason. Once completed they can click "Request Support". In this example, the user
"Professor" is requesting support to admin the tiki site of his/her students on an educational
scenario. The question was: "How can I edit my students information".

488 Back to TOC

 Tikiwiki Documentation 1.9+

This is when the request will appear in the Operator console (see Live Support Admin).

If accepted, an online chat session between the operator and user will start. In this example, the
operator "Xavi" was online, accepted the support request and answered: "Hi Professor. You need to
go to "Admin > Users" and click on the edit icon next to the student name whose information you
want to edit...".

Back to TOC 489

In this example, user Profess replied back some messages, and after that, closed the window to end
the conversation

490 Back to TOC

 Tikiwiki Documentation 1.9+

See Live Support Admin to view the operator side of the same support request process.

4.25.2. Live Support Admin

4.25.2.1. Live Support settings

First enable the feature on "Admin->Features".

Back to TOC 491

On the Admin dropdown menu choose the Live Support option
Now make some Tiki users into operators.

To make the Live Support visible on the site, create the module through Admin->Modules.
The name of the module is live_support and assign it the desired column and set visibility
accordingly.

4.25.2.2. Operator usage (1 user to 1 operator)

Now logged into the Tiki site as one of the operators, click the Open Live Support Console window.
Lets assume in this example that there are 3 users defined as operators, and only one of them is
online.

492 Back to TOC

 Tikiwiki Documentation 1.9+

When a user makes a support request, you will see an tilting popup small window to request you to
see that request in order to see it, so that you decide to accept it or not.

If you click on accept, then you will be able to "accept" or not the support request, or "join" the
support that another operator is already giving to that request.

If you accept the support request, this is the window where the request for support will appear:

Back to TOC 493

Now the chat can continue, until the user requesting support closes his/her window to end the
support session.

See Live Support User to view the user side of the same support request process.

4.25.2.3. Two operators on the same support request

If two or more operators where online by the time of the support request, all of them would get the

494 Back to TOC

 Tikiwiki Documentation 1.9+

popup window noticing a support request was made, and once they clicked on the small popup
"accept" window, each one of them could accept of join the support request process.

In this example, another support request was made by user "Professor".

2nd support request by user Professor

By that time, operators "admin" and "Xavi" where online. The first to accept was admin, which
already answered the support request with an answer.

Back to TOC 495

Then the second operator ("Xavi"), would see a screen like this one, where he could add some more
information, if this was the case:

In this case, the second operator could complement the answer of the first, since In Tiki 1.10 two
new features have been added to support this need declared by the Professor: Action log and (
Contribution)) features.

4.25.3. Live Support Details

On the live support admin screen ("tiki-live_support_admin.php"), there are some other options.
One of them is "Generate HTML" ("tiki-live_support_admin.php?show_html"), which leads you
a page where you can copy some html code to paste it in any html page you wish to produce the live
support icon:

496 Back to TOC

 Tikiwiki Documentation 1.9+

Moreover, there is the option "Transcripts", which can be filtered by operator. In this example, we
filtered the transcripts for operator "admin" (tiki-
live_support_transcripts.php?filter_operator=admin):

If you click on the number at the column "msgs", you can view the messages of that support request
process (3, in this example):

Back to TOC 497

4.26. Map
Feature Overview
By enabling the Maps feature, you can display interactive maps of any area in the world in any
projection. You can zoom on a map, select which geographic layer you want to see and query any
geographical object.

Tiki combined with this feature becomes a Geospatial Content Management System (GeoCMS).
Other features are taking advantage of maps: user preferences, image galleries,...

The system is based on the Mapserver software from the University of Minesota . Tiki provides a
nice, easy and integrated interface to the Mapserver.

Applications are unlimited:

• help to decision making by providing relevant geographical information
• geology mapping
• environmental mapping
• location mapping
• creating interactive geographical manuals
• ...
This system can be part of an e-government initiative.

However, enabling this feature is not trivial (yet) as it requires installing correctly the Mapserver
Software with its php mapscript extension.

The system is composed of a Map viewer, a Layer Management tool and a Mapfiles manager.
In short to create a map:
• you upload your GIS files using the Maps Layer Management.
• you create and edit a Mapfile using the Maps Mapfiles Manager
• you display the map inside the Map viewer

Table of Contents
• Maps User: How to operate the maps viewer
• Maps Editor: How to create maps
• Maps Layer Management
• Maps Mapfiles Manager
• Maps Details: Tips, tutorials and troubleshooting
• Maps Mapfile Tutorial: A tutorial on mapfile editing
• Maps MapView: Creating specifc views for a map
• Maps Admin: To install and administer the system.
• Maps Install: Installing the php mapscript extension
• Maps Config: Configuring parameters in the admin interface

498 Back to TOC

 Tikiwiki Documentation 1.9+

It is advised to read the MapServer Documentation on how to install and operate the software.
Some specific information to enable Mapserver inside Tiki is in Maps Admin.

Useful Links
MapServer Home Page
DM Press Release about MS 4
Reducing Vulnerabilities Via a Web Map Server

TikiMap Out There:

• http://www.sopac.org/maps
• http://www.lands.gov.to/tiki/
• http://map.mrd.gov.fj
• http://map.gov.ki
• http://map.vanuatu.gov.vu
• http://map.mineral.gov.pg
• http://map.meteorology.gov.ws
• http://map.tuvalu.tv
• http://mapgis.ciat.cgiar.org/valle/

Back to TOC 499

4.26.1. Maps User

4.26.1.1. The Interface

The interface is composed of several elements:

• The Map Title
• The Map
• The Overview
• The Legend
• The Layer Manager
• The Cursor Coordinates
• The Scalebar

500 Back to TOC

 Tikiwiki Documentation 1.9+

• The Control Buttons

• The Map Info

4.26.1.2. Working with Maps

Zooming and Panning

First you have to select from the drop down box the level of zoom or pan you which to use. You
then click on the map to define the point that will appear centered after the zoom/pan. Do not drag
the map or try to draw a rectangle on the map

Querying a geographical object

Select the query tool next to the pan and zooming tools and click on the map on a geographical
object. The object(s) will be highlighted and a table of objects with their attribute data will be
displayed below the map.

Changing the Image size of the map.

The default map size is 400 pixels width, you can change the size to various pixels size, then click
on redraw with pan being selected.

Selecting Views from dropdown list

A set of preselected locations may be available via a dropdown list.
Select a location name from the dropdown list then click on the Go button. This action will display
the selected location in the redrawn map.

Selecting the layers on the map

The Maps Layer Manager is here to help you select the layers you want to display on your map. Use
the [-] and [+] to fold or unfold the Layer Manager. Check the boxes of each feature you want to
display. Beware some layers may hide others. The layers are organised from top to bottom on their
drawing order. Therefore the bottom layer is the last one to be drawn, so it will appear on top on the
map. You can also select to display labels when the layer supports it. If there is a link on the layer
name then you can learn more about this layer. Some layers are queryable and will be indecated as
such. Finnaly, if you are a registered user you may download in native format the public layers.

4.26.2. Maps Editor

4.26.2.1. Maps Layer Management

4.26.2.2. Maps Mapfiles Manager

Back to TOC 501

 4.26.2.3. Maps Details

Here are a series of tutorials and tips to be used when utilising the Map feature.
• Maps Mapfile Tutorial: Creating mapfiles
• Maps MapView: Creating views inside the mapfile

4.26.2.4. Maps Mapfile Tutorial

Mapfile structure

Comments
Any text after a # is a comment. Use comments a lot to document your mapfile.

Objects or Groups
A mapfile is composed of several objects. Each object start by the keyword object and finishes by
END. Inside an object there can be several objects with the object starting by its keyword and
finishing by END.
A mapfile starts by the keyword MAP and finishes by END
MAP
... some lines...
END # end of map

Inside the mapfile there are objects like layers, each layer start by the keyword LAYER and finishes
by END
MAP
...
LAYER
...
END # end of layer

LAYER
...
END # end of layer
END # end of map

Do not try to figure how many END you need to put in the mapfile but use indentation to clearly
identify each object with its keyword, text and END keyword. All objects are nested and with
proper indentation, they are clearly visible. Indentation is not required but facilitates understanding
a mapfile. Adequate comments help a lot too.

A word on colors
The keyword COLOR, OUTLINECOLOR,.. specify the color in the RGB color space. The first

502 Back to TOC

 Tikiwiki Documentation 1.9+

value is the red intensity from 0 (no red) to 255, the second value is the green intensity from 0 (no
green) to 255 and the last value is the blue intensity from 0 (no blue) to 255. A COLOR 0 0 0
indicates black while COLOR 255 255 255 indicates white. COLOR 0 255 0 would be pure green.
The 3 values are compulsory and must be numbers. To select some correct values, use a color
selector like the one inside MS-Paint in accessories. You select the color and the RGB values are
indicated.

Mapfile header
The mapfile header is composed of several objects for the representation of the maps on the screen,
you have the map itself, the web object to define how the web image is created, the reference or
overview, the scalebar, the legend and if the map should be queryable. It is better to use pre-canned
header and modify little parameters to conform to a specific map.
This is the standard header for a map object
#
# Start of map file
#
MAP
NAME "Efate"
STATUS ON
SIZE 400 400
EXTENT 196900 8027100 245000 8073000
UNITS METERS
TRANSPARENT OFF
SHAPEPATH "/var/www/html/map/"
IMAGETYPE png24
FONTSET "fonts/fontset.txt"

OUTPUTFORMAT
NAME png24
DRIVER "GD/PNG"
MIMETYPE "image/png"
IMAGEMODE RGB
EXTENSION "png"
END

#
# Start of web interface definition
#
WEB
TEMPLATE /var/www/html/map/map.html
IMAGEPATH /var/www/html/map/images/
IMAGEURL /map/images/
LOG /var/www/html/map/maplog
END

#
# Start of reference map
#
REFERENCE
IMAGE /var/www/html/map/data/efate.png
EXTENT 196900 8027100 245000 8073000
STATUS ON
COLOR -1 -1 -1
OUTLINECOLOR 255 0 0

Back to TOC 503

 SIZE 95 95
END

#
# Start of legend
#
LEGEND
KEYSIZE 18 12
LABEL
TYPE BITMAP
SIZE MEDIUM
COLOR 0 0 89
END
STATUS ON
END

#
# Start of scalebar
#
SCALEBAR
IMAGECOLOR 255 255 255
LABEL
COLOR 0 0 0
SIZE SMALL
END
SIZE 350 5
COLOR 255 255 255
BACKGROUNDCOLOR 0 0 0
OUTLINECOLOR 0 0 0
UNITS kilometers
INTERVALS 5
STATUS ON
END

#
# Start of query definitions
#
QUERYMAP
STATUS ON
STYLE HILITE
END

Tip: A quick way to start a mapfile is to take the above and just add a END at the end of it.
Point to a real image in the REFERENCE section and change all the paths to reflect your own
installation. You will have then a working mapfile with no layers. You can then add a GRID
to it and start to make modification to suit what you really want to achieve.
It is important here to have the following paths set correctly in regards to where you installed the
mapfiles:
• SHAPEPATH
• IMAGEPATH
• IMAGEURL
• IMAGE
See their definition later in the text

504 Back to TOC

 Tikiwiki Documentation 1.9+

Map object
MAP
NAME "Efate"
#name of the map file
STATUS ON
# is this map on by default
SIZE 400 400
# size in pixel of the image map
EXTENT 196900 8027100 245000 8073000
# geographic extents of the map
UNITS METERS
# units for the geographic extents
TRANSPARENT OFF
# the background is not transparent
SHAPEPATH "/var/www/html/map/"
# where the shapefiles are stored on the
# server also used for directory reference
IMAGETYPE png24
# type of image output, here PNG format in 24bits color
FONTSET "fonts/fontset.txt"
# file containing the locations of fonts

Web
This group defines where to store information on the server and how to provide it to the web
browser
WEB
TEMPLATE /var/www/html/map/map.html
# location of the template for results
# the line needs to be here, but it is
# not used (no file at this location)
IMAGEPATH /var/www/html/map/images/
# location where to store maps images
IMAGEURL /map/images/
# web path for the maps images
LOG /var/www/html/map/maplog
# location of the logfile
END

Metadata

VIEW
View allows you to create views so you can quckly move to the geographic location, for instance
moving from one country to another one.

WEB
METADATA
VIEW1 "American Samoa,181.496593149,-20.0990853659,199.331777248,-8.22408536586"
VIEW2 "Australia,97.5030380511,-48.984521576,168.843774449,-1.48452157598"

Back to TOC 505

VIEW3 "Cook Islands,180.098325105,-27.4401969982,215.768693304,-3.69019699813"
...
END
...
END

Each view needs to be numbered in sequential order. Each field is separated by commas, the first
field is the name of the view, the following fields are minx,miny,maxx,maxy of the view.

Cf. Maps MapView for a detailed description.

Reference
This group defines how the overview should be displayed. You use an image representing the area
of interest and you specify the coordinates of the location of the edge of the image. The system will
draw on the image a rectangle based on the current view, indicatin the boundaries of such view.
REFERENCE
IMAGE /var/www/html/map/data/efate.png
# location of the image
EXTENT 196900 8027100 245000 8073000
# extent of the image
STATUS ON
# the overview is on by default
COLOR -1 -1 -1
# transparent background
OUTLINECOLOR 255 0 0
# the color of the outline
SIZE 95 95
# the size of the image in pixels
END

The tip to create an image for overview, is to not worry about the image at the begining. Any image
will do. When the layers are implemented in the mapfile and the main view sounds pretty enough,
then select a default view, click Redraw if neccessary to get the minx, maxx, miny, maxy
parameters in the URL, (if necessary adjust them manualy). Save the current map as an image onto
your local machine, use an image editing software to resize the image to the size you want to use in
the overview (here 95x95 pixel). Upload the image using the maps->layer manager and update the
IMAGE link in the REFERENCE group to point to this new image. Finish by entering the correct
EXTENTS that corresponds to the minx,miny,maxx,maxy of the map you used to create the
overview.

Legend
The legend is linked to each LAYER by the way each object type is represented (POINT, LINE,
POLYGON,...) and its COLOR and OUTLINECOLOR and by the NAME used in the CLASS
group. It is important to have a meaningful NAME for each CLASS group in every LAYER group.
The NAME of the CLASS can be different from the NAME of the layer as a LAYER can have
several CLASSes.
LEGEND
KEYSIZE 18 12

506 Back to TOC

 Tikiwiki Documentation 1.9+

# the size of the object representing the

# geographical object
LABEL
TYPE BITMAP
# Font type for the legend name of each
# geographical object
SIZE MEDIUM
# font size
COLOR 0 0 89
# font color
END
STATUS ON
# legend is on by default
END

Scalebar
It is interesting to display a scalebar to get information on distances.
SCALEBAR
IMAGECOLOR 255 255 255
# background color of the image placeholder

LABEL
COLOR 0 0 0
# color of the labels indicating the distance
SIZE SMALL
# size of the labels
END
SIZE 350 5
# sixe in pixels of the scalebar
COLOR 255 255 255
# color used in the scalebar
BACKGROUNDCOLOR 0 0 0
# background color of the drawn scalebar
OUTLINECOLOR 0 0 0
# outline color of the salebar
UNITS kilometers
# units to be used
INTERVALS 5
# How many intervals in total in the
# scalebar
STATUS ON
# the scalebar is on by default
END

Query
This group secify that the map will be queryable and how the selected objects should be
represented. Include this group even if you don't have a LAYER that can be queryable. It will
certainly come later.
QUERYMAP

Back to TOC 507

 STATUS ON
# the map is queryable by default
STYLE HILITE
# the selected object is highligthed
END

Layers

Vector layer
Let's start by a very simple layer that we will add more features to it. A layer start by the keyword
LAYER and finishes by END. It can include CLASS groups, METATADATA groups. For a vector
layer the CLASS is compulsory.

Layer Type
The two main types of GIS vector are ESRI shapefiles of Mapinfo TAB files. ESRI shapefiles are
natively supported while the Mapinfo filesare supported via the OGR library.
All locations of files must be indicated in relative reference to the path indicated by the keyword
SHAPEPATH in the MAP group.
If you have a file in "/var/www/html/map/data/mylayer.shp and SHAPEPATH indicates
"/var/www/html/map/" then your file location must be "data/mylayer.shp". Using this convention
allows you to easily locate files when you upload them using Maps->Layer Management.
File names are case sensitives and spaces in file names must be absoutely avoided. The extensions
used for files in layer must stay with the same case sensitivity. A shapefile is usually made of a shp,
idx, dbf files while a Mapinfo layer is made of TAB, ID, MAP, DAT (and sometimes IND) files.

Shapefile
LAYER
NAME "My Layer"
TYPE LINE
STATUS ON
DATA "data/myshapefile.shp"
CLASS
COLOR 255 0 0
NAME "My layer legend"
END # end of class
END # end of layer

In this example we see that the file is located in "data/", it is made of LINE objects that will be
displayed with the COLOR red. The layer should be drawn on the map by default (STATUS ON),
and it will be indicate as "My Layer" in the layer manager on the map, while being indicated as "My
layer legend" in the LEGEND.

Mapinfo TAB
The difference with a shapefile is the use of the OGR library to read the Mapinfo files. The
keyword CONNECTIONTYPE OGR must be used and the location of the file is given by the

508 Back to TOC

 Tikiwiki Documentation 1.9+

keyword CONNECTION instead of DATA. All the rest stay the same.
LAYER
NAME "My Layer"
TYPE LINE
STATUS ON
CONNECTIONTYPE OGR
CONNECTION "data/mymapinfofile.TAB"
CLASS
COLOR 255 0 0
NAME "My layer legend"
END # end of class
END # end of layer

Query
To make the layer queryable add anywehere inside the LAYER object the following lines:

TEMPLATE "query.html"
TOLERANCE 3
TOLERANCEUNITS PIXELS

The first parameters is necessary but does not need to pint to a real file. It is only used outsied
tikimaps. The second parameters specify the pointing TOLERANCE in TOLERANCEUNITS, here
3 pixels. If you click on the map all the objects from this layer which are at less than 3 pixels from
the click on the image will be selected.
The map is then redraw and at the bottom of the page will be the information related from the
object.
Note: if you create a GIS layer which fields contain HTML tags, like for IMG or A (anchor/link),
they will be rendered accordingly. This allows you to create a layer pointing to images stored on
Tiki.

Labels
You can use querying to know which fields a GIS layer contains. From these fields you can select
on to be used a object labels in the map. For instance you have a GIS layer which contains country
names. The name of the country is in the field "NAME". You will use LABELITEM "NAME" to
tell the mapserver which field to use for labels.
Inside the CLASS object, you would specify how you want the labels to be rendered. For instance
in our example the layer would look like this:
LAYER
NAME "Country Names"
TYPE POINT
STATUS ON
METADATA
DOWNLOAD "T"
END
LABELITEM "NAME"
LABELCACHE ON
CONNECTIONTYPE OGR
CONNECTION "data/Country.TAB"

Back to TOC 509

 CLASS
SYMBOL 0
COLOR 0 0 0
NAME "Country Names"
LABEL
COLOR 0 0 0
FONT arial
TYPE TRUETYPE
POSITION CC
PARTIALS TRUE
SIZE 7
BUFFER 1
OUTLINECOLOR 255 255 255
END
END
END

In this example LABEL is black (COLOR 0 0 0) using the arial FONT which is a TRUETYPE font.
The POSITION of the label is Center/Center in regard to the POINT object. If an object is not fully
on the map, the LABEL is still drawn (PARTIAL TRUE). The SIZE of the label is 7 points. There
are no labels closer than 1 pixels from each others (BUFFER 1). For this last parameter to work,
you need to enable the LABELCACHE. Finally the label is surrounded by a white outline
(OUTLINECOLOR 255 255 255).

Thematic Mapping
Each layer contans one or more CLASS. The CLASS defines how each object should be drawn on
the screen. by using CLASSITEM, you can use one field to separate objects in classes. For instance
all the bathymetric lines which depth is between -100m and -500m belong to one class while each
bathymetric lines which depth is between -500m and -1000m belong to another class. The
separation into CLASS is made using an EXPRESSION in each CLASS. The EXPRESSION uses
simple logic based on the field in CLASSITEM.
For instance in the example below we use the field "value" which contain the water depth of the
LINE object to display this line object in various colors depending of the depth. If the
EXPRESSION is true then the parameters in the CLASS apply. A CLASS without an
EXPRESSION is a default CLASS for all the objects which have not been classified otherwise.
LAYER
NAME "Bathymetry 20m"
TYPE LINE
STATUS OFF
METADATA
WIKI "FijiBathymetry"
END
TEMPLATE "query.html"
TOLERANCE 3
TOLERANCEUNITS PIXELS
LABELITEM "Value"
CLASSITEM "Value"
LABELCACHE ON
CONNECTIONTYPE OGR
CONNECTION "data/fiji/viti_bathy_contour.TAB"
CLASS
SYMBOL 0

510 Back to TOC

 Tikiwiki Documentation 1.9+

COLOR 0 200 255

NAME "Bathymetry 2.5m >-50m"
EXPRESSION ([Value]>-50)
LABEL
ANGLE AUTO
COLOR 0 0 0
FONT arial
TYPE TRUETYPE
POSITION cc
PARTIALS FALSE
BUFFER 5
SIZE 6
OUTLINECOLOR 200 200 200
END
END
CLASS
SYMBOL 0
COLOR 0 100 255
NAME "Bathymetry 20m >-500m"
EXPRESSION ([Value]<-50 AND [Value]>=-500)
LABEL
ANGLE AUTO
FONT arial
COLOR 0 0 0
TYPE TRUETYPE
POSITION cc
PARTIALS FALSE
BUFFER 5
SIZE 6
OUTLINECOLOR 200 200 200
END
END
END

Metadata
Inside a LAYER group you can have a METADATA group. Some of this metadata is used for
special purposes inside tikiwiki. There is only one METADATA group inside a LAYER group.

WIKI
Using WIKI creates a link from the layer name to a wiki page. Use the wiki page to indicate some
information on the layer:
• custodian
• ownership
• date of creation
• accuracy
• history
• datum/projection
• interesting layer features
• ...
METADATA

Back to TOC 511

 WIKI "MyLayerPage"
END

DOWNLOAD
If DOWNLOAD is set to "T" then the files that forms the layer can be downloaded by a registered
user.
METADATA
DOWNLOAD "T"
END

The system selects all the files with the same base name as defined in the LAYER DATA or
CONNECTION clause but with different extension. However if one of these files has the extension
NDL, the download is disabled. This allows to upload GIS data that can only be viewable.

Raster layer
The easiest way to handle raster layers is to use Geotiff images which contain projection
information. However making geotiff images may need advanced remote sensing software. The
other way is to use an additional file which contains information about the coordinates of the pixels
in the image file.
When several images are used instead of using a layer for each image they can be tiled. A shapefile
is created with a rectangel for each image which helps the system to find the right image for the
right location.

Geotiff
Using a geotiff image in a layer is simple, the TYPE RASTER is used with DATA pointing to the
tiff file. the keyword OFFSITE is used to define which color in the tiff image should be used for
transparency. This is useful when tiling or overlapping several images.
LAYER
NAME "DTM 50m"
TYPE RASTER
STATUS OFF
DATA "data/fiji/VLevudtm.tif"
OFFSITE 0 0 0
END

Image Tiles
Images tiles are created using utility tools from the mapserver software. The utility is called
gdaltindex and parses mainly geotiff images to get their boundaries and create a shapefile
containing an outline for each of the images. Under Maps->Layer Management, at the bottom of the
page a utility is avalilable to generate the shapefile. Basically upload the images to the right
directory. The images should have the same name prefix. Then reference all these images with a
wildcaard and name the shapefile to be created. For instance you can upload coralcoastsigatoka.tif,

512 Back to TOC

 Tikiwiki Documentation 1.9+

coralcoastmomi.tif, coralcoastnavua.tif and reference them as coralcoast*.tif and create the

shapefile img_index.shp
LAYER
NAME "Coral Coast 4m IKONOS"
TYPE RASTER
METADATA
WIKI "FijiImagery"
END
STATUS ON
TILEINDEX "data/fiji/img_index.shp"
TILEITEM "Location"
OFFSITE 0 0 0
END

Grid Layer
A grid layer allows you to draw a grid in the local cordinates on your map. It is useful to find
location of objects on the map. For best effect the grid must be the last layer in the mapfile to be
drawn the last.
LAYER
NAME "Grid"
TYPE LINE
STATUS OFF
CLASS
COLOR 0 0 0
LABEL
FONT arial # must be in your FONTSET
TYPE TRUETYPE
SIZE 8
COLOR 0 0 0
OUTLINECOLOR 255 255 255
END
END
GRID
MINARCS 2
MAXARCS 6
END
END

Maps MapView

Working with Views

Please read the documentation of the Mapserver and read the Maps Mapfile Tutorial if you need to
learn the basics of a Mapfile.

Back to TOC 513

Creating Views

Specifing the View

The VIEW must be used as VIEW1,VIEW2,VIEW(n)...VIEW30. Followed by a location
id/location name and the extents in double qoutes.
VIEW1 "location id, "
VIEW2 "location id, "
VIEW3 "location id, "
...
...
VIEW30 "location id, "

Set View Extents

Get the map extents for the view you want to display and set the minx, miny, maxx, maxy values
inside the double qoutes " " separated by coma ','.
VIEW1 "location id,minx,miny,maxx,maxy"

Adding in the Views

A Mapfile contains a WEB object. Inside the WEB object the METADATA keyword can be used
to store your views and close it with an END. You can have up to a maximum of 30 views.
#
# Start of web interface definition
#
WEB
...
....
.....
METADATA
VIEW1 "location id,minx,miny,maxx,maxy"
VIEW2 "location id,minx,miny,maxx,maxy"
VIEW3 "location id,minx,miny,maxx,maxy"
....
...
VIEW30 "location id,minx,miny,maxx,maxy"
END
....
...

END

514 Back to TOC

 Tikiwiki Documentation 1.9+

4.26.3. Maps Admin

Installation
Read first Maps Install and then proceed to configuration.

Configuration
Maps Config configure the maps feature.
See also the Maps Mapfile Tutorial to understand mapfiles and how to create them.

4.26.3.1. Maps Install

Pre-requisites
You need Mapserver v4.6 php_mapscript.so and have your .map files in /var/www/html/map/.
This is configurable from the admin panel: Maps Config, but first ensure that you have enabled the
maps feature in Admin.

Mapserver v4.6 mapscript is now capable to work as an extension to the php apache module

The default map file is pacific.map, it will be loaded if you do not specify anything when clicking
on tiki-map.phtml. This is also configurable from the Admin/Features menu.

Compilation of mapscript
I use the following to compile mapserver.so, but now you may find ready made packages for
various distributions:
./configure --with-proj --with-gdal --with-ogr --with-wms --with-php=/usr/include/php --without-tiff
--with-threads
make

Installation of mapscript
I then copy the file mapscrip/php3/php_mapscript.so into the php extension directory, usually
/usr/lib/php/extensions. I then need to get php to load automatically this extension. I create an ini
file for that.

/etc/php/40_mapscript.ini
#Loads the MapScript extension
extension = php_mapscript.so

To test if the extension is correctly loaded with all library dependencies, install php as command

Back to TOC 515

line inteface and run:
php -m

You should see the module MapScript loaded correctly. If a library is missing then you will have to
install it too. Check the error messages generated at the beginning by php -m. Most common
libraries to install grass, proj, gdal,...

Check in your Apache configuration that phtml files like php files are handled by the Apache php
module.

Creation of directories and installation of sample data

I now downlaod the tikiwiki-mapdata package, that you can find in the file section of the tikiwiki
project on sourceforge, and I install the contents into the directory /var/ww/html/map. It contains a
world.map file and the data that goes with it in the data/world directory.

Your files that compose the layers must be in the data subdirectory of where are your map files. ie
/var/www/html/map/data. They are then manageable with the Layer Manager inside Tiki. You can
create subdirectories and upload your geographic files using the Tiki interface.

You need to create a directory /var/www/html/map/images. The mapscript will save the generated
maps/images into this directory and Apache will serve them to the browser.

Now ensure that everything under the directory /var/www/html/map is owned by apache.apache, the
user and group that runs Apache.
chown -R apache.apache /var/www/html/map

You should have this directory structure:

/var/www/html/map
/var/www/html/map/world.map
/var/www/html/map/images/
/var/www/html/map/data/
/var/www/html/map/data/world/
/var/www/html/map/data/world/* (layers)

This directory structure is unsafe, I use the following conf file for Apache to ensure that the maps
and data directory are protected against direct download of data. Some of the data you upload
should be only visible as rendered as a map.

/etc/httpd/conf.d/41_mapserver.conf
#protect mapserver against downloads
<Directory /var/www/html/map>
AllowOverride All
Options -Indexes FollowSymLinks MultiViews ExecCGI

516 Back to TOC

 Tikiwiki Documentation 1.9+

<IfModule mod_access.c>
Order allow,deny
Deny from all
</IfModule>
</Directory>
<Directory /var/www/html/map/images>
AllowOverride All
Options -Indexes FollowSymLinks MultiViews ExecCGI
<IfModule mod_access.c>
Order allow,deny
Allow from all
</IfModule>
</Directory>
<Directory /var/www/html/map/graphics>
AllowOverride All
Options -Indexes FollowSymLinks MultiViews ExecCGI
<IfModule mod_access.c>
Order allow,deny
Allow from all
</IfModule>
</Directory>
<Location /tiki/files>
AllowOverride All
Options -Indexes FollowSymLinks MultiViews ExecCGI
<IfModule mod_access.c>
Order allow,deny
Allow from all
</IfModule>
<IfModule mod_mime.c>
SetHandler default-handler
</IfModule>
</Location>

Before Mapserver 4.6, php mapscript was obliged to run under a php cgi module. This is why the
map rendering page is called tiki-map.phtml instead of the classical php extension. Fortunately
since, the mapscript runs inside the php apache module.

When someone wants to download a layer, all the files are copied in the /tiki/files location for
download. Unfortunately on my system the file with the extension .MAP are handled as html maps.
I created a special directive for http to handle all the files in the /tiki/files directory as normal files
as you can see in the apache configuration file above.

Automatic removal of generated images

You also need to add a file to delete generated images, or the /var/www/html/map/images directory
will grow indefinitively. I use a file in cron:
/etc/cron.hourly/mapwatch
/usr/sbin/tmpwatch -f 2 /var/www/html/map/images/

This will check every hours for file older than 2 hours and delete them.

Back to TOC 517

 Complete setup in Tiki
Finish the setup on the admin panel with Maps Config. If you have used the tikiwiki-mapdata
package ensure the default mapfile is world.map.

Then you need to create a mapfile and set the correct paths see Maps Mapfile Tutorial. If you have
used the tikiwiki-mapdata and the paths indicated in this install then you should be set, otherwise
you need to edit the world.map file to point to the various paths you have chosen.

Finally ensure that some groups have the correct permissions to view, create and delete mapfiles
and their data.

4.26.4. Maps Config

On this page you configure the following:
Title Description
full path to mapfiles: the location where are the .map files on this server
default mapfile: the map that is displayed by default when you click on maps on the application menu
Wiki Page for Help: a wiki page to explain how the maps interface is working
Wiki Page for
a wiki page to put any type of comments
Comments:
Full path to
the path on this server of gdaltindex to allow the system to create a tiled shapefile of images
gdaltindex:
the path on this server to the ogr2org binary to allow the system to create shapefiles containing
Full path to ogr2ogr:
user position (My Preferences) or image position (Image Galleries)
Map Zone: select which zone in degrees you are working with

• Click on the button change preferences to update the above

• Click on the button Generate User Map to create a shapefile containing the position of all
the registered users who have indicated a latitude and longitude in their preferences.

518 Back to TOC

 Tikiwiki Documentation 1.9+

4.27. Google Map feature (Gmap)

Tikiwiki has more than one map feature, tikimap? can handle a huge number (5000+) of objects,
Gmap provides the convenience of having Google maintain your mapserver. This implementation
uses v2 of the google map API, documented on http://www.google.com/apis/
maps/documentation/reference.html

What it does
The googlemap can
• provide a display of a map with a set location.
• store geolocations from user input
• show where all the site's users are on the map
• search and categorize geolations.

Quick Guide to Setup GMap

1. requires at least Tikiwiki 1.9.4
2. request a google key on http://www.google.com/apis/maps/signup.html
3. enable google map in features admin panel tiki-admin.php?page=features
4. add googlemap key to /tiki-admin.php?page=gmap (and only key) and save
5. when key is added that page presents a map so you can setup default center and zoom level
6. the link to googlemap locator is now added in user preferences page
7. admin can setup and change location for any user from adminuser page
8. add a link to /tiki-gmap_usermap.php in your navigation

Back to TOC 519

 From here:
• tiki-gmap_usermap.php and templates/tiki-gmap_usermap.tpl
Bonus
• check http://video.google.com/videoplay?docid=8056461464933652343&q=dennis+daniels
for some live experience

4.27.1. Google Maps User

As explained before, the main use for Google Map is to provide a way to store geolocations from
user input easily, and provide an easy display of such a map.

4.27.1.1. Set up your coordinates

You can set up the coordinates of your location through "MyTiki > Preferences > Personal
Information", as Longitude and Latitud (in WGS84/Decimal degress).

If you don't know them, you can use the "Google Map Locator" link instead (tiki-
gmap_locator.php?for=user)

520 Back to TOC

 Tikiwiki Documentation 1.9+

There, you have some buttons to make commons actions related to the Google Map for that user or
for the whole tiki:
Link Action
Back to preferences Go back to your preferences screen
Save clicked point Save that point (Longitude, Latitude, and scale fields, on the left of the button)
Save current view as default Save that view as the default for that user
Reset to site-wide default Save that view as the default for the whole tiki site

At last, you can see the users map through "tiki-gmap_usermap.php" (hibrid map in the
screenshot: Satellite + Geographic Map):

Back to TOC 521

4.27.2. Google Maps Admin

Google Maps icon

Google Map feature can be enabled through "Admin home > Features > Google Map".

It can be initially set up for the whole Tiki through "Admin home > Google Maps" (tiki-
admin.php?page=gmap).

First time, it will recognize that you don't have any Google Map key for your specific web site
domain (required), and it will suggest you to request one at:
http://www.google.com/apis/maps/signup.html

One you complete the process in the Google site side, yuo can come copy the generated key to the
correspongfing field in tiki-admin.php?page=gmap. Once done, you will be able to see your map
below, like this:

522 Back to TOC

 Tikiwiki Documentation 1.9+

4.27.3. Google Map Details

There are some improvements made to Tiki to take advantage of Google Maps.

4.27.3.1. Geolocation of Tracker items

(for Tiki version 1.10)

Items in a tracker can be geolocated:

Back to TOC 523

 4.27.3.2. Panoramio

Other similar features (which also Google Maps) could be introduced in your Tiki installation.

For instance, Panoramio, a photo-sharing community using Google Maps ("Discover the world
through satellite photos" - http://www.panoramio.com ).

This kind of simple feature could included through creating and using those two files in your tiki
installation:

tiki-panoramio.php
<?php
include 'tiki-setup.php';

524 Back to TOC

 Tikiwiki Documentation 1.9+

$default_lon = '2.338';
$default_lat = '48.89';
$default_zoom = '3';
$default_kind = '2';

if (isset($_REQUEST['lon'])) { $lon = preg_replace('/[^0-9\.-]

/','',$_REQUEST['lon']); }
else { $lon = $default_lon; }
if (isset($_REQUEST['lat'])) { $lat = preg_replace('/[^0-9\.-]
/','',$_REQUEST['lat']); }
else { $lat = $default_lat; }
if (isset($_REQUEST['zoom'])) { $zoom = preg_replace('/[^0-
9]/','',$_REQUEST['zoom']); }
else { $zoom = $default_zoom; }
if (isset($_REQUEST['kind'])) { $kind = preg_replace('/[^0-
9]/','',$_REQUEST['kind']); }
else { $kind = $default_kind; }

$smarty->assign('lon',$lon);
$smarty->assign('lat',$lat);
$smarty->assign('zoom',$zoom);
$smarty->assign('kind',$kind);

$smarty->assign('mid','tiki-panoramio.tpl');
$smarty->display('tiki.tpl');
?>

templates/tiki-panoramio.tpl
<form>
<input type="text" name="lat" value="{$lat}" size="8" />
<input type="text" name="lon" value="{$lon}" size="8" />
<input type="text" name="zoom" value="{$zoom}" size="2" />
<input type="text" name="kind" value="{$kind}" size="2" />
<input type="submit" name="act" value="{tr}send{/tr}" />
</form>
<div>Map is grabbed with panoramio plugin.</div>
<iframe
src=http://www.panoramio.com/plugin.php?lt={$lat}&amp;ln={$lon}&amp;z={$zoom}&am
p;k={$kind}
width="100%" height="600px" border="0" style="border:0;"></iframe>

Technical details
This implementation uses v2 of the google map API, documented on http://www.google.com/apis/
maps/documentation/reference.html
Related pages

Back to TOC 525

 • Google Maps
• Google Maps User
• Google Maps Admin

• http://www.panoramio.com
• http://tikiwiki.org/TikiPanoramio

526 Back to TOC

 Tikiwiki Documentation 1.9+

4.28. Tikibot

4.28.1. Tikibot User

4.28.2. Tikibot Admin

4.28.3. Tikibot Details

Back to TOC 527

4.29. Mobile Tiki
All TikiWiki based sites have the ability to be browsable through WAP enabled mobile phones or
PDA pocket based browsers, thanks to the power of the HAWHAW library.

This is currently limited to Wiki pages, Articles and Forums. Future support for other TikiWiki
areas and authentication is planned for the future. In either small font size or magnified version:

Small font size

528 Back to TOC

 Tikiwiki Documentation 1.9+

Magnified font size

You can follow its development on this dedicated Mobile Tiki website:
• http://mobile.tikiwiki.org/

4.29.1. Mobile Tiki User

This is how a user will see a MobileTiki enabled site through the computer web browser:

This same page, in the mobile version, will look much simpler, using either small fonts:

Back to TOC 529

Or a magnifying version with larger fonts for visually handicapped people:

4.29.2. Mobile Tiki Admin

530 Back to TOC

 Tikiwiki Documentation 1.9+

4.29.3. Mobile Tiki Details

Back to TOC 531

4.30. Structures
Structures organize a group of wiki pages into a tree or book that can be easily navigated by users.
The pages are placed in a hierarchy that you specify, with blank pages created where they do not
already exist. Creating a structure is the fastest method for creating multiple pages at once.
Navigation aids are automatically created to help user move through the structure.

Related pages.
Structure User
Structure Admin
Structure Details

How to use Feature

Enable the Feature

Structures are on by default if the wiki feature is enabled.

Requirements
A user needs to be granted this permissions in order to enabling him/her to edit structures:
Allows a user to be able to create and edit
tiki_p_edit_structures
structures

Try it out
For example, note that this page is in fact in a structure. The house icon ( ) and the arrows on top
of this page - they allow you to navigate between pages of this manual which is a structure
(backwards: | up: | forward: ).

If the user belongs to a group with the required permission (see above), you can add pages to the
structure from any page which already belongs to it:

532 Back to TOC

 Tikiwiki Documentation 1.9+

You can create table of contents using the toc syntax (explained in the following pages); e.g. the
one you see on the top (or "root") page of this structure by clicking on the house icon ( ):

More information
See more information about its usage at Structure User, and about managing structures at Structure
Admin.

4.30.1. Structures user

Structures are used to group an arbitrary set of wiki pages into a navigable tree . They are very
useful for grouping Wiki pages into documentation, manuals, FAQs, HowTos, etc.

4.30.1.1. Navigating Structures

When browsing through the Wiki:

• If a page is part of one or more structures, a select box containing the word 'structures...' will
appear at the top of the page. Select the structure name from this list to activate it.
• If the wiki page is the structures root Wiki page, the structure will be automatically
activated.

Once a stucture is active, pages belonging to the structure are displayed with a navigation bar.

Back to TOC 533

The navigation bar provides icons to the next, parent, previous and homepage structure pages. In
1.10, there will be a tree icon which you can click to see the structure layout tree. On that page, if
you have "tiki_p_edit_structures" permissions, you can modify the structure (see "Editing an
Existing Structure" on Structure Admin for more info.

4.30.1.2. Slide Show

If the slide-show feature is enabled, selecting the 'slides' button from the page bar will display a
structure page as a slide-show!

4.30.1.3. PDF Creation

If the pdf-creation feature is enabled, selecting the 'pdf' icon whilst viewing a structure page will
populate the pdf document with the relevant wiki pages from the structure. (chris.holman: Aliases
and toc items dont work at present)

4.30.1.4. Table of contents tag ({toc})

To display the table of contents below the current page, you can use the wiki tag . Default options
for the possible parameters are shown below in bold.

Parameter Value Description

order asc or desc order (default asc)
showdesc 0 or 1 show the description of the page (default 0)
shownum 0 or 1 show the numbering (default 0)
plain or if fancy, show automatically the description of the page and use the fancytoclevel class
type
fancy for each line instead of tolcevel class (default plain)
structId number the id of the structure or the name of the structure(tw >1.10)
maxdepth number maximum depth of tree to be created, any number starting from 0, 0 means no limit and is

534 Back to TOC

 Tikiwiki Documentation 1.9+

the default

Using a {toc} tag in a page belonging to a structure will display a Table Of Contents for any sub-
pages the page has. For this to work, the page must have sub-pages.
• Used in the structures 'root' page, this creates a full TOC.
• Used in a sub-page, this creates a chapter TOC.

Example 1: type plain

This code:
{toc order=asc shownum=1 type=plain }

Would produce on the main page of a structure (using the Documentation page in this example):

Example 2: type fancy

This code:
{toc order=asc shownum=1 type=fancy }

Would produce on the main page of a structure (using the Documentation page in this example):

Example 3: type fancy, showdesc

This code:

Back to TOC 535

{toc order=asc shownum=1 type=fancy showdesc=1 }

Would produce on the main page of a structure (using the Documentation page in this example):

Note that in this example, the description is used as the name of the page, instead of the title field,
which is shown next to it. If a page has no description field (like in many pages of the structure in
this example), no title is shown for the page, and no description is shown next to it. Since the link is
shown at the page name, no description field means no link to go to that page. So that only use this
option if ALL your pages have the description field set.

4.30.2. Structures Admin

4.30.2.1. Managing Structures

Clicking on 'Structures' in the Wiki sub-menu will take you to a page listing existing structures and
a form to create new structures (tiki-admin_structures.php). This menu item will only be
displayed if you have the permission "tiki_p_edit_structures"

In 1.10, you can access the menu item even without "tiki_p_edit_structures" to see the list of
existing structures, but you will not see the form to create new structure, or any of the editing
features.

Also, in 1.10, the ability to remove, create webhelp, and dump tree (see description of these
functions below) requires respects the permissions (whether object or category) set on the structures
'root' page. So a user must have edit rights on this 'root' page to access these functions. The ability
to view/access in the listing, also respects the permissions (whether object or category) set on the
structures 'root' page.

In 1.10, activation of the "create webhelp" feature is also controlled by an option in the admin Wiki
Config screen.

536 Back to TOC

 Tikiwiki Documentation 1.9+

Structures
A list of existing structures is displayed along with the following icons:
Icon Action Description
Export Exports the wiki source the wiki pages in the structure
Dump tree Exports the tree of the structure suitable for copying or editing
Remove Deletes the structure and optionally the associated wiki pages
Create webhelp Generates an tree menu and static HTML pages from the structure
View webhelp View the generated webhelp

Create New Structure

The 'Structure ID' is used as the name of the structures root Wiki page. If the Wiki page doesn t
exist it will be created when creating the structure. The 'Alias' is an alternative name for the
structures root Wiki page. If an alias exists, this will be used in preference to the real Wiki page
name. This is useful for common page names such as 'contents' or 'introduction'
The 'Tree' field enables the user to provide a skeleton structure tree. Each line of the tree indicates a
consecutive Wiki page in the structure.
• To create an indented tree structure, precede the Wiki name with space(s).
• To include an alias for the wiki name, append the Wiki name with '-> alias'.
An example of 'Tree' might look like this:
Tree Example

Wiki -> Introduction

Using Wiki Pages
Wiki Links
Wiki Lists
Wiki Images
Wiki Text Formatting

Back to TOC 537

 Wiki Special Characters
Wiki Admin -> Administration
Wiki Details

To create a new structure upon this dump tree, you would need to add just the structure name, and
optionally an alias. In this example, the form to create a new structure would look like:

After you create this structure, you'll have a nine page group of wiki pages, including whatever
amount of those pages that were already created in the same Tiki site. And you will see the structure
listed like:

If you click on the name of the new structure created ("Feature001 (Feature Wiki)", in this
example), then you will be able to manage the structure: move nodes, add brand new pages to it or
from existing pages in the same Tiki (see further down), and you will be able to see the structure
layout:

For instance, if you click on the view link, next to "1. Wiki(Introduction)" node, you will see the
page "Wiki", named as "Introduction", with all the navigation aids at the top of the page.

538 Back to TOC

 Tikiwiki Documentation 1.9+

If you add a "toc" ("table of contents" tag) to that page (regardless that you are at the root page of
the structure or not), you will see the table of contents for that page (Wiki). For instance, adding this
code to the page:
{toc shownum=1 }

would produce a numbered table of contents of the child pages starting from this node (but not the
ones in the same level as this page or higher levels):

Tip_: See Structure User for more information on the toc__ tag syntax and optional parameters
allowed.

When your user belongs to a group with the permission "tiki_p_edit_structures", you will see a
mini-form on each navigation bar to create new pages if needed just after this one, or as child pages
from this one if you select the "Child" check box next to it (see example just above).

When you are not logged in, or a user in groups without this permission, you would see a plain
navigation bar on top of each page:

Back to TOC 539

The following sections explains you how to create, delete, move, and re-prioritize the pages in your
structure

Editing an Existing Structure

Select a Structure from the list to open the 'modify structure' page. In this example, it is
"Feature001 (Feature Wiki)", as seen from the list of structures:

In 1.10, the ability to edit an existing structure respects the permissions (whether object or category)
set on the structures 'root' page. So a user must have edit rights on that 'root' page to be able to edit
the structure. A user with view rights but no edit rights on that 'root' page will be able to access the
structure tree, but not edit it.

The form at the top of 'Modify Structure' page (tiki-edit_structure.php?page_ref_id=1, in our

example) indicates the current node. The default selected node is the structures 'root' page. Select an
alternative structure node to edit from the 'Structure Layout' tree at the bottom of the page (selected
"Using Wiki Pages" node in this example):

Use the 'Update' button to add or update the current nodes 'Page alias'.

540 Back to TOC

 Tikiwiki Documentation 1.9+

Use the navigation buttons to move the current node to a different position within the 'Structure
Layout'. The current node will be highlighted in bold (except the root node, which is never
highlighted).

Adding Pages to Current Node

Any pages that you add will be added as sub-pages to the 'current node' and inserted after the page
indicated by 'After Page'.
• If you enter a Wiki name in the 'create page' field, a new Wiki page of this name will be
created. If populated, this field takes precedence over the 'Use pre-existing page' field.
• The 'Use pre-existing page' field allows the user to insert one or more existing pages. The
filter field can be used to restrict the set of existant pages.

Structure Layout
The 'Structure Layout' provides links to:
• View the referenced wiki page: Only if you have the relevant permissions
• Edit the referenced wiki page: Only if you have the relevant permissions
• Remove the page reference from structure: If you click 'x' to remove a page, the system will
ask if you want to remove the page from the structure or if you want to remove the page
completely.
Note that if the page being removed has subpages, all the subpages will be removed recursively
from the structure. (The underlying wiki pages will also be removed if you choose the 'remove page
too' option)

Table Of Contents
See Structure User for more information on the table of contents syntax (using the toc tag) and
optional parameters allowed.

Slide Show
If the slide-show feature is enabled, selecting the 'slides' button from the page bar will display a
structure page as a slide-show!

PDF Creation
If the pdf-creation feature is enabled, selecting the 'pdf' icon whilst viewing a structure page will
populate the pdf document with the relevant wiki pages from the structure. (chris.holman: Aliases
and toc items dont work at present)

Webhelp
The basic idea is to generate a WebHelp from a Tiki Structure (Structure = a tree of wiki pages as
you know)
From the structures menu you will see a button to create a webhelp ( ).

Back to TOC 541

The webhelps are created in whelp/$name where name is configurable and defaulted to the name of
the root of the structure.

The generated webhelp is a static representation of the structure with a js tree that can be used to
navigate the structure and a search function, print function, history and some other gizmos.

This feature aims to allow distributing whatever documentation you create through structures at
your Tiki site in an usable format for users. Since structures can be re-created whenever you want,
you can also keep an online version in your site updated quite easily.

Example of Usage:
• http://themes.tikiwiki.org/whelp/Tiki%20Transforming/index.html

Related pages
• Structure
• Structure User
• Structure Details

4.30.3. Structure Details

StructuresTechnical Reference

This page may not be complete. Please correct as needed

Database Tables

MySQL
tiki_structures
tiki_structure_versions

542 Back to TOC

 Tikiwiki Documentation 1.9+

PHP Modules

./tiki-import_structuredtext.php
./tiki-admin_structures.php
./tiki-edit_structure.php
Templates

./templates/structures_toc_level.tpl
./templates/tiki-import_structuredtext.tpl
./templates/structures_toc-endul.tpl
./templates/structures_toc-leaf.tpl
./templates/structures.tpl
./templates/structures_toc-startul.tpl
./templates/tiki-admin_structures.tpl
./templates/structures_toc.tpl
./templates/tiki-edit_structure.tpl
Known Bugs

View Structure Bugs Here

Permissions
tiki_p_edit_structures
Development Roadmap
This has a lot of potential but there's a lot to improve in the presentation and very raw code I just
introduced.

From WebHelp:
PS: One to-do is to make the CSS of the webhelp compatible with the default style for the site, in
order to do this I think that we must edit the base (.html) files in the lib/tikihelp directory and make
them use elements
already defined in the style instead of redefining new elements.

External Links

Developer Notes
An upgrade of structures was done in 1.10. The documentation the pages linked to this page makes
some mention as to what is available.

Developers Contact
koth (or I am usually nkoth on IRC)

Feature FAQ
Any Questions? Add it to the faqs

Back to TOC 543

Related Category

Include the appropriate category display using the Category Plugin?.

External Links
A list of links outside of tw.o (Wikipedia, RFC's, Other Manuals)

544 Back to TOC

 Tikiwiki Documentation 1.9+

4.31. Slideshows
Slideshows allow you to create simple presentations via Wiki Syntax or by creating a Structure.
You can customize the appearance of the show via CSS. Some uses for slideshows:
• classroom lectures
• business presentations

4.31.1. Slideshow User

4.31.1.1. Starting a Slideshow

Click the "Slides" button at the bottom of the wiki page.

4.31.1.2. Example:

See this page: http://tikiwiki.org/Presentation20050319Crisol_Argentina

From this normal looking Tiki page (central and right columns in wiki view mode)...

...when you click on the slides button, you can see it in the slides presentation mode (showing slide
2 in this screenshot):

Back to TOC 545

Slides add automatic links to previous and next slides, home slide and edit page link. Moreover, the
slides allow shadowing when the mouse pointer is over items in a bulleted or ordered list. The color
of the shadow can be changed in the .css file selected in the settings as admin.

4.31.2. Slideshow Admin

4.31.2.1. Enabling Slideshows

Select Admin--->Wiki and check the slection box "Uses Slideshow". (See below)

546 Back to TOC

 Tikiwiki Documentation 1.9+

4.31.2.2. Changing Slideshow Appearance

To change the appearance of your slides, select the CSS file to use in the Admin--->General panel.
(See below)

4.31.3. Slideshow Details

Slideshow Technical Reference

This page may not be complete. Please correct as needed

Database Tables

There are no specific tables for Slideshows

PHP Modules
./tiki-slideshow.php
./tiki-slideshow2.php
Templates
./templates/tiki-slideshow.tpl
CSS Files

./styles/slideshows
./styles/slideshows/slidestyle.css
./styles/slides

Known Bugs

View Slideshow bugs and wishlist here

Permissions
Permissions are controlled by the wiki pages
Development Roadmap

Back to TOC 547

Slideshow CSS editing was supposed to be added in 1.8.x.
External Links

548 Back to TOC

 Tikiwiki Documentation 1.9+

4.32. Comments
Some screenshots are needed. urgent help needed in this and related pages since this is a very basic
a commonly used feature on most tikis. Copied from CommentDoc

Comments can be used in:

• Articles
• Wiki pages
• Blogs
• Blog posts
• Image galleries
• File galleries
• Polls
• FAQs
• Trackers

If you enable comments for some of the features of Tiki from the admin menu you will see links to
show/hide comments and the number of comments for the object being viewed. In this section we'll
explain comments for Tiki pages, everything will be the same for other Tiki features such as
articles, blogs, polls, etc.

insert graphic

If you see this bar at the bottom of the central part of the screen (or somewhere else if the
customization changed the appearance) then you can see/enter comments. Click the Show
comments link to display comments and a form to post new comments (if you have the permission).

4.32.1. Comments User

Some screenshots are needed. urgent help needed in this and related pages since this is a very basic
a commonly used feature on most tikis

4.32.1.1. Posting a Comment

If you are a registered user, you should first login before posting comments, this will allow the
posting to be attributed to you.

Both title and comment body are required.

4.32.1.2. Controlling the display of comments

insert graphic

You can see here the comments panel, you can enter a new comment, set which comments you
want displayed and see the comments. To get started enter some comment.

Back to TOC 549

The toolbar at the top can be used to configure how many comments to display per page, how
comments will be sorted (Score/Date), the minimum number of points for a comment to be
displayed, the minimum score for a comment to be displayed (threshold) and a find box to filter
comments containing some word. The top link can be used to get back to first page of comments
from any page of comments. If you reply to a comment replies will be displayed nested to the
comment as in the following screen:

insert graphic

Clicking any of the replies will take you to a page where replies for the comment are displayed and
you can enter a new reply or reply an existing reply.

If you are admin or the comment was entered by you as a registered user (not anonymous) you will
be able to edit a comment after posting. You will be able to remove this comment only if you have
the right permission.

4.32.1.3. Viewing Recent Comments

The wiki_last_comments module can be assigned to a column in Admin Modules, or inserted into
a page using
{MODULE(module=>wiki_last_comments)}{MODULE}

Which will produce:

Darrers wiki comentaris
1) Wysiwyg Editor: Re: wysiwyg
2) Wysiwyg Editor: wysiwyg
3) Wiki Page Editor: documentation for editor problems
4) Webmail: Debug 1.9, 1.10
5) Features: Re: Own dogfood
6) Upgrade 1.9.x to 1.9.7: Disable tiki-install.php?
7) Wiki: Re: Re: Temporarily Locked for security until fivos learns how to create greek pages a
part, and lin
8) Wiki: Re: Temporarily Locked for security until fivos learns how to create greek pages a part,
and link tr
9) Wiki: Temporarily Locked for security until fivos learns how to create greek pages a part, and
link transl
10)Wiki-Syntax Lists: Locked to avoid fivos editting the english page as if it was greek

550 Back to TOC

 Tikiwiki Documentation 1.9+

More documentation

4.32.2. Comments Admin

Some screenshots are needed. help needed in this and related pages since this is a very basic a
commonly used feature on most tikis

4.32.2.1. Voting

The voting options on each comment contribute to a user karma score system.
insert graphic

4.32.2.2. Comment perms

Comments in wiki
There is a super- permission tiki_p_wiki_view_comments that will allow or not comment on wiki
page. Without this perm, you can't view, post, edit a wiki comment. It's overwrite all others
folowing perms.

Comments in wiki, faq, poll...

- to view a comment, you need tiki_p_read_comments
- to post a comment, you need tiki_p_post_comments
- to edit a comment, you need to be the author or to have the perm tiki_p_edit_comments
- to delete a comment, you need the perm tiki_p_remove_comments

Of course a tiki_p_admin can do whatever he/she wants

4.32.3. Comments Details

Back to TOC 551

4.33. Contribution
(only for tikiwiki = 1.10+)
Improving this documentation is a kind of needed for 1.10. Some screenshots might need to be
replaced

Contribution allows a user to select some types of contribution at each time he/she creates or
modifies a wiki page, posts or replies to a comment, posts or replies a forum topic, posts to a blog,
or modifies a tikisheet (so far). They are very useful for educational scenarios, promoting and
enhancing students onto experiential-reflective learning (Kolb et al, 1975 ; De Pedro, 2006 ).

For instance, a contribution can be:

• support requests
• questions that allow new evolution on an electronic discussion/dialogue
• new hypothesis
• new information
• summarizing
• issues related to organization in the team of work
• ...

4.33.1. Contribution feature oveerview

4.33.1.1. Admin setting

The contribution setting is set in admin->contribution. A contribution can be mandatory or not in a

per-feature basis.

552 Back to TOC

 Tikiwiki Documentation 1.9+

These contributions are displayed in page history and, if chosen, in the comment or post.

Another setting related to contributions is at Admin -> Login ("Displays user's contribution in
the user information page:"). If enabled, a user will be able to see other user's activity log,
including his/her contributions on the report.

4.33.1.2. Examples

Forum
Example on forum post, prior to posting:

Back to TOC 553

and after posting:

The byte count in action log report does not take into account the lines starting by "> " or included
by QUOTE tags (previous message).

Wiki
Example at wiki edition time, showing the description of each item in the list of type of
contributions as a pop up blue window when the mouse passes over the help roud blue icon ( ).

554 Back to TOC

 Tikiwiki Documentation 1.9+

Example on Wiki page history:

Back to TOC 555

 Tikisheet
Example on a spreadsheet:

556 Back to TOC

 Tikiwiki Documentation 1.9+

4.33.1.3. Report contributions through action log

The action log feature can display them.

There is also a table reporting the evolution in time (weeks or days) of contributions:

Additions are shown in green background, deletions in pink, and the difference is shown without
any special background color. Units are either bytes or kb, specified previously through the
reporting filters described in Action log page, as well as start and end date, and if columns are days
or weeks.

The main goal of reporting them is showing students in tutorship sessions what the log of their
activity respect to the average of their class, for instace, as a simple way to enable students self-

Back to TOC 557

regulate their effort investment in the learning process of that activity/subject/course, etc. Many
other uses can be achieved with that information, and it is not intended to be the only way to
"grade" students activity but to enhance broad information to tutors about students activity to
improve feedback to student along the learning activity process, and not only as grading
information at the end.

4.33.1.4. Contributor feature

If enabled in Admin -> Contribution, a user is able to select which other mats of his/her group
where co-authoring (or just contributing, at least) to that wiki page edition.

Action log will reflect that contribution also.

Note that there is a setting to allow users to see user's contributions (within a user activity log) at
Admin -> Login ("Displays user's contribution in the user information page:"). If enabled, a
user will be able to see other user's activity log, including his/her contributions on the report.

References

558 Back to TOC

 Tikiwiki Documentation 1.9+

Kolb. D. A. and Fry, R. (1975)

Toward an applied theory of experiential learning. in C. Cooper (ed.) Theories of Group
Process, London: John Wiley.

De Pedro, X. (2006)
“Estimulación y evaluación del aprendizaje 'experiencial-reflexivo' del alumnado mediante la
formulación explícita del tipo de contribuciones”. Workgroup on Experiential-Reflective
Learning, at the Institute of Sciences of Education, University of Barcelona, Catalonia, Spain.
100 pp. (pdf: http://gclub.ub.es/dl55 )

De Pedro, X. (2007)
“New method using Wikis and forums to evaluate individual contributions in cooperative
work while promoting experiential learning: results from preliminary experience".
Communication Submitted to to WikiSym2007 (http://www.wikisym.org/ws2007 ): 2007
International Symposium on Wikis. Wikis at Work in the World: Open, Organic,
Participatory Media for the 21st Century. October 21-23, 2007, Montréal, Canada. (Pdf:
http://gclub.ub.es/dl61 )

Back to TOC 559

4.34. Copyright
The Copyright Management System (or ©MS) is a way of licensing your content, typically under
and open or free content license, such as the Gnu Free Documentation License or the Open Game
License. By switching this feature on you can define a content license for all your wiki content,
associate copyright notices with individual pages and even display a full license for printing.

Useful Links
• GNU/FDL
http://www.fsf.org/copyleft/fdl.html
• Open Game License
http://www.opengamingfoundation.org/ogl.html
• Open Publication License
http://opencontent.org/openpub/

4.34.1. Copyright Management User

The Copyright Management System (©MS) allows you to specify a content license under which all
wiki pages are published when submitted. When this feature is activated by an administrator (see
Copyright Admin for more information) new form elements appear on the Wiki Edit Page :

This allows users submitting content to attach a copyright notice to the page. The user enters the
title of work being copyright (which may or may not be different to the page title), the year of
copyright and the author(s) associated with the content.

Normal users can only add copyright notices to a page, and only administrators can delete or
modify submitted ones. Copyright notices can then be recalled using the Copyright Notice Plugin.
This is normally only done in the license page. To view the license for a particular page click on the
license link at the bottom of the page, for example:

This will take you the the license (in this case the OpenGameLicense) for that page. Depending on
how the administrator has set-up the license you may also be able to peruse all the copyright pages
for that page as well.

560 Back to TOC

 Tikiwiki Documentation 1.9+

Similarly, clicking on the PrintIcon will now take you to a full print-out of your page content and
the license under which it is published.

4.34.1.1. Editing Copyright Notices

The ©MS uses the permission tiki_p_edit_copyrights which allows users to access the copyrights
edit page. To access the copyrights edit page for a particular page, go to the license page for that
page and click on the link at the bottom of the page:

If you have permissions this will take you to the copyright edits page where you can edit the
copyright notices for that page:

This page allows administrators to alter the order of copyright notices, edit their data or add new
copyright notices.

To edit a copyright notice simply alter the information in the text boxes and click the 'edit' button on
the right-hand side.

To delete a copyright notice click on the 'x' on the right-hand side.

To move a copyright notice's order click on 'up' or 'down' on the right-hand side.

To add a new copyright notice simply fill in the information in the empty text boxes at the bottom
of this page, as you would adding a copyright notice in the wiki edit page above, and click the 'add'
button.

4.34.2. Copyright Management Admin

4.34.3. Copyright Details

Back to TOC 561

4.35. Communication Center

Overview
The communications center is a eature which can be used to send/receive the current version of
wiki pages and articles from one Tiki to another Tiki. To send a page with all versions see import.

Enable this Feature: Admin>Features select "Communication Center"

Configuration:
1. In order to use the communications center the feature must be enabled from the admin screen in
both Tikis.
2. You must be logged in to the sending Tiki as a user with the outbound mail permissions:
• tiki_p_send_articles
• tiki_p_send_pages
To set these permissions goto Admin>Groups>assign permissions.
3. You must have a username and password for the reciving Tiki with the inbound permissions:
• tiki_p_sendme_articles
• tiki_p_sendme_pages

Sending objects

Once enabled, there should be a link in the application menu Wiki>Send Objects.

The send objects screen looks like this:

562 Back to TOC

 Tikiwiki Documentation 1.9+

Clicking the send link from the application menu displays the screen where you can send Tiki
objects to other sites. The first part of the screen must be filled after you selected all the objects to
send, the second part can be used to select the Wiki pages that will be sent to another site, select
pages (as many as you want) clicking the add page link. When you have selected all the pages to
send fill the information at the top as follows:
Site
The URL for the site, for example: www.foo.com (Don't use http://....)

Path
The path to the commxmlrpc.php script for the site, a typical value is /commxmlrpc.php or
/tiki/commxmlrpc.php, but if the installation is different it can be another path, which can be
verified by FTP. \

The "Path" value is added to the end of the end of "Site" value to build the complete URL for
accessing the commxmlrpc program.
Username
The username that will be used to recieve objects at the remote site.

Back to TOC 563

Password
The password for that username.

If everything goes well you will see a message describing the result of the operation.

How to test if this is working

From the admin screen make sure that you have the communications feature enabled, you can use
the following information to send an object to yourself:
(warning: you don't want to "accept" the received page - though it should not overwrite the existing
page, it probably won't work.)
• Site: localhost (if your server is on your local - otherwise the site Url like http://tw.org)
• Path: /commxmlrpc.php (change it you installed Tiki in other directory) - do not forget the
first /, if the directory is wrong it will generate the error 'Didn't receive 200 OK from remote
server'
• User:
• Password:
Click send and the communication should be performed and you are ready to examine the received
pages.

Trouble shooting
• Sometimes the error 'Didn't receive 200 OK from remote server ' occurs even if the transfer
was sucessfuil. Check your Received pages.
• You can debug by changing 0 to 1 in the file tiki-send_object.php, line : $client-
>setDebug(1);

Received pages
From the Wiki section in the application menu click the received pages link. The Recieved pages
screen will be displayed.

In this screen you can see the list of pages received, the date when the page was received, the site
that sent the page, and the user used from the sending site to send the page.

For each page you can remove it (if you don t want it), edit the page (where you can rename it),
view the page or accept it.

If the name of the page is in red then the page has the same name as an existing page in your system
and so you have to rename the page before being able to accept it.

bug? note: this "display in red" function may not work. If you try to accept a page that already
exists, the accept will fail, and you will see the page just as before. (not working in 1.9.7 ?)

564 Back to TOC

 Tikiwiki Documentation 1.9+

Once accepted the page will be part of your Wiki as a normal Wiki page.

Administering other received objects

The procedure to admin other received objects is similar to the procedure described to manage
received pages, you will see listing of the received objects and you will be able to edit them, remove
them or accept them as objects in your Tiki site. Once accepted you will be able to manipulate the
objects as normal Tiki objects.

Permissions
The following permissions can be used to control the communications

If you want to configure a user that other sites can use to send objects to your site put the user in a
group with the tiki_p_sendme_pages, tiki_p_sendme_articles or similar permission.

Try it out
please link to the live Feature on tikiwiki.org

Developer Notes
This feature was developed by:

Notes on the ongoing development of this feature, please indicate the latest released stable version,
identified bugs, links to development pages, etc.

Feature FAQ
Any Questions? Edit this page and someone will respond!

Related Category
Include the appropriate category display using the Category Plugin?.

Back to TOC 565

4.36. Spellchecking
Tiki contains a optional spellchecking ability. When entering text in specific features, Tiki can
automatically identify misspelled words and offer suggestions.

The language-specific dictionary used by the spellchecker is an additional database table that can be
downloaded from Sourceforge and added to your database.

4.36.1. Spellchecking User

If you have permission to edit a specific page or object, and if the Spellchecking option for that
feature is enabled, then the Spellcheck option will appear on the edit page:

Spellcheck option when editing a wiki page.

To use the spellchecker, use this procedure:

1. Select the Spellcheck option.
2. Click Preview. Tiki will show a preview of the page with your edits. Any misspelled words
will appear red.

3. Click a red word. Tiki will display a list of suggested corrections in a popup window.

566 Back to TOC

 Tikiwiki Documentation 1.9+

4. Click the correct word in the popup menu. Tiki will replace the misspelled word with the
selected correction.
Note: Re-preview the page to view the correction.

4.36.2. Spellchecking Admin

Each Tiki feature may have its own spellchecking option.
• Spellchecking Admin
• Articles
• Wiki

4.36.2.1. Articles

To enable spellechecking with creating or editing articles, select the Spellchecking option in the
CMS Features section of the Articles Config page.

CMS Features section of the Articles: Config page.

4.36.2.2. Wiki

To enable spellechecking with creating or editing a wiki page, select the Spellchecking option in
the Wiki Features section of the Wiki Config page:

Back to TOC 567

 Wiki Features section fo the Wiki: Config
page.

4.36.3. Spellchecking Details

568 Back to TOC

 Tikiwiki Documentation 1.9+

4.37. Redirect On Error

4.37.1. Redirect On Error User

4.37.2. Redirect On Error Admin

4.37.3. Redirect On Error Details

Back to TOC 569

4.38. Drawings
This feature enables using a java program called "jgraphpad" to make drawings and schemes at
your computer and insert them directly to your wiki page.

Example of drawing made with Tiki 1.8.x drawing feature - jgraphpad -

4.38.1. Drawings User

To make a new graph called "foo", edit a page, and add something like:
{draw name=foo}

It will show something like:

click here to create draw foo

When clicked, and provided that you have the java runtime environment installed in your computer,
you will several boxes appearing in your computer, something like:

570 Back to TOC

 Tikiwiki Documentation 1.9+

Say "Yes", at this point, to let the application run.

Back to TOC 571

This means that you can start creating your drawing with this Java applet started in your computer.

When done, open the "File" dropdown window, and select: "Save to Tiki and exit"

Then, you can re-edit the drawing by simply pressing on the graph as registered (and logged) user.
For instance, when cliking on the graph like the one in the main Drawing page (not on this
screenshot here at doc.tw.o, but on the real drawing on the server where it was created), you would
get something like:

572 Back to TOC

 Tikiwiki Documentation 1.9+

4.38.2. Drawings Admin

4.38.3. Drawings Details

Back to TOC 573

4.39. HTML Pages
This page still needs help - some examples of dynamic pages and a screenshot or two

Most content pages (such as wiki pages, blogs, articles, and so on) in Tiki are created using Tiki's
wiki syntax and plugins. However, there may be some pages where you want to make a page
entirely with HTML, for example if you want to create an web form, or a splash page, or some other
kind of special content.

Layout: The HTML Pages feature is still within the CMS, so the same layout can apply, or not (it's
optional).
Permissions: It is easy to have the permissions for HTML pages be completely different from wiki
pages.
HTML Front End: HTML pages can be used as a "front end" for a site - and for pages that are not
intended to be user editable.

Note: You can also place normal HTML created by any web design software files in tikiwiki's main
directory and set one of them as the "home page" - a good idea if you are finding that the tiki CMS
is slow to load for first time visitors.

Static or Dynamic HTML Pages

Use Tiki's HTML Pages to create content pages using pure HTML syntax. HTML pages can be
static or dynamic.

Note:
• HTML pages should adhere to XHTML Validation , since Tiki's final output is XHTML.
• HTML pages are not included when using Tiki's search feature.
• HTML pages do not maintain a page history.
• HTML pages can not have attachments.

Static vs Dynamic HTML pages

When creating an HTML page, you can specify if the page is dynamic or static.
• Dyanmic pages include dynamic zones (displayed within an &lt;IFRAME>) that are
reloaded at specified time intervals.
• Static pages are displayed as normal HTML.

Problem with this page? Open a Documentation Bug

4.39.1.1. Editing a page

To edit HTML pages follow the "edit HTML pages" link from the admin section of the application

574 Back to TOC

 Tikiwiki Documentation 1.9+

menu. A screen similar to the following one will be displayed:

Note that you have to enter a name and the page content just that. The page content can be any
HTML with the addition of dynamic zones. Dynamic zones are portions of the HTML page that
will be replaced by content taken from the database. For example you can create the following
HTML page:
Soccer results <table> <tr><td>Liverpool {ed id=liverpool}</td><td>Man UTD {ed
id=manutd}</td></tr> .... </table>

The syntax to include dynamic zones can be

{ed id=name}
or
{ted id=name}
the difference is what HTML element is used to edit the zone, ed uses text input boxes while ted
uses textareas
After creating that page and saving it you will see a link to "content" from the listing of pages,
clickin on content will take you to a screen where you can edit each dynamic zone on a page:
Important: when editing an HTML page line feeds are automatically converted to HTML <br/> tags

Note that static pages can use dynamic zones as well as dynamic pages.

4.39.1.2. Applying templates for HTML pages

Note that you can choose to apply a template for HTML pages, this can be very useful to automate
the creation of pages from a stablished template where you can indicate dynamic zones. To create a
template for HTML pages go to the edit content templates section in the admin menu.

4.39.1.3. Editing dynamic zones for a page

This is a screen where you can edit the dynamic zones for a page:
Note that you just edit the zone and click update you can edit the zones from the listing directly or
clickin on edit to individually edit a zone in a larger area. Static and dynamic pages again
When a page is accessed using tiki-page.php?pageName=some the page will be rendered replacing
the dynamic zones by their values, if no value is found then the zone is displayed as blank. Now is
where the difference between a static or a dynamic page can be noticed: For static pages the page
will be rendered and if the user wants to refresh the page to update dynamic zones the page must be
reloaded by refreshing the browser as usual.
For dynamic pages the page will be automatically updated without refreshing at specified intervals
(in seconds) that can be specified when editing a page. So if a page is dynamic the dynamic zones in
a page will be updated without the user refreshing the window and without forcing the page to be
reloaded. This is specially useful for "live" results, stock values, auction prices, etc etc.

Back to TOC 575

 4.39.1.4. How dynamic pages work

So how dynamic pages work? Simple in dynamic pages an invisible "iframe" is used along with the
page this invisible frame is reloaded at the interval specified as the page refresh rate. This invisible
frame picks the values for dynamic zones from the database and using javascript updates the page
dynamic zones without regenerating the page.

Permissions
The following permissions can be used to control HTML pages.

4.39.2. HTML Pages User

4.39.3. HTML Pages Admin

4.39.4. HTML Pages Details

576 Back to TOC

 Tikiwiki Documentation 1.9+

4.40. Dynamic Content System

The Dynamic Content System (DCS) allows you to edit blocks of HTML code or text from an
admin screen and display the block in any Tiki template or user module. Updating the block content
will update the template. You can also create block content by date, storing several blocks to be
displayed at future dates. This simple system adds a lot of flexibility to Tiki; you can display
anything you like anywhere in the screen and you can set up areas that can be changed or that
change automatically according to time.

The DCS can be used, for example:

• To display a quote in the top bar or a user module
• To display news in a user module
• To announce products, chats, news at a specific time
• To announce an event
• To display sport results or sports information
• Anything!

{content id=n}

Will be replaced by the actual value of the dynamic content block with id=n

Dynamic Content, which displays pre-created content where the DSC tag is placed in template files
and/or modules, is not the same as Dynamic Variable, which is an edit-in-place feature for use in
wiki pages.
More Documentation
• Dynamic Content Admin How to activate and program DCS blocks.
• Screenshots (to be recreated here) on page 296 of http://de.tikiwiki.org/tikidoc/

4.40.1. Dynamic Content User

4.40.2. Dynamic Content Admin

The Dynamic Content System (DCS) is a very easy and flexible tool for displaying dynamic content
in your Tiki sites/applications. While this tool is easy to use, there are a few steps involved in
implementing it.

The DCS lets you administer blocks and then program content for these blocks. After a block is
created, you will be able to display it in any Tiki template (.tpl file) or user module.

First of all, enable dynamic content from the main admin screen. Then you will see a link to "admin
content" at the end of the admin menu. Clicking on that link will take you to the DCS edit screen:

Back to TOC 577

 4.40.2.1. Creating and editing blocks

(img src=http://de.tikiwiki.org/tikidocs/pg_0297.jpg)

In this screen you can see a list of dynamic blocks, to create a block you just need to provide a
description; for example, create the "quote of the moment" block:

(img src=http://de.tikiwiki.org/tikidocs/pg_0297.jpg)

Once it is created, you will see the block in the listing:

(img src=http://de.tikiwiki.org/tikidocs/pg_0298.jpg)

From the listing you can remove the block (all content if present will be removed as well), you can
edit the block description (Edit desc), or you can program some content for the block. Click on
"program" to add some content:

4.40.2.2. Creating and editing content for a block

(img src=http://de.tikiwiki.org/tikidocs/pg_0299.jpg)

In this screen you will see a listing of all the programmed content for the block and you will be able
to edit content, create new content, remove content, etc. Enter some quote using the default date
(this will be the current date).

(img src=http://de.tikiwiki.org/tikidocs/pg_0300.jpg)

So you have some content for the block "2". It's very important to note the block number that you
are editing at the top of the page.

4.40.2.3. Displaying DCS blocks

You can display dynamic content blocks in any Tiki template or user block using the following
syntax:
{content id=1}

Note: The ids are likely to be different in your installation.

Where the id is the id of the block (not the id of the block content!!).

Now let's see how we can use the content in a user block.

Edit a user module as follows:

578 Back to TOC

 Tikiwiki Documentation 1.9+

(img src=http://de.tikiwiki.org/tikidocs/pg_0301.jpg)

And assign it to the right sidebar.

(img src=http://de.tikiwiki.org/tikidocs/pg_0301.jpg)

You wil now see the user module displaying the content you just entered in the DCS!

(img src=http://de.tikiwiki.org/tikidocs/pg_0302.jpg)

4.40.2.4. Programming content

Now to program some content for the future, go again to the Admin Content screen, click
"program" for the block with the id=2 (or the id applicable in your case). Click on "program" and
enter some data, changing the date for 5 minutes ahead of the current time.

(img src=http://de.tikiwiki.org/tikidocs/pg_0303.jpg)

The listing will show in a dark shadow the current content active for the block and in a lighter color
the rows for future content or old content. As you can see, there is a block displaying "The new
quote" that will be displayed at 13:41. Now just wait until that time and refresh the screen — the
user block on the right side bar will change!

(img src=http://de.tikiwiki.org/tikidocs/pg_0303.jpg)

4.40.3. Dynamic Content Details

Back to TOC 579

4.41. Dynamic Variable
This is referring to the dynamic variable
%variable14%

To use, just click on the text in the box below:

Hello tikiwiki

The permission tiki_p_edit_dynvar must be given to the group. On the current site
tiki_p_edit_dynvar has been given to anonymous. The box above is just to help you find the text.
Dynamic variables can be used in a sentence. For example, " Hello tikiwiki " is the current value.

This can be useful for contact name, phone number, etc to be used throughout a Tiki site. If you
have a multilingual Tiki, you can use dynamic variable for strings of text which are the same in all
languages.

This feature is different than Dynamic Content

580 Back to TOC

 Tikiwiki Documentation 1.9+

4.42. Freetags
screenshots are needed.

Freetags are the folksonomy implementation of TikiWiki. The name is based on the name of the
underlying library from Gordon Luk: http://www.getluky.net/freetag/ .
Freetags is a feature in TikiWiki HEAD, the development version available from CVS.

Basically folksonomy tagging means/is based on:

• everybody can assign keywords to anything
• bottom-up instead of top-down categorization
• from chaos comes order
• emergent patterns are more powerful than imposition of categories

What can I tag within Tiki?

You can currently tag:
• Wiki pages
• Blog posts
This currently only works while editing.

Anything else?
There are two modules:
• Prefered tags
• My favourite tags

4.42.1. Freetags User

When offered to do so, just enter your tags into the textfield seperated by spaces.
You can browse the available tags by clicking on one, when seeing it somewhere. It will take you to
tiki-browse_freetags.php with the tag centered in the morcego browser, if that feature is enabled.

4.42.2. Freetags Admin

There is an admin screen, which currently only accepts configuration of the morcego browser for
browsing the freetags.
To use the morcego 3D-Network-Browser, you'll have to activate the features:
• Morcego? and
• Ajax?

More information
• http://en.wikipedia.org/wiki/Folksonomy

Back to TOC 581

4.43. Poll
Insert small Screenshot
Polls are a commonly used in community and news oriented sites to help reveal popular opinion? or
for decision making?. For example, the Tikiwiki Community has always used polls to decide the
titles of each Tikiwiki Release? since 1.0. Polls are only one way to ask questions to users.
Alternatives to Polls:
Survey can include multiple questions (polls only ask one).
A Quiz is a survey with a fixed amount of time to answer it - can be used for online tests.
a Tracker is a more robust way to collect input from users and display collected results.

Related Pages
Pages about this feature: Customize Polls?, Poll Admin, Polls Dev?, Poll Plugin?
Related Tiki Features: Groups?, Survey, Quiz, Tracker

4.43.1. Using Polls

To begin using Polls, first activate the feature in the ADMIN-->General screen.
Insert small Screenshot

Tiki you can create as many polls as you want. zero to n polls in the Tiki pages. You can also have a
set of several active polls and display only one poll in a page. In that case, Tiki will rotate through
the set of polls. Users with the right permission can see poll results, examine old polls and vote in
any poll that is not closed.

4.43.1.1. Polls as a Plugin

Insert small Screenshot

4.43.1.2. Polls as a Side Module

Insert small Screenshot

Once you have actived the polls feature you can assign a poll to side module using Create new
user module under Admin Modules, see Module User.
(Copy this template into any feature page and use as a format guide.)

4.43.1.3. Where to find it:

1. Explain how to admin the feature, starting by clicking on admin home (if that is indeed the place
to go first)
2. Give the yoursite.com/url to the administration screen for this feature.

4.43.1.4. Creating/Adding an instance

582 Back to TOC

 Tikiwiki Documentation 1.9+

Modify/Customize the instance

Permissions

Try it out
please link to the live Feature on tikiwiki.org

Related Category
Include the approproiate category display using the Category Plugin?.

External Links
A list of links outside of tw.o (Wikipedia, RFC's, Other Manuals)

4.43.2. Polls User

4.43.3. Polls Admin

Settings Documentation

Clicking the Polls icon on the Admin Panel (see Tiki Config ) takes you to the Polls settings.

4.43.3.1. Configure Polls

You can set up polls using this panel.

-n Tiki you can create/display and use as many polls as you want, to admin polls use the polls link
from the admin section in the application menu.

Back to TOC 583

 4.43.3.2. Creating/editing polls

In this screen you can edit/create new polls and remove existing polls, to create a poll you have to
indicate the title the type of polls and the publishDate, the type can be:
• Active: The poll can be voted The form to vote can be displayed in a user module using {
poll id=n}
• Current: The poll can be voted and can be selected to be shown in a module using {poll}
without indicating an id. It can also be displayed using {poll id=n}
• Closed: The poll is closed it won t be displayed and the users can t vote this poll any more.
Results can be seen.
• object: ?
• templates: The poll can be used in a wiki rating. If used, a new poll will be created with the
name given in the wiki rating setting

The publishDate is used to control when the poll will be enabled, you can program polls for the
future if you want. A poll can t be viewed/voted/anything until the current date is greater on equal
than then poll publishingDate.

Some special links are also provided:

• Close all polls but last will close all polls except the last one.
• Set last poll as current will set the last poll as the current poll
• Activate all polls will make all polls active

584 Back to TOC

 Tikiwiki Documentation 1.9+

If you click activate all polls and set last poll as current you will have all polls active and the last
one being the current poll. If you click close all polls but last and set last poll as current you will
have all polls closed and the last one being the current one (only the current poll can be voted in this
scheme)

To edit the options in a poll clikc in the options link from the poll listing:

insert graphic

In this screen you will see a preview of the poll, a form to edit/add an option to a poll and the list of
options, you can edit options, remove options and add options to a poll as you want.

4.43.3.3. Using polls

user modules
Once created the form to vote a poll can be displayed using user modules, the syntax to include a
poll can be:

{poll}

This will display a random poll from the list of polls with type = current and that have been
published.

{poll id=n}

This can be used to dsiplay any active or current poll indicating the id of the poll to displayed.

in wiki pages
You can also activate Rating in the wiki admin panel and choose a poll at edit time.

4.43.4. Polls Details

Back to TOC 585

4.44. RSS Feeds
Overview
An RSS feed is a summary of a Website's news, files, and other activities that it distributes or
syndicates to other Websites and individual users. RSS is an acronym for "Rich Site Summary"
(sometimes also used as Really Simple Syndication). Indeed, RSS files are a nearly painless way to
syndicate news and articles from one site to many. For instance, RSS files can be used to gather
Slashdot news and Freshmeat releases, and display them on your Tiki. RDF is the Resource
Description Framework, see links below.

Tiki is remarkably flexible when it comes to RSS. It can both display external RSS feeds from other
sites in user modules and elsewhere and syndicate its activities (blogs, articles, forums, etc.) to
other Websites via RSS.

The configuration of incoming RSS feeds is explained here in this page, and the configuration of
outgoing RSS feed (data Tiki provides for others to include into their site) is explained in RSS User.

Key Function and sub-features

Tiki has RSS feeds for
• Articles
• Blog
• Directory
• File gallery
• Forum
• Image gallery
• Map
• Wiki pages
• Calendar

You can find the feeds at the bottom bar (if it is switched on in admin menu):

You can click on any of those RSS icons ( ) at the bottom of the page in order to get the
syndicated content from that Tiki section. Copy that url and paste it in your favourite RSS feeds
agregator, email program, web site (provided they support collecting RSS feeds).

More information
Click on any of the links below for more information on RSS feeds in Tiki:

586 Back to TOC

 Tikiwiki Documentation 1.9+

4.44.1. RSS Feeds User:

An RSS feed is a summary of a Website's news, files, and other activities that it distributes or
syndicates to other Websites and individual users. RSS is an acronym for Really Simple
Syndication. Indeed, RSS files are a nearly painless way to syndicate news and articles from one
site to many. For instance, RSS files can be used to gather Slashdot news and Freshmeat releases,
and display them on your Tiki.

Tiki is remarkably flexible when it comes to RSS. It can both display external RSS feeds from other
sites in user modules and elsewhere and syndicate its activities (blogs, articles, forums, etc.) to
other Websites via RSS.

The configuration of outgoing RSS feeds is explained in RSS main page. In this document, we'll
cover the configuration of incoming RSS feeds from external sources.

Brief summary
To add an RSS feed from another site in to your tikiwiki site:
1. Admin > RSS Modues > Create new RSS module
2. Complete the form using a descriptive title and proper RSS URL. Save.
3. Note the RSS Channel ID
4. On the wiki page, add {rss id=n} when "n" is the RSS channel ID. Put a title above.
Preview. OR Add in Admin > Modules > User Module, create a new user modules with the
RSS channel ID.

4.44.1.1. Create RSS Modules

First you have to configure the RSS feeds that you want to use. As an admin-level user, click the
RSS feeds link from the Admin (click!) section of the Application menu to enter the Admin RSS
modules screen.

The Create a new RSS module panel can be used to create and configure incoming RSS feeds.
Complete the fields on the form to create a new RSS module:
Field Description
Name Name of the RSS feed. This could be the website or publisher.
Description Short description of the RSS feed.
URL The URL of the RSS feed. Normally this will be an XML file. E.g., http://slashdot.org/slashdot.rdf

Back to TOC 587

 Field Description
Specify how often Tiki should refresh the feed, from once per minute to once per day. Normally you
Refresh rate don't want to refresh the feed each time you display it since that can make the site offering the feed
slower. So Tiki caches RSS feeds and refreshes them using the interval of time you indicate here.
Specify if the feed's title (as defiend by the publisher) should be displayed when you include the RSS
Show feed title
module on a wiki page.
Show publish Specify if the publication date for each item in the feed should be displayed when you include the
date RSS module on a wiki page.

The module (the RSS feed from another site) can then be included in a Tiki wiki page. When you
save the new module, Tiki will assign a unique ID to the module and your new module will appear
in RSS channels.

• In this example we have 2 feeds configured:

• The Slashdot feed is refreshed each 60 minutes and the URI is
http://slashdot.org/slashdot.rdf
• The Salon feed is refreshed each 360 minutes and the URL is http://xml.newsisfree.com/
feeds/83/783.xml
• The righthand column of this table contains actions you can do to your channels: remove,
edit, and view.
• Clicking view previews the feed--showing a bullet list of a site's content. E.g., from
Slashdot:

• RSS Channels also shows the last time the feed was updated. Unlike other weak RSS

588 Back to TOC

 Tikiwiki Documentation 1.9+

systems, Tiki won't crunch the cache if it cannot connect to the external site when it needs to
refresh it. If a site goes down, Tiki will show the last cached version of the feed without
errors or problems to your site.
• Note that the RSS channels panel also assigns an ID number to each channel. You'll use this
to import RSS feeds into your Tiki.

4.44.1.2. Incorporate RSS Channels Into Your Tiki

User Modules

Now your Tiki is ready to receive RSS feeds. So, how do you insert them into your site? If you'd
like to have them appear as a module in one of your columns, you must create a new user module.
For full information on module creation, please see Module Admin.

As an admin-level user, click the Modules link from the Admin (click!) section of the Application
menu to enter the Admin Modules screen. Scroll down to the Create new user module panel.
First time administrators of Tiki may think that this means you are creating a module for a new
user. But no! You are creating a user module for the first time--that is, a new one!

Enter:
• A Name for your module, which will be used to identify it later.
• E.g., Slashdot
• A Title, which will appear on screen when the module is displayed.
• E.g., Slashdot News

Back to TOC 589

 • data, that is, a bit of code--HTML permitted--that incorporates your channel(s) into the
module. RSS-channel data is displayed using the following syntax (remember the ID
number that we created for each RSS channel?):
• {rss id=x max=y}
• Replace x with the ID number of the channel.
• Replace y with the maximum number of items that you want displayed.
• In this example, we've used the channel-feed ID number for Slashdot on our
system and limited it to five items.
• Tiki will automate this process for you:
• From the Objects that can be included side of the panel, pick a channel
from the drop-down list labelled RSS modules. Then click the link, use rss
module to automatically insert the channel data into the data box.
• However, it will not set a max number for you.
• You may now embellish the module data by adding HTML tags. In this example, we
wanted the Slashdot headlines to be numbered and so we added a ordered list tag to
it.
• Tiki provides a basic WYSIWYG (What You See Is What You Get) editor to
facilitate HTML coding. Click Use wysiwyg editor to try it out.
• Tip: You can include more than one RSS channel in a single module.
• Click create/edit to complete the module-creation step.

Next, you must tell Tiki where to display this new module. In other words, you must assign it to the
Tiki layout.

• Once you've create your RSS user module, it'll appear in the Module name drop-down list
in the Assign new module panel. Select it.
• Decide on its Position in the left, center or right column of your Tiki.
• Give it a number to determine its relative Order (top to bottom) in the column.
• Select which Groups will be permitted to see this module. Select more than one group by
Control-clicking.
• Group permissions are explained further in PermissionAdmin.
• Click preview to see what your module will look like. When you're satisfied, click assign.
• For example, here's how our Slashdot module turned out:

no s'ha trobat la imatge img/wiki_up//AssignNewModulePreview.png

590 Back to TOC

 Tikiwiki Documentation 1.9+

Once it's been assigned, it'll appear in the Assigned Modules panel, where it may be edited, moved
up/down, or deleted (the x link).

Wiki Pages

You can include RSS channels in a Wiki page through the same syntax as in modules (using
PluginRSS):
{rss id=x max=y}

4.44.2. RSS Admin

Clicking the RSS icon on the Admin Panel (See Tiki Config ), takes you to the RSS settings.

4.44.2.1. Configure RSS Feeds

This panel can be used to control the RSS feeds that Tiki generates on-the-fly as they are requested.
RSS feeds can be used to syndicate different aspects of your Tiki web site to other web sites. In this
panel you can enable/disable feeds and you can control the maximum number of items that will be
generated for each feed.
• Switch a single feed on/off
• Set number of entries for each feed
• Language tag for RDF output (eg en-us, de-de ...)
• Publisher (RDF 1.0 only)
• Creator (RDF 1.0 only)
• Editor (RDF 2.0 only)
• Webmaster (RDF 2.0 only)

Back to TOC 591

The available feeds and their meanings:
Feed Description
Articles This feed lists the last n articles in your site.
Weblogs This feed lists the last n posts to weblogs (any weblogs) in your site.
Image galleries This feed lists the last images uploaded to image galleries (any) in your site
File galleries This feed lists the last n files uploaded to file galleries (any) in your site.
Wiki This feed lists the last changes to the Wiki.
This feed lists the last uploaded images to a given gallery. (There's a feed for each
Individual Image galleries
gallery.)
This feed lists the last files uploaded to a given file gallery. (There's a feed for each file
Individual file galleries
gallery.)
Individual weblog This feed lists the last posts to a given weblog. (There's a feed for each weblog.)
Forums Lists the last n topics to the Forums (all the forums)
Individual Forum List the last n topics to a given forum.
Mapfiles List the last n mapfiles new on the tiki site.
Directories List the last n sites new in all directories.
Individual Directory List the last n sites to a given directory.
Calendar List the last n items in the given calendar

592 Back to TOC

 Tikiwiki Documentation 1.9+

For more information

• How to use RSS Streams if your site is secured by an htAccess

Mailing Lists:
• http://groups.yahoo.com/group/rss-dev rss-dev - the RSS 1.0 Interest Group list
• http://groups.yahoo.com/group/syndication Syndication - a general list for RSS matters
• http://groups.yahoo.com/group/syndic8 Syndic8 - a list for Syndic8 support matters
• http://groups.yahoo.com/group/RSS2-Support RSS2 Support - support for RSS 2.0 matters
• http://groups.yahoo.com/group/aggregators Aggregators - a list for discussion of aggregator
software
Validators:
• http://feeds.archive.org/validator - The most up to date validator, optimized for RSS 2.0
• http://www.ldodds.com/rss_validator/1.0/validator.html - Leigh Dodd's experimental RSS
1.0 validator
• http://aggregator.userland.com/validator - Userland Software's RSS validator
• http://www.w3c.org/RDF/Validator - The W3C's RDF validator
Other:
• http://www.wiwiss.fu-berlin.de/suhl/bizer/rdfapi/ RAP - RDF API

4.44.3. RSS Feeds Details

Since version 1.9 Tiki uses an external library for generating rss output: Kai Blankenhorn's
FeedCreator .

Earlier versions of tiki provide the following output formats:

• ATOM 0.3 (since Tiki 1.8.1)
• RSS 1.0 - RDF Site Summary 1.0 (fixed for Tiki 1.7.1)
• RSS 2.0 - RDF Site Summary 2.0 (since Tiki 1.8)
• any of those with attached stylesheet for better display in browsers

Tiki 1.9.x and newer provide the following output formats, using Kai Blankenhorn's LGPL library
FeedCreator :
• ATOM 0.3
• HTML
• JAVASCRIPT
• MBOX
• OPML
• PIE 0.1
• RSS 0.91
• RSS 1.0
• RSS 2.0
• some of those with attached stylesheet for better display in browsers

Back to TOC 593

 Typical uses

• http://tikiwiki.org/tiki-wiki_rss.php results in default RDF 2.0 output.

• http://tikiwiki.org/tiki-wiki_rss.php?ver=1 results in RDF 1.0 output.
• http://tikiwiki.org/tiki-wiki_rss.php?ver=2&css=y results in RDF 2.0 output with
attached stylesheet for better display in browsers, should not be used with other RDF
parsers.
• http://tikiwiki.org/tiki-blogs_rss.php
• http://tikiwiki.org/tiki-blog_rss.php&blogId=1
• http://tikiwiki.org/tiki-acticles_rss.php
• http://tikiwiki.org/tiki-articles_rss.php?topic=2
• http://tikiwiki.org/tiki-articles_rss.php?topicname=Tiki+releases
• http://tikiwiki.org/tiki-forums_rss.php
• http://tikiwiki.org/tiki-image_galleries_rss.php
• http://tikiwiki.org/tiki-image_gallery_rss.php&galleryId=1
• http://tikiwiki.org/tiki-file_galleries_rss.php
• http://tikiwiki.org/tiki-file_gallery_rss.php&galleryId=1

Related Links

• RDF at W3C
• RDF Site Summary (RSS) 0.91
• RDF Site Summary (RSS) 0.92
• RDF Site Summary (RSS) 1.0
• RDF Site Summary (RSS) 2.0
• known RSS 1.0 modules
• Atom 0.3 draft

Tikiwiki is known as a toolkit at http://www.syndic8.com (ToolkitInfo ).

tw.org's links are known there as follows:

• article feed, RSS 1.0
• article feed, RSS 2.0

• wiki feed, RSS 1.0

• wiki feed, RSS 2.0

594 Back to TOC

 Tikiwiki Documentation 1.9+

4.45. Score
This feature is a game to motivate people to participate in the community. Users are given points for
things they do in the site, like writing an article, reading an article, starting a new topic in forum,
voting a poll, etc. They also earn points by being popular, like having his/her blogs and articles read
and commented. Then the users will be able to see their position in a ranking.

Module users_rank from scores

This feature is implemented in version 1.9

How scoring works

• Users get an amount of points for events related to them
• The amount of point is configurable
• Users are ranked according to points earned
• Events can be repeated or not. For example, earning 5 points for each hour logged in.

Typical Uses
The Score system is good for small and starter sites, to motivate new users to contribute. This can
also help administrators to focus activity in one or two areas by granting more points to these areas,
so that small communities won't get dispersed with lots of tools in the beginning.

Related pages
• Score Admin
• Score Details
• Karma
• Score vs Karma

4.45.1. Score Admin

This page explains how to configure points for each action

Go to "Score" option in Admin menu, you'll see this screen:

Back to TOC 595

Here you configure how many points users will be given for each action in the site.

Points are a positive integer value.

Expiration is the time in seconds during which the user does not get additional scores added for the
same action.

4.45.2. Score Details

Implementation
The field `score` in users_users holds user's total score.

The table tiki_users_score logs events so that users aren't scored twice for same thing
• user - user's login
• event_id - an unique id for this event
• expire - expiration time for this scoring. so that users can earn points per 10 minutes in a

596 Back to TOC

 Tikiwiki Documentation 1.9+

chat, for example

• tstamp - timestamp of this score

Every time the user makes some scoring action, the event will be given a unique id (for example,
read_article_10 if he's reading article with id 10). If there is no event for this user with same event
id, or if the event has expired, this new event will be logged and the user's score will be updated.
TODO: old events (with age configurable) should be erased for performance.

The table tiki_score holds all events and respective punctuation:

- event - the name of the event. In the previous example 'read_article' would be the event's name.
- score - number of points for these events
- expiration - how long, in seconds, before the user can earn points again for the same event. 0
indicates only once.

All events are listed in lib/score/events.php. This file loads the array $events, each element is an
array with properties of an event. The properties are, by array index:

0 - dependent features, separated by space or comma. Event will only appear in admin if all features
listed here are set to "y".
1 - category name
2 - event name - a string identifier for the event
3 - description, must be inside tra()
4 - default score
5 - default expiration

Elements in $events file are sorted as they appear in admin, they must be grouped by category.

4.45.2.1. Creating new event

Edit lib/score/events.php and add the new event. Find in code where the event occurs and put the
hook:
global $user, $tikilib, $feature_score; // if not in global scope
if ($feature_score == 'y') {
$this->score_event($user, "EVENT_NAME");
}

4.45.2.2. Future expansion and ideas

In the future Score and Karma will be integrated in one system. lfagundes aka batawata has some
ideas not yet documented, but by now everyone is invited to write here any ideas for these cool
features.

Back to TOC 597

 Ideas for these cool features

• Upload/download ratio. It would be nice to see a file gallery upload/download ratio.

Maybe this is a "Score" feature, or maybe it's a "Gallery" feature. It's probably familiar to
some people as a feature of online bulletin board systems. It encourages people to contribute
file uploads. The ratio requirement should only apply to a particular group, and should
return a message when the ratio has been exceeded. An option would allow the first
download "free." The system could tell the user his ratio, and how many downloads he has
available, before he commits to making a download. Download failures, to the extent
detectable, would not be counted.

• Score results in privileges. For example, a user who a member of a basic group and attains
a certain minimum score is included in another group that has the download privilege.

• Score phases out. Here a user's score erodes over time if he doesn't continue to participate.
For example, the points for creating a wiki page could have a life of six months and then
expire. When combined with the previous item, this user could lose his download privilege
because of his inactivity, but could re-establish it by creating another wiki page.

Related pages
• Score
• Score Admin
• Score vs Karma

4.45.3. Karma
This pages explains the relationship between voting Comments and the Karma system

If enabled by the admin you may be able to vote comments from 1 (poor) to 5 (very cool) in the title
bar for each comment. When a user votes a comment the Tiki karma system for comments is
applied, the karma system works following this rules:
• Each registered user have an associated number of points , an average between the user
points and the number of votes gives a user a certain karma level varying from 0 to 5.
• Users gain points when a comment posted by him/her is voted, when someone votes a user
comment with 3 the user gains 3 points and earns one vote.
• When a user votes a comment the number of poinst added to the comment depends on the
karma level of the user, if the user has a high karma level the comment receives more points.
For example a vote of 5 for a comment may add 4.22 points if the user has a very good
karma or only 0.23 if the user has a lower karma level.

This system makes users that post good comments gain more karma and so their votes will make
comments voted by them rank higher .

598 Back to TOC

 Tikiwiki Documentation 1.9+

NOTE: The current Karma system has a conceptual problem: if user A has a karma of 1, user B has
a karma of 5 and A gives rating 5 to B, B will be given rating 1 (because of A's karma) and so B
will have karma lowered. This happens because user's vote weight and his points are the same field,
can be solved by separating in two fields. UserPagelfagundes

4.45.4. Score vs. Karma

Tiki has 2 ways of ranking users according to activity and popularity. They're the Score and Karma
systems. They'll probably be merged in future.

In the karma system, users are given points according to other user's rating on their comments, and
the more karma you have, more karma people rated by you will gain. It's a reliable measure of
someone's popularity, by community itself.

In the score system you earn point's by your actions or other user's actions related to you, like
reading an article, writing a message, creating a wiki page, having your topic replied in forum, etc.
This is a quantitative measure, not by community but by computer.
Karma Score
Points according to other users rating on published content Points for every action, including other users rating
Reflects user popularity Reflects user activity
Qualitative Quantitative
Subjective Objective

Back to TOC 599

4.46. Shoutbox
The Shoutbox is a module that can be placed in either column of Tiki. It serves as an internal Instant
Messaging service for the site. Shoutbox is used as a quick informal way for site participants to
communicate with each other.

4.46.1.1. Adding a Shoutbox

1. Enable the Shoutbox feature on the Administration:Features page by clicking on the checkbox
and clicking the "Change Preferences" button at the bottom of the page to save your change.

Figure 1. Enabling Shoutbox

2. Select Module from the Admin Menu.

Figure 2. Selecting the module

3. Add the Shoutbox module and assign the groups which can use it. In our example, we've limited
use to the registered group. We've positioned it as the second item in the right column.

600 Back to TOC

 Tikiwiki Documentation 1.9+

4. Your ShoutBox is now visible!

4.46.1.2. Configuring the Shoutbox

Changing URL's to links

Click the checkbox at the top of the admin page to auto-link URL's. The screenshots below shows
the checkbox and the effect when this option is enabled.

Back to TOC 601

 4.46.1.3. Adding Banned Words

If there is certain language you do not want to see in the shoutbox, you can create a list of banned
words. Select "Shoutbox Words" from the admin menu:

Then add the words you want to ban. In the example below we're banning some of our least favorite
vegetables:

602 Back to TOC

 Tikiwiki Documentation 1.9+

If a user types in one of these words in his shoutbox message, the message will be discarded. It will
not be displayed or saved.

4.46.2. Shoutbox User

4.46.3. Shoutbox Admin

4.46.4. Shoutbox Details

Back to TOC 603

4.47. Search

Help!
If you can't find results that you think should appear, first check the search mode.

Overview

If the search feature is enabled and you assign the search box module to the left or right side bar,
you will see a search box where that you can use to search content in Tiki. The search box module?
will display a select box allowing you to search for something in a specific content :
• Entire site : sum of all fields below
• Wiki Pages : page name, description, data
• Directory : name, description
• Articles : title, heading, body
• Image Galleries : name, description
• Images : name, description
• File Galleries : name, description
• Files : name, description, search_data (data produced by the converter))
• Forums : forum posts title and content (name and description with tiki search)
• Blogs : title, description (and user with tiki search)
• Blog posts : title, data (and user with tiki search)
• FAQs : title, description
• FAQs questions : question, answer
• Comments : title, data (and summary for tiki search)

Once you select an option and click the search button you will be redirected to the searchresults
page :

604 Back to TOC

 Tikiwiki Documentation 1.9+

In this screen you will see a list of results for the search. The links below the title can be used to
search in different areas of Tiki the same way as the search module does. If there are a lot of results
you will see links to the next/prev pages at the bottom. The number of items where the search
criteria was found can be located just below the links to search different features.

This integrated search engine is very useful to quick-find content or information in Tiki and it will
automatically detect which features/sections are enabled or disabled allowing the search only in
enabled features. If the Wiki is disabled, for example, you won't be able to find things in Wiki
pages.

4.47.1. Search User

The administrator can choice between 2 engines.Search Admin

4.47.1.1. Database search engine

4.47.1.2. Tikiwiki search engine

• search without case consideration

• don't index words less that 3 characters (no stoplist)
• relevance and ranking don't work . the relevance is based function of the object type on
number od read, hits.... there is no ranking

Back to TOC 605

 • can search on a part of a word

4.47.2. Search Admin

You can activate this feature through "Admin home > Features > Search"

Then, you can set the search settings under the magnifying lens icon ( ), which will lead you to
"tiki-admin.php?page=search".

4.47.2.1. Search settings

606 Back to TOC

 Tikiwiki Documentation 1.9+

2 search modules
There are 2 search modules in Tikiwiki
• the module search_box. It is called "database search". It uses the resources of the database
to do the search and indexation. It can be used with or without fulltext capacity. You can see
you are running this search if the search page is tiki-searchresults.php.
• the module search_new: It is called the "database independent search" or "tiki search".
The search resources are managed by tikiwiki. There is no fulltext capacity in this module.
search_new was introduced in Tikiwiki 1.8. You can see you run this search if the search
page is tiki-searchindex.php

Both can be used as soon as you check the feature search.

fulltext/mysql search
The fulltext feature performs best with MySQL. It may not work properly with other databases. The
performance of the database search is also dependent on your database release. Refer to your
database documentation to find ways to improve performance.
• The fulltext indexation and the database search indexation is updated by the database itself
in real time.

Back to TOC 607

 • If you do not activate the fullsearch feature, it will do an "OR" between the searched words.
• If you use the fullsearch feature, it will do a database full search. For each type of objects
(wiki, article... ) the max number (set in admin->general) will be searched. After all the
results will be sorted on the relevance. Be careful that you can see a results in an object type
that is not so relevant that an object in another type you do not see in the page.

If you are using the database search and if you do not have either category permissions or object
permissions, you can check one of the boxes shown above to speed up the search
tiki search
The tiki indexation is updated by tiki. Each access to Tikiwiki runs an indexation of a random
object.
It is possible not to refresh the indexation at each access to the site by setting the search refresh rate
in admin->search to 0 . In this case, if you want to use the tiki search, the indexation must be
handled outside in a cron for instance. See an example of recomplete reindexation in doc/devtools/
batch_refresh_indexes_tikisearch.php . This script must be moved to the tiki root to work.

Search on the file galleries

If you want to search on files in the file galleries, you must provide handlers to extract the text for
the file
ex:
• application/pdf with the command pdftotext %1 - (if pdftotext exists on your server)
• application/msword with strings %1
This must be defined in the admin->file galleries page

See also
• Search Config

4.47.3. Search Details

4.47.3.1. Search modes

If you want, you can enable full-text search. With this option your results will be ordered according
to their relevance to the search terms.

The search can be configured by the administrator as a simple search or as a full text search. (A user
knows it is a full text search because each result has a relevance indicator)

608 Back to TOC

 Tikiwiki Documentation 1.9+

Simple search
If the administrator has not activated the "full-text" feature, the search is done in a very simple way.
Each query is split into words (a word is recognized as delimitated by space). An object will be
returned only if it contains each string word.
Example: If the query is "full text", only the object that contains "full" and that contains "text" will
be returned.
Be careful that it is not "contains the word" but contains the string; it means that an object with
"fulltext" will be returned, as an object with "faithfully textual" or "carefull texture".
Be also careful that an object has some hidden text like the links. So, an object that contains
"http://fulltext/|Mysite" is selected.
The search is performed in case-insensitive fashion. It means that if you look for "tiki", you will
find objects than contain the word "Tiki" and not "tiki".
Advantages:
• quick
• pick up everything that is indexed (see the section describing the search space)
Disadvantages:
• The search is very noisy: a lot of objects are returned
• There is no relevance and the objects are not sorted. It means that an object with 2
occurrences of the searched word will be returned as an object with only 1 occurrence.
• the word is exactly seached, it means "cliche" will not find "cliché"

4.47.3.2. Full text search

Tiki:FullTextSearch

Word highlighting
In v1.9 there is a new searchbox (search_new) and results page (tiki-searchindex.php) that together
provide highlighting of search words. Additionally, by adding "&highlight=words", where words
are the words you want to highlight, to the end of the URL (web address) for any wiki page, the
words will be highlighted in the page.

Word highlighting from referals

In v1.9 there is an experimental feature that automatically highlighs search words when one follows
a link from a search engine. Fore more information, please see Referer Search Highlighting and
Tiki:SearchDev .
Try it out
• Use the search module (search_box) or get directly to the Search results page .
• In v1.9, use the highlighting search module (search_new) or get directly to the Search index
page .
• View this page with the word highlight highlighted: http://doc.tikiwiki.org/
Search?highlight=highlight

Back to TOC 609

 4.47.3.3. Search Stats

If you enabled the Search feature, you can also enable the search statistics at "Admin home >
Search > Search features > Search stats".

Then, you can access them uner "Admin > Search stats", which will lead you to "tiki-
search_stats.php":

610 Back to TOC

 Tikiwiki Documentation 1.9+

4.48. MyTiki
Needs review: please search the docs and review the content migrated from tw.o at the sub-feature
pages below

The User Features in Tikiwiki add ways for users to interact, and to customize the site for their own
purposes. Logged-in users can enjoy many convenient features in the MyTiki section. All of these
features can be enabled/disabled by an administrator.

Some features can't be offered to users without being registered first to create a user account with
valid login name and password, so they are only present when a user has logged in to Tiki. The
features that are available to registered users are grouped in the MyTiki section.

4.48.1. MyTiki Admin

This is a stub. You can fill it in.

Features under MyTiki section can be set at "Admin > Features", under "User features" section.

4.48.2. MyTiki Details

Back to TOC 611

This navigation bar will be displayed in all the MyTiki sections, in order from left to right the icons
link to: MyTiki, Preferences, Messages, Tasks, Bookmarks, Configure modules, Newsreader,
Webmail, User notepad, User files and User calendar. We ll explain each section next.

This screen shows a list of items that belong to the user, the screen can list user pages, blogs,
assigned items from the trackers, messages and tasks. Other modules can be added in future
versions of Tiki. The user can configure which of this listings will appear on the MyTiki screen
from his user preferences screen.

If enabled from the admin menu you will see a link to user preferences in the main menu, the user
preferences page is a page for registered users (users with a valid login and password already
logged in the system) where they can set up several preferences about the site and where they can
see some stats and quick links to pages, blogs or galleries they have created.

612 Back to TOC

 Tikiwiki Documentation 1.9+

The user preferences will display a screen such as the one presented, as you can see it has a box
where the user can change his email, the theme, his real name, home page and it has a link to the
user personal wiki page as well as a link to edit the page.

This screen can be used to set up different themes for users, in the future we plan to add a lot of
themes, specially themes for users needing special accesibility features such as aural properties,
bigger than normal text, abscense of colors, etc.

Basically all the preferences that can be set at the user level can be found in this screen. The user
can choose an avatar for him, the pcik user avatar link can be used to let the user select hist avatar.

In this screen the user can also configure the user messages settings, the user tasks settings and what
will be displayed in the mytiki screen.

Back to TOC 613

 4.48.2.1. MyTiki bar

This navigation bar will be displayed in all the MyTiki sections, in order from left to right the icons
link to: MyTiki, Preferences, Messages, Tasks, Bookmarks, Configure modules, Newsreader,
Webmail, User notepad, User files and User calendar. We ll explain each section next.

4.48.2.2. MyTiki screen

614 Back to TOC

 Tikiwiki Documentation 1.9+

This screen shows a list of items that belong to the user, the screen can list user pages, blogs,
assigned items from the trackers, messages and tasks. Other modules can be added in future
versions of Tiki. The user can configure which of this listings will appear on the MyTiki screen
from his user preferences screen.

4.48.3. Webmail

The webmail feature can be used to offer a web-based interface to your users webmail accounts,
note that Tiki is not a mail server, your users should already have email addresses before being able
to use webmail. Any POP3 accesible mail account can be used from Tiki.

4.48.3.1. Configuring webmail accounts

After enabling webmail from the features section of the admin panel you will be able to enter the
webmail section from the application menu. In your first visit to the webmail you will be
automatically redirected to the webmail configuration panel.

insert graphic

In this panel you can configure as many webmail accounts as you want, you also have to select the
account that you want to use by clicking its name. Note that the current webmail account will be
displayed in bold text. The information you need to setup a webmail account is very similar to the
information you need for other mail clients such as Outlook express so the user will be familiarized
with the settings.

4.48.3.2. Reading emails

Back to TOC 615

The mailbox icon will take you to the INBOX of your current mail account. In this screen you will
be able to see your emails, read them and manipulate them:

insert graphic

Clicking on an email will take you to the screen where you can read the email.

insert graphic

Mails that you already read are displayed in a different background than unread emails. You can
select some emails using checkboxes and delete them, mark them for followup or mark them as
read/unread. You can use filters to display only unread mails or unly flagged emails.

4.48.3.3. Writing emails

The compose icon let's you compose an email and send it using your SMTP configuration. The
screen will be the following:

insert graphic

Note that you can use addresses from your address book by clicking the "to", "cc" or "bcc" links in
the compose email screen.

insert graphic

You can attach up to three fies to an email each attachment will have a maximum size that admin
can configure. If your email server has limitations about email attachment size you should observe
them since Tiki cannot override them.

insert graphic

You can send HTML email using Tiki just write the tags in the email using < b >,< i > and so...
Managing contacts Whenever an email is sent Tiki will check the addresses and if they are not in
your addressbook will offer you to add the addresses to your address book.

insert graphic

The addressbook can me managed clicking on the contacts icon in the webmail screen. You can
assign a nickname to an address and use it when sending an email, Tiki will automatically replace
the nickname with the email address when it can.

insert graphic

4.48.4. Inter-User Messages

Users can send messages to other tiki users and read/reply/remove messages in their mailboxes.

616 Back to TOC

 Tikiwiki Documentation 1.9+

Messages can have a priority and the user may choose to be notified by email when important
messages are received by Tiki. The user can close his mailbox from this user preferences screen and
he will not receive messages. Messages can be flagged for follow up. Admins can send broadcast
messages to all the users in a Tiki site. A module to display the number of unread messages is also
included. User with permission can send messages to all the members of a group.

The user messages screen can be used to access the Tiki internal messaging system between users
(like email but internal to your tiki site).

4.48.4.1. Mailbox

The messages section is divided in four screens: Mailbox, compose, broadcast (if permissions are
ok) and archive. The mailbox is shown on the left of this text, it displays the list of messages
ordered by date. The user can sort messages as he wants, he can filter messages by different flags or
priority or find messages containing some text. Messages can be mark as read, unread or
flagged/unflagged. There s a filter to see only flagged messages or unflagged. The checkboxes on
the left are used to mark or remove some messages. Unread messages are displayed in bold font to
make the user notice them. If the user clicks on any message subject a screen to read messages is
displayed:

Back to TOC 617

The user can read the message, reply it, move to the next message or flag the message for follow up
if he wants. Since 1.9 the user can move messages to the archive, thus speeding up the regular mail
check process, because the mail archive is a separate table. The size of the mailbox and the size of
the archive can be defined by the admin in admin / login (where most of the general user settings
are). If the maximum number is set to 0 (zero), the number is 'unlimited'. If the number is bigger
than zero, the user cannot receive any more mails if the number of mails in the users mailbox
exceeds this limit. He can archive some mails then or delete some. If the archiving limit is reached,
no more mails can get archived by the user.

4.48.4.2. Composing messages

618 Back to TOC

 Tikiwiki Documentation 1.9+

In this screen the user can compose a message the to, cc and bcc are similar to the fields used to
send emails but Tiki user names should be entered instead of mail addresses. If any of the users has
a full mailbox, you receive an error that the mail could not get delivered to that user.

4.48.4.3. Broadcasting

A broadcast is a message sent to many users, the message can be sent to a Tiki group or to all users
(if permissions are ok).

Tips

The function to send messages is messu-compose.php (it is useful to put this function in a menu for
a contact page for example)

You can force Subject or cc or to record by using

messu-compose.php?subject=foo&to=admin&cc:otheruser

4.48.4.4. How to enable this feature as admin

As administrator of a Tiki site, you can enable this feature in order to allow users send messages to
other users provided they know their usernames.

Those are the needed steps:

Back to TOC 619

 1. Under "Admin home > Features", "User Features" section, enable "User messages"
2. Grant permission tiki_p_messages ("Can use the messaging system") to the group you need
(you may probably want to grant it to "Registered" users)
Note: An admin might consider granting to editors or admin group the permissions
"tiki_p_broadcast" (Can broadcast messages to groups) or "tiki_p_broadcast_all" (Can
broadcast messages to all users)
3. Under "Admin home > Login", you may want to modify these preferences:
1. Checkbox "Users can opt-out internal messages:"
4. Checkbox "Users accept internal messages by default:"

620 Back to TOC

 Tikiwiki Documentation 1.9+

4.48.5. User Notepad

This page needs new screenshots
This application has been enhanced and a re-write is needed for 1.10

This feature is used to let users write notes, save them and use them when they want. The user
notepad main screen list the user notes:

4.48.5.1. Listing notes

From this screen notes can be removed, notes can be red (clicking the name), notes can be saved to
disk or deleted. A find feature is provided to search for notes containing some text. A note can also
be uploaded from the locak disk using the upload box at the bottom. Note that user notes are always
stored in the database. The quota is configured as the same quote used for user files (see user files
next)

4.48.5.2. Writing a note

Back to TOC 621

In this screen you can write a new note.

4.48.5.3. Reading a note

This is how notes are displayed, note that you can read a note as normal text or as a Wiki page
making wiki markup being interpreted.

622 Back to TOC

 Tikiwiki Documentation 1.9+

4.48.6. User Tasks

This feature is used to admin user tasks, similar to a to-do list, the tasks screen is divided in two
parts: a list of tasks and a form to enter a new task:

4.48.6.1. The list of tasks:

This list shows the all tasks to a user and some shared tasks.
• There are tree different types of tasks
• private
• >> received task, a task another user assigned to you
• << submitted task, you assigned this task to a other user
• >< shared task, this task is public to a group where you are member.
To use the features send, receive and shared tasks you have to set special rights on users and groups
a user can only send if he has the right tiki_p_tasks_send and the receiver tiki_p_tasks_receive
rights. Also I you want to share a task you must be in a group with the right tiki_p_tasks_receive.
There is also a spezail right tiki_p_tasks_admin this right allows an admin to see all shared tasks

Back to TOC 623

and edit them.
• Icons:
means that this task is accepted by user and creator
means that only one user has accepted the task, beware if you are making changes on submitted
or received task it will get this state as default
one user has rejected this this task
• States
• waiting / not started
• open / in process
• completed (100%)
A task is in the state waiting while the percentage is not set, after opening a task or setting the
percentage between 0 and 100 it will go into the state open, if you mark a task as completed or set
the percentage on 100 it will be in the completed state.
The task list offers you to hide completed tasks with the ceckbox completed.
• Trash
Similar to many other programmes is here also something like a trash implemented
You can mark tasks as trash and you can emty the trash with the button "emty trash".
But if you are not the creator you can only move the task in the trash of the creator if he has the
option rights by creator disabled.

4.48.6.2. Tasks and dates:

From the user preferences screen the user can choose if he want to use dates for tasks. What is this?
If dates are being used then tasks with a start date higher than the current date ARE not displayed in
the listing or module, this can be used to program tasks for the future. If dates are not used then all
tasks are always active. Note: when dates are in use the task listing will show links to display all
tasks or tasks using dates only.

4.48.6.3. Editing a task:

624 Back to TOC

 Tikiwiki Documentation 1.9+

This form is used to enter or edit a task, the start date field is only shown if using dates.

Back to TOC 625

 4.48.6.4. View tasks

4.48.6.5. The user tasks module

normal Usertasks-module (shows own and received tasks)

public Usertask-module (shows public tasks) (this picture with activated mouse-over-feature)

626 Back to TOC

 Tikiwiki Documentation 1.9+

A special module is provided to show tasks to the user when using your Tiki site. The module is
called user tasks and it is displayed on the left. The user can add a new task to the list of tasks and
he can also view the tasks that are active and mark some tasks as done or delete a number of tasks if
he wans. This nice module is perfect to be used as a to-do list.

4.48.7. User Files

This section is used to let users upload files and store them in their tiki personal space, they can then
download the files.

Back to TOC 627

The screen is very simple users can upload files, download them and delete them as they want. The
quota and where files are stored can be configured from the userfiles section of the admin menu
illustrated below:

4.48.7.1. Configuring userfiles

As you can see you can setup the quota in Mbs for each user and decide where to store user files,
either the database or a directory. The path can be absolute or relative to the tiki directory, and must
have a trailing slash. Example files/

4.48.8. User Calendar

The calendar can be used to let the users keep a track of events and see them in several forms.

A bar is used to navigate the calendar, the navigation bar has the following format:

We'll explain each option below.

4.48.8.1. Adding events

628 Back to TOC

 Tikiwiki Documentation 1.9+

With this form you can enter events indicating the title, start date, duration, topic (if some) and
description of the event.

Once some events are added you can view them using the daily view, weekly view or the list of
events.

4.48.8.2. Calendar preferences

Click on [Prefs] to get to the calendar preferences screen:

The first part of the screen is used to control general preferences. Like the interval between slots in

Back to TOC 629

the daily view. The start and end working hour for the calendar. The number of upcoming events to
show in the upcoming events list and when events must be reminded. When this feature is activated
a javascript alert window will popup some time before an event starts.

The last section of the screen can be used to admin topics, events can be asociated with topics. To
setup a topic you have to enter the name of the topic and an image to be used as icon (it must be
small or it will look really ugly), you can upload the icon or point to an existing icon using a file
path absolute or relative to the tiki directory or a URL.

Once your calendar preferences are set you can try adding events using the add link.

4.48.8.3. Daily view

The daily view will show the upcoming events list (the next n events to occurr), the calendar to
navigate your calendar and the list of events for the day. You can navigate the daily view using the
calendar or the < and > links at the top of the list to go to the next or previous day.

4.48.8.4. Weekly view

630 Back to TOC

 Tikiwiki Documentation 1.9+

The weekly view shows the events for the current week and you can go to the next and previous
week using the < and > links at the side of the week information.

4.48.8.5. Event list

This view shows all the events you can order them by any column and find events containing some
text, you can remove events and there s an option to remove all past events.

4.48.8.6. Exporting

The export link can be used to export your tiki calendar to a CSV file that can be used to import
your events into Outlook.

4.48.8.7. Importing

Then you have a box to import events from a CSV (comma separated values) file, you can use it to
import events from Outlook, just export your outlook calendar as a CSV file (DOS) and you will be
able to import all your events to the Tiki calendar.

Back to TOC 631

4.48.9. User Menus
This section can be used to manage items in the user menu section of the application menu (if
enabled). Then, you can reach it under "Application Menu > MyTiki (click!) > User menu". The
screen lists items added to the menu (if any), and new items can be added or edited:

There s an option to automatically add all your top-level bookmarks (bookmarks in the root folder)
to the menu. The links are displayed in the user menu section of the admin menu. This would mean
that if, for instance, I had this user bookmarks:

After clicking on the "Add top level bookmarks to menu", I would get something like:

632 Back to TOC

 Tikiwiki Documentation 1.9+

4.48.10. User Preferences

User preferences let the user select all the user-level preferences for the site: personal avatar, time
zone, theme, language, etc.

4.48.10.1. Key Function and sub-features

If enabled from the admin menu you will see a link to user Preferences in the main menu, the user
preferences page is a page for registered users (users with a valid login and password already
logged in the system) where they can set up several preferences about the site and where they can
see some stats and quick links to pages, blogs or galleries they have created.

The user preferences will display a screen where the user can change his or her email, the theme, his
or her real name, home page and it has a link to the user personal wiki page as well as a link to edit
the page.

4.48.10.2. Personal Information

How do we set up the lat and longitude info? See gmap (Google maps) feature in Tiki for more info
there.

Back to TOC 633

The "Pick user Avatar" link ("My Tiki > Preferences > Personal Information > Avatar > Pick user
Avatar", tiki-pick_avatar.php) can be used to let the user select his or her avatar:

By default there are no avatar in your tiki installation. You can upload your own (you would better
use images of 45 pixels x 45 pixels, approximately), or choose one from the collections you can
install through the Mods Type Avatars.

4.48.10.3. General Preferences

This screen can be used to set up different themes for users. Basically all the preferences that can be
set at the user level can be found in this screen.

634 Back to TOC

 Tikiwiki Documentation 1.9+

Back to TOC 635

 4.48.10.4. Other Preferences

In this screen the user can also configure the user messages settings, the user tasks settings and what
will be displayed in the MyTiki screen.

636 Back to TOC

 Tikiwiki Documentation 1.9+

4.48.11. User Bookmarks

From the user preferences screen you will see a link to user bookmarks if you have enabled this
feature.

User bookmarks are not only intended for internal links you can bookmark any site using this
system.

The user bookmarks section let users bookmark any URL and organize their bookmarks in folders
and subfolders, Tiki can also cache the current content of any page if the user has the permission to
cache bookmarks. The user bookmarks screen is like this one:

Users can create or edit folders and subfolders and add links to the current folder, each link can be
edited or removed. If caching is enabled then a link to the cached version of the bookmark will be
provided. Navigating bookmarks is easy. You can click on a folder to enter it, once in a folder a
special .. folder can be used to go to the parent folder. For instance, in the example shown, when
you click on the folder icon () at the left of "Tikiwiki Community", you will view its contents (4
links in total):

Back to TOC 637

The previous number 4 meant the total number of links including all subfolders on them. In this
example, there were three in a child folder of level 1, and another in the child folder "Developers
resources" in level 2.

4.48.11.1. The user bookmarks module

What makes user bookmarks more atractive to users is the user bookmarks module. This module
will be displayed as follows:

insert graphic

638 Back to TOC

 Tikiwiki Documentation 1.9+

The module can be used to navigate existing bookmarks, you can click on a folder to enter it and
you can click on a link to open it, you can remove bookmakrs using the x link if you want. The
module will remember the current folder so it won t be changed even if you navigate to any section
of tiki. There s an input box and two buttons below the module that work as follows:
• Entering a name and clicking mark will create a new bookmark to the current URL (the
current tiki page) with the provided name
• Entering a name and clicking new creates a new folder in the current folder.

If you click mark without entering a name from any tiki page Tiki will try to guess a good name for
the bookmark using the following reasoning:
• If the page is a wiki page the name will be the name of the Page
• If you are reading an article the name will be the article s title
• If you are reading a FAQ the name will be the FAQ title
• If you are reading a weblog the name will be the weblog title
• If you are browsing an image gallery the name will be the name of the gallery
• If you are browsing a file gallery the name will be tha name of the gallery
• If you are viewing an image tha name will be the image s name

So you can use the user bookmarks module to quick-bookmark sections of Tiki that will be
remembered every time you log in, and can be accessed from the bookmars module from any Tiki
section.

See also Directory

4.48.12. User (assigned) modules

User modules are modules where the content can be anything you want. Under MyTiki section, if
enabled by an admin, a user seelct which and where modules he/she wants to see, from the list of
modules assigned to the tiki site that he/she has permission to see.

Back to TOC 639

This screen shows currently assigned modules and their order, cache,groups and number of rows.
There are two tables, one for the modules at the left bar and other for the modules at the right bar.
You can edit (assign) a module, remove it (it will only unassign the module, you can reassigned
later) and you can also move the module up or down one position using the up/down links.

See Module Details for more information on how this user modules can be rules by Tiki. And see
Module Admin for more information on how to create new user modules, how to assign them, how
to edit their assignment, and how to edit them.

4.48.13. User Watches

If a user wants to receive an e-mail when something is edited or when new articles or forum topics
are added, they can create a watch.

A watch for new articles can be turned on and off in a user's MyTiki's "My Watches" page.

The user can click the click the little eye that appears toward the top of many pages. The eye
changes to , indicating that you have set a Watch.
• A Watch for a web page sends you the new page when it is edited, and any new comment
when they are added to the page, and replies to those comments.
• A Watch for a Forum tells you about new Topics. It does not notify you of replies.
• A Watch on a Forum Topic sends you any future replies posted to that Topic. It does not
notify you of new Topics or replies to the new Topics.

To turn off a watch, a user can either:

• click on the open eye, which then closes, or
• go to MyTiki's "My watches" page and delete any or all of your watches.

Some versions of the Tikiwiki documentation suggest that a watch does not report a change to a
web page that has been designated as a "minor" change. That does not appear to be the case for
Tikiwiki 1.9.2.

640 Back to TOC

 Tikiwiki Documentation 1.9+

4.48.13.1. Which sections can be watched?

Feature
name and Descripció Watch item
link
Articles Fast-breaking news, announcements. Submission & approval. Topics & Types. yes (global)
yes (global and
Forum Online discussions on a variety of topics. Threaded or flat. File attachments, etc
individual)
yes (global and
Tracker Facts and figures storage & retrieval. A forms & database generator, with reporting.
individual)
Collaboratively authored documents with history of changes. Tiki's Wiki has all the
Wiki features you could want from a first-rate wiki. Ex.: attach files, comments, history, yes (individual)
images, warn on edit, page locking, powerful wiki syntax, etc
File Gallery Computer files, videos or software for downloading yes (global)
yes (global and
Blog Online diaries or journals
individual)

4.48.14. Newsreader
The newsreader can be used to read newsgroups that support the NNTP protocol for news. The first
step is to configure or select a news server:

4.48.14.1. Selecting a server

In the example we configured news.php.net as the news server indicating just the name of the server
(no authentication needed in this server).

You can edit servers and add as many as you want. Clicking on a server in the list of servers will
take you to server groups screen:

Back to TOC 641

 4.48.14.2. Selecting a group

insert graphic

The list of groups is displayed click on any group to view news for that group.

4.48.14.3. Reading news

insert graphic

The list of news for the group will be displayed, you can click on any article to read it. You can also
mark your position so only messages that are newer than the marked date will be displayed in bold.

This is the screen used to read an article:

insert graphic

Note the next/prev links that can be used to read articles sequentially.

4.48.15. User Action log

A user can view a report of all his/her actions, provided an admin has configured the Action log
feature and granted users the Tiki permission to do so. You can click on the action log icon at "
MyTiki" section.

There you will see the interface to select which category and time frame you want for your action
log report or graph.

642 Back to TOC

 Tikiwiki Documentation 1.9+

Besides, you can select which features and actions you want to be added int he report:

Finally, this will produce a detailed report of that user's actions in that tiki site for that time frame.

Back to TOC 643

Please note that at the time of this writting, only some tiki features are included in Action log
reports. See Action log for more details.

644 Back to TOC

 Tikiwiki Documentation 1.9+

4.49. Tell a Friend

tw >= 1.10 (can be easily backported to 1.9)

This feature allows you to add a link "Email this page" in all the pages at the top of the screen.
If you click on it you will see

When you click a message to each of the indicated mails will be sent with your comment, the link
and your name.

the feature is activated in the features admin panel

You need a perm tiki_p_tell_a_friend in the tiki section

Back to TOC 645

4.50. Internationalization (i18n)
Internationalization in computer science means the process of making a computer program ready
to support many languages (have the interface translated in to different languages which the user
can select according to his/her preferences, showing content or menus for some languages but not
others, etc.).
TIP:
It is often also known as "i18n" (since the word internazionalization is quite long, but is the most
common word starting with an I, followed by 18 more characters, and ending with an n: i+18+n =
"i18n").

A similar approach was followed with the word localization (the process of making a new
translation for a local language in an internationalized software) as "l10n" (= l+10+n).

TikiWiki supports many languages. The list and the status of the strings translations are updated on:
http://tikiwiki.org/TikiWikiInternationalizationAndLanguages .

The strings are the messages and the menu labels.

As an administrator, you can build a monolingual site other than an English one or a multilingual
site.
As a user, you can view a multilingual site in you favorite language.

As of TikiWiki release 1.9 all language files could be added and removed using the Mods system.
This means that you could choose which languages are available on your site through using the
Mods interface. However, most languages are still included by default in tiki installation by users
commodity, since Mods feature is still quite new and many users haven't used it yet.
More documentation
• Internationalization Admin
• Translating to a new language

4.50.1. Internationalization Admin

This page explains how to administer a Tiki site with all issues relative to languages (
Internationalization - i18n - ). To learn how to create a new language, please see: Translating to a
new language.

4.50.1.1. How to build a monolingual site?

By default TikiWiki is English/American. But Tiki supports many other languages.

First, you must check if the Tiki strings (the menu texts, messages ...) have been translated in your
language for your tiki release. The list and the status of the translations are updated on:
http://tikiwiki.org/TikiWikiInternationalizationAndLanguages . You can also see them on you
installation by looking in the admin/general panel the list of available language in "Language".

646 Back to TOC

 Tikiwiki Documentation 1.9+

Then, you have to set up some information:

• In the admin/login panel, you have to uncheck "Reg users can change language"
• In the admin/features panel, you have to uncheck "Multilingual" and "Best language"
• In the admin/general panel, you have to set "Language" to your site language
• In the admin/general panel, you have to uncheck "Detect browser language"
• In the admin/general panel, you can set "Default charset for sending mail". Tiki default is
utf8 but if the default for you language is iso-8859-1 and if you users use mail user agent
that are not able to read utf8, it is better to set the charset to iso-8858-1. A registered user
will always be able to reset this preference.
• In the admin/general panel, you have to set the date formats, if you want the language
default, copy/paste from the language.php file.

Some tips:
• Tip: if you want to speed up you site, it is better to "compile" the templates. Go to the panel
admin/system admin and click on "compile" of you language.
• Tip: if you want to save some space on disk, you can delete the directories lang/xx where xx
is a language you don't use
• Tip: if you want to change some strings, you can edit the file lang/xx/language.php. But be
careful, you must follow the syntax and you must use and save the file in utf8 encoding. To
see your update in action, you must clear the cache tiki build automatically. To do that, go in
the panel admin/system admin and click on the "Empty" of templates_c line

It is possible to use the database to store the translated strings instead of the language.php file. See
this page for more information

4.50.1.2. How to build a multilingual site?

Tiki supports multiple languages, it means that the strings and messages can be displayed in a
specific language chosen by the user or automatically chosen in function of the browser languages
configuration.
The content of some objects (page, article) can also be displayed in the same language than the
strings if the translations has been done and established.

4.50.1.3. To configure a multilingual site:

• In the admin/login panel, you have to define the list of languages you want. You have to
check "Reg users can change language". You can restrict the available languages by
setting "Restrict available languages"
• In the admin/general panel, you have to set the default language for the site, it is the
language, the anonymous visitor of your site will see.
• In the admin/general panel, you can check or uncheck "Detect browser language". If it is
set, the browser languages will override the site language for an anonymous visitor or for a
user who didn't set his user language preference (in the MyTiki/preferences panel)
• In the admin/features panel, you have to check "User Preferences Screen"

Back to TOC 647

 4.50.1.4. To have a multilingual content:

• In the admin/features, you have to check "Multilingual". This will give the user the
possibility to set the language of a Wiki page or an article and to build a set of translations
(he would be able to say that this page/article is the translation of this page/article). Each
user who has the right to edit a page/article can set the language and links it to the other
translations.

The different languages for a Wiki page or article that has translations are shown in a popup menu,
the page/article language first. A user can navigate through the different translations via this menu.

Establishing a set of translations will give Tiki the opportunity to automatically select in some case
a Wiki page or an article in the best language for the user.
The best language for a user is the first of the list:
1. page language for the articles plugin
2. user language (or current language)
3. contextual language (for a link in a tiki page it is the page language - not yet implemented)
4. browser languages
5. site language
For each language with a linguistic variant (ex: en-uk), the root language is added (ex: en) to the list
(just after the variant)

Tiki will use the best language in some situations:

• In the Articles Home page and in the plugin Articles, if an article belongs to a set of
translations only the article with the best language will be displayed.
• If the parameter bl or best_lang is given to tiki-index.php and if the page belongs to a set of
translations, the page in the best language will be automatically displayed.
• If the feature "Best language" is set in the admin/features, a link to a wiki page from a wiki
page will reach the page in the best language if this page is in a set of translations

The Best language feature is mainly used in an open multilingual site as tikiwiki.org. The pages are
not translated in order. The translators don't have to change the links to the translated page. Their
job is easier and it avoids to have a lot of bad links during a translation phase. For an operational
multilingual site, the links must be adapted and the feature desactivated.

4.50.1.5. Modules displayed only for some language

If you want a module to be displayed only for some language, you have to set the parameter lang in
the admin/modules/the_module panel. The syntax is
• lang=fr
• lang[]=en&lang[]=fr
• lang=fr&max=20
The module will be displayed only if the current language is in lang

648 Back to TOC

 Tikiwiki Documentation 1.9+

4.50.1.6. Multilingual user menu

You can use the previous feature (module displayed only for a language) or you can use the
translation process
• set your menu option name in admin-> menu in English
• set the user module title in the admin -> modules panel in English
• add in lang/your_language/language.php, the list on translations

Tip
If you want to speed up you site, it is better to "compile" the templates. Go to the panel
admin/system admin and click on "compile" of each language.

4.50.1.7. Goodies

Tiki also has some goodies that can help in a multilingual site:
• a module: mod_switch_lang? that enables a user or an anonymous to switch language.
• a wiki plugin pluginVersions more generic can be used for language switch
• a wiki plugin pluginLang to display a text only if the language matches
• a wiki plugin pluginTranslated to display a link only if the language matches
• a smarty modifier smartyTranslation? to display a text only if the language matches
• in 1.10, you can add an additional parameter to the url switchLang=<langName>, where
langName is the 2 language letters code (+ eventually - 2 country letters code). This
parameter switches the language (for a logged user, it changes his preference - for an
anonymous, it remembers the language in a session variable). Example: tiki-
index.php?page=Internationalization&swithchLang=fr

4.50.1.8. Calendar first day

This can be done on a language basis, you have to edit your lang/your_language/language.php and
adapt the translation of the string
First day of week: Sunday (its ID is 0) - translators you need to localize this string!
So for Monday as the first day, translate this string to 1
Add or modify in your language.php file
"First day of week: Sunday (its ID is 0) - translators you need to localize this string!"=>"1",

utf8
An interesting article about database in utf8 on tikiwiki.org UTF-8

Back to TOC 649

4.51. Admin Panels

4.51.1. Features Admin

4.51.1.1. Settings Documentation

Clicking the Features icon on the Admin Panel (see TikiAdminSettings ) takes you to the
Features screen, where you can enable or disable Tiki features. See Fig 1.

Figure 1. A view of the Features Page

Use this screen to choose which features will be available in your tiki. Thus, you can tailor Tiki to
your specific needs without configuring the entire application. The default installation of Tiki
enables very few features.

Remember, when you disable a feature, all the screens and modules related to the feature will
produce an error screen if accessed. If you are receiving an error screen when accessing a feature,
check this page first.

650 Back to TOC

 Tikiwiki Documentation 1.9+

TikiFeatures provides short descriptions of the main Tiki features. Follow the links below for
additional documentation on each of the features you can enable or disable from this screen. In
addition, while viewing the Administration screen, you may click any term for help!

4.51.1.2. Tiki sections and features

Wiki Blog
Image Gallery File Gallery
Articles Forum
FAQ Shoutbox
Chat Tracker
Directory Webmail
Newsreader Survey
Poll Ephemerides
Quiz Search
Featured links Banner
Games Workflow engine
Newsletter Live support system
Mini Calendar Map
Help System Multilingual
Category Best language
Show Category Path? Show Babelfish Translation URLs?
Show Category Objects? Show Babelfish Translation Logo?
RecipeModuleControls Tiki Calendar
Mail-in EditTemplatesDoc
Integrator PhpLayersMenu
JsCalendar Use Tabs?
ScoreSystem Tiki Sheet
FriendshipNetwork Using Site Identity Feature
Mobile Intertiki
Google Maps Trackbacks Pings

New features coming along in Tikiwiki 1.10

... Action log setting
Freetags Intertiki
Morcego 3D Browser? Ajax?
Calendar manual selection of
Contribution
time/date?

Back to TOC 651

 Wysiwyg Editor Propose a Fullscreen mode?
Help System? Copyright system?
HTML Purifier? (Content is
cleaned to XHTML 1.1 Strict ...
on each save)

4.51.1.3. Content Features

Figure 2. The Content Features Section

If enabled, Wiki pages are parsed and some words are automatically converted to HTML links.
Hotwords E.g., TVCrit becomes http://www.TVCrit.com. Admins can edit these words from the Admin
Hotwords screen.
Hotwords in New When enabled clicking a Hotword bring the target page in a new window instead of changing the
Windows current page.
Custom Home If enabled, a customized page will serve as the home page for the Tiki.
Drawings Enables JGraphPad drawing tool.
Charts Enables charts for featured links.
Dynamic template editing from within Tiki. Permits the rearrangement of Tiki's headers, footers,
Edit templates
and columns.
Dynamic CSS (Cascading Style Sheet) editing from within Tiki. Permits the changing of Tiki's
Edit CSS
style (fonts, colors, etc.)
Dynamic Content
Edit blocks of text or HTML code that can be included in any template or user module.
System
Allow Smileys Permit emoticons in forum/blog posts, Wiki pages, etc.

652 Back to TOC

 Tikiwiki Documentation 1.9+

4.51.1.4. Administration Features

Figure 3. The Administration Features section

Banning system Ban unruly users.

Stats Site statistics.
PHPOpenTracker A logging engine that logs each request to a website into a database. Not implemented
Referer stats Tracks which sites have referred users to your site.
Theme control Admin can make sections, categories or individual objects use different themes.
Debugger Console Analyze the operation of your Tiki.
Communications
Users may exchange Tiki objects with each other and admin.
(send/receive objects)
The Blogger XMLRPC API, which allows Blogger-compatible applications to manage
XMLRPC API Tiki blogs. Note that the API is carefully implemented to respect Tiki permissions so it is
NOT a security compromise to enable this feature. It is as safe as the rest of the site.
Contact-us feature includes a contact form and an email link that is coded to defeat
Contact Us
spammers.

4.51.1.5. User Features

Figure 4. The User Features section

These settings apply only to registered users.

Back to TOC 653

User Preferences Screen A screen where users can set up their preferences--for example, their themes.
User Bookmarks Users get a personal hyperlink directory.
Users can configure the blogs, forums, Wiki pages, etc. that they are monitoring ("
User Watches
watching").
User Tasks Users get a to-do lists.
User Files Allows users to upload personal files.
Users can Configure Modules Users with the right permissions can configure modules to their needs.
Users can Shade Modules Users can flip between show module title only and show module title+contents
User Menu Users can create their own menus of Tiki objects.
User Messages Users can send personal messages between them.
User Notepad Users can create personal notes.

4.51.1.6. General Layout options

Figure 5. The General Layout Options section

Left column Display left column

Right column Dispaly right column
Display the top bar, possibly including site tabs, search, banners, logo and/or login field
Top bar
(depending on theme and preferences)
Display the bottom bar, possibly including server stats, powered by logos and/or RSS XML
Bottom bar
links (depending on theme and preferences)
Layout per section When this is enabled the page layout can be individually configured for different Tiki sections.
Admin layout per
Access the admin layout screen by clicking the Admin layout per section link.
section

This part of the features section can be used to control the look and feel (layout) of your Tiki site.
Basically, you can enable/disable the columns, the top bar (where the Tiki version is indicated) and
the footer. If you want a 1-column layout without changing anything in the code, this is the way to
go.

Some users ask if there's a need to display the copyright message for Tiki. The answer is a clear
NO. You can use Tiki for whatever you want and you can customize it to look exactly as you want.

654 Back to TOC

 Tikiwiki Documentation 1.9+

Note that you may want to enable the Layout per section option. When this is enabled the page
layout can be individually configured for different Tiki sections. For example, you may want to
remove the right column only in the forums. If so, enable the layout per section option and use the
admin layout screen to select individual layouts for sections. (Access the admin layout screen by
clicking the Admin layout per section link.)

4.51.1.7. Layout-per-section Options

You can select an individual layout for the following sections:

• Wiki
• Image galleries
• File galleries
• CMS (Articles)
• Blog
• Forum
• Chat
• Category
• Games
• FAQ
• HTML sages
• Quiz
• Survey
• Webmail
• Tracker
• Featured links
• Directory
• User messages
• Newsreader
• MyTiki
• WorkFlow
• Charts

Remember to click the Update button when you've made changes.

4.51.2. General Admin

Click the General icon on the Admin Panel to display the General screen. Use the General
Admin panel to set general Tiki preferences and settings.

These settings apply site-wide to your Tiki. Some General preferences require specific features to
be enabled on the Features Admin panel.

Back to TOC 655

 4.51.2.1. General Preferences

Setting Description
Select the default them for your Tiki. To add additional themes, place the theme's CSS file in
your STYLES directory.
Theme
Use the < and > buttons to scroll through the available themes.
Click Change Style Only to use the theme's CSS file — but not its templates.
Select the CSS theme used in slideshows. This option applies only if you have enabled the Use
Slideshows Theme
Slideshow option on the Wiki Config page.
Use group Specify that each group has its own homepage. Use the Groups Management panel to define
homepages the homepage for each group.
Use URI as home
Specify any valid URI as the home page for your Tiki.
page
Select the home page for your Tiki. Select from the list of enabled features (such as wiki,
articles, or blog).
Home page
Note: This setting will be ignored if you selected the Use URI... setting.
Language Select the default language for the Tiki interface. See i18n for more information on i18n.
If selected Tiki will attempt to automatically select the correct language, based on the user's
browser. If selected, this will override the Language setting for anonymous (non-logged in)
Detect browser users, or for users who have not selected a language in their language preference in their
language MyTiki panel.

Note: Do not select this option if you have a monolingual Tiki.

Use database for
translation
Select the operating system of the server hosting your Tiki: Unix, Windows, or
OS
Unknown/Other.
Specify how Tiki should report any PHP errors to non-Admin users.
PHP error reporting
level for non-admin
Note: Select None to hide error reports from your site users.
Default charset for
Specify the character set encoding used by Tiki when sending Mail notifications.
sending mail
Mail end of line Specify the end of line characater used by Tiki when sending Mail notifications: CRLF or LF.

4.51.2.2. General Settings

Setting Description
Disallow access to the Use this setting to "close" your Tiki (such as for maintenance). Users attempting to access
site your site will see only a login. Only users with specific permission will be allowed to log in.
Message to display when Specify the message that visitors will see when accessing your site. This setting applies
site is closed only when Disallow access... is selected.
Disallow access when
Use this option to "close" your Tiki when the server load exceeds a specific threshold. Only
load is above the
users with specific permission will be allowed to log in.
threshold
Max average server load Define the maximum server load. This setting applies only when Disallow access... is
threshold in the last selected.

656 Back to TOC

 Tikiwiki Documentation 1.9+

Setting Description
minute
Specify the message that visitors will see when accessing your site if the site is closed due
Message to display when
to excessive server load. When the server load falls below the threshold, users will be
server is too busy
allowed back into the site.
Open external links in Specify if links to external sites should open in a new browser window. If not selected, all
new window links will reuse the current browser window.
Specify if all Module are visible to all group — regardless of the specific module settings.
Display modules to all
If not selected, use the Module Admin page to specify which modules are visible to which
groups always
groups.
Use cache for external
Specify if external pages are cached and stored on your server.
pages
Use cache for external
Specify if external images are cached and stored on your server.
images
Use direct pagination
links
Specify if menu options be displayed using the folder icon . If not selected, a + and - will be
Display menus as folders
used instead.
Specify if Tiki should use GZIP to compress pages before sending them to the user's
Use gzipped output browser. Selecting this option will reduce your site's bandwidth usage. See Compression
for more information.
Count admin pageviews Specify if the Tiki statistics will include page views from users with Admin permission.
Hide anonymous-only
modules from registered Specify if Module with only anonymous permission are visible to non-anonymous users.
users
Server name (for
The server name to use when creating aboslute URIs.
absolute URIs)
The text to include in the <TITLE> tag for each Tiki page. This will appear in the titlebar of
Browser title
your users' browser.
A directory on your web server to use for temporary files.

Temporary directory Note: You must have write- access to this directory. It is also where your session files if
saved on disk will go. If you do not want interference with other application than redefines
the session lifetime, it is better to define a directory specific to tikiwiki.
Sender email The return email address used by Tiki when sending Mail notifications.
Specify the user who receives mail from the Contact Us feature. You must enable the
Contact user
Contact Us feature on the Features Admin page.
Store session data in Specify if session data will be stored in the database instead of memory. Use this feature to
database share load between servers.
Session lifetime in Specify the session time. (0 will use the default session.gc_maxlifetime defines in php.ini).
minutes If session uses files, the files will go in the temporary directory.
Specify if your server requires a proxy to access external web pages (i.e. to cache them). If
Use proxy
selected, specify the Proxy Host and Proxy Port.
Maximum number of
Specify the maximum number of records (items) to show when Tiki displays pages.
records in listings
Specify the root URL for your Tiki's online help. To use the default Tiki help on this site,
Help URL
use: http://doc.tikiwiki.org/tiki-index.php?page=

Back to TOC 657

 Setting Description

Note: This option applies only when the Help System feature has been enabled on the
Features Admin page.

4.51.2.3. Date and Time Formats

Specify the Long Date, Short Date, Long Time,and Short Time formats. The following table lists
the possible format strings:
Day
%a Abbreviated weekday name according to the current locale
%A Full weekday name according to the current locale
%d Day of the month as a decimal number (range 01 to 31)
%e Day of the month as a decimal number, a single digit is preceded by a space (range 1 to 31)
%u Day of the week as a decimal, with 1 representing Monday (range 1 to 7)
%w Day of the week as a decimal, with 0 being Sunday (range 0 to 6)
%j Day of the year as a decimal number (range 001 to 366)

Week
Week number of the current year as a decimal number, starting with the first Sunday as the first day of the
%U
first week
Week number of the current year as a decimal number, starting with the first Monday as the first day of the
%W
first week
The ISO 8601:1988 week number of the current year as a decimal number, range 01 to 53, where week 1 is
%V the first week that has at least 4 days in the current year, and with Monday as the first day of the week. (Use
%G or %g for the year component that corresponds to the week number for the specified timestamp.)

Month
%b Abbreviated month name according to the current locale
%B Full month name according to the current locale
%m Month as a decimal number (range 01 to 12)

Year
%C Century number (the year divided by 100 and truncated to an integer, range 00 to 99)
The 4-digit year corresponding to the ISO week number (see %V). This has the same format and value as
%G
%Y, except that if the ISO week number belongs to the previous or next year, that year is used instead.
%g Like %G, but without the century.
%y Year as a decimal number without a century (range 00 to 99)
%Y Year as a decimal number including the century

Time
%H Hour as a decimal number using a 24-hour clock (range 00 to 23)

658 Back to TOC

 Tikiwiki Documentation 1.9+

%I Hour as a decimal number using a 12-hour clock (range 01 to 12)

%M Minute as a decimal number
%p Either am or pm according to the given time value, or the corresponding strings for the current locale
%r Time in a.m. and p.m. notation
%R Time in 24 hour notation
%S Second as a decimal number
%T Current time, equal to %H:%M:%S

Notes
%c Preferred date and time representation for the current locale
%x Preferred date representation for the current locale without the time
%X Preferred time representation for the current locale without the date
%D Same as %m/%d/%y
%h Same as %b
%n Newline character
%t Tab character
%Z or
Time zone or name or abbreviation
%z
%% A literal % character

See the PHP Manual for details.

4.51.2.4. Other Settings

Setting Description
Specify the name of the Favorite's Icon (or page icon) for your Tiki.
Favicon icon file name
Note: The file must be in your root directory.
Favicon icon MIME type Specify the format of the Favicon: PNG, BMP, or X-ICON.
Locations separator The icon used in the breadcrumbs when displaying the category or structure path.

4.51.2.5. Register This Site

Use this option to register your Tiki with tikiwiki.org and join the Tiki community .

4.51.2.6. Change Admin Password

Use this option to change your Admin password. Enter a new password (case sensitive), repeat the
password for verification, and click Change Password.

Back to TOC 659

4.51.3. Login Config
We need help in adding the new authentication methods.
This page should undergo a refactor to break the form up into smaller pieces

Clicking the Login icon on the Admin Panel (see TikiAdminSettings ) takes you to the Login
settings. The login settings screen allows you to configure the that users maintain thier identity on
your Tiki system. You'll find a description of each setting below.

4.51.3.1. Login Settings

Authentication Method
Tiki currently supports six different methods of user authentication. The Login Authentication
Methods page has details on each of these methods

Users can Register

This is an on/off switch that controls whether users are allowed to register using the webform. Click
the check box to enable registration. Note:_ If this switch is disabled, users can still be set up by the
site admin.

... but need Admin validation

If this box is checked, the user's registration must be validated. See the Configuring User
Validation? page for details on this procedure.

Create a group for each user

This feature can be used when a login is used by more than one person. If the box is checked, a
group with the same name as user is automatically created for each user.

Use tracker for more user information

Use a tracker to store additional information about each user. See Using Trackers for User
Infomation? for details.

Use tracker for more group information

Use a tracker to store additional information about each group. See Using Trackers for Group
Information? for details.

Request Passcode to register

Reguire a user to enter a passcode that you have supplied before they can register. Use this for
invitation only sites or to track site marketing efforts.

Prevent automatic/robot registration

If enabled, it will present the new user with a graphic showing a series of numbers. They will need

660 Back to TOC

 Tikiwiki Documentation 1.9+

to key in these numbers before they will be allowed to register.

Use login as email

Use the user's login as their email address

Validate users by email

Send an email message to the user's address. The message contains a link that must be clicked to
validate the registraion.

Vailidate users email server

help How is this accomplished

Users can opt-out of internal messages

If this is enabled, users can choose not to receive internal messages.

Users accept internal messages by default

If enabled, users accept internal messages as soon as registration is complete.

Remind passwords by email

If this is set and store passwords in cleartext is enabled, the user's password will be mailed to him
when he clicks on the "Forgot password" link. If not, a new password is generated and sent to the
user.

Store plaintext passwords.

If enabled, passwords are stored in the database in clear plaintext; and the remind password feature
sends the user his password. If not enabled, only a hash is stored; and the remind password feature
generates a new password and sends that password to the user.

Crypt passwords method

This dropdown is used to choose the method of password encryption

Registered Users chan change password.

If this is enabled, registered users can change their password using a webform. If not, they must be
changed by the admin.

Registered Users can change theme

If enabled, registered users can choose their own theme. Click on "Restrict Available Themes" to
open a drop down box. Use the dropdown to select the themes you want to make available to the
user.

Back to TOC 661

Registered Users can change language
If enabled, registered users can choose their own language. Click on "Restrict Available
Languages" to open a drop down box. Use this box to select the languages you want to make
available to the user.

Maximum mailbox size

This setting controls the maximum number of messages that a user is allowed to have in their
internal message inbox. Set to zero for unlimited.

Maximum mail archive size

This setting controls the maximum number of messages that a user is allowed to have in their
internal message archive. Set to zero for unlimited

Maximum sent box size

This setting controls the maximum number of messages that a user is allowed to have in their sent
message archive. Set to zero for unlimited

Minimum Username Length

Defaults to 1

Maximum Username Length

Defaults to 50

Force lowercase username

If this is enabled, all alpah characters in the username are downshifted. See Case in Usernames? for
a discussion of case in the various versions of Tiki.

Use challenge/response authentication

If enabled and the user's browser supports JavaScript, passwords ARE NOT SENT across the
network. Instead, a challenge response algorithm is used. Tiki generates a challenge code and the
browser sends a response based on the challenge that Tiki verifies to login the user. Challenge
responses cannot be reused. This method, if enabled, strongly enforces the security of your user
passwords. If you use it you don't need an HTTPs connection for extra security. The drawback to
this method is that users will have to enter their email address every time they login. - three boxes to
fill in not two.

Force to use chars and numbers in password

If enabled, the password must contain both numbers and characters

Minimum Password Length

Defaults to 1 char, you should make it longer

662 Back to TOC

 Tikiwiki Documentation 1.9+

Password Invalid after days

Passwords will expire after the number of days you enter here. In tw >=1.10, if the value is -1, the
password will never expire

Re-validate users by email after days (in tw >1.10)

An email will be sent to the user when logging after the number of days you enter here. The user
will not be able to log-in until he activates the link sent in the email. This can be use to check that
the email is valid.

Allow secure (https) logins

If enabled http logins are allowed

Require secure (https) logins

If enabled http logins are required

HTTP server name

help What is this used for? to be checked: It will be your server name ex: tikiwiki.org. In tw >=1.10,
this field is set at the installation.

HTTP port
help What is this used for? to be checked: If you access your site with for instance
tikiwiki.org:2038, you must put 2038 in the field.

HTTP URL prefix

help What is this used for? to be checked: If you install tikiwiki in a subdirectory like tiki, the value
will contain /tiki/. In tw >1.10, this field is set at the installation

HTTPS server name

help What is this used for? to be checked: if you access your site with https://tikiwiki.org, the filed
must be tikiwiki.org

HTTPS URL prefix

help What is this used for?to be checked: If you access your site with for instance tikiwiki.org:2038,
you must put 2038 in the field.

Remember me feature
If enabled, the user's login and password will be saved and pre-populated in the login form when
the user returns to the site. The duration box controls how long the login will be remembered

Remember me name
Used to build the user's remember me cookie. This setting maps to Tiki's setcookie function. See
http://us2.php.net/manual/en/function.setcookie.php for more information.

Back to TOC 663

Remember me domain
Used to build the user's remember me cookie. This setting maps to Tiki's setcookie function. See
http://us2.php.net/manual/en/function.setcookie.php for more information.

Remember me path
Used to build the user's remember me cookie. This setting maps to Tiki's setcookie function. See
http://us2.php.net/manual/en/function.setcookie.php for more information.

Protect against CSRF with a confirmation step:

HelpWhat is this setting used for?

Protect against CSRF with a ticket

HelpWhat is this setting used for?

Highlight Group
HelpWhat is this setting used for?

User can choose beyond these groups at registration time

HelpWhat is this setting used for?

Display's user's contribution in the user page

HelpWhat is this setting used for?

Display Tracker Information on User page

If enabled, displays UserTracker informations in user information page. Format:
trackerId,fieldId1,fireldId2,...:

Deactivate login autocomplete

User Registration And Login Settings

In this section of the admin panel you can setup several settings for your user registration and site
security features. The settings are the following ones:

664 Back to TOC

 Tikiwiki Documentation 1.9+

Back to TOC 665

 Choose between Tiki, Web server, and Tiki/Pear::Auth. Tiki will use your user
database built into Tiki. Web server will use your web server's authentication.
Authentication method Tiki/Pear::Auth is a combination of the Tiki user database and Pear::Auth ,
which will allow LDAP? authentication (and others in future?). See below for
Pear settings. We need help on the additional authentication methods.
If enabled, the login box will display a register link when the user is not
Users can register: logged and the user will have the option to register using a webform. If
disabled, each user will need to be setup by an admin.
If enabled, you have to enter a password that will be required to let users
register into the system. This can be used in sites where users are invited or
Request passcode to register:
they receive a passcode after paying a fee or something like that. Semi-private
or semi-public sites may enjoy this feature.
If enabled, it will present the new user with a graphic showing a series of
Prevent automatic/robot registration: numbers. They will need to key in these numbers before they will be allowed
to register.
If enabled, then when a user registers Tiki will send the user an email with a
link that the user must use to login for the first time. Once logged in using this
Validate users by emails: link, the user will be validated and can login as a regular user. This feature is
useful if you as an admin want to be sure that the user email addresses are
correct and not fake.
If enabled, then a link to I forgot my password will be displayed in the login
Remind passwords by email: box. Users will be able to enter their login names, and Tiki will send them
emails with their passwords.
Reg users can change theme If enabled, registered users can configure the theme.
Reg users can change language If enabled, registered users can configure the site's language.
If enabled, passwords are stored in the database in clear plaintext; and the
Store plaintext passwords
remind password feature sends the user his password.
If not enabled, only a hash is stored; and the remind password feature generates a new password and sends that
password to the user.
If enabled and the user's browser supports JavaScript, passwords ARE NOT
SENT across the network. Instead, a challenge response algorithm is used.
Tiki generates a challenge code and the browser sends a response based on the
challenge that Tiki verifies to login the user. Challenge responses cannot be
Use challenge-response authentication
reused. This method, if enabled, strongly enforces the security of your user
passwords. If you use it you don't need an HTTPs connection for extra
security. The drawback to this method is that users will have to enter their
email address every time they login. - three boxes to fill in not two.
Force to use chars and numbers in If enabled, Tiki will validate user passwords and reject passwords that do not
passwords contain both letters and numbers.
Minimum password length The minimum length for a password to be accepted.
Passwords are invalid after n days Tiki will force users to change their passwords after this period.
Allow secure https login Enable this setting If you want to use an HTTPs connection for login.
Settings for HTTPs logins. You may have your HTTP and HTTPs server in
HTTP and HTTPs settings
different URLS/ports.
If enabled, this will put a Remember me checkbox for the user's login. You
Remember me feature:
will also need to set how long the server will remember them.
Remember me name help - what the heck are these for (1.9.7)

666 Back to TOC

 Tikiwiki Documentation 1.9+

Remember me domain
Remember me path
User can choose their group at tikiwiki > 1.10 If some groups are selected, at registration time, a user will
registration time: be able to choose between one of the group
Displays UserTracker informations in
tikiwiki>1.10 you can display in user info some field from user tracker. For
user information page. Format:
example the syntax 11,56,57,58 means frome the tracker ID 11, you will show
TrackerId,item1,item2,item3..."=>"Af
field 56 followed by field 57 and e third line with field 58. All the field
fiche les informations de Trackeruser
returning text can be displayed. The images can be displayed too. The line are
dans la page d'informations. Format :
name of the field and the value of the field.
TrackerId,item1,item2,item3...
tikiwiki >=1.10 - desctivate the autocomplete in the login box. the
autocomplete can be optionally set in the browser to remember the form input
Desactive login autocomplete
and proposes the remember the password. Id this option is set, the user login
and password can not be remebered - recommanded for highly secure site

Case:
• Before tikiwiki 1.10, login is case sensitive. After tikiwiki1.10, the login action is case
insentive. A user can log in or ask for a password with a login in a different case. After log-
in, the login is displayed with its original case. For previous compatibility, if 2 users have 2
same logins with different case, they will be obliged to use their case sensitive login.
• After tikiwiki1.9, you can't register 2 case login case insentive.
• password is always case sensitive.

Remember me feature:
If you activate this feature, it enables you to manage the time the system remembers a user (= a user
stays logged in). Without a rememberme cookie, the session finishes when the php session finishes.
A session can finish either because the iddle time has been reached, either you close the browser or
the tab (depending on the browser). The session length is set in php.ini (session.gc_maxlifetime) or
if your hosting allows the redefinition by yourself: admin->general->Session lifetime in minutes
(Be careful sometimes other application running on the same server can redefine the session length
and if your session saves the session files in the same place than tikiwiki, you can have interference)
With a remember me cookie, you can extend the time the system remembers a user (if the user
allows cookies of course and if he doesn not limit the cookie to the session time). This time is set in
admin->login. When a user checks remember me checkbox, the browser creates a cookie with a
name beginning with 'tiki-user-' followed by the rememberme name you gave in admin->login.
The rememberme feature allows you also to be able to close the browser and to be still logged in
when you reopen the browser (if the timeout is not reached)
This cookie is secure in 1.10. The value does not contain the user name and user password. The
value is a value saved in the database that is matched to find out the user name when the php
session has expired.
The cookie is deleted when you log-out.
In tikiwiki >= 1.10, the remember me can be always activated (admin->login)

Back to TOC 667

 LDAP Pear::Auth General Settings Overview
Tiki can authenticate users using a LDAP server via Pear::Auth (see http://pear.php.net/package-
info.php?package=Auth ) . The following settings only make sense, if you have set "Authentication
method" to "Tiki/Pear::Auth" in the above dialog. Tiki then uses the LDAP server in addition to its
own user database (users_users) to authenticate users.

If a user was authenticated via LDAP, but not found in the Tiki user database, Tiki will create an entry
Create user if
in its user database if this option is checked. If this option is disabled, this user wouldn't be able to log
not in Tiki?
in
Create user if If a user was authenticated by Tiki's user database, but not found on the LDAP server, Tiki will create
not in Auth? an LDAP entry for this user. See Pear::Auth on how an entry is created.
Just use tiki
If this option is set, the user "admin" will be authenticated by only using Tiki's user database and not
auth for
via LDAP. This option has no effect on users other than "admin".
admin?
LDAP Host The hostname or ip address of you LDAP server (usually localhost).
LDAP Port The port number your LDAP server uses (389 is the default).
Search scope (base = Base object search, one = one-level search, sub = Subtree search (default) ) used
LDAP Scope
during authentication for finding a user on the LDAP server.
LDAP Base Base DN of the LDAP server. If you leave this empty, Pear::Auth will try to query your LDAP server
DN for its base DN. Example: dc=my-company,dc=com
LDAP User RDN to prepend to the base DN when searching for a user. Example: ou=People will search in
DN ou=People,dc=my-company,dc=com

668 Back to TOC

 Tikiwiki Documentation 1.9+

LDAP User Attribute that contains the username. (Note: for Active Directory try UserAttribute:
attribute sAMAccountName)
LDAP User Object class an entry must have when searching for a user. This is mandatory ! If you dont know what
OC to fill in, use * (an asterix)
LDAP Group RDN to prepend to the base DN when searching for a user. Example: ou=Groups will search in
DN ou=Groups,dc=my-company,dc=com
LDAP Group
Attribute that contains the group name. Example cn
Attribute
LDAP Group Objectclass used to create groups. Example groupOfUniqueNames would result in a group search
OC usinf the filter (objectclass=groupOfUniqueNames)
LDAP
Attribute used to retreive group members. Example uniqueMember will result in retrieval of all
Member
uniqueMembers from a groupOfUniqueNames
Attribute
LDAP
Member Is Defines whether member attribute retrieved using LDAP Member Attribute is full DN (y/n)
DN
DN of the entry to use to bind to the LDAP server for user creation. While authentication works
without binding as a privileged DN, creation of an entry usually does not. This admin DN is only used
LDAP Admin
when creating user entries on the LDAP server (i.e. only if the option Create user if not in Auth is
User
checked). Authentication works without an admin DN (Pear::Auth will try to bind using the username/
password to authenticate).
LDAP Admin
Password for the above DN.
Pwd

The LDAP Group and LDAP Member settings are currently not used by Tiki (as of 1.9.2).

LDAP Pear::Auth Settings With LDAP version 3 And TikiWiki 1.9.7

You may have to explicitly set the version in TikiWiki 1.9.7 to get it to work with LDAP v3. If you
are having problems, try the following:

Open userslib.php search for the following code around line 624:
$options["memberisdn"] = ($tikilib-
>get_preference("auth_ldap_memberisdn", "y") == "y");

Add the following lines right after this line:

$options["version"] = $tikilib-
>get_preference("auth_ldap_version", "3");

Back to TOC 669

LDAP Pear::Auth Settings With Microsoft Active Directory Services (ADS) And TikiWiki 1.9.7
Essentially the LDAP settings to work with a Microsoft Active Directory Server are the same.
However they won't work from the get-go without changing the userslib.php (valid for version
1.9.7)

Open /lib/userslib.php and search for the following code around line 624:
$options["memberisdn"] = ($tikilib-
>get_preference("auth_ldap_memberisdn", "y") == "y");

Add the following lines right after this line:

$options["binddn"] = $tikilib-
>get_preference("auth_ldap_adminuser", "");
$options["bindpw"] = $tikilib-
>get_preference("auth_ldap_adminpass", "");

These lines create the necessary binding for the ADS since by default it doesn't allow anonymous
requests.

After that the following LDAP configuration settings do work with ADS:
1. in the 'User registration and login' section, set 'Authentication method' to 'Tiki and
PEAR::Auth'

In the 'PEAR::Auth' section set the following settings:

1. set 'AUTH Type' to 'LDAP'
2. set 'LDAP Host:' to the Active Directory server's name or IP address
3. set 'LDAP Port:' to '389'
4. leave 'BaseDSN' empty
5. activate 'Create user if not in Tiki?'
6. deactivate 'Create user if not in Auth?' (we do not want the user to be created in the LDAP
dir)
7. leave 'LDAP URL' empty
8. set 'LDAP Scope:' to 'sub'
9. set 'LDAP Base DN:' to the LDAP version of the domain name as it appears in 'Active
Directory Users and Computers'. E.g., if the domain is called my-domain.local, set this to
'dc=my-domain,dc=local'. You might add an 'ou=yourorganizaonalunit' entry too. That
depends on your config.
10.leave 'LDAP User DN' empty
11.set 'LDAP User Attribute:' to 'sAMAccountName'
12.set 'LDAP User OC:' to '*'
13.leave 'LDAP Group DN' empty
14.set 'LDAP Group Attribute:' to 'cn'
15.set 'LDAP Group OC:' to 'groupOfUniqueNames'
16.set 'LDAP Member Attribute:' to 'uniqueMember'
17.set 'LDAP Member Is DN::' to 'n'
18.set 'LDAP Admin User Name' to 'cn=LDAPReader, cn=users, dc=my-domain, dc=local' -

670 Back to TOC

 Tikiwiki Documentation 1.9+

replace 'LDAPReader' with a username that is able to read the LDAP directory on ADS.
Adjust the cn=, dc= settings accordingly.
19.set 'LDAP Admin User Name' to the password of your LDAPReader user password.

Now you should be able to login. If you get a blank page after login make sure your PHP version is
>=4.3.2 as this is required by the LDAP Pear module. After it works with these basic settings you
can further refine the settings carefully if (for example) you only want a special group inside the
LDAP directory have access to the TikiWiki.

AuthPAM
AuthPAM provides PAM authentication to Tikiwiki just as Pear Auth does with LDAP.
It's mainly intended for those tiki admins who have integrated they're Linux boxes onto they're
network's authentication using PAM;
For example, in admins might have their Linux boxes authenticate trhough PAM to their Windows
2000 Active Directory Domain (via winbind and kerberos 5) so with AuthPAM
Then, they can authenticate their networked users against tiki without adding them by hand

Admin Documentation
AuthPAMOld configuration is very simple once you've met all the requirements (only a few). Once
met you just have to go to the Login section of TikiAdmin.
There will be a nice option onto 'Method' called 'Tiki and PAM' (which you should select if you
plan to use it!). Then at the bottom of the screen there are a few options for AuthPAM. You can see:
• Create user if not in Tiki?: Check this if you want Tiki to add users authenticated through
PAM but who are not onto it's internal database.
• Use tiki for admin only?: That's to make tiki authenticate 'admin' user with it's internal
system nor PAM, if you don't select that you'll have to add a system user called 'admin'.
• PAM Service (currently unused): Here you should specify which pam service should Tiki
authenticate against but these is now disabled due a lack of the auth_pam php module.

Requirements for AuthPAM

AuthPAMOld has a small requirement that must be met in order to work, you need pam_auth php
module. I've seen it's on some Linux distributions but not on all.
On the main page AuthPAM Link's section you can get the link to the author's home to get the
module and compile it if your distribution doesn't include a binary package.

After compilling and installing the module as stated in it's documentation you have to create a PAM
service for Tiki (normally at /etc/pam.d).

Then just jump onto Tikiwiki and setup PAM there.

Permissions!
Take care of file permissions, remember that php runs with apache privileges, normally a normal
user account like www-data or so. If you plan to use PAM against your system's users and your

Back to TOC 671

system uses shadowed password you should remember that /etc/shadow is only readable by root, so
php won't be able to read it,
(the PAM library runs with the calling user privileges) so you'll have to workaround it, maybe
letting your webserver's user read shadow file or so.

Security Issues
With a default PAM service any account will be granted (try user: nobody ) so here are a few things
to take care about that:

It is recomended that you make use of pam_require module to require a specific group to be in for
the user. Also you can take a look at PAM Modules at kernel.org to refine a bit more your pam
service for tiki.

Also take note that pam only receive a user/pass pair and checks it, it relays on your web server
settings to handle a secure transaction of that pair from the browser to the server. SSL is
recommend.

4.51.3.2. Login Authentication Methods

Overview of Login Methods

Tiki allows you to use several different login Authentication? methods. For standalaone sites (not
connected to a central authentication server), you can use "Just Tiki" or "Web Server". For sites that
are part of
a larger environment Tiki offers Pear::Auth, CAS, and Shibboleth authentication.

4.51.3.3. Just Tiki

The Just Tiki authentication method uses the usernames and passwords stored in the tiki database
for authentication. This is best used for sites that are not part of a larger intranet.

4.51.3.4. Web Server

A common way of protecting webpages is through Basic HTTP authentication. The web server
sends a "401 Authentication Required" header when a protected page is requested. The browser
would then prompt the user for a username and password. Access is allowed if the username
password pair are valid; else, the web server sends a HTTP 401 error, meaning "access denied."
HTTP authentication is usually used by creating a .htaccess file. (Only in Apache?)

Tikiwiki is able to detect when a visitor to the site is currently logged in using Basic HTTP
Authentication. If the username of the user matches a username within Tikiwiki's database, Tikiwiki
will automatically log the user in and, of course, grant all the assigned permissions.

672 Back to TOC

 Tikiwiki Documentation 1.9+

4.51.3.5. Tiki and Pear::Auth

LDAP Pear::Auth General Settings Overview

Tiki can authenticate users using a LDAP server via Pear::Auth (see http://pear.php.net/package-
info.php?package=Auth ) . The following settings only make sense, if you have set "Authentication
method" to "Tiki/Pear::Auth" in the above dialog. Tiki then uses the LDAP server in addition to its
own user database (users_users) to authenticate users.

If a user was authenticated via LDAP, but not found in the Tiki user database, Tiki will create an entry
Create user if
in its user database if this option is checked. If this option is disabled, this user wouldn't be able to log
not in Tiki?
in
Create user if If a user was authenticated by Tiki's user database, but not found on the LDAP server, Tiki will create
not in Auth? an LDAP entry for this user. See Pear::Auth on how an entry is created.
Just use tiki
If this option is set, the user "admin" will be authenticated by only using Tiki's user database and not
auth for
via LDAP. This option has no effect on users other than "admin".
admin?
LDAP URL Use a URL instead of host/port. If this is set the host/port settings below are overidden

Back to TOC 673

LDAP Host The hostname or ip address of you LDAP server (usually localhost).
LDAP Port The port number your LDAP server uses (389 is the default).
Search scope (base = Base object search, one = one-level search, sub = Subtree search (default) ) used
LDAP Scope
during authentication for finding a user on the LDAP server.
LDAP Base Base DN of the LDAP server. If you leave this empty, Pear::Auth will try to query your LDAP server
DN for its base DN. Example: dc=my-company,dc=com
LDAP User RDN to prepend to the base DN when searching for a user. Example: ou=People will search in
DN ou=People,dc=my-company,dc=com
LDAP User Attribute that contains the username. (Note: for Active Directory try UserAttribute:
attribute sAMAccountName)
LDAP User Object class an entry must have when searching for a user. This is mandatory ! If you dont know what
OC to fill in, use * (an asterix)
LDAP Group RDN to prepend to the base DN when searching for a user. Example: ou=Groups will search in
DN ou=Groups,dc=my-company,dc=com
LDAP Group
Attribute that contains the group name. Example cn
Attribute
LDAP Group Objectclass used to create groups. Example groupOfUniqueNames would result in a group search
OC usinf the filter (objectclass=groupOfUniqueNames)
LDAP
Attribute used to retreive group members. Example uniqueMember will result in retrieval of all
Member
uniqueMembers from a groupOfUniqueNames
Attribute
LDAP
Member Is Defines whether member attribute retrieved using LDAP Member Attribute is full DN (y/n)
DN
DN of the entry to use to bind to the LDAP server for user creation. While authentication works
without binding as a privileged DN, creation of an entry usually does not. This admin DN is only used
LDAP Admin
when creating user entries on the LDAP server (i.e. only if the option Create user if not in Auth is
User
checked). Authentication works without an admin DN (Pear::Auth will try to bind using the username/
password to authenticate).
LDAP Admin
Password for the above DN.
Pwd

The LDAP Group and LDAP Member settings are currently not used by Tiki (as of 1.9.2).

LDAP Pear::Auth Settings With LDAP version 3 And TikiWiki 1.9.7

You may have to explicitly set the version in TikiWiki 1.9.7 to get it to work with LDAP v3. If you
are having problems, try the following:

Open userslib.php search for the following code around line 624:
$options["memberisdn"] = ($tikilib-
>get_preference("auth_ldap_memberisdn", "y") == "y");

Add the following lines right after this line:

$options["version"] = $tikilib-

674 Back to TOC

 Tikiwiki Documentation 1.9+

>get_preference("auth_ldap_version", "3");

LDAP Pear::Auth Settings With Microsoft Active Directory Services (ADS) And
TikiWiki 1.9.7
Essentially the LDAP settings to work with a Microsoft Active Directory Server are the same.
However they won't work from the get-go without changing the userslib.php (valid for version
1.9.7)

Open userslib.php search for the following code around line 624:
$options["memberisdn"] = ($tikilib-
>get_preference("auth_ldap_memberisdn", "y") == "y");

Add the following lines right after this line:

$options["binddn"] = $tikilib-
>get_preference("auth_ldap_adminuser", "");
$options["bindpw"] = $tikilib-
>get_preference("auth_ldap_adminpass", "");

These lines create the necessary binding for the ADS since by default it doesn't allow anonymous
requests.

After that the following LDAP configuration settings do work with ADS:
1. in the 'User registration and login' section, set 'Authentication method' to 'Tiki and
PEAR::Auth'

In the 'PEAR::Auth' section set the following settings:

1. set 'AUTH Type' to 'LDAP'
2. set 'LDAP Host:' to the Active Directory server's name or IP address
3. set 'LDAP Port:' to '389'
4. leave 'BaseDSN' empty
5. activate 'Create user if not in Tiki?'
6. deactivate 'Create user if not in Auth?' (we do not want the user to be created in the LDAP
dir)
7. leave 'LDAP URL' empty
8. set 'LDAP Scope:' to 'sub'
9. set 'LDAP Base DN:' to the LDAP version of the domain name as it appears in 'Active
Directory Users and Computers'. E.g., if the domain is called my-domain.local, set this to
'dc=my-domain,dc=local'. You might add an 'ou=yourorganizaonalunit' entry too. That
depends on your config.
10.leave 'LDAP User DN' empty
11.set 'LDAP User Attribute:' to 'sAMAccountName'
12.set 'LDAP User OC:' to '*'
13.leave 'LDAP Group DN' empty

Back to TOC 675

 14.set 'LDAP Group Attribute:' to 'cn'
15.set 'LDAP Group OC:' to 'groupOfUniqueNames'
16.set 'LDAP Member Attribute:' to 'uniqueMember'
17.set 'LDAP Member Is DN::' to 'n'
18.set 'LDAP Admin User Name' to 'cn=LDAPReader, cn=users, dc=my-domain, dc=local' -
replace 'LDAPReader' with a username that is able to read the LDAP directory on ADS.
Adjust the cn=, dc= settings accordingly.
19.set 'LDAP Admin User Name' to the password of your LDAPReader user password.

Now you should be able to login. If you get a blank page after login make sure your PHP version is
>=4.3.2 as this is required by the LDAP Pear module. After it works with these basic settings you
can further refine the settings carefully if (for example) you only want a special group inside the
LDAP directory have access to the TikiWiki.

4.51.3.6. Tiki and Pam

Help Need to transfer info from main login page

4.51.3.7. CAS

Central Authentication Service (http://www.ja-sig.org/products/cas/) is a Web Initial Sign-on

(WebISO) system designed by Yale ITS. CAS facilitates single sign-on across multiple web
applications and provides these web services with the ability to authenticate users without having
access to their passwords. From an end-user point of view, all protected pages show a standized
CAS challenge page where the user types in their NetID (a unique username of sorts assigned to
everyone affiliated with Yale) and password.

Much to our delight, we were able to make Tikiwiki interface with CAS without any customization.
Yale ITS provides mod_cas, an Apache modules that protect webpages through CAS. Since
mod_cas is an Apache module, it behaves like standard HTTP authentication. Tikiwiki supports
HTTP authentication. When a user is logged in through HTTP authentication, and the username
matches one of the usernames in the Tikiwiki database, Tikiwiki automatically logs the user in.
That way, when a user logs in through CAS, Tikiwiki matches the NetID (username) of the user
with a pre-created account in its database, and logs the user in.

(Taken from the YaleUniversityITS Case Study.)

4.51.3.8. Shibboleth

Shibboleth Authentication for TikiWiki

To Enable Shibboleth Authentication you will need to Do 2 main Steps.

Shibboleth Step 1: Update the Wiki

676 Back to TOC

 Tikiwiki Documentation 1.9+

To enable Shibboleth authentication within the Wiki goto the Admin page and in dropdown box
select Shibboleth

When Selected Goto the bottom to the Shibboleth Seettings.

Below is a table of the options and what they do.

Property Description
This option Creates a user when the user has logged in using Shibboleth but is not in the
Create user if not in Tiki?
Wiki.
Just use Tiki auth for Used to allow admin to login via shibboleth (Not recommended) or just using the tiki
admin> Auth
Valid Affiliations A comma separated list of affiliations which will allow users to login to this Wiki.
If selected a default group will be created (If no group is specified a default of
Create with a default group
Shibboleth will be used)
Default Group the name of the default group. If none Shibboleth will be used.

When the above is completed the wiki is ready to use shibboleth as an authentication source. You
will now need to ensure that shibboleth is setup correctly.

Below are the files that were modified to enable Shibboleth Authentication;
• lib/userslib.php
• templates/modules/mod-login_box.tpl
• templates/tiki-admin-include-login.tpl
• tiki-admin_include_login.php
• tiki-setup_base.php

Below is a table of these files and a description of the changes;

File name Description
This is used to validate a shibboleth user, changes have been made to the validate_user
userslib.php
function.
This file needs to be changed to display “Login through Shibboleth�? login box when
tiki-admin-include-login.tpl
not loged in.
tiki-admin-include-login.tpl This file needs to be changed to display the Shibboleth options in the Login Admin page
tiki-
This file changes will process the new values in the Login Admin page above.
admin_include_login.php
tiki-setup_base.php This page will need to be changed to ensure the shibboleth user is validated.

Back to TOC 677

 Shibboleth step 2:Update Shibboleth

To enable the wiki to be protected by Shibboleth you will need to add a the following to you apache
conf.

<Location /tikiwiki/tiki-login_scr.php>
AuthType shibboleth
ShibRequireSession On
ShibRequireAll On
require valid-user
</Location>

The other thing you will need to do is update your Shibboleth Service Providers AAP (Attribute
Assertion Policy) AAP.XML.

Below are the Attributes required by the Tikiwiki Auth and the required Header values;

<AttributeRule Name="urn:mace:dir:attribute-def:eduPersonPrincipalName"
Scoped="false" Header="REMOTE_USER">
<AnySite>
<!-- Ensure the value is unscoped so all IDs are unique-->
<Value Type="regexp">.*@.*</Value>
</AnySite>
</AttributeRule>

<AttributeRule Name="urn:mace:dir:attribute-def:mail" Header="MAIL">

<AnySite>
<AnyValue/>
</AnySite>
</AttributeRule>

<AttributeRule Name="urn:mace:dir:attribute-def:eduPersonAffiliation" Header="Shib-EP-

UnscopedAffiliation">
<AnySite>
<AnyValue/>
</AnySite>
</AttributeRule>

678 Back to TOC

 Tikiwiki Documentation 1.9+

4.51.4. Users Management

Changes in 1.10 require an urgent refactor of this page.
This page needs a lot of screenshot help.

General
Users management is done only by the admin of the TikiWiki. Users can either be added by the
admin or they can register themselves from the homepage. When some users register themselves,
they receive an email with a confirmation link. This concludes their registration. They automatically
become members of the default group "Registered" and are entitled to all the rights that you have
given to this group. For more information see the groups management page.

4.51.4.1. Adding a new user

After you have installed the software and logged in as the admin you will see the Menu on the left
side. One of the items is Admin.

: insert image here

To manage users of your TikiWiki, click on the plus sign (+) on the right of Admin (it can be
changed for "::" or a folder image displayed on the left later). This will cause the Admin submenu to
fold out.

: insert image here

In this submenu you will see the item for Users. Click on this and the users management module
starts. It shows the form for adding a user and a list of current users with their relevant information.
The user administration screen allows admins to create and edit users. You can create new users
(useful if users can't register themselves), remove users and assign groups to a particular user. You
can find users by login name using the find button at the top of the listing (it will act as a filter).

Back to TOC 679

Enter the name of a new user, that (s)he is going to use on your system, in the User field. Be sure to
use only a combination of A..Z, a..z, 0-9. Other characters in the username may be problematic.

You can either create a password for the new user or have the system generate one for you by
clicking on the Generate a password link. When you generate a password, copy it in both of the
password fields. The repeat password field is there to make sure that you entered the password that
you intended and to ensure that you can login with that password.

Fill in the email address and finish the registration with a click on the Add button.

The new user will receive an email that will ask for confirmation of the registration by clicking on a
URL that is in the confirmation email. When the user clicks on the link (s)he is registered and
automatically logged in.

4.51.4.2. Adding new users in bulk

You can upload a list of users from a file. The file needs to be in a CSV format. The first line will
contain the list of field names. The fields are login, password, email and groups. The next lines have
a user per line.

680 Back to TOC

 Tikiwiki Documentation 1.9+

Example:
login,password,email,groups
dupont,passe,[email protected],'Editors,GroupX'
durant,passe,[email protected]

"email","login","password"
"[email protected]","mister user1", "password,"

These groups must exist.

4.51.4.3. Adding a user to a group

Click the Key icon next to the user you want to assign a group to
You will see a list of groups available below the User Information
Under action you can click what group you want to add this user to

4.51.4.4. Finding a user

In the user management module there is a field where you can enter the name of a user that you
want to find. The name you enter doesn't need to be exactly like the name you want to find. It is for
instance not case sensitive. To search on part of a name is also supported. Searching on 'an' finds all
the users with 'an' somewhere in their username.

4.51.4.5. Deleting a user

To delete a user, click on the red cross behind the users name. You are asked to confirm the
deletion, go back to the user management module or return to the homepage. After confirmation the
user is deleted.

4.51.4.6. Modifying existing user information

4.51.5. Groups management

For general information about the Group feature see Group.
Related pages:
Group, user permissions, permissions, category, admin?

4.51.5.1. Creating Groups

To create a group:
• Expand the Admin drop down:
• Click on Groups, you'll see the page below

Back to TOC 681

 • Fill in the form with the Group name and description
• If the Group you are creating should be included as a sub-group of another Group, use the
include box to choose the Group or Group that the new Group should be a part of.
• If the Group should have it's own homepage, put the wiki page name or full URL in the
Home Page Box
• When all fields have been filled in click the Add button. The form will refresh and you
Group will appear in the new list (see below)

4.51.5.2. Assigning users to groups.

From the user administration screen click on the gold key to the right of the user line.

682 Back to TOC

 Tikiwiki Documentation 1.9+

The assign user form will be opened (see below)

This form shows the user information, the Group that the user already belongs to, and a list of
Group that the user can join. There are also shortcuts to Group permissions, Group admin, and user
admin from this page.

4.51.5.3. Assigning permissions to groups.

From the Group administration screen click on the gold key icon for a particular Group and you will
see a screen divided in two parts. The first part (see below)shows the permissions that are currently
set for the group.

The lower part of the screen shows all the permissions available to the Group, as well as details
about the currently assigned permissions.

The entry below shows that the permission has been inherited from the permissions given to
registered users.

An entry like the one below shows that the Group has permission to administer the feature, in this
case, calendars.

Additional permissions are assigned by clicking the checkboxes next to the permission, and then
clicking the update button at the top or bottom of the page when finished.

4.51.5.4. Changing or Removing Groups

Back to TOC 683

 • To change a Group, click on the Group name
• To change permissions on a Group, click on the key icon
• To remove a Group, click on the X.

4.51.5.5. Changing Group Settings

After clicking on the Group you want to change, you'll see the form above.
• To change Group Name, Description, Subgroups Included, or Homepage, edit the form and
click the save button.
• To remove a Group member, click on the red X next to the members name. __Note!: This

684 Back to TOC

 Tikiwiki Documentation 1.9+

does not remove the user, it just takes them out of the group.

4.51.5.6. Assigning a tracker to a Group

You can assign a tracker to a group. Each user of this Group will have a tracker item that he will be
able to modify from MyTiki.
In TikiWiki 1.10, you can decide to have this tracker item filled at registration. In order to do that,
you need to assign a tracker to the Group and specify the field that you want to request at the second
step of the registration. Be careful you need to save first the Group with the tracker name and then
edit the Group to be able to set the list of fields. As you can decide if a field is mandatory or not,
you can use this tracker as a mandatory set of new fields for a user.

In this section you can see information for the Group that you selected as name, description and
permissions assigned.

Then you can create a new permission level and you can if you want assign all the permissions in
some level to the group. Or remove all the permissions in some level from this group. As you can
see permissions are organized in levels. By default Tiki comes with four prearranged levels that you
can modify as you want:
• Basic: permissions for anonymous users, basic site usage
• Registered: permissions for logged users
• Editor: Permissions to site editors can manipulate content.
• Admin: Permissions for admins only. Can be dangerous if misused

In the second part of the screen you can assign permissions and change levels.

Back to TOC 685

The top section is used to select a permission category, for example games, forums, FAQs,etc. All
can be used to see all the permissions at once (the screen will be VERY long). For each category for
which permissions will be displayed the checkboxes indicate if the permission is assigned to the
Group or not. You can assign/remove permissions using the checkboxes; you can also change the
level of any permission using the dropdown. In this way you can re-classify the permissions as you
need and then easily assign all level-x permissions to a Group whenever you want.

When a user belongs to more than one Group the permissions are accumulated.

4.51.6. Permissions
Permissions are what Group CAN do. Note that permissions always ALLOW Group to do things;
there are no restrictive permissions in Tiki because they can conflict if the user belongs to more

686 Back to TOC

 Tikiwiki Documentation 1.9+

than one group. The list of permissions that you can assign to Group are:

4.51.6.1. General permissions

tiki_p_admin Administrator, can manage users Group and permissions and all the weblog features
tiki_p_use_HTML Can use HTML in pages
tiki_p_edit_templates Can edit site templates
tiki_p_admin_dynamic Can admin the dynamic content system
tiki_p_admin_banners Administrator, can admin banners
tiki_p_admin_categories Can admin categories
tiki_p_vote_poll Can vote polls
tiki_p_edit_cookies Can admin cookies
tiki_p_view_stats Can view site stats
tiki_p_view_referer_stats Can view referer stats
tiki_p_eph_admin Can admin ephemerides
tiki_p_admin_mailin Can admin mail-in accounts
tiki_p_edit_languages Can edit translations and create new languages
tiki_p_admin_banning Can ban users or ISP
tiki_p_create_css Can create new css suffixed with -user

4.51.6.2. Wiki permissions

tiki_p_edit Can edit pages

tiki_p_view Can view page/pages
tiki_p_remove Can remove
tiki_p_rollback Can rollback pages
tiki_p_admin_wiki Can admin the wiki
tiki_p_wiki_attach_files Can attach files to wiki pages
tiki_p_wiki_admin_attachments Can admin attachments to wiki pages
tiki_p_wiki_view_attachments Can view wiki attachments and download
tiki_p_upload_picture Can upload pictures to wiki pages
tiki_p_minor Can save as minor edit
tiki_p_rename Can rename pages
tiki_p_lock Can lock pages
tiki_p_edit_structures Can create and edit structures
tiki_p_edit_copyrights Can edit copyright notices

Back to TOC 687

 4.51.6.3. File galleries permissions

tiki_p_admin_file_galleries Can admin file galleries

tiki_p_create_file_galleries Can create file galleries
tiki_p_upload_files Can upload files
tiki_p_download_files Can download files
tiki_p_view_file_gallery Can view file galleries
tiki_p_batch_upload_files Can upload zip files with files

4.51.6.4. Comment permissions

tiki_p_post_comments Can post new comments

tiki_p_read_comments Can read comments
tiki_p_remove_comments Can delete comments
tiki_p_vote_comments Can vote comments
tiki_p_edit_comments Can edit all comments

4.51.6.5. Blog permissions

tiki_p_create_blogs Can create a blog

tiki_p_blog_post Can post to a blog
tiki_p_blog_admin Can admin blogs
tiki_p_read_blog Can read blogs

4.51.6.6. Image gallery permissions

tiki_p_admin_galleries Can admin Image Galleries

tiki_p_create_galleries Can create image galleries
tiki_p_upload_images Can upload images
tiki_p_view_image_gallery Can view image galleries
tiki_p_batch_upload_images Can upload zip files with images

4.51.6.7. Forums permissions

tiki_p_admin_forum Can admin forums

tiki_p_forum_post Can post in forums
tiki_p_forum_post_topic Can start threads in forums
tiki_p_forum_read Can read forums

688 Back to TOC

 Tikiwiki Documentation 1.9+

tiki_p_forum_vote Can vote comments in forums

tiki_p_forums_report Can report msgs to moderator
tiki_p_forum_attach Can attach to forum posts
tiki_p_forum_autoapp Auto approve forum posts

4.51.6.8. Communications permissions

tiki_p_send_pages Can send pages to other sites

tiki_p_sendme_pages Can send pages to this site
tiki_p_admin_received_pages Can admin received pages
tiki_p_send_articles Can send articles to other sites
tiki_p_sendme_articles Can send articles to this site
tiki_p_admin_received_articles Can admin received articles

4.51.6.9. Games permissions

tiki_p_play_games Can play games

tiki_p_admin_games Can admin games

4.51.6.10. Quiz permissions

tiki_p_admin_quizzes Can admin quizzes

tiki_p_take_quiz Can take quizzes
tiki_p_view_quiz_stats Can view quiz stats
tiki_p_view_user_results Can view user quiz results

4.51.6.11. Articles & Submissions permissions

tiki_p_edit_article Can edit articles

tiki_p_remove_article Can remove articles
tiki_p_read_article Can read articles
tiki_p_submit_article Can submit articles
tiki_p_edit_submission Can edit submissions
tiki_p_remove_submission Can remove submissions
tiki_p_approve_submission Can approve submissions
tiki_p_admin_cms Can admin the cms
tiki_p_autoapprove_submission Submitted articles automatically approved

Back to TOC 689

 4.51.6.12. FAQ permissions

tiki_p_admin_faqs Can admin FAQs

tiki_p_view_faqs Can view FAQs
tiki_p_suggest_faq Can suggest FAQ questions

4.51.6.13. User permissions

tiki_p_create_bookmarks Can create user bookmarks

tiki_p_configure_modules Can configure modules
tiki_p_cache_bookmarks Can cache user bookmarks
tiki_p_usermenu Can create items in personal menu
tiki_p_minical Can use the mini event calendar
tiki_p_userfiles Can upload personal files
tiki_p_tasks Can use tasks
tiki_p_notepad Can use the notepad
tiki_p_newsreader Can use the newsreader

4.51.6.14. Chat permissions

tiki_p_admin_chat Administrator, can create channels remove channels etc

tiki_p_chat Can use the chat system

4.51.6.15. Content template permissions

tiki_p_edit_content_templates templates Can edit content templates

tiki_p_use_content_templates templates Can use content templates

4.51.6.16. Shout box permissions

tiki_p_view_shoutbox Can view shoutbox

tiki_p_admin_shoutbox Can admin shoutbox (Edit/remove msgs)
tiki_p_post_shoutbox Can pot messages in shoutbox

4.51.6.17. Drawing permissions

tiki_p_admin_drawings Can admin drawings

tiki_p_edit_drawings Can edit drawings

690 Back to TOC

 Tikiwiki Documentation 1.9+

4.51.6.18. HTML page permissions

tiki_p_view_html_pages pages Can view HTML pages

tiki_p_edit_html_pages pages Can edit HTML pages

4.51.6.19. Tracker permissions

tiki_p_modify_tracker_items Can change tracker items

tiki_p_comment_tracker_items Can insert comments for tracker items
tiki_p_create_tracker_items Can create new items for trackers
tiki_p_admin_trackers Can admin trackers
tiki_p_view_trackers Can view trackers
tiki_p_attach_trackers Can attach files to tracker items

4.51.6.20. Survey permissions

tiki_p_admin_surveys Can admin surveys

tiki_p_take_survey Can take surveys
tiki_p_view_survey_stats Can view survey stats

4.51.6.21. Webmail permissions

tiki_p_use_webmail Can use webmail

4.51.6.22. Newsletter permissions

tiki_p_admin_newsletters Can admin newsletters

tiki_p_subscribe_newsletters Can subscribe to newsletters
tiki_p_subscribe_email Can subscribe any email to newsletters

4.51.6.23. User message permissions

tiki_p_messages Can use the messaging system

tiki_p_broadcast Can broadcast messages to Group
tiki_p_broadcast_all Can broadcast messages to all user

Back to TOC 691

 4.51.6.24. DSNs

Permissions are created dynamically. See the Wiki SQL plugin? for information

4.51.6.25. Directory permissions

tiki_p_admin_directory Can admin the directory

tiki_p_view_directory Can use the directory
tiki_p_admin_directory_cats Can admin directory categories
tiki_p_admin_directory_sites Can admin directory sites
tiki_p_submit_link Can submit sites to the directory
tiki_p_autosubmit_link Submitted links are valid
tiki_p_validate_links Can validate submitted links

4.51.6.26. Galaxia Workflow

tiki_p_admin_workflow Can admin workflow processes

tiki_p_abort_instance Can abort a process instance
tiki_p_use_workflow Can execute workflow activities
tiki_p_exception_instance Can declare an instance as exception
tiki_p_send_instance Can send instances after completion

4.51.6.27. Charts

tiki_p_admin_charts Can admin charts

tiki_p_view_chart Can view charts
tiki_p_vote_chart Can vote
tiki_p_suggest_chart_item charts Can suggest items
tiki_p_autoval_chart_suggestio Autovalidate suggestions

4.51.6.28. ExtWikis

missing permissions here

4.51.6.29. Live Support

tiki_p_live_support_admin Admin live support system

tiki_p_live_support Can use live support system

692 Back to TOC

 Tikiwiki Documentation 1.9+

4.51.6.30. Calendar

tiki_p_view_calendar Can browse the calendar

tiki_p_change_events Can change events in the calendar
tiki_p_add_events Can add events in the calendar
tiki_p_admin_calendar Can create/admin calendars

4.51.6.31. Permissions for individual users

What if you want to give a specific user some permissions? Just create an artificial Group, assign
the user to that Group and give the Group the permissions that you need.

4.51.6.32. Individual permissions

As we explained you can set up individual permissions for some Tiki objects. When assigning
individual permissions the permissions you can assign are the same as you have in the global
permissions screen. Once an object has individual permissions only the individual permissions
apply to the object, and not the global permissions.

The following objects accept individual permissions:

• Wiki pages
• Image galleries
• File galleries
• Forums
• Weblogs
• Newsletters
• Surveys
• Quizzes
• Trackers

4.51.6.33. Permissions Settings

Related Pages: Group, Groups Admin, Category, Category Admin, Permissions List

Understanding Tiki Permissions

The most important part of Tiki administration is understanding the permission system used by
Tiki. Here are the basic permission components and how they interact. A complete list of
permissions can be found on the Permissions List page.

How Permissions Work

• Administrators can create and edit a Group.

Back to TOC 693

 • Each Group can have a fully customized access to all site features.
• Users can be assigned to one or several groups.
• Groups can have subgroups.
• Permissions are assigned to Group, NOT users.
• Administrators can create and edit Category.
• Objects (after 1.9) can be added to categories.
• a category can then be assigned to a group.
• category based permissions give members of the Group the right to view, or the right to
modify (or both).
• Individual objects can have permissions applied to them directly
• If no permissions are specified for a Group or category universal permissions apply.

When Tiki is installed, there are two pre-defined groups:

• Anonymous: Users that are not logged automatically belong to the anonymous group.
• Registered group: Users logged in automatically belong to this group.

What order are permissions settings applied?

• category permissions override universal (group based) permission settings.
• Individual object permissions override category permissions.
• Users will have the aggregated permissions of all Group they are in.

For example, if a user in Group "registered" is normally allowed to edit wiki pages, but the wiki
page in category "Admin" is restricted to administrator only editing, the user may not edit. If the
object in Group "Admin" has a local setting overriding the category, then they could.

Horizontal and vertical permissions structures.

Group (Vertical) Permissions

Tikiwiki's most basic permission system is based on groups.There are two pre-defined groups:
• Anonymous: Users that are not logged in automatically belong to the anonymous group.
• Registered group: Registered users that are logged in automatically belong to this Group

The site administrator can create multiple Group of users, including Group that contain other
groups. For example, a school site may have Group like this:

694 Back to TOC

 Tikiwiki Documentation 1.9+

In the diagram above we see three groups: pupils, instructors, and administrators. The
instructors and administrators are both members of a fourth Group, school personnel. Finally all
three of the lowest level Group are part of the All School group.

A Tiki administrator would give the privileges that applied to any user to the "All School Group".
The "School Personnel" Group would be assigned all privileges that apply to both Instructors and
"Administrators". Finally each individual Group would be assigned privileges that apply only to
them.

To see a step by step procedure for setting permissions, see the Groups Admin page. For other
examples of creating vertical permissions structures, see the Groups Permission Tutorial?

Category (Horizontal) Permissions

"Horizontal permissions" enable object permissions, which are applied to categories of content.
Horizontal permissions are built by creating a privilege on a category for a group. Extending our
school example (see above), an administrator can use Horizontal Permissions to set up
configurations like these:
• The Red Team and the Blue Team are both part of the pupils group. We can create sub-
groups for each team, create categories for each team, and associate a wiki page with each
category. Each team will now have a wiki page that is exclusively viewable and/or editable
by their team members.
• We can create categories for status (not started, in progress, finished, testing, released) and
set different permissions for each status. For instance, the "testing" team could be restricted
from editing an object unless it was in testing status.

To see a step by step procedure for setting category permissions, see the Category Admin page. For
other examples of creating horizontal permissions structures, see the Categories Permission
Tutorial?

Tiki provides you with virtually unlimited permission configurations for your Tiki-powered site.

Tiki 1.9 offers 173, (yes 173!) different permissions you can assign to any group. And Group can be
included in Group, and thereby, inherit permissions. Below is a list of global permissions you can
set Tiki-wide.

Back to TOC 695

And permissions can be overriden for many features. For example, you can set permissions for
image galleries in general. But say, you want a specific image gallery to have different permissions
(more or less restrictive, your choice), it is easy to do. Please note that once you set a specific
permission (for a specific image gallery), it completely overrides the default ones (that apply to
image galleries in general). This provides you full control.

Permissions by section
Can override
Name Description Permissions global
permissions?
tiki_p_edit_article
tiki_p_remove_article
tiki_p_read_article
tiki_p_submit_article
Fast-breaking news, announcements.
tiki_p_edit_submission
Articles Submission & approval. Topics & via topic_read
tiki_p_remove_submission
Types.
tiki_p_approve_submission
tiki_p_admin_cms
tiki_p_autoapprove_submission
tiki_p_topic_read
tiki_p_admin_forum
tiki_p_forum_post
tiki_p_forum_post_topic
Online discussions on a variety of
tiki_p_forum_read
Forum topics. Threaded or flat. File yes
tiki_p_forum_vote
attachments, etc
tiki_p_forums_report
tiki_p_forum_attach
tiki_p_forum_autoapp
tiki_p_admin_galleries
tiki_p_create_galleries
Collections of graphic images for tiki_p_upload_images
Image Gallery yes
viewing or downloading (photo album) tiki_p_view_image_gallery
tiki_p_batch_upload_images
tiki_p_batch_upload_image_dir
tiki_p_modify_tracker_items
tiki_p_comment_tracker_items
tiki_p_create_tracker_items
tiki_p_admin_trackers
Facts and figures storage & retrieval. A
tiki_p_view_trackers
Tracker forms & database generator, with yes
tiki_p_attach_trackers
reporting.
tiki_p_view_trackers_pending
tiki_p_view_trackers_closed
tiki_p_tracker_view_ratings
tiki_p_tracker_vote_ratings
Collaboratively authored documents tiki_p_edit
with history of changes. Tiki's Wiki tiki_p_view
has all the features you could want tiki_p_remove
Wiki from a first-rate wiki. Ex.: attach files, tiki_p_rollback yes
comments, history, images, warn on tiki_p_admin_wiki
edit, page locking, powerful wiki tiki_p_wiki_attach_files
syntax, etc tiki_p_wiki_admin_attachments

696 Back to TOC

 Tikiwiki Documentation 1.9+

Can override
Name Description Permissions global
permissions?
tiki_p_wiki_view_attachments
tiki_p_upload_picture
tiki_p_minor
tiki_p_rename
tiki_p_lock
tiki_p_edit_structures
tiki_p_edit_copyrights
tiki_p_wiki_view_comments
tiki_p_wiki_view_ratings
tiki_p_wiki_vote_ratings
tiki_p_wiki_admin_ratings
tiki_p_wiki_view_history
tiki_p_use_HTML
tiki_p_map_edit
tiki_p_map_create
Navigable, interactive maps with user-
Map tiki_p_map_delete
selectable layers (requires mapserver)
tiki_p_map_view
tiki_p_map_view_mapfiles
Provide content organization and
communication tools for registered
users
tiki_p_configure_modules
MyTiki Bookmark, User Preferences, Watch, N/A
tiki_p_minical
User Menu, Task, Inter-User
Messages, User Files, Notepad and
Mini Calendar
tiki_p_admin_surveys
Questionnaire with multiple choice or
Survey tiki_p_take_survey yes
open ended question
tiki_p_view_survey_stats
tiki_p_admin_quizzes
Timed questionnaire with recorded tiki_p_take_quiz
Quiz yes
scores tiki_p_view_quiz_stats
tiki_p_view_user_results
tiki_p_admin_directory
tiki_p_view_directory
tiki_p_admin_directory_cats
Directory (links) User-submitted Web links tiki_p_admin_directory_sites yes
tiki_p_submit_link
tiki_p_autosubmit_link
tiki_p_validate_links
tiki_p_admin_file_galleries
tiki_p_create_file_galleries
Computer files, videos or software for tiki_p_upload_files
File Gallery yes
downloading tiki_p_download_files
tiki_p_view_file_gallery
tiki_p_batch_upload_files
tiki_p_view_calendar
tiki_p_change_events
Events calendar with public, private
Calendar tiki_p_add_events yes
and group channels
tiki_p_admin_calendar
tiki_p_view_tiki_calendar

Back to TOC 697

 Can override
Name Description Permissions global
permissions?
Simple menu system which can
Featured links optionally add an external web page in
an iframe
tiki_p_tasks
To do list. Can send tasks to other tiki_p_tasks_send
Task N/A
users. Also shared group tasks. tiki_p_tasks_receive
tiki_p_tasks_admin
Turn a wiki page into slideshow by
using more than one title bar in the
page. You can also make slideshows
Slideshow
from a structure. Here is a nice
example of a slideshow about Using a
Wiki as an Organizational Portal
Enable users to send internal messages
to each other. (like email but internal to
tiki_p_messages
MyTiki Inter- your tiki site). A broadcast is a
tiki_p_broadcast N/A
User Messages message sent to many users, the
tiki_p_broadcast_all
message can be sent to a Tiki group or
to all users (if permissions are ok).
tiki_p_admin_sheet
tiki_p_edit_sheet
Spreadsheet Datasheets with calculations and charts no
tiki_p_view_sheet
tiki_p_view_sheet_history
tiki_p_admin_faqs
Frequently asked questions and
FAQ tiki_p_view_faqs no
answers
tiki_p_suggest_faq
tiki_p_admin_newsletters
tiki_p_subscribe_newsletters
Newsletter Content mailed to registered users yes
tiki_p_subscribe_email
tiki_p_send_newsletters
tiki_p_create_blogs
tiki_p_blog_post
Blog Online diaries or journals yes
tiki_p_blog_admin
tiki_p_read_blog
tiki_p_live_support_admin
Live support One-on-one chatting with customer
tiki_p_live_support
Static and dynamic HTML content.
tiki_p_view_html_pages
HTML page Note: HTML can be used in wiki
tiki_p_edit_html_pages
pages. This is a separate feature.
tiki_p_admin_charts
tiki_p_view_chart
Like polls, but more feature-rich;
Charts tiki_p_vote_chart
displayed in center column
tiki_p_suggest_chart_item
tiki_p_autoval_chart_suggestion
Use of Google Maps interactively
Gmap
inside Tiki, added to 1.9.4
Users upload files and store them in
User Files tiki_p_userfiles
their tiki personal space, they can then

698 Back to TOC

 Tikiwiki Documentation 1.9+

Can override
Name Description Permissions global
permissions?
download the files.
Users can write, upload, download and
read notes. Notes can be read as raw
text files or as Wiki pages interpreting
User notepad the Wiki markup syntax. The user- tiki_p_notepad N/A
quota that admin can control is used to
set the maximum size that user notes
can take.
tiki_p_admin_chat
Chat Real-time group text chatting
tiki_p_chat
tiki_p_view_shoutbox
Provide a graffiti box on the site's
Shoutbox tiki_p_admin_shoutbox no
home page.
tiki_p_post_shoutbox
Contact Basic form from visitor to admin N/A
Newsreader NNTP newsreader tiki_p_newsreader N/A
tiki_p_play_games
Game Flash games
tiki_p_admin_games
Give users Web-based access to their
MyTiki Webmail tiki_p_use_webmail N/A
POP3 e-mail accounts
Friendship Users can identify other users as their
network friends.
The generated webhelp is a static
representation of the structure with a js
tree that can be used to navigate the
WebHelp
structure and a search function, print
function, history and some other
gizmos.

I want to test
Login here: (user: admin / password: demo) to test giving permissions:
http://demo.opensourcecms.com/tiki/tiki-assignpermission.php?group=Registered

Category permissions
There is also a new feature in Tiki 1.9.x to restrict permissions via the category feature. Basically,
you can already assign all the permissions you need as described above. However, permissions via
the category feature is just to make it faster to assign permissions. This feature is little tricky to
understand. We are working to improve it. There are only two levels (view & admin) in Tiki 1.9.4

Workspaces
Tiki workspaces are included in a special Mod to further facilitate management of large &
complex Tiki sites. See http://edu.tikiwiki.org/tiki-index.php?page=AulaWiki Mod for more
information.

Back to TOC 699

4.51.7. Admin DSN

Sorry. Doc is still at old site:

http://tikiwiki.org/tiki-index.php?page=AdminDSN

4.51.8. Backup
This page is part of the Basic Docs Project. Some help is needed to make equivalent screenshots of
this page but in English. The TikiLiveCD can be used, if you want to help but you don't have a
phpmyadmin handy or available

Two types of things in a standard tikiwiki installation must be saved for a backup of your specific
site:
1. your data base
The best is to use the save tool your database (or your hosting) provide
ex for mysql : mysqldump -u database_user -ppassword database_name > file
2. your local files
• the image galleries directory if you use a directory
• the file galleries directory if you use a directory
• the wiki attachment files if you use a directory
• img/wiki
• img/wiki_up
• img/trackers
• maps
• whelp
• mods

You do not need to save the templates_c and the temp directories

In a customized installation, you need to save all tpls, css, php you have modified
Note
The bundled Backup feature in Tiki (tiki-backup.php) is not recommended. And it will be deleted from tikiwiki
because to save via the web is not safe. You can have timeout. If you use it, set your php.ini to allow for enough time
for the process to finish, as well as the size of the download.

700 Back to TOC

 Tikiwiki Documentation 1.9+

Note

You'd better use instead one of the following procedures:

1. Through web interface: PhpMyAdmin

http://www.phpmyadmin.net/
2. Through command at a terminal screen (command mysqldump)
http://www.mysql.com/doc/en/mysqldump.html

A. Backing up through Web interface (Phpmyadmin)

If needed, ask your system admin if they provide Phpmyadmin in that hosting, and where is it
located for you to access it.

Eventually, you could get Phpmyadmin software to install it yourself: http://www.phpmyadmin.net/

The main screen in Phpmyadmin looks like:

(screenshots are taken using the TikiLiveCD: http://tikiwiki.org/TikiLiveCD )

Back to TOC 701

Select your database from the list (tiki19 in this example), at the drop down from the left column of
the screen. You will see then something like:

Click on the tab that says SQL (or Export, in newer versions of phpmyadmin):

702 Back to TOC

 Tikiwiki Documentation 1.9+

At the export screen, make sure that you check the box from the section "Structure", that says
"Add DROP TABLE", since it will be much easier the process to re-insert a backup later on from
this same database that you are now exporting.

The rest of options are ok as seen by default.

At last, select the box "send", and click on the button "Execute". You will see a dialog menu like
this one:

Back to TOC 703

Save it on disc at your preferred location.

We will now open it to check that everything is all right (and to let you show the type of file saved,
if this is new to you):

704 Back to TOC

 Tikiwiki Documentation 1.9+

The file has to be encoded in utf-8. If we want to change the character set to, for instance, iso-8859-
1 (to be able to edit it with most MS Windows applications that didn't cope well with other charsets
different from that default), we can do it direcetly from true "utf-8 enabled" editors (see ToolBox
pages for links on common applications to do that depending on your operating system). For
instance, using KWrite, on GNU/Linux, it would look like:

Back to TOC 705

 B. Backing up through commands at a terminal screen (mysqldump)

Write a command like:

mysqldump -uuser -ppass tiki19 > tiki19_backup_yymmdd.sql

In your case, change in the example above:

• user for your username at the mysql server
• pass for the password for that username at the mysql server
• tiki19 for your database name, and
• yymmdd for the two digits of year, month and day, respectively, for instance, to have your
backups easily sorted by name and date of creation also.

Then, save your backup copy on a safe place. It's recommended to send by ftp or sftp that file to
your local computer to prevent problems if server hardisk and backups fail at any time.

706 Back to TOC

 Tikiwiki Documentation 1.9+

Importing the database again

In order to restore the database you have in a backup, you have to import it to you mysql server.
See Import database for more details.

Other approaches

Felix's approach
I installed phpMyBackupPro v.1.8 http://www.phpmybackuppro.net and modded 1 line of tiki-
login: including a call of the scheduled backup script of pMBP. Now I get my daily gziped backup
of the Database delivered right into my mailbox.

phpMyBackupPro has also a feature for directory backup per FTP; I've not yet tried it for
attachment and gallery folders located outside of wwwroot.

I included the backup feature into the Login-script because only logged users can post on my site -
thus the script is only called once for every user, and performance is only slightly affected for the
first user each new day who triggers the daily backup (has to wait some seconds until backup is
finished). If nobody logs in there's no need to update the last backup.

4.51.8.1. Import database

This is part of the Basic Docs Project. It needs review, and screenshots need to be replaced by their
English equivalents

There are two easy ways to proceed:

1. Through web interface (Phpmyadmin), o
2. Through command at a terminal screen (command mysql)

A. Through web interface (Phpmyadmin)

Go to your Phpmyadmin installation.

Back to TOC 707

Select your database name, from the drop down list on the left column in the previous screen.

You have to go to the phpmyadmin tab which says "SQL", (versions 2.6.x of Phpmyadmin, like the
one in the TikiLiveCD, or tab "Import", included in version 2.8.x of Phpmyadmin, for instance).

708 Back to TOC

 Tikiwiki Documentation 1.9+

Export tab, in Phpmyadmin version 2.8.x

B. Through command at a terminal screen (command mysql)

Write a command like

mysql -uuser -ppass tiki19 < tiki19_backup_yymmdd.sql

In your case, change in the example above:

• user for your username at the mysql server
• pass for the password for that username at the mysql server
• tiki19 for your database name, and
• yymmdd for the two digits of year, month and day, respectively, for instance, to have your
backups easily sorted by name and date of creation also.

If you had exported your database without the option to delete the tables (Drop tables, from the
Backup instructions through Phpmyadmin) before attempting to restore them from the database
backup, then you will have to empty the database tables first. (through phpmyadmin, for instance).

Back to TOC 709

And in case that you have troubles with the character set used to import the database to mysql, you
can specify the character set in which your sql database backup is encoded. In order to do so, you
can add the parameter --default-character-set=code (and as code, you can set for instance utf8 or
iso-8859-1)

As an example, in order to set the character set to utf8, you would have to write something like:
mysql -uuser -ppass --default-character-set=utf8 tiki19 <
tiki19_backup_yymmdd.sql

Related pages
• Backup

4.51.9. Banning
This feature allows you to limit who can access what features based on the IP address of the
computer they use.

It is handy to block wiki spammers if your site has registered or anonymous editing permissions, or
spammers to any of most of the other features in Tiki.

Once activated, you can access the Banning admin page under the Admin menu

That link will lead you to tiki-admin_banning.php, which will show this options:

710 Back to TOC

 Tikiwiki Documentation 1.9+

Once a new rule is created, it will be listed below under the list of banning rules:

Note: By the time of this writing (Tiki 1.9.7), the banning system only worked if rules were not
activated by dates (leave the "Rule activated by dates" checkbox unticked if the banning rule
doesn't work for you with activation by dates).

Back to TOC 711

4.51.10. Cache
This page is a quick copy from tw.o and needs refactoring
This page needs screenshots

Whenever Tiki founds a link to an external site in a Wiki page the link is cached in the Tiki cache,
this allows the Wiki users to visit the page even if the site is offline or the page is removed or
changed.

When you make a link in a Wiki page, you can choose to request that it not be cached. This is done
by adding the phrase |nocache after the link description between the square brackets.

The cache option in the Admin menu lets the administrator administer the Tiki cache:

insert graphic

You can list the cached pages, find pages using the find button and for each cache entry you can
view it, remove it, or refresh it (will retrieve a fresh copy of the page). If the enrty is removed it will
no longer display a cache link from the Wiki page where the site is referentiated.

insert graphic
If the wiki cache is enabled then cached pages will show a (cached) text besides the page
description. A special icon is also added to let the user force a refresh of the page if something that
should be updated was not because the cached page is being displayed. The icon can be found at the
top:

insert graphic
This icon can be used to refresh a cached wiki page.
Try it out
please link to the live Feature on tikiwiki.org
RFE
It would be very nice if there was a way of purging the cache via the tiki interface.

To empty the cache manually try

mysql -e 'truncate table tiki_link_cache;' tiki

adjust tiki db name to fit yours

Anecdotally, we've noticed a huge speed gain after clearing the cache on HEAD.

4.52. Content Templates

Content templates are texts that can be applied as templates when creating different tiki options, you
can use templates when:
• Editing wiki pages
• Editing articles or submissions

712 Back to TOC

 Tikiwiki Documentation 1.9+

• Editing HTML pages

To edit content templates follow the "content templates" link from the admin section of the
application menu. The screen will be as follows:
The process is simple edit the template and save it, you can preview the template if you want.
Important: If editing an HTML page template the wiki syntax is OFF and features such as wiki
references and others are not parsed. For HTML pages only HTML code and {ed id=name} or {ted
id=name} are allowed and parsed when previewing.

Once a template is created you will be able to apply the template when editin an object for the
template type. Note that applying a template replaces ALL the text at the textarea so first apply the
template and then fill it in.

4.52.1. Cookies (Taglines)

Cookies feature is also called "Fortune cookies" or "Taglines".

Overview
Users with permission to admin cookies (taglines) are capable of editing, adding and removing
taglines, taglines are just strings that can be displayed using the "How many feature is too much?"
syntax in any template, wiki page, article or comment.

Taglines are managed from this screen:

Back to TOC 713

You can add taglines, remove taglines or upload taglines from a text file, the file should contain one
tagline per line.

The remove all cookies option can be used if you want to renew your set of cookies using a new
text file.

Usage
This is a small tutorial on how to use taglines on your tiki site.
1. Log into your Tiki as admin or with appropriate permissions.
2. Download the taglines.txt text file from the Tiki site at SourceForge (see reference below),
or from Mods Type Taglines. Or, create a text file with one saying per line.
3. Upload the taglines.txt (if downloaded manually from SourceForge) or your text file into
your Tiki. Open the left-hand admin menu by clicking on the "::" or folder icon, find
Cookies, and click it. Use the interface to upload.
4. Again in the left-hand admin menu, find Modules and click it. In "Create New User
Module", create a new module with the Name and Title set to "Funnies" or something of that
nature, and add "{cookies}" to its Data textbox, without the quotes. That's curly-brace,
cookies, and curly-brace.
5. Save the module, and note that it is now listed in the "Assign Module" section above where
you created the module.
6. Now assign the module to somewhere on your site, for example, to the right column,
position 6. Be sure to assign a group (pick anonymous if you just want to see it work) and
set the module's display parameters.
7. See that the module is now displayed with one of the "cookies" inside.

Use dynamic content to display taglines

Another cool feature is that you can include a dynamic block in a Wiki pages, dynamic blocks are
configured as admin using the “Edit dynamic content” feature, basically a dynamic content block is
some text that is programmed to
appear from a given date. You can include dynamic content using:
{content id=1}

That will display the current value of the dynamic content block with id=1

Or
{rcontent id=1}

That will display a random value for all the contents defined for the block with id=1 (ideal for
cookies or taglines!!)
Related pages
• Mods
• Mods User
• Mods Admin

714 Back to TOC

 Tikiwiki Documentation 1.9+

• Mods Details
• Mods List

• Mods Type Taglines

• Dynamic Content

4.52.2. Edit Templates

4.52.3. External Wikis

External Wiki feature is used to make linking to topics easier.

Here are some examples:

The string on the left are the wikilink shorthand. tw for tikiwiki.org, dev for dev.tikiwiki.org, wq for
wikiquote, wd for wiktionary, lq for linuxquestions, wp for wikipedia.

tw http://tikiwiki.org/tiki-index.php?page=$page
dev http://dev.tikiwiki.org/tiki-index.php?page=$page
wq http://en.wikiquote.org/wiki/$page
wd http://en.wiktionary.org/wiki/$page
lq http://wiki.linuxquestions.org/wiki/$page
wp http://en.wikipedia.org/wiki/$page

This way, you can make a link to that external wiki using the internal wiki double round brackets
syntax with a prefix as "code:" inside. For instance, to make a link to

http://dev.tikiwiki.org/tiki-index.php?page=Download

you could use:

((dev:Download))

And it would produce this link:

Download

4.52.3.1. Enable the feature

You can enable the feature through "Admin home > Features"

Back to TOC 715

 4.52.3.2. Insert an external wiki reference:

You can do that through the link at "Admin > External wikis", that will lead you to tiki-
admin_external_wikis.php:

4.52.3.3. List external wiki references

From the same tiki-admin_external_wikis.php you can see the list of external wiki references you
already introduce them and edit or delete any of them. Below you can see, as a reference, the list of
external wikis that we have defined in http://doc.tikiwiki.org :

4.52.3.4. For more information

• Please see flash movie of config process

http://tikiwiki.org/tiki-download_wiki_attachment.php?attId=345&page=ExternalWiki
• Nice list of potential external wikis at http://tavi.sourceforge.net/InterWiki

4.52.4. Featured Links

The featured links section manages links. You can enter as many links as you want and a user
module displays the links in the order that you want. Clicking the links will open the site in a frame

716 Back to TOC

 Tikiwiki Documentation 1.9+

inside the central section of Tiki. Statistics are kept about the number of times that featured links are
visited and you can automatically order featured links by the number of hits they have.

The featured links admin panel screen lets you enter links that will be displayed in the featured links
module.

You can access the screen to admin the featured links by following the 'links' link from the admin
menu. Or copy and paste this on the tail end of your site's URL:
tiki-admin_links.php

insert graphic

In this screen you can enter links, remove or edit existing links and set the position for each link in
the featured links modules. Links with position = 0 won't be displayed, so you can use that number
to temporarily disable a link without removing it from the listing.

You can select the opening type for each link that can be:
• Replace current window (a normal link)
• New window (a normal link opened in a new window)
• Framed (The page will be opened as an iframe inside the Tiki window)

You will also have an option to automatically generate the positions for featured links using the
number of hits (visits) which each link has.

4.52.5. Mail notifications

Email notification allows you to receive an email when certain events occur on your Tiki site. The
current list of events that can trigger mail are
• a user registering
• a user posting an article
• any wiki page is changed
• any wiki page is changed, even minor edits
• a comment is posted or changed in a wiki page
• PHP error
Please note: You must set your sending email address on the General Admin page to enable this
feature.

4.52.6. Wiki mail-in

The wiki mail-in feature can be used to setup email accounts that can be used to
read and/or write (create and/or modify) Wiki pages and create articles (Tiki1.9). As admin click on
the Mail-in link in the Admin section of the application menu to get to the mail-in admin section :

Back to TOC 717

 The Mail-in admin page

4.52.6.1. Edit/Add new mail account

In this screen you can set-up mail accounts indicating the POP3 server, the SMTP server and the
user-password to be used, it's like any normal email configuration tool with the addition that you
can indicate the type of mail account to set-up. There is four types of accounts:
• wiki-get
When an email is sent to the account indicating in the subject the name of a Wiki page Tiki
will answer the email sending the wiki page to the sender.
• wiki-put
When an email is received indicating the name of a wiki page in the subject the body of the
email will be used to overwrite the wiki page indicated.
• wiki-append
When an email is received indicating the name of a wiki page in the subject of the email the
wiki page is appended with the data in the body of the email.
• wiki-prepend
the same than wiki_append, but the message is added at the top of the page

718 Back to TOC

 Tikiwiki Documentation 1.9+

• wiki
Wiki accounts can be used to GET, PUT and APPEND wiki pages, the body of the email is
the page content, the subject is used to indicate what to do.
• GET:pagename
• PUT:pagename
• APPEND:pagename
• PREPEND:pagename
• article-put
When an email is received an article will be created with the message subject as article
article and message body as article heading. The topic and type of the article can be
specified at the mail-in account configuration.

4.52.6.2. Other parameters

• Active
Says whether the account is to be checked or not.
• Allow anonymous access
Says whether anonymous users (regarding of their email address) can use this feature or not.
If this parameter is set to 'No', and a user sends a mail to a mail-in account from an adress
that is not in TikiWiki users list, Then the system will send a mail to this user saying that he
can not use this feature.
• Allow attachments
Says whether mail attachments are to be added or not.
• Check automatically
If this parameter is set to 'yes' the system will automatically check all active mail-in accounts
according to the 'Frequency' parameter.
• (Tiki 1.10) Discard to the end from
The end of the message (for a put, append, preprend) will be deleted after the string you give

4.52.7. Maps Config

On this page you configure the following:
full path to mapfiles: the location where are the .map files on this server
default mapfile: the map that is displayed by default when you click on maps on the application menu
Wiki Page for Help: a wiki page to explain how the maps interface is working
Wiki Page for
a wiki page to put any type of comments
Comments:
Full path to
the path on this server of gdaltindex to allow the system to create a tiled shapefile of images
gdaltindex:
the path on this server to the ogr2org binary to allow the system to create shapefiles containing
Full path to ogr2ogr:
user position (My Preferences) or image position (Image Galleries)
Map Zone: select which zone in degrees you are working with

• Click on the button change preferences to update the above

Back to TOC 719

 • Click on the button Generate User Map to create a shapefile containing the position of all
the registered users who have indicated a latitude and longitude in their preferences.

4.52.8. Custom Menus

The Custom Menus option allows you to create a menu where sections of a menu items can be
extendened or collapsed within a parent section (folder).

In the Admin menu, select Menus, which takes you to Admin menus page (/tiki-
admin_menus.php).

4.52.8.1. Creating a Custom Menu

There are three different types of menus that can be created:

• Fixed (f): The menu will be static all the options will be displayed in the menu module.
insert screenshot here
• Dynamic collapsed (d): The menu is dynamic only the sections will be displayed in the
menu module and there will be +/- links or a folder icon to open/close sections. The
application menu in tiki is an example of this class of menu.
insert screenshot here
• Dynamic expanded (e): The same as before but all the sections are expanded by default and
the user can close with (-) or the folder icon the options that he wants to close.
insert screenshot here

720 Back to TOC

 Tikiwiki Documentation 1.9+

4.52.8.2. Configuring a Custom Menu

Once created, click the configuration button on this new menu's row, which will take you to /tiki-
admin_menu_options.php?menuId=n

To create menu item fill-in the edit menu options form: at least Name, URL, Type = "option" and
Position which is a number to set the menu item order. Save and look at the Preview of the menu.

To create a section i.e. a folder that can be opened or collapsed, fill-in the edit menu options form
with at least Name, URL (relative or absolute), , Type = "section" and Position.

NOTE: Do not put anything in Sections unless you know the tiki specific feature references e.g.
feature_wiki or feature_blog_rankings. These can be auto-filled using Some useful URLs pull-
downs, or look at the Tips below to know how to gues the section name of the feature you are
interested in.
• A section is an option that can fold the following options. The options depending of a
section are defined as the list of consecutive options with type 'option'. The options of a
section stop when the next option is a section or a sorted section or a separator.
• A sorted section sorts all its depending options when displayed.
• A separator does nothing - except to stop a section (usefull if you want to do a section
followed by an option)

If you need a same option with different perms or group, duplicate the option with the same position
value.

Example
• option1
• section1
• option2
• option3
• option4
• section2
• option5

will be
option1 option
section1 section
option2 option
option3 option
separator
option4 option
section2 section
option5 option

In tikiwiki>1.9.8, more levels have been introduced

Back to TOC 721

Example:
• option1
• section1
• option2
• section3
• option3
• option4
• section4
• option5
• section5
• option6
will be
option1 option
section1section level 0
option2 option
section3section level 1
option3 option
option4 option
section4section level 2
option5 option
section5section level1
separator
separator
option6 option

Trick: It is better to create the options with non consecutive position values to be able later to
update easier the menu.

4.52.8.3. Allow viewing options/sections only under some conditions

Allow only to some specific groups

You can restrict the view of some options and sections in the menu, so that only specific groups can
view them. For instance, you could add a "User Preferences" option in position 100 to your
customized menu that is seen by users only when they log in (registered group).

To do this, you would add:

Name: User Preferences
URL: tiki-user_preferences.php
Sections:
Permissions:
Group: Registered

722 Back to TOC

 Tikiwiki Documentation 1.9+

Type: option Position: 100

Allow only if feature X is enabled

Imagine you want to add the option "Users Map" in position 110, to anonymous or registered
groups, only when the feature Google Maps (gmap) is enabled iin your site. You can do that with:
Name: Users map
URL: tiki-gmap_usermap.php
Sections: feature_gmap
Permissions:
Group:
Type: option Position: 110

Allow only if feature X enabled and if user in a group with given permission
You could also restrict the menu option to be seen when the feature X is enabled, but also only
when the user belongs to a group which has a specific permission.

For instance, you could add an option "Upload image" in position 120 which is seen only when the
feature image galleries (feature_galleries) is enabled AND only by users in groups which have the
permission to upload images (tiki_p_upload_images).

To achieve this behavior, you have to add something like:

Name: Upload image
URL: tiki-upload_image.php
Sections: feature_galleries
Permissions: tiki_p_upload_images
Group:
Type: option Position: 120

Tips
1. You could add to a menu entry any combination of settings for sections, permissions or
groups.
2. If you need a same option with different perms or group, duplicate the option with the same
position value.
3. To know the section names in order to allow only some new options when the feature is
enabled, you can disable/enable them under "Admin home > Features" (tiki-
admin.php?page=features), and you will see its name reported on top of the page when it's
reloaded after you saved your changes. Then, you can enable/disable them again to its
original state, if you don't want to change this setting.
4. To know the permission names, go to Admin > Groups > press on the key icon ( ) next to

Back to TOC 723

 a group) (tiki-assignpermission.php?group=Registered, for instance)

4.52.8.4. Include menu in a new user module

Once the menu has all or most of the options go to "Admin Modules" page (/tiki-
admin_modules.php), under " Create new user module" at the bottom, find your menu title in the
pull-down "Menus" on the right, click use menu and "{menu id=n}" (where n = your menu ID) will
appear in the "Create new user module" data box. Add a title (what will users will see) and a name
(what admin sees) and click create/edit.

Now you have created a new user module for the custom menu.

Moreover, it is possible to create dynamic pop-up menus by putting {phplayers id=n} in a TPL file.
For older versions of Tiki, you might need to copy the layersmenu CSS entries out of damian.css
into the css of your choice (or copy them from a later version).

On Admin Modules you can assign the module using the "Assign new module" form.

Links in iframe
Links to be opened inside an iframe in the main display area can be done this way ( Featured Links
feature has to be enabled):
Link opens in iframe
tiki-featured_link.php?type=f&url=https%3A%2F%2Fptop.only.wip.la%3A443%2Fhttp%2Fwww.siemens.com%2f
All special characters have to be replaced with the html encoding, e.g. / has to be replaced with
%2f!

Links in new page

Links in Menu can be made to open in a new page whenn adding int he "URL:" field "Edit menu
options" the following string after the url (no space between url and "):
" target="_blank

4.52.9. Theme Control

Definition
Using multiple Themes on your Tiki site. Changing the css and the template (.tpl) files used.

Setting
The theme control is activated from the Administration Panel tiki-admin.php / Features tiki-
admin.php?page=features . If you enable the theme control center you will see a link to Theme
Control tiki-theme_control.php in the admin section of the application menu and on tiki-admin.php

724 Back to TOC

 Tikiwiki Documentation 1.9+

Use
To use the theme control, you need to go in the submenu Theme control tiki-theme_control.php of
Administration menu. The theme control center can be used to assign a theme to:
• A tiki category
• A tiki section
• A tiki individual object

So you can have a gray site with a wiki page displayed in a red background and the articles section
in blue and the Sun category in purple!

The theme control center screen is presented as follows:

This screen is used to assign themes to categories. There are two similar screens that can be
accessed using the links at the top of the page to assign a theme to a tiki section or to an individual
tiki object.

Back to TOC 725

 Theme selection policy
It is important to know how a theme will be selected by Tiki, the following policy is applied.
1. If there is a theme for the individual object being displayed, then that theme is used.
2. If not, then if there is a theme for the category where the object belongs, then that theme is
used
3. If not, then if there is a theme for the current Tiki section, that theme will be used
4. If not, then if the user selected a theme, that theme is used (users must be permitted to select
their theme on the Administration tiki-admin.php / Login page tiki-admin.php?page=login
5. If not, then the default site theme is used (specified on the Administration tiki-admin.php /
General page tiki-admin.php?page=general )

Related pages
• Styles and Themes: How To Create a Custom Theme
• Smarty Templates: How to modify templates which control html layout produced by Tiki

Useful Links
• More information and demos of Tiki themes.
http://themes.tikiwiki.org
• Open Source Web Design.
http://www.oswd.org/

4.52.10. Phpinfo
Use this option to display and review information about the current state of PHP including:
• information about PHP compilation options and extensions
• the PHP version, server information and environment
• the PHP environment
• OS version information,
• paths
• master and local values of configuration options
• HTTP headers
• PHP License.

See the PHP Manual for details.

4.52.10.1. Displaying PHP info:

1. From the Admin menu, click Phpinfo.

2. The phpinfo() page appears appears, showing the current PHP configuration.

726 Back to TOC

 Tikiwiki Documentation 1.9+

4.52.10.2. Admin Details

4.52.11. Action Log

(Tikiwiki >= 1.10)
This feature is new. Documentation is needed for 1.10
This page has several screenshots that need to be replaced)

This feature allows you to follow what a user is doing on a user basis or a category basis.
For instance, you want to know the time a user was active or how many actions (update, view, ... )
have been done by a user or by a category during a period of time.

Admins can see reports of all action logs. Each user can see the report of his/her own actions
through a section which can be accessed through this icon under MyTiki: (Action log icon,
which links to an url like: tiki-admin_actionlog.php?selectedUsers[]=username, being username
the name of that user)

4.52.11.1. Configuration

This feature can be activated in the Admin -> Features panel.

The actions that can be recorded can be selected in the Admin -> Action Log panel. The actions that
can be viewed at report time can be selected also in the Admin -> Action Log panel, for an admin,
or in My Tiki -> Action log icon. For instance,

Back to TOC 727

 Setting for recording and viewing actions (admin)

Some actions are always recorded as they are needed in other functions (the logging/loggout time
and the wiki page updated) . Some others can be recorded by activating them individually through
this panel, plus it can be chosen which ones are needed for each report, regardless that there may be
be more actions being logged but not chosen to be displayed in the report.

728 Back to TOC

 Tikiwiki Documentation 1.9+

Setting for viewing actions (any user)

Etc...

Adding the permission to the group/s of interest

An admin has to grant a group of users the permission to see action logs, as it should be done for
any other permission (see Permission). This permission is called tiki_p_view_actionlog.

Choose if user's activity log has to be public or private

Another setting related to contributions is at Admin -> Login ("Displays user's contribution in
the user information page:"). If enabled, a user will be able to see other user's activity log,
including his/her contributions on the report. If not, only each owns logs will be reported, except for
admin, which will be able to see the log reports of all users, groups, etc.

4.52.11.2. Report and Statistics

An admin can obtain a report and some statistics on a user/s, group/s and category basis.
Any user can obtain a report and some statistics about his/her activity on a category basis.

In the Admin -> Action Log panel for an admin, or in My Tiki -> Action log for any user, the
settings and filters can be selected.

Back to TOC 729

 Reporting filters

Reporting filters for an admin, through Admin -> Action Log panel

Reporting filters for any user, through My Tiki -> Action log

Two actions have special meanings. The category action will record at the same time the action on a

730 Back to TOC

 Tikiwiki Documentation 1.9+

object is done the current category(ies) the object has. And the logging action that is only a switch
to display or not the login statistics.

Notice: if you change the configuration, the previous actions will not be changed. A new selected
action (except for those that are always saved) will not show this type of action that have occurred
in the past. If you take away an action, the recording and/or display will be updated accordingly
from then onwards.

Report list of actions

Individual actions are listed:

If feature "Contribution" is enabled, a new column called "Contributions" is added to the list of
actions reported, or exported.

Back to TOC 731

 Report statistics
And some basic statistics are included below:

http://doc.tikiwiki.org/img/wiki_up/doc.tikiwiki.org/Admin_action_logs_statistics.png

If feature "Contribution" was enabled, a new table reporting the evolution in time (weeks or days)
of contributions is added below:

732 Back to TOC

 Tikiwiki Documentation 1.9+

Additions are shown in green background, deletions in pink, and the difference is shown without
any special background color. Units are either bytes or kb, specified previously through the
reporting filters described above, as well as start and end date, and if columns are days or weeks.

4.52.12. Intertiki

needs review

This feature makes tikis can communicate with each others. It's based on xmlrpc protocol (thus, you
need xmlrpc feature enabled in your Tiki) so it will be extendable to several other applications. It
was introduced already in Tiki branch 1.9, since this feature was really needed in the Tikiwiki
community for gathering authentication for subdomains *.tikiwiki.org.

Key Function and sub-features

Initially thought for distributed auth system, Intertiki can be extended to other functionalities.

4.52.12.1. Configuration example

You can see below an example of two Tiki clients (doc.tikiwiki.org, edu.tikiwiki.org])
configuration using Intertiki against tikiwiki.org as a master server.

Intertiki client 1: doc.tikiwiki.org

Back to TOC 733

 Intertiki client 2: edu.tikiwiki.org

734 Back to TOC

 Tikiwiki Documentation 1.9+

Intertiki Server: tikiwiki.org

Back to TOC 735

 4.52.12.2. Intertiki internal details

Get version : intertiki:get_version

Mainly for debug use right now, it will be useful to be able to specify a minimal version for some
future enhancements.

Remote login : intertiki.validate

This enable using a tiki account on another tiki. One tiki is server, the other is client. The server has
to provide an url where to reach the xmlrpc server, the client uses that url to reach server and send
xmlrpc requests.
The idea is to avoid creating a local account for such remote login. I used the @ as a delimiter for
specifying the 'realm' the login belongs to.

The @ login will then become logged into the local tiki, and will be attributed membership to
groups that are defined by the configuration. Some changes are made here and there to avoid login
containing a @ access certain features (like preferences and such).

So, in login-box, a new menu is proposed with that feature when enabled, with a list of possible
auth locations, either local or remote. You also can type login@remote directly it will be processed
correctly.

Each validation request also sends a hash key that sort of identifies the client server. The use of that
key will be optional ultimately but for the tests it's a good protection.

Related Links
• http://www.xmlrpc.com/
• http://phpxmlrpc.sourceforge.net/ (on which is based the xmlrpc pear lib used in tiki)
• http://tikiwiki.org/InterTiki

4.52.13. Contribution
(only for tikiwiki = 1.10+)
Improving this documentation is a kind of needed for 1.10. Some screenshots might need to be
replaced

Contribution allows a user to select some types of contribution at each time he/she creates or
modifies a wiki page, posts or replies to a comment, posts or replies a forum topic, posts to a blog,
or modifies a tikisheet (so far). They are very useful for educational scenarios, promoting and
enhancing students onto experiential-reflective learning (Kolb et al, 1975 ; De Pedro, 2006 ).

For instance, a contribution can be:

• support requests
• questions that allow new evolution on an electronic discussion/dialogue
• new hypothesis

736 Back to TOC

 Tikiwiki Documentation 1.9+

• new information
• summarizing
• issues related to organization in the team of work
• ...

4.52.13.1. Admin setting

The contribution setting is set in admin->contribution. A contribution can be mandatory or not in a

per-feature basis.

These contributions are displayed in page history and, if chosen, in the comment or post.

Another setting related to contributions is at Admin -> Login ("Displays user's contribution in
the user information page:"). If enabled, a user will be able to see other user's activity log,
including his/her contributions on the report.

Back to TOC 737

Contributor feature
If enabled in Admin -> Contribution, a user is able to select which other mats of his/her group
where co-authoring (or just contributing, at least) to that wiki page edition. Action log will reflect
that contribution also.

Note that there is a setting to allow users to see user's contributions (within a user activity log) at
Admin -> Login ("Displays user's contribution in the user information page:"). If enabled, a
user will be able to see other user's activity log, including his/her contributions on the report.

Related pages
• Contribution
• Action log

External links
• http://edu.tikiwiki.org
• http://gclub.ub.es/awikiforum/

4.52.14. Wysiwyg Editor Admin

This documentation is needed for 1.10. Some screenshots are needed also. This page needs review

Since version 1.10, Tikiwiki includes a Wysiwyg (What You See Is What You Get) editor: ,
through the integration of Fckeditor in the Wiki feature. It can be enabled at Admin -> General
panel.

738 Back to TOC

 Tikiwiki Documentation 1.9+

Description of Wysiwyg Editor Features

Wysiwyg Editor is
Enable/Disable it
optional:
... and is displayed
If checked, it will be the default editor when creating or modifying a wiki page.
by default:
means all content of the wiki page is parsed, then __bold__ is shown as bold in parsed result,
"Content is parsed
and is still displayed __bold__ in the source of the wiki page. Then you can mix wysiwyg
like a wiki page"
edition and wikistyle code.
partial parsing includes:
"Content is partially * parsing of links
parsed" * parsing of images and generally what is included in { }
* parsing of wikiplugins
Toolbar skin: It selects the theme styles for icons, colors, etc. used by Wysiwyg editor
Shows a list of features that will be loaded with the editor. For more information on these
Toolbar content:
features, check the FCKEditor Documentation at http://www.fckeditor.net/

Back to TOC 739

 5. TUNNING TIKIWIKI

740 Back to TOC

 Tikiwiki Documentation 1.9+

(page intentionally left blank)

Back to TOC 741

5. Tuning Tikiwiki
5.1. Design
When designing your site, please consider using a user centered design approach to best satisfy the
primary needs of your audience.Recommended resources: http://usableweb.com

5.1.1. Styles and Themes

The look of your tiki site is controlled by a set of files which specify the html layout (smarty .tpl
files) and one or more Cascading Styles Sheet file/s (.css). They both are selected through the
"theme" style drop down box under "Admin home > General", fro the whole tiki site, and if
allowed a user to override the general setting for his/her account, then through "MyTiki >
Preferences > General Preferences".

By selecting a theme styles to, for instance, simple.css, you are selecting not only simple.css as the
cascading style sheet file, but also all the specific .tpl files associated with it (more information on
tpl files at Smarty templates ).

By default Tikiwiki comes with plenty of themes, and some more can be installed either through the
Mods system, or by hand from other sites, such as the dedicated Tiki site: http://themes.tikiwiki.org
, where you can test all the themes there before installing them on your site. If your are using a
new Tiki version, and some features seem not to work properly, first try using tikineat.css theme
style, since it is the style most updated for the latest Tiki developments.

5.1.1.1. New themes from themes.tikiwiki.org

These themes are available for download or will be soon.

The themes listed here are not included in the Tiki package (see Tiki-bundled_themes) and are not
Legacy_themes that were once part of the archive. They are new themes for distribution
independent of the Tiki archive/package.

For general instructions on adding a new theme to your Tiki site, see How To Add a New Theme.

Twist
Twist
This theme, by gg is a page that floats in the center of the screen and has
custom icons for the menu folders.

Status: Available for downloading!

742 Back to TOC

 Tikiwiki Documentation 1.9+

Andreas09
Andreas09
This theme, an adaptation of a design by Andreas Viklund , offers the
choice of six background colors.

Status: Released! Download here !.

Zuka
Zuka - Originally made for zukakakina.com , this theme is an experiment
to make a rather spartan page with few colors and some simple drop
shadows.

Status: Released! Download from here . Initial version (1.0) tested with
Tiki 1.9.7.

Tikipedia
Tikipedia - Mediawiki's default Monobook theme — also used at
Wikipedia — adapted for Tikiwiki.

Status: Released!

Kubrick
Kubrick - Tiki adaptation of popular theme found on around 27 other
CMSs and blog programs.

Released! Download here . See Kubrick and Kubrick_customizing for

details and info on personalizing the theme.

Planetfall
Planetfall - Competition-winning theme for Mambo CMS. This is an
adaptation for Tiki of the mighty fine original.

Status: Released! Download here . See Planetfall for details and info on
customization.

Back to TOC 743

 Snow
Snow - A winter theme, uses conventional three-column layout. Flash
"snowfall" is optional for the top_bar.

Status: Released! Download here . See Snow for details and information
on personalizing the theme.

5.1.1.2. Tiki-bundled themes

These themes are part of the Tiki download.

BlueGreen
- StylesBluegreen -

Boreal
- themes.tikiwiki.org sample page? -

Codex
- themes.tikiwiki.org sample page? -

Damian
- themes.tikiwiki.org sample page? -

Dblue
- tikiwiki.org sample page -

744 Back to TOC

 Tikiwiki Documentation 1.9+

Default
- tikiwiki.org sample page -

Default2
- tikiwiki.org sample page -

Elegant
- themes.tikiwiki.org sample page? -

FMSC
- themes.tikiwiki.org sample page? -

Gemsi
- themes.tikiwiki.org sample page? -

Geo
- tikiwiki.org sample page -

Back to TOC 745

 Geo-light
- tikiwiki.org sample page -

Hec
- tikiwiki.org sample page -

Jalist
- tikiwiki.org sample page -

Jalist2
- tikiwiki.org sample page -

Lesjetesdelencre
- tikiwiki.org sample page -

Moreneat
- tikiwiki.org sample page -

746 Back to TOC

 Tikiwiki Documentation 1.9+

mose
- tikiwiki.org sample page -

Mozilla
- tikiwiki.org sample page -

Neat
- tikiwiki.org sample page -

Notheme
- tikiwiki.org sample page -

Notheme.II
- tikiwiki.org sample page -

Notheme.III
- tikiwiki.org sample page -

Back to TOC 747

 Olive
- tikiwiki.org sample page -

Olive-blue
- tikiwiki.org sample page -

Olive-red
- tikiwiki.org sample page -

Simple
- themes.tikiwiki.org sample page? -

Smartiki
- tikiwiki.org sample page -

Subsilver
- tikiwiki.org sample page -

748 Back to TOC

 Tikiwiki Documentation 1.9+

Tceti
- tikiwiki.org sample page -

Tiki
- tikiwiki.org sample page -

Tikigod
- tikiwiki.org sample page -

Tikineat
- tikiwiki.org sample page -

Tranquil
- tikiwiki.org sample page -

Trollparty
- tikiwiki.org sample page -

Back to TOC 749

 Vidiki
- tikiwiki.org sample page -

Whitebluegrey
- tikiwiki.org sample page -

(Screenshots made with Opera 9/WindowsXP; some variation in

appearance should be expected with other browsers and operating
systems.)

5.1.1.3. Legacy themes

These are themes that originally were included in the Tiki archive but have been removed, for
license incompatibility or to reduce the archive size. They work fine, but probably aren't current
with new Tiki versions, so they may not support all current Tiki features and style elements.
Available at the Tiki Mods archive, they are listed here for the sake of completeness.

3dblue
- tikiwiki.org sample page - download
Version: 1.2 - Licence: GNU/LGPL
Blue and 3D

Akwa
- tikiwiki.org sample page download
Version: 1.3 - Licence: GNU/LGPL
Looking like MacOSX

Bluemetal
- tikiwiki.org sample page download

750 Back to TOC

 Tikiwiki Documentation 1.9+

Version: 1.2 - Licence: GNU/GPL

Theme borrowed from another CMS.

Classicblue
- tikiwiki.org sample page download
Version: 1.1 - Licence: GNU/GPL
Variation of BlueMetal

Greenjelly
- download
Version: 1.2 - Licence: GNU/LGPL
British taste

Greenmetal
- download
Version: 1.2 - Licence: GNU/GPL
Theme borrowed from another CMS. (Background image is missing from
archive. Change body background color in stylesheet, as a workaround.)

Isabelsworld
- download
Version: 1.1 - Licence: GNU/LGPL
The theme of Isabel.

Back to TOC 751

 m508
- download
Version: 1.1 - Licence: GNU/LGPL
Originally aimed for 508 compliance, but not very successful

Matrix
- tikiwiki.org sample page download
Version: 1.2 - Licence: GNU/LGPL
Requires a fast computer, light version also included.

Matrixlight
- tikiwiki.org sample page
Version: 1.2 - License: GNU/LGPL
Included with the Matrix archive.

NHS
- download
Version: 1.1 - Licence: GNU/LGPL
A stylesheet by sdl of the Tiki Community conforming to the NHS colour
schemes.

Purplemetal
- download
Version: 1.3 - Licence: GNU/GPL
Theme borrowed from another CMS. Purple version. (Background image
is missing from archive. Change body background color in stylesheet, as
a workaround.)

752 Back to TOC

 Tikiwiki Documentation 1.9+

RedGrey
- download
Version: 1.3 - Licence: Unknown
A rip of the Fedora* themes

Redmetal
- download
Version: 1.2 - Licence: GNU/GPL
Theme borrowed from another CMS.

Specialsauce
No screenshot available. - download
Version: 1.1 - Licence: GNU/LGPL
Black, Yellow and Grey
(This theme needs some updating to be used with current Tiki versions. There are major text-
background contrast problems.)

Tarynsworld
- download
Version: 1.2 - Licence: GNU/LGPL
This is the theme in action at TarynsWorld.

Underworld
- download

Back to TOC 753

Version: 1.2 - Licence: GNU/LGPL
Underworld theme, very dark colours

Veryorange
- download
Version: 1.2 - Licence: GNU/LGPL
Orange version of moreneat

Zaksworld
- download
Version: 1.3 - Licence: GNU/LGPL
This is the theme in action at Zaks site.

Ztheme
- download
Version: 1.3 - Licence: GNU/LGPL
Simple theme, conservative colors. Designed for easy "readability" and
use.

5.1.1.4. How To Create a Custom Theme

Tiki themes control both the layout or structure of a site and its overall look. You can alter the
position of elements on your Web pages (adding/subtracting components) and you can modify
stylistic elements like color and font. Thus, by creating or modifying a theme, you can define:
• The application layout (basic structure)
• The presentation of elements in the layout (style)

754 Back to TOC

 Tikiwiki Documentation 1.9+

5.1.1.5. Layout

Within Tiki, the terms style and theme are used pretty interchangeably.

First, you'll need to create the basic layout of your new theme.
1. Pick a name for the theme. Check the templates/styles directory to make sure there's not a
pre-existing theme with the same name.
• For this example, we're going to create a theme called screensite.
2. Using your new theme name, create a sub-directory in the templates/styles directory.
• For example, create templates/styles/screensite.
3. Copy the files in a pre-existing theme's directory to your theme directory.
• For example, copy the files from templates/styles/moreneat to
templates/styles/screensite.
4. Using the theme name you chose in the first step, create a .css file in the styles directory and
copy the contents of the pre-existing theme's .css file into it.

At this point, your new theme has been created! If you go to User Preferences and check the drop-
down menu for Theme, you'll find your theme listed (e.g., screensite). But, without changing the
TPL files, your new theme will look just the same as the pre-existing theme you based it on.

5.1.2. How to modify TPL files

The TPL files are written using the Smarty template language, which takes a little getting used to.
See smarty.php.net .

To modify the layout of Tiki in your theme, just edit the files you copied. You can add images,
define columns, etc.

The specific template files will differ based on which pre-existing theme you choose, but some of
the commonly used files are:
• tiki.tpl: the main template defining the layout of the whole application
• tiki-show_page.tpl : this is the middle part (which replaces $mid in tiki.tpl)
• error.tpl: used to display errors
• header.tpl: the HTML header
• tiki-top_bar.tpl: top navigation bar
• tiki-bot_bar.tpl: bottom navigation bar
• the template files with names like tiki-print.tpl are used for printable representation of
objects so you usually don't want to change them.
As you can see you can modify the layout of the whole tiki application by just changing one file.

5.1.2.1. Overriding templates

As we saw above, the template files for custom themes all live in a directory named something like
templates/styles/custom_theme_name--for example, templates/styles/screensite. The default
template files live just one directory below there, in templates and its subdirectories, notably:

Back to TOC 755

 • templates/mail
• templates/modules
When creating a theme you can override any template file. You just need to put a modified template
file in the directory templates/styles/custom_theme_name.

For example, if we wanted to modify the forum listing in our screensite theme, we'd just copy the
file tiki-forums.tpl from
• templates/tiki-forums.tpl
• to
• templates/styles/screensite/tiki-forums.tpl
Then we'd edit our new copy of the file.

Tiki will substitute whatever is in your custom theme directory for the TPL files in the default
directories.
This technique works on files in the subdirectories, too. E.g., to change the application menu in
your theme, just copy the file mod-application_menu.tpl from
• templates/modules/mod-application_menu.tpl
• to
• templates/styles/custom_theme_name/modules/mod-application_menu.tpl

5.1.2.2. Presentation

The presentation of elements, the visual style of your theme, is created using CSS (Cascading Style
Sheets). So, the next step in building a custom theme is to make a CSS file for it.
W3C provides tutorials and other tools for learning CSS principles: www.w3.org/Style/CSS

1. Pick an existing CSS file from the styles directory. Please note that the CSS files are not in
the templates directory tree. In a default Tiki installation, there are two directories named
styles under the Tiki root:
• styles (for CSS files)
2. templates/styles (for the custom-theme sub-directories, into which you put TPL files--as we
just did above)
3. Copy the CSS file, rename it to match your new theme name, and keep it in the styles
directory with all the other CSS files. For example, we would call ours screensite.css.
4. Edit it to produce a style for your theme--selecting things like fonts, background colors and
the behavior of hypertext links.
5. If you wish to add images to your CSS style, it's best to create a subdirectory for them
beneath the styles directory--giving it your theme's name.
• For example, styles/screensite

We recommend the use of jalist.css as a basic theme that you can use to start your new theme. If
you want to make a very detailed theme use subsilver.css as the model.
Since you can change the CSS file and you can override any template your themes can make your

756 Back to TOC

 Tikiwiki Documentation 1.9+

Tiki site look like anything you want. The only limit is your imagination.

5.1.3. Allow User to Set Theme

Under Admin > Login you can activate "Reg users can change theme".

Once activated users can change their theme in their Preferences page under My Tiki menu.

Under Module you can also activate the switch_theme module which makes it super easy for users
to change themes.

5.1.4. Using multiple Themes / Styles on your Tiki site

Theme Control is all about how to assign Themes to
• A tiki category
• A tiki section
• A tiki individual object (i.e. an individual Wiki page, Blog, Gallery, etc.)

If you enable the theme control center you will see a link to Theme Control in the Admin section of
the application menu.
Useful Links
• Themes.tikiwiki.org is the place for demonstrating and distributing Tiki themes. This is a
Tiki community site, and all members are welcome to submit their creations. This will also
be the place for sharing ideas, getting help, and finding tutorials and other resources related
to Tiki themes.
http://themes.tikiwiki.org/

5.1.5. Design rules

This is a stub

5.1.6. Smarty Templates

Smarty is a "Template/Presentation Framework." It provides the programmer and template designer
with a wealth of tools to automate tasks commonly dealt with at the presentation layer of an
application.

5.1.6.1. Smarty in Tikiwiki

The default Smarty template files are in /templates.

If you want to modify a template, you shuold do so in a custom style directory, e.g. /
templates/styles/custom_theme_name/

See Styles and Themes ("How To Create a Custom Theme") for more details.

Back to TOC 757

 Tips

• use the {literal} {/literal} tag to escape Smarty parsing for a block of code, e.g. for a
javascript
• {* comment *} is used for commenting in smarty
• {tr}some text{/tr} is used for strings that are intended to be translated into other languages
(internationalization)

More information
• http://smarty.php.net/crashcourse.php : Crash Course in Smarty
• http://smarty.php.net/manual/en : Smarty Manual

5.1.6.2. Theme Layout Schema

tiki.tpl is the master template and imbricates many other templates

The main schema that Tikiwiki uses for layout is:

758 Back to TOC

 Tikiwiki Documentation 1.9+

The source page where this screenshot was taken from is:
• http://tikiwiki.org/MoreNeatLayoutSchema

Back to TOC 759

5.2. Hacking Tikiwiki

5.2.1. The 3 rules

Used by Tiki project administrators in the Recruitment Ceremony. A one line set of maxims on how
members of the Tiki Community collaborate.
We wish to follow the 3 rules, and also to convince anyone in Tikiwiki community to respect those
simple rules:

In brief
1. Preserve Environment
Tikiwiki is both software and a community. The mix of both, contextualized in the Internet
and the real life, is called The Environment. Any change in TikiWiki? should take in account
its effect on the entire Tiki community and should allow for a balanced evolution with
respect for the humans that use it. Please make sure any code you commit respects the LGPL
license
2. Commit early, Commit often
CVS is the central point in tikiwiki collaborative development. CVS commits should be
frequent, even in the early stages, to offer an opportunity of interaction between
contributors. Early commits provide more chances for feedback and for the community to
start to assimilate the ideas you propose
3. Make it Optional
TikiWiki? is used in many smaller contexts and its modularity is key to adoption in those
areas. Help preserve this flexibility by making your changes optional whenever possible,
accessible for tuning to the admin at least, via admin panels.

Verbose mode
1. Think about other users
Tiki is both a piece of software and a community of people. This combination means that we
invite you, as a member of the community, to think not only about the code, but also to the
wide variety of people who use Tiki everyday. Consider your proposed changes in this
context. We believe that a careful, thoughtful, and highly collaborative approach is a way to
maintain respect for both the code and the people who depend on it. Rather than seeing Tiki
as a game, we invite you to see Tiki as a manner of producing change. Recognize that your
code could affect the lives of people.
2. Share Early, Share Often
If you have an idea for an improvement, new feature, performance enhancement, or anything
else of that nature, be quick to share it. Be proud of your idea and get it out there on the e-
mail list or IRC channel. Be open to questions and ideas that others may have. As you work
out your ideas and implementations, share your progress and approach often. Ask for advice
and feedback. There are many smart people in the Tiki Community who love to help.
Documenting what you are doing on TikiWiki?.org keeps others up to date with changes.
You are encouraged to create a wiki page for your idea so others can comment. Create a
showcase site to show off your work in progress. Once it basically works and the

760 Back to TOC

 Tikiwiki Documentation 1.9+

community likes it, commit your code to CVS. Yes, it may be imperfect, nevertheless by
following the maxim of Release Early, Rlease Often others are more able to help with
development and debugging.
One BIG caution: Don't commit sweeping or wide reaching changes to CVS until there is
community consensus, or at least approval from one or more of the project administrators.
They are those who have that designation in the list of developers. Checking with others is
the right way to develop code and helps us to avoid really screwing up other people's lives
and projects. When in doubt, communicate! This could be on IRC, by email, or some other
agreed upon method.
A caution about the BIG caution : I feel it is impossible to reach consensus without
effective code. Asking before is a matter of gathering information, not getting prior
acceptance of something. Good decisions can provide bad implementations and in such
cases there is a difficulty in correcting what was mutually agreed beforehand (without
really knowing). Of course, that only applies to experienced coders who are supposed to
know what they are doing. People who learn to code need to be particularly cautious. You
decide whether this is for authoritative reasons or as a means of obtaining wisdom (if
available). That's my 2 cents. — mose
3. Make It Optional
Tiki is used in the real world by MANY people for MANY different uses. Try to avoid
forcing new features on everyone. Allow new features to be tuned and configured by the site
admin, and, if at all possible, allow it to be turned off. At the very least, make sure that the
default config doesn't change Tiki's behavior.

5.2.2. TikiDevNewbie
This page is dedicated to helping you, the new TikiWiki developer, get started in Tikiwiki
Development. There are a lot of references here - Some are basic, some advanced. You may need to
read some or all of the references, but please take the time to read this page before you start. We
hope it will save you time in the long run. As you learn, we invite you to come back and update this
page - share what you have learned.
1. Join the TikiWikiDev mailing lists at https://sourceforge.net/mail/?group_id=64258 and
ask lots of questions.
2. Join the #tikiwiki group on IRC and ask lots of questions. Read ConnectingToIrc for
instructions
3. Use TikiWiki and understand how it works before you start trying to change it. Set up a site,
use and administer it on an everyday basis until you can fix the problems you encounter.
4. Set up your development system to use one or more of the CVS branches (there are several).
The bleeding edge is Head.
5. If you are not sure how to set up a local server and want to use IIS on a Windows machine
read IisInstall or InstallTiki. There are some good "LAMP" stacks Sokkit and XAMPP
available for Windows if this will be your development platform.
6. Set up an Internet available site. This will be your playground and showcase to show off
your latest feature. Then let everyone on #tikiwiki know you have something new. If you
haven't already been asked to join the group - you will be now.
7. CVS is one of the more complicated things you'll need to learn about Tikiwiki Development.
1. Read the SourceForge pages for beginners on CVS
http://sourceforge.net/docman/display_doc.php?docid=29894&group_id=1 . It has

Back to TOC 761

 links to a lot of references and ideas on CVs use.
2. Ask lots of questions on IRC about CVS. Using CVS correctly could be a degree all
by itself.
3. You will need CVS access via SSH if you are going to be updating SourceForge - so
read http://sourceforge.net/docman/display_doc.php?docid=6841&group_id=1
8. Read the 3Rules
9. If this is the first open-source project you have worked on, understand that working on an
open-source project is NOT like any other development project you have ever done. You
will be dealing with a large number of people who are scattered all over this beautiful world
of ours. Many of our friends learned English as a second (or third) language.
Misunderstandings WILL happen! Assume positive intent and practice forgiveness. All of
this will require an added effort on your part. Please read KinderCode? often. A good place
to learn about the diferences of open source development is Eric Raymond's Cathedral and
the Bazaar
10.Before you DO anything - ask for help on the Development list or on #tikiwiki. It doesn't
make a lot of sense for you to spend a lot of time trying to accomplish something the Hard
Way when a few questions could save you a lot of effort. Again - ask questions and use the
expertise that is available.
11.If you have an idea for a new feature, suggest it on the dev list or #tikiwiki. Get some
feedback and opinions on the need for the feature and ideas on how to implement it. Some in
the tikiwiki community have been here for 2-3 years and know the history. As Newton
before you, take an opportunity to see further by standing on the shoulders of giants.
12.If you need help with something - ASK! Most developers are more than happy to assist
when they we can - but we need to when (and where) the help is needed. This is a very
friendly group who believe in helping each other!
13.Read the Hello World introduction in order to learn the basic structure of the tikiwiki
environment. This article starts with a basic "hello world" page and goes on to cover
permissions, menus, queries, wiki parsing, themes and more.
14.Tiki is licensed under the LGPL license . Take the time to understand the meaning of this
license before you commit any code. By submitting to the project you are committing to that
license model. Further, any code you copy from another open source project must be
compatible with LGPL.
15.Finally – That nasty word Documentation. While nobody expects a developer to spend
his time writing the documentation for the manual, some documentation is necessary.
Writing a simple proposal in a Wiki page stating what you want to accomplish and how you
plan to do it does several things. First, it will help you to clarify your thoughts. Second, it
should provide you and others with some specific goals. The most important thing is that it
will provide others with a place where they can comment on your ideas. Documenting the
source code is also important! Comments allow the unskilled novice to become better.

Other tw.o references:

• DevTips : http://dev.tikiwiki.org/DevTips

762 Back to TOC

 Tikiwiki Documentation 1.9+

5.2.3. Adding a new feature

5.2.3.1. smarty/php
Tikiwiki uses the Smarty template engine . Its purpose is to separate the presentation layer from the
programming layer.
The PHP interfaces with the database, does the computation…and assigns the smarty variables.
The smarty templates use these variables to generate the actual HTML.

For instance:
<?php // Smarty use sample
$user='admin';
$smarty->assign('user', $user);
?>

This php assigns the smarty variable $user.

This variable will be used in a template like that
<h1>{$user}</h1>

This will display

<h1>admin</h1>

In a smarty template, you can loop over array of data and do some simple computation. To preserve
separation and optimization, no php code must be inserted in a template.

5.2.3.2. The hello world page

How to display "hello world" in the central column of a tikiwiki page:

Create a php file in the tikiwiki root directory (where tiki-install.php is).
hello_world.php:
<?php // hello_world displayed in a tikiwiki center column
include_once('tiki-setup.php');
$smarty->assign('mid', 'hello_world.tpl');
$smarty->display('tiki.tpl');
?>

Create a template located in the sub directory templates/ (http://www.domain.com/templates/) or in

templates/styles/your_style/
hello_world.tpl:
<p>Hello World</p>

Back to TOC 763

To test it, type the url in your browser : http://my.domain.com/hello_world.php (where
http://my.domain.com links to your tikiwiki root).

Notice the use of include_once(‘tiki-setup.php’) in the php code. This include initializes the context
to be able to use smarty. Later we will see it is doing more.
tiki.tpl is the tikiwiki global template file. It is the only(almost) template that contains a complete
html page. A simplified working tiki.tpl file would be:
{* top *}
{include file="header.tpl"}
{* middle *}
<table>
<tr>
<td> {* left column *}
{section name=ix loop=$left_modules}
{$left_modules[ix].data}
{/section}
</td>
<td> {* middle column *}
{include file=$mid}
</td>
<td> {* right column *}
{section name=ix loop=$right_modules}
{$right_modules[ix].data}
{/section}
</td>
</tr>
</table>
{* bottom*}
{include file="footer.tpl"}

You can see the top section header.tpl, the bottom section footer.tpl and the 3 columns. The left
column displays all the left modules through a loop. Idem for the right column. The central part is
an include of the $mid file. (Notice: in tikiwiki 1.10, it is simply {$mid} and not {include
file=$mid})
In our hello_world example, the $mid part is the template hello_world.tpl and will display the string
“hello world”.

The templates hello_world.tpl can be created in the sub-directory templates/ or the sub-directory
templates/styles/your_style/ (where your_style is the name of the theme you are currently using (A
theme name is the css file name without extension). If it exists, the template in your current theme
directory overrides the one in the default directory. The avantage of putting your templates in your
local theme directory is to better identify what you have changed from the original tikiwiki. (Notice:
if you are using CVS and are handy with cvs conflict resolution, it may be better to directly modify
the templates in the default directory to be able to update/merge the tikwiki modification with
yours)

The $left_modules and $right_modules smarty variables are set up in tiki-modules.php. You will
see later in the module section how the modules are set.

764 Back to TOC

 Tikiwiki Documentation 1.9+

5.2.3.3. tiki-setup.php

This include does everything you need to have a tikiwiki page. It does a lot more that initializing
smarty. By including this file in your php, you:
• establish the connection with the database.
• read all the system preferences, user preferences, permissions from the database.
• check if the user is logged via a cookie.
• computes all the modules (in tikiwiki1.9). In tikiwiki 1.10 this is done in $smarty->display
• check up for some security points
• …

A couple of interesting variables are also set there

• user (user login)
• group (default group name)
• language
• all preferences
• ….
All these variables are set for php and for smarty.

To see your username in the hello world program, modify your template:
<p>Hello World, Dear {$user}</p>

5.2.3.4. How to debug and to see the smarty variables

If you want to see all the smarty variables that are set, you can use the smarty function {debug} in
your templates. Smarty will display a popup window.
{debug}
<p>Hello World</p>

You can also use the php function echo or print_r to see some php variable for debugging.
And you can use the function debug_backtrace to see the php trace.
<?php
function test() {
echo "<pre>";
print_r(debug_backtrace());
echo "</pre>";
}
include_once('tiki-setup.php');
echo "<pre>user:$user</pre>";
test();
$smarty->assign('mid', 'hello_world.tpl');
$smarty->display('tiki.tpl');

Back to TOC 765

 5.2.3.5. To execute some queries in the php

Tikiwiki uses the ADODB database abstraction library. A good description about how to code the
queries can be found at http://tikiwiki.org/tiki-index.php?page=DbAbstractionDev

A typical list routine without permission check.

In lib/contribution/contributionlib.php
// List a subset of contribution
// $offset = will return the objects from there to $offset + $maxRecords (if 0 =
from the beginning)
// $maxRecords = max number to return if = -1 returns all the objects
// $sort_mode = order criterium
// $find = string to search
function list_contributions($offset=0, $maxRecords=-1, $sort_mode='name_asc',
$find='') {
$bindvars = array();
$mid = '';
if ($find) {
$mid .= " where (`name` like ?)";
$bindvars[] = "%$find%";
}
$query = "select * from `tiki_contributions` $mid order by ".$this-
>convert_sortmode($sort_mode);
$result = $this->query($query, $bindvars, $maxRecords, $offset);

$ret = array();
while ($res = $result->fetchRow()) {
$ret[] = $res;
}
$retval = array();
$retval['data'] = $ret;
if ($maxRecords > 0) {
$query_cant = "select count(*) from `tiki_contributions` $mid";
$retval['cant'] = $this->getOne($query_cant, $bindvars);
} else {
$retval['cant'] = count($ret);
}
return $retval;
}

First, you have to notice that all table names and column names must be back quoted.
The $sort_mode is the concatenation of the column name, the underscore and asc or desc. It can be
any column.

In the main php, tiki-contribution.php, you will have

include_once('lib/contribution/contributionlib.php');
$contributions = $contributionlib->list_contributions();
$smarty->assign('contributions', $contributions['data']);

766 Back to TOC

 Tikiwiki Documentation 1.9+

and in the template templates/tiki-contribution.tpl, you will have

{cycle values="even,odd" print=false}
{section name=ix loop=$contributions}
<tr>
<td class="{cycle advance=false}">{$contributions["ix"].name|
escape}</td>
<td class="{cycle}">{$contributions["ix"].hits}</td>
</tr>
{/section}

Notice: There is not yet good method to check the perms in this kind of routine. You have to get all
the objects and checked them.

5.2.3.6. To introduce a new feature or a new preference

For instance, you want to create a new feature called contribution

First you have to create an entry in the database
INSERT IGNORE INTO tiki_preferences(name,value) VALUES ('feature_contribution',
'n');

Each database update must be done in db/tiki.sql and db/tiki_1.xto1_y.sql. The first sql does the
complete database creation, the second is the upgrade script. The second one can be rerun as many
times as needed ((with the mysqldump option –f to ignore error).. The update of each script for each
database supported by tikiwiki is done by the script db/convertscripts/convertsqls.sh (Available in
1.10). So each time you have to update the database scheme, you have to modify 2 files and run a
script.
The script can be run by
cd db/convertscritps
./convertsqls.sh <virtualhost/root>

virtualhost/root can be localhost/tiki1.9 for instance

After you have to insert the check box into the features administration page.
In templates/tiki-admin-include-features.tpl, you have to insert these lines :
<tr>
<td>
<input type="checkbox" name="feature_contribution"{if $feature_contribution eq
'y'} checked="checked"{/if}/>
</td>
<td class="form">
{if $feature_help eq 'y'}<a href="{$helpurl}Contribution" target="tikihelp"
class="tikihelp" title="{tr}Contribution{/tr}">{/if}
{tr}Contribution{/tr}
{if $feature_help eq 'y'}</a>{/if}
</td>

Back to TOC 767

 <td colspan="3">&nbsp;</td>
</tr>

just before these lines if you want it in the first table.

</table>
{* ---------- Administration features ------------ *}

In tiki-admin_include_features.php, you have to insert the line "feature_contribution",

in the $features_toggles table definition
$features_toggles = array(
"feature_contribution",
….
);
foreach ($features_toggles as $toggle) {
simple_set_toggle ($toggle);
}

The loop on features_toggles will to the wanted step:

- update the database
- update the smarty variable and the php variable
Notice: Not all the admin pages are using simple_set_toggle ($toggle);even if it is the best practice.

You have nothing else to do, tiki-setup.php will automatically read and assign the php variable and
the smarty variable $feature_contribution in any tikiwiki page.

Feature and preference are set the same way.

You can have the list of feautures/preferences in the sql table tiki_preferences.
Notice: all the preferences are not necessarily there. Some old preferences have not been set in this
table and are test through isset($this_preference).This is bad habit: it is better to always include
your preference as described previously in the database and not to test if it is set with the isset
function
INSERT IGNORE INTO tiki_preferences(name,value) VALUES ('my_preference',
'my_value');

5.2.3.7. To get/set a user preference

To get the value of a user preference, you can use in a function :

global $tikilib, $user;
$tikilib->get_user_preference($user, $pref_name, $default_pref_value);

$user is the user name.

768 Back to TOC

 Tikiwiki Documentation 1.9+

$pref_name can be ‘theme’, ‘allowMsgs’…

The default for $default_pref_value is ‘’
Notice: “global $tikilib, $user;” is not necessary if you add these lines in the same file that the
include tiki-setup.php (the hello_world.php) but are needed in you add these lines in a function.

To set a user preference

global $tikilib, $user;
$tikilib->set_user_preference($user, $pref_name, $pref_value);

Notice: we don’t include lib/tikilib.php because it is always included in tiki-setup.php. Meanwhile,

the other libraries must be included like this:
global $categlib; include_once('lib/categories/categlib.php');

Notice the use of global. Global is necessary because your library can have been included in another
function that is out of scope of your new function.

You can have a list of user preferences in the sql table tiki_user_preferences. Same remark than for
tiki_preferences, the list can be incomplete.

5.2.3.8. To create a menu or to introduce a menu option

Tikiwiki has a couple of ways to introduce menus

- one by creating the menu and the menu options through sql (1)
- one by using the tiki API (2)
- one by using the templating / module feature (3)
- one based one phplayers (4)

There is not really a best method to create a menu. It depends. If your menu can be dynamically
updated, you will not use the template. If your menu is fixed, perhaps a template is the best.
The phplayers method is not described here as there is no current API. (phplayers menu are
interested because they can have more than 2 levels (Means an option in an option in a section)

Menu created by sql

INSERT INTO tiki_menus (menuId,name,description,type) VALUES ('100', ‘My

menu','My very own menu','d');
INSERT INTO tiki_menu_options
(menuId,type,name,url,position,section,perm,groupname) VALUES (‘100’,'o','My
option','tiki-my_option.php',10,'','','');
INSERT INTO tiki_menu_options
(menuId,type,name,url,position,section,perm,groupname) VALUES (‘100’,'o','My
other option','tiki-my_other_option.php',15,'','','');

A menu affects 2 tables. One for the menu by itself, and the other one for the menu options. In the

Back to TOC 769

previous example, we created a menu ‘My menu’ with 2 options.
A menu type can be
- d (dynamic collapsed)
- e (dynamic extended)
- f (fixed)
an option type can be:
- s (section)
- r (sorted section)
- o (option)
- - (separator)

The section parameter corresponds the feature. If the feature is not activated, the option will not
show up.
The groupname parameter is a filter on the group.

Notice: the menuId 42 is reserved for the application menu (the default tikiwiki menu).
Trick: we usually don’t give consecutive number to menu options to be able later to add additional
options easier.
If an option can be see with 2 perms, you need to add 2 options with the same position and different
perm. Idem if it can be see in 2 sections or 2 groups.
Some documentation can be found at http://doc.tikiwiki.org/tiki-index.php?page=Custom+Menus.
Notice: there is some bugs about the expand/collapse javascript in tw1.9.2.

To insert this menu in a column, you need to create a user menu that uses it (admin->modules-
>create a new user menu) and then assign this user menu (admin->modules->assign new module)

Menu created with the tikiwiki API

global $menulib; include_once(‘lib/menubuilder/menulib.php’);

$menulib->replace_menu($menuId, $name, $description, $type);
foreach (… optionmenu…) {
$menulib->replace_menu_option($menuId, $optionId, $name, $url, $type, $position,
$section, $perm, $groupname);
}

The parameter values are the same than described previously.

Notice: you can notice the use of global $menulib. This is very useful when you use this part of
code in a function. The include can have been done somewhere else, and the global gives you the
opportunity to catch the variable $menulib.

If you don’t know the $menuId you want to use, you need to
$menulib->replace_menu(0, $name, $description, $type);
$query = 'select max(`menuId`) from `tiki_menus`';
$menuId = $tikilib->getOne($query);
foreach (… optionmenu…) {
$menulib->replace_menu_option($menuId, $optionId, $name, $url, $type,
$position, $section, $perm, $groupname);
}

770 Back to TOC

 Tikiwiki Documentation 1.9+

Next, you have to create a user menu and assign it

global $modlib; include_once ('lib/modules/modlib.php');
$modlib->replace_user_module($name, $title, "{menu id=$menuId}");
$modlib->assign_module($name, $title, $position, $order, 0, $rows , serialize($
groups), $params, $type);

$position is ‘l’ (left column) or ‘r’ (right column)

If you assign 2 modules with the same order in the same column, they will appear both in a random
order.
$groups is an array of groups (ex: array("Registered", "Anonymous"))
$params is the value you put in the param field in admin->modules->assign module. (ex:
“max=10”)
$type is ‘D’ to assign to everybody.

Menu created with a smarty template

You can also create a menu with a template module. A good example is templates/modules/mod-
application_menu.tpl. This menu is the old tikwiki menu that has been replaced by a database menu
to be able to use the mods.

You only need to create a new template in templates/modules/ with a filename beginning with
mod-. This new module will automatically appear in the admin->modules scrolling list.

5.2.3.9. To introduce a new permission

If you want to create a new permission, you need to add it in the database like this:
INSERT INTO users_permissions (permName, permDesc, level, type) VALUES
('tiki_p_whatever', 'Perm definition', 'level', 'feature');

This must be added in db/tiki.sql and db/tiki_1.xto1.y.sql.

Where level can be editors, registered, admin … and feature is the group of perms (wiki, cms,
blog..)
You can create a new group of perms there. There is no other requirement for a group of perms.
The perm will be read and set to a php variable and a smarty variable in tiki-setup.php

In a php, the perm is used like this:

if ($tiki_p_whatever == 'y')

Don’t forget to compare to a value a current error is to write only

if ($tiki_p_whatever)

We usually name a perm with a name beginning by tiki_p_

Back to TOC 771

 5.2.3.10. To check a permission

All permissions can be overwritten at a category or object level. The rule to check if you have the
tiki_p_perm on an object is:
- check if the object has special perm. If yes, test if one of the group user has the perm tiki_p_perm
otherwise returns false.
- check if the object has a category with special perm. If yes, test if one of the group user has the
perm tiki_p_perm otherwise returns false.
- if none above, use the tiki_p_perm value

A function is dedicated to do the job

include_once('tiki-setup.php');
include_once('lib/tikilib.php');
$perm = $tikilib->user_has_perm_on_object($user, $object_id, $object_type,
$tiki_p_perm);

where user is the login name, $object_id is the object id (can be the page name or the article_id or
…), $object_type is the object type (can be ‘wiki page’, ‘article’….). You can use an array of perms
instead of tiki_p_perm if needed.

Example
if (!$tikilib->user_has_perm_on_object($user, $pageName, 'wiki_page',
'tiki_p_view') {
$smarty->assign('msg', tra('Permission denied you cannot read this
page'));
$smarty->display('error.tpl');
die;
}

Example
if (!$tikilib->user_has_perm_on_object($user, $quiz_id, 'quiz',
array('tiki_p_take_quiz','tiki_p_view_quiz_stats')){
$smarty->assign('msg', tra('Permission denied you cannot access this
quiz'));
$smarty->display('error.tpl');
die;
}

Notice: This function is very convenient but it is quite a bit slow even if there are a couple of cache
to optimize it. There is only one example in the tikiwiki code that integrates the perm checking in
the sql query.

To reassign all the permissions a user has on an object

There is actually no integrated function to do the job. This snippet reassigns the perm variables.
global $userlib; include_once('lib/userslib.php');

772 Back to TOC

 Tikiwiki Documentation 1.9+

global $feature_categories;
if ($userlib->object_has_one_permission($objectId, $objectType)) {
$perms = $userlib->get_permissions(0, -1, 'permName_desc', '',
$objectType);
foreach ($perms['data'] as $perm) {
$permName = $perm["permName"];
if ($userlib->object_has_permission($user, $objected,
$objectType, $permName)) {
$permName = 'y';
} else {
$permName = 'n';
}
}
} elseif ($feature_categories == ‘y’) {
global $categlib; include_once('lib/categories/categlib.php');
$perms_array = $categlib->get_object_categories_perms($user, $objectType,
$objected);
if ($perms_array) {
foreach ($perms_array as $permName => $value) {
$permName = $value;
}
}
}

$objectId is the object identifier: Ex: the page name for a wiki page, the article_id for an article.
$ObjectType is one of ‘wiki page’, ‘article’, ‘forum’, ‘post’, ‘blog’, ‘faq’, ‘image gallery’, ‘file
gallery’, ‘comment’, ‘tracker’, ‘survey’, ‘quiz’ …

5.2.3.11. To wiki parse a textarea

Imagine you have a textarea and you want this textarea to accept wiki format.
To parse the textarea, you will have to call
$tikilib->parse_data($text)
Usually if you have a choice like “it is html”, you need to add an additional
parameter
$tikilib->parse($test, $is_html)

PS: some tikwiki1.9 have bugs around the is_html parameter. There are patched by replacing $test
with htmlspecialchars($test);

If you want to add some quicktags to the textarea

include_once ('lib/quicktags/quicktagslib.php');
$quicktags = $quicktagslib->list_quicktags(0,-1,'taglabel_desc','','wiki');
$smarty->assign_by_ref('quicktags', $quicktags["data"]);
$smarty->assign('quicktagscant', $quicktags["cant"]);

In the templates in order to use the quicktags, you have to add in the template where you want the
quicktags to appear:

Back to TOC 773

 {include file="tiki-edit_help_tool.tpl"}

PS: only one quicktag zone per page is allowed

If you want to add the resize buttoms, you have to add in the php:
include_once("textareasize.php");

And in you tpl, you have to add something like this:

<form … id='editpageform'>
{include file="textareasize.tpl" area_name='editwiki' formId='editpageform'}
<textarea id='editwiki' … rows="{$rows}" cols="{$cols}">{$pagedata|
escape}</textarea>
<input type="hidden" name="rows" value="{$rows}"/>
<input type="hidden" name="cols" value="{$cols}"/>
</form>

5.2.3.12. Categories

How to make your feature use categories.

docs need to be written

5.2.3.13. Theme control center

How to make your feature be able to take on a different theme (depending on context)
docs need to be written

5.2.3.14. Search

Tikiwiki has 2 search features. One that is based on the mysql fulltext search feature and the other
one that is tikiwiki feature. (see http://doc.tikiwiki.org/tiki-index.php?page=Search+Admin for
more details)

To add a new object in a mysql search

First you have to add a fulltext index in the database.
For instance, you have a table
CREATE TABLE contribution (
title varchar(80) default NULL,
body text
) TYPE=MyISAM;

774 Back to TOC

 Tikiwiki Documentation 1.9+

If you want to be able to search on the title and the body field, you will need to add a fulltext index
CREATE TABLE contribution (
title varchar(80) default NULL,
body text,
hits int(8) default NULL,
lastModif int(14) default NULL,
FULLTEXT KEY ft (title ,body)
) TYPE=MyISAM;
Mysql will automatically takes care of the indexation in real time.
You can put as many fields as you want

Notice: if a field is in a wiki format and if you want to index what you see, you will need to have
another field that contains the parsed field. Even in this case, you can have some difference (for
instance if your field contains a last module format, only the result at indexation time will be
indexed). Usually, in tikiwiki we index the field not parsed as.. in IMHO no choice is perfect.

Second, you have to add the search function in lib/searchlib.php

function find_contributions($words = '', $offset = 0, $maxRecords = -1,

$fulltext = false) {
static $search_contributions = array(
'from' => '`tiki_contributions` c,
'name' => 'c. `title`',
'data' => 'c. `body`',
'hits' => 'c. `hits`',
'lastModif' => 'c. `lastModif`',
'href' => 'tiki-view_contribution.php?
contributionId=%d',
'id' => array('c. `contributionId`'),
'pageName' => 'c. `title`',
'search' => array('c.`title`', 'c.`body`'),

'permName' => 'tiki_p_view_contribution',

'objectType' => 'contribution',
'objectKey' => 'c.`title`',
);

return $this->_find($contributions, $words, $offset,

$maxRecords, $fulltext);
}

‘name’ is the column that contains the name of the object

‘search’ must be the list of fields of the mysql fulltext index.

Third, you need to add a call to the function in templates/modules/mod-search_box.tpl

{if $feature_contribution eq 'y'}
<option value="contributions">{tr}Contributions{/tr}</option>
{/if}

Back to TOC 775

Also in templates/tiki-searchresults.tpl
{if $feature_contribution eq 'y'}
<a class="linkbut" href="tiki-
searchresults.php?highlight={$words}&amp;where=contributions">{tr}
Contributions{/tr}</a>
{/if}
….
<form class="forms" method="get" action="tiki-searchresults.php">
…..
{if $feature_articles eq 'y'}
<option value="contributions">{tr}Contributions{/tr}</option>
{/if}
</form>
And in tiki-searchresults.php
If ($where == 'contributions' && $feature_contribution != 'y') {
$smarty->assign('msg', tra("This feature is disabled").":
feature_contribution");
$smarty->display("error.tpl");
die;
}

And you need to add the search on this object in the global search. In lib/searchlib.php, you need to
update the function find_pages
function find_pages($words = '', $offset = 0, $maxRecords = -1, $fulltext =
false) {
….
if ($feature_contribution == 'y') {
$rv = $this->find_contributions($words, $offset, $maxRecords,
$fulltext);
foreach ($rv['data'] as $a) {
$a['type'] = tra('Contribution);
array_push($data, $a);
}
$cant += $rv['cant'];
}
}

If you data are a little more sophisticated, you can do some join in the search. This is the faqs
example
function find_faqs($words = '', $offset = 0, $maxRecords = -1, $fulltext
= false) {
static $search_faqs = array(
'from' => '`tiki_faqs` f , `tiki_faq_questions` q',
'name' => 'f. `title`',
'data' => 'f. `description`',
'hits' => 'f. `hits`',
'lastModif' => 'f. `created`',
'href' => 'tiki-view_faq.php?faqId=%d',
'id' => array('f. `faqId`'),
'pageName' => 'CONCAT(f. `title`, ": ", q. `question`)',

776 Back to TOC

 Tikiwiki Documentation 1.9+

'search' => array('q. `question`', 'q. `answer`'),

'filter' => 'q. `faqId` = f. `faqId`',
'permName' => 'tiki_p_view_faqs',
'objectType' => 'faq',
'objectKey' => 'f.`title`',

);

return $this->_find($search_faqs, $words, $offset, $maxRecords,

$fulltext);
}

NO additional perm checking is needed. The function does the perm checking.

5.2.3.15. To add a confirmation step

Notice: We consider here only the “Protect against CSRF with a ticket:” feature in admin->login.
The “Protect against CSRF with a confirmation step:” was supposed to disappear.

if ($_REQUEST["action"] == 'delete') {
$area = 'delete_object';
if ($feature_ticketlib2 != 'y' or (isset($_POST['daconfirm']) and
isset($_SESSION["ticket_$area"]))) {
key_check($area);
…..delete …
} else {
key_get($area);
}
}

This works only if the delete parameters are passed directly in the url. Key_get losts the parameters
passed through a form input. In this case, you have to copy the parameters with the limit of url size
(it is why usually the multiple delete has no confirmation step

Here is an example from the multiple remove in admin->users

if ($_REQUEST["submit_mult"] == "remove_users") {
$area = 'batchdeluser';
if ($feature_ticketlib2 == 'n' or (isset($_POST['daconfirm'])
and isset($_SESSION["ticket_$area"]))) {
key_check($area);
foreach ($_REQUEST["checked"] as $deleteuser) {
$userlib->remove_user($deleteuser);
$tikifeedback[] =
array('num'=>0,'mes'=>sprintf(tra("%s <b>%s</b> successfully
deleted."),tra("user"),$deleteuser));
}
} elseif ( $feature_ticketlib2 == 'y') {
$ch = "";
foreach ($_REQUEST['checked'] as $c) {
$ch .= "&amp;checked[]=".urlencode($c);
}

Back to TOC 777

 key_get($area, "", "tiki-
adminusers.php?submit_mult=remove_users".$ch);
} else {
key_get($area);
}

• To protect your application against sea surf(CSRF - XSS)

Each tikiwiki page must include a protection against sea surfing.
For instance tiki-action_object.php
<?php
require_once('tiki-setup.php');
if ($_REQUEST['action_object’]) {
check_ticket('action_object');
// execute your action
}
ask_ticket('action_objet');
$smarty->assign('mid', 'tiki-action_object.tpl');
$smarty->display('tiki.tpl');
?>

5.2.3.16. To create a new module

To create a new module, the minimum thing you need to do is to create a template file under the
templates/modules/ (or templates/styles/your_style/modules/) with a filename beginning with mod-
and a .tpl extension.
Example, a contribution module will be
templates/modules/mod-contribution.tpl
{tikimodule title="{tr}Contribution{/tr}" name="contribution
flip=$module_params.flip decorations=$module_params.decorations}
<div align="center">
My contribution
</div>
{/tikimodule}

Notice the use of the smarty function tikimodule that will set up the box, the title and the box
preferences.

If you need to set up some variables, you need to create a php file
modules/mod-contribution.php
<?php
$smarty->assign('my_contribution_text', 'hello world’);
?>

The template that uses this variable will look like

778 Back to TOC

 Tikiwiki Documentation 1.9+

{tikimodule title="{tr}Contribution{/tr}" name="contribution

flip=$module_params.flip decorations=$module_params.decorations}
<div align="center">
{$my_contribution_text}
</div>
{/tikimodule}

Notice: This is a simplified version. This simple program allows only to have one occurrence of the
module (there is only one variable $my_contribution_text. And in 1.9, the modules are computed at
the beginning in tiki-setup.php that don’t allow to use variable set in the main program.

If you want to use the parameters that are set up in the admin->modules-> param module line or in
the MODULE plugin, you can use
<?php
$smarty->assign('max', $module_params['max']);
?>

where max is either a param of MODULE or a param inserted in the admin->modules->param line.

5.2.3.17. To create a new plugin

To create a new plugin, you need to create a file in lib/wiki-plugins/ with a filename beginning with
wikiplugin- and an extension .php.
Example
lib/wiki-plugins/wikiplugin-helloworld.php
<?php
function wikiplugin_helloworld_help() {
return tra("To return the text hello world title name").":<br
/>~np~{HELLOWORLD(title=M|Mme|Melle)}name{HELLOWORLD}~/np~";
}

function wikiplugin_helloworld($data, $params) {

extract ($params, EXTR_SKIP);
return "Hello World $title $data!";
}
?>

In a wiki page uses

{HELLOWORLD(title=Mr)}Tiki{HELLOWORLD}

The display will be

Hello World Mr Tiki!

Back to TOC 779

A plugin consists of 2 functions. A help function and a process function. The name of the functions
must be formatted. They begin with wikiplugin_, then the name of the plugin in lower case, then
_help for the help function.
If there is an help function, the help will automatically appear in the wiki help.
The help function returns a string that must be wiki parse-able.
The process function has 2 parameters, the text inside the tags data and the list of parameters param.
The list of parameters are usually extracted with the php extract function. Be careful to use the
param EXTR_SKIP for security reason. In our example, the variable $type is set just after the
extract to the value Mr.

5.2.3.18. A select all checkbox

You have a table and each line is identified by an id

Put if not the table in a form.
You may adapt $objects, $ix to your need
<form>
.....
<table>
.......
{section name=ix loop=$objects}
....
<input type="checkbox" name="checked[]" value="{$objects[ix].id|escape}"
{if $smarty.request.checked and in_array($objects[ix].id,$
smarty.request.checked)}checked="checked"{/if} />
....
{/section}
<xxxxx type="text/javascript"> /* <![CDATA[ */
document.write('<tr><td colspan="...">
<input type="checkbox" id="clickall"
yyyyy="switchCheckboxes(this.form,\'checkedPerms[]\',this.checked)"/>');
document.write('<label for="clickall">{tr}select all{/tr}</label>
</td></tr>');
/* ]]> */</xxxxx>
...
</table>
<div>
{tr}Perform action with checked:{/tr}
<input type="image" name="delsel" src='pics/icons/cross.png'
alt={tr}delete{/tr}' title='{tr}delete{/tr}' />
</div>
</form>

replace xxxx with script and yyyy with onclick

In php you test

if (isset($_REQUEST['delsel_x']) && isset($_REQUEST['checked'])) {
....
foreach($_REQUEST['checked'] as $id) {
...
}
}

780 Back to TOC

 Tikiwiki Documentation 1.9+

5.2.3.19. To do something specific in tiki.tpl function of the categories of the object

This is an example how to display in the top page something specific to the categories of the current
object
This function is not completly functionnal. It needs that object set a php variable $objectId or
$objectid or $objId and $objecType or $section. But if you need you can easily add a $objectId = $
forumId for instance in the .php
{if !isset($objectCategoryIds)}
{php}
global $smarty, $section, $objId, $objectId, $objectid, $objectType;
global $tikilib; include_once('lib/tikilib.php');
global $categlib; include_once('lib/categories/categlib.php');
if (empty($objectType)) {
$objectType = $section;
if ($objectType == 'wiki')
$objectType = 'wiki page';
elseif ($objectType == 'cms')
$objectType = 'article';
}
if (empty($objectId))
$objectId = $objId;
if (empty($objectId))
$objectId = $objectid;
if (!empty($objId)) {
$objectCategoryIds = $categlib-
>get_object_categories($objectId,$objectId);
$smarty->assign('objectCategoryIds', $objectCategoryIds);
}
{/php}
{/if}
{if (empty($objectCategoryIds) or empty($objectCategoryIds[0])}
......
{elseif $objectCategoryIds[0] eq '13'}
......
{/if}

The documentation is licensed under a Creative Commons Attribution-ShareAlike License.

Author: sylvie g
Sponsors: Gerhard Brehm, Marc Laporte

5.2.4. Using Smarty Filters

This is a stub. help needed.

Back to TOC 781

5.2.5. Translating to a new language
This page needs review. Moreover, some more screenshots would be nice...

• Translating to a new language

• General process
• Character sets
• Free software with Unicode (utf8) suport
• GNU/Linux
• M$ Windows
• Mac
• Reference sites
• Others: Convert to .PO file
• A. Each time directly to CVS central repository of code
• GNU/Linux
• M$ Windows
• Mac
• B. Through Wiki
• C. Through Tiki interface (data base)

5.2.5.1. General process

For example, to improve the translation into Catalan, it is necessary to modify the content of the
file:
./lang/ca/language.php

This contains a bunch of lines with pieces of sentences or words ("strings of text") like:
Codi
(...)
"Internationalization" => "Internacionalització (I18n)",
"I18n setup" => "Configuració de I18n ",
"Best Language" => "Millor idioma",
"Restrict available languages" => "Restringeix idiomes disponibles",
"Available languages:" => "Idiomes disponibles:",
// "Intertiki exchange feature" => "Intertiki exchange feature",
// "Intertiki client" => "Intertiki client",
(...)

Lines that start with "// ", such as:

Codi

782 Back to TOC

 Tikiwiki Documentation 1.9+

// "Intertiki exchange feature" => "Intertiki exchange feature",

have not been translated yet. It Is necessary to translate the right side of the line (from "=>", all
what there is between double quotation marks ("text to translate"), and delete the two initial
slashes ("// "). This way, the previous example would be as (once translated):
Codi
"Intertiki exchange feature" => "Funcionalitat d'intercanvi Intertiki",

Once translated a few strings, you can go back to dispose the file language.php in place if you had
moved it to edit it, and then execute the command:
Codi
http://yourdomain/get_strings.php?lang=ca

per assegurar-nos que el Tiki ho entèn bé, i reordena les cadenes de text agrupant les que falten per
ser traduïdes, etc.

Then you can continue translating, etc., and repeating the process as frequently as desired.

At the end, the file will need to be uploded to the Tiki CVS (the central repository of code; keep
reading, further down).

This general process has some variants, depending on how to edit the file that contains the text
strings. Shortly, you can modify:
1. Each time directly against the central repository CVS
2. Previously through Wiki pages
3. Previously through Tiki itself (database)

Character sets
help

Free software with Unicode (utf8) suport

GNU/Linux
• Gedit (recommended for novice users)
http://www.gnome.org/projects/gedit/

M$ Windows
• UniRed (recommended)

Back to TOC 783

 http://www.esperanto.mv.ru/UniRed

Mac
• SUE:
http://free.abracode.com/sue/
• Or look at list in:
http://www.alanwood.net/unicode/utilities_editors_macosx.html

Reference sites
• OpenTrad Apertium: On-line free software translator, including Catalan-French, French-
Catalan, Catalan-English, English-Catalan, among others.
http://xixona.dlsi.ua.es/prototype/
http://www.opentrad.org

• Dictionary English-Catalan (open source code):

http://www.ibiblio.org/dacco/cat/

Others: Convert to .PO file

Also there is the option to convert the language.php to a .po file, in order to take advantage of other
tools which support the translation of PO files using the GNU Gettext.

This system is not explained here. You can find more information at:
• http://tikiwiki.org/PO+Convertor+for+TikiWiki

5.2.5.2. (A). Each time directly to CVS central repository of code

(recommended)
• there are programs that allow to access to the CVS code repository (that is the "Concurrent
Versions System").

You can find more instructions on how access the Tikiwiki CVS at:
• http://tikiwiki.org/TikiCVSHowTo And http://dev.tikiwiki.org/CvsTips

In any way, if somebody wants to contribute directly the improvements to the corresponding
language.php, it is necessary to be a registered user of sourceforge.net (http://sf.net ), and ask
through the IRC chat to any Tikiwiki administrator that you want to do so, so that they can add you
to the group of users with access to commit changes to code (at least, your language.php file).

784 Back to TOC

 Tikiwiki Documentation 1.9+

You can ask through IRC chat through:

• http://tikiwiki.org/tiki-pjirc.php
or With any of the other methods described in:
• http://tikiwiki.org/ConnectingToIrc

GNU/Linux
• Cervisia:
http://cervisia.kde.org

• Eclipse:
http://www.eclipse.org

M$ Windows
• TortoiseCVS:
http://www.tortoisecvs.org

• WinCVS:
http://www.wincvs.org

• Eclipse
http://www.eclipse.org

Mac
• MacCVS
http://www.maccvs.org

5.2.5.3. (B). Through Wiki

This is how to do it easily for most users (but it is more work for those who coordinate the group
task). It implies that somebody take the text strings that remain untranslated in language.php, and
put them in Wiki pages (better in parts, pieces distributable to different people, and for that each
wiki page needs to be short).

Once translated, somebody combines them again in the original language.php , and goes back to
execute the command:

Back to TOC 785

Codi
http://elteudomini/get_strings.php?lang=ca

to ensure that the Tiki understands the file without problems, and sorts again the text strings
grouping those that are missing to be translated, etc.

At the end a person uploads the updated file to the Tikiwiki code repository at sourceforge.net,
through CVS.

5.2.5.4. (C) Through Tiki interface (data base)

You need to enable the option: "Admin > i18n (Internationalization) > Use database for
translation", and afterwards, clean caches ("Admin > System Administration" > ./templates_c/
Empty).

Then, the link is enabled in the main application menu: Admin > Edit languages, that will bring to
an url like:
http://yourdomain/tiki-edit_languages.php

Then it is necessary to create the translation into the database, for the Catalan language in this
example, and tell Tiki to import the text strings already translated at the file language.php. This is
performed in some short steps:
1. Tell Tiki to create a record for the new language (Catalan) into the database
1. Create Language
Shortname: ca (like en)
Longname: Catalan (like English)
2. Click in the Create button
2. Select the language you want to edit (Catalan) in the drop down menu.
1. Select the language to edit: ca
2. Click on the button Set
3. Then go to the link above called: Im- Export Languages,
that will lead you to to an url like:
1. http://yourdomain/tiki-imexport_languages.php?

4. Import the text strings of the language.php in Catalan

1. Go to "Import > Select the language to", and choose Catalan (Catalan,ca) in the
drop down menu. ## Click on the button Import.
5. Clean cache ("Admin > System Admin" > empty the three sections).
You will see already the interface in your new language (Catalan, in this example).

To edit the text strings, then you need to:

Go to "Admin > Edit languages". In "Edit or export/import Languages", select the language you
want to edit (do as explained above), and afterwards go to "edit Translations".
Then you will be able to edit the text strings you want, search any of them, etc. The process is quite

786 Back to TOC

 Tikiwiki Documentation 1.9+

intuitive.

Once finished, export the translation to the file language.php (through the link "Import/Export
Languages"), and select the language you want to export. It Is necessary that the file and unix
folder are writable for the apache user, if in a GNU/Linux or similar environment.

At the end, it is necessary to take this generated file language.php (in ./lang/ca/language.php) and
upload it (commit changes) the central repository of code of Tikiwiki at sourceforge.net, through
CVS, in case you want that other people can benefit from your improvements (desirable! (:wink:)).
For more information
• Internationalization
• Internationalization Admin
• http://tikiwiki.org/TikiWikiInternationalizationAndLanguages

Back to TOC 787

For more information
• Internationalization
• Internationalization Admin
• http://tikiwiki.org/TikiWikiInternationalizationAndLanguages

5.2.6. Tikiwiki Performance Tuning

This is a guide related to installation and troubleshooting.

tikiwiki.org is enhanced by eAccelerator

This page doesn't include tuning on the database. That you'll find here: DbPerformance?

5.2.6.1. Apache

Some documents

This is a page about mod_perl tuning, just ignore the perl stuff and look at the apache tweaks in
there. They did help me to get our tw.o stable again. :-)
• mod_perl Performance Tuning

Additional apache tuning for sites with much traffic (german)

• Häuptling Schnelles Wiesel: Wirksames Tuning für viel besuchte Webauftritte

Apache Config (httpd.conf)

# time out connections earlier, 300 is too much

Timeout 150
# clients may keep alive existing connections
KeepAlive On
MaxKeepAliveRequests 120
KeepAliveTimeout 15

# switch off hostname lookups, that needs some time

HostnameLookups Off

MinSpareServers 6
MaxSpareServers 8
StartServers 10

788 Back to TOC

 Tikiwiki Documentation 1.9+

# 10 clients should be enough, but for peaks 50 might be good.

# depends on your memory, 50 works for 2GB memory
MaxClients 50
# dont set this to a value too low:
MaxRequestsPerChild 1500

Try to move load from the server, tell clients to cache data:
<IfModule mod_expires.c>
<IfModule mod_headers.c>
ExpiresActive On
# dont cache html as people wont get page updates:
# ExpiresByType text/html "access plus 1 month"
ExpiresByType text/css "access plus 6 month"
ExpiresByType text/javascript "access plus 6 month"
ExpiresByType image/gif "access plus 6 month"
ExpiresByType image/jpeg "access plus 6 month"
ExpiresByType image/png "access plus 6 month"

<Files ~ "\.(js|css|gif|jpe?g|png)$">
Header append Cache-Control "public"
</Files>
</IfModule>
</IfModule>

Virtual Host Settings

Limit connections from one ip to a given number.

Homepage of mod_limitipconn
• mod_limitipconn.c page

<IfModule mod_limitipconn.c>
Customlog /var/log/nameofvirtualhost-access-denied.log combined
env=LIMITIP
<Location />
MaxConnPerIP 10
NoIPLimit img/*
</Location>
</IfModule>

5.2.6.2. PHP Settings (php.ini)

# if you want to reduce CPU usage, set it to off

Back to TOC 789

# if you want to limit traffic, set to on
zlib.output_compression = Off

max_execution_time = 30 ; Maximum execution time of each script, in seconds

max_input_time = 30 ; Maximum amount of time each script may spend parsing
request data
memory_limit = 16M ; 8 is way too far, try 16 MB here, if you still get blank
pages, raise it in 1 MB steps

ohertel?

5.2.6.3. Accelerating PHP

eAccelerator
Homepage: http://www.eaccelerator.net/
Description: A PHP Accelerator & Encoder.
License: GPL-2

eAccelerator is a further development from mmcache PHP Accelerator & Encoder. It increases
performance of PHP scripts by caching them in compiled state, so that the overhead of compiling is
almost completely eliminated.

Install
• http://www.eaccelerator.net/wiki/InstallFromSource
• Gentoo/Portage users: emerge eaccelerator
• Debian/Apt users:
• apt source: deb http://packages.dotdeb.org/ stable all
• apt-get install php4-eaccelerator
• Check the cache directory, eaccelerator will fail to load unless it can write to this directory
(see http://eaccelerator.net/wiki/Settings ): eaccelerator.cache_dir = "/tmp/eaccelerator"

If your are compiling and installing eAccelerator yourself, add this to php.ini:
zend_extension="/usr/lib/php4/20020429/eaccelerator.so" <-- path may be
different
eaccelerator.shm_size="64" <-- set to 32 or 16 if php core dumps .)
eaccelerator.cache_dir="/tiki/var/tmp/eaccelerator" <-- path may be different
eaccelerator.enable="1"
eaccelerator.optimizer="1"
eaccelerator.check_mtime="1"
eaccelerator.debug="0"
eaccelerator.filter=""
eaccelerator.shm_max="0"
eaccelerator.shm_ttl="0"
eaccelerator.shm_prune_period="0"
eaccelerator.shm_only="0"
eaccelerator.compress="1"
eaccelerator.compress_level="9"

790 Back to TOC

 Tikiwiki Documentation 1.9+

Alternative PHP Cache (APC)

License: PHP License, version 2.02
Homepage: http://pecl.php.net/package/APC
A version is available for PHP5

Install
• Debian/Apt users:
• apt source: deb http://packages.dotdeb.org/ stable all
• apt-get install php5-apc PHP5 only, no PHP4 package for APC.

PHPA (not free !)

http://www.php-accelerator.co.uk
Benchmark says that smarty gets a real advantage :
http://www.phpinsider.com/benchmarks

BUT that is not really a free software, it's distributed in binary and there is no source. There are
some other solutions I have to try out.
2003-06-30 : something strange happened with phpa, it was not working anymore, I had to disable
it and re-enable it. I'm inquiring.
Finally : I disabled PHPA because it puts random white pages.

I have gotten quite some memory errors when using PHPA, seems smarty does not like it, and stops
with a memory overflow

BTW, apc also doesn't work, same error.

Turck MMCache
http://turck-mmcache.sourceforge.net

Install Turk MMCache

It's a FREE open source PHP accelerator, optimizer, encoder and dynamic content cache for PHP
and even faster than commercial Zend Zend Performance Suite.

Remember to follow the installation steps one by one:http://turck-mmcache.sourceforge.net/#install

Do remember to create a temp dir for it, otherwise it will produce blank pages. OK, that's all. I'm
sure you will be impressed about the increase in speed. It's nearly 5 times faster!

Performance measurements

Environment:

Back to TOC 791

Athlon XP 2100+, 512 MB DDR, Apache 1.3.X, PHP 4.3.0

1st try:

used a shellscript, that does 10 wget runs at a time with wget -r -l 2. All features in tiki are switched
on, anonymous group got basic privileges.

Results:
settings Time taken max. load
bare 7:17 11.5
Zend accelerator default 2:23 11.6
Zend accelerator 128MB 2:36 11.8
turck mmcache default 2:21 11.4
turck mmcache 128MB 2:15 11.5

2nd try:

Used siege . I took the same URLs that wget crawled. 150 concurrent users:

Zend:
Transactions: 16262 hits
Availability: 100.00 %
Elapsed time: 420.17 secs
Data transferred: 59162949 bytes
Response time: 3.44 secs
Transaction rate: 38.70 trans/sec
Throughput: 140807.17 bytes/sec
Concurrency: 133.01
Successful transactions: 16262
Failed transactions: 0

load got up to 110

mmcache:
Transactions: 19360 hits
Availability: 100.00 %
Elapsed time: 423.15 secs
Data transferred: 61369649 bytes
Response time: 2.87 secs
Transaction rate: 45.75 trans/sec
Throughput: 145030.49 bytes/sec
Concurrency: 131.49
Successful transactions: 19360
Failed transactions: 0

792 Back to TOC

 Tikiwiki Documentation 1.9+

load got up to 95.

So mmcache seems to be slightly faster. Be extremly careful while testing. siege crashed my server
two times (:cool:)

userPageredflo

Other performance pages

You may be interested in reading also some of the following pages:
• Database Performance

5.2.7. Database Performance

This is a troubleshooting guide for database performance.

5.2.7.1. MySQL

MySQL has a slow queries feature which is accessible via a log or at the command line. Please read
the MySQL manual page to enable this feature.

Using the information in MySQL's chapter on optimization , look for

places where indexes may improve the database access speed. Add an index, then re-test. If you
think you've found an
improved indexing scheme, please open a tracker item on dev.tikiwiki.org.

Back to TOC 793

5.3. ToolBox
There some tools that are frequently used when using Tikiwiki for different tasks.

Some of them are Multiplatform Tools, some others can be found only in one specific platform or
operative system, like the ones only GNU/Linux based, M$ Windows based, or Macintosh based.

5.3.1. Multiplatform tools

This is a short list of free software tools frequently used under more than one platform or operating
system to work with Tikiwiki (for instance, GNU/Linux, Windows, Mac, ...):

5.3.1.1. Java based

Eclipse
Integrated Development Environment (IDE). A project aiming to provide a universal toolset
for development. Open Source IDE, mostly provided in Java, but the development language is
independent and allows editing code in many languages, including PHP. See Eclipse
http://www.eclipse.org

FreeMind
Utility to draw mind maps. See PluginMindmap
http://freemind.sourceforge.net/

5.3.1.2. Text processing in local machine

OpenOffice
A very complete Office Suite
http://openoffice.org

5.3.1.3. Firefox extensions

Web developer toolbar

Adds a menu and a toolbar with various web developer tools.
https://addons.mozilla.org/firefox/addon/60 - http://chrispederick.com/work/web-developer/

ColorZilla
A collection of tools, including a Color Picker similar to the one found in Photoshop, an
Eyedropper that helps to get a color reading from anywhere in the Desktop.

794 Back to TOC

 Tikiwiki Documentation 1.9+

https://addons.mozilla.org/firefox/addon/271

Document Map
Displays the current page's heading structure in the sidebar, allowing rapid navigation
between sections.
https://addons.mozilla.org/firefox/addon/475

5.3.1.4. Web Developing

PhpMyAdmin
A tool written in PHP intended to handle the administration of MySQL over the web.
http://www.phpmyadmin.net/

XAMPP
An easy to install Apache Distribution for Linux, Windows, Mac OS X, and Solaris. The
package includes the Apache web server, MySQL, PHP and Perl. XAMPP is really very easy
to install and to use - just download, extract and start.
http://www.apachefriends.org/en/xampp.html

5.3.1.5. Image Processing

Gimp
The GNU Image Manipulation Program, for X Windows systems, ported also to other
platforms. Official site, including download area, documentation, FAQs, and a plugin
registry.
http://www.gimp.org/

5.3.1.6. On-line communication

Pidgin (ex-Gaim)
An instant messaging client, which can handle multiple protocols, including AIM, ICQ, IRC,
MSN, Yahoo!, Jabber, and Gadu-Gadu. [Windows, Unix]
http://pidgin.im

Back to TOC 795

 5.3.1.7. Freeware (but not free software) tools

Image editing and screenshot capturing

Wink
A tutorial and presentation authoring software.
http://www.debugmode.com/wink/

Related pages
(You might be interested in checking also the Linux tools , Windows tools or Mac Tools, specific of
those platforms).

5.3.1.8. Eclipse

Eclipse is an open source community whose projects are focused on building an open development
platform comprised of extensible frameworks, tools and runtimes for building, deploying and
managing software across the lifecycle. A large and vibrant ecosystem of major technology
vendors, innovative start-ups, universities, research institutions and individuals extend, complement
and support the Eclipse platform. New to Eclipse?

Screenshots at http://eclipse.org

Eclipse Home page:

http://www.eclipse.org

Eclipse CVS compare

Comparing local and CVS versions of files with Eclipse

This is a great feature in the Eclipse IDE that allows you to visually see
what changes are in both, local and remote CVS versions of files. Even better, you can edit them
and save them while comparing them.

Eclipse's Synchonize feature shows you how many incoming, outgoing and conflicting files exists.
It then creates a browsable directory structure for you to quickly view, compare and edit these files.

796 Back to TOC

 Tikiwiki Documentation 1.9+

See the example picture below. It shows we have 21 outgoing, no incoming and no conflicting
changes.

Comparing versions in Eclipse

Eclipse CVS Branches

How to checkout a certain CVS Branch of tikiwiki with Eclipse

This page shows you how to checkout a certain CVS Branch of tikiwiki with Eclipse
It is not very intuitive but it is very useful and a must for those working with Eclipse.

I am assuming you already have Eclipse setup and working with the latest tikiwiki HEAD checked
out. If you have not gotten this far yet. Do a search here for the pages that can get you that far.

The pictures are large but explain it well

First you must tell Eclipse about the new branch.

Right click on your tikiwiki project and follow the menus below.

Back to TOC 797

 • Click "Details"
• Click "Configure Tags"
• Browse the tiki directory to the first PHP file and select it.
• All the versions and branches should appear for that file on the right.
• Select "Deselect All"
• Check off the Branch you are interested in. (i.e. BRANCH-1-8)
• Click "Add Checked Tags"
• Click OK
• Finish up by naming your Branch and clicking OK again.

798 Back to TOC

 Tikiwiki Documentation 1.9+

Now it's time to update your local files with the new Branch you selected.

WARNING This proceedure will delete all files in your project directory no matter if they are part
of the CVS tree or not. If you have any files you want to save, back them up now.

Now
• Click right on your tikiwiki project
• Click "Replace with"
• Click "Another Branch of version"
• Select your Branch and follow the steps.
• You may have to delete the contents of you template_c directory manually if you get errors

Back to TOC 799

 that it can not delete these files. Otherwise you're done.

5.3.2. Linux tools

This page lists the free software tools that can only be found under a GNU/Linux platform.
Please check first the Multiplatform tools, which are mostly installable (if not native :-) to GNU/
Linux also, and they are recommended since they can be used by your colleagues which don't know
(yet) how to use free software operating systems

800 Back to TOC

 Tikiwiki Documentation 1.9+

5.3.2.1. CVS GUI's

(CVS: Concurrent Versions System, GUI: Graphical User Interface)

Cervisia
A graphical frontend to CVS. (C++) [GNU/Linux, Unix] It aims to support CVS and other
version control system programs in a unified interface
http://cervisia.kde.org/

5.3.2.2. PHP Editors

gPHPedit
a GNOME2 editor that is dedicated to editing PHP files and other supporting files, like
HTML/CSS
http://www.gphpedit.org

Gedit
Lightweight but powerful text editor of the GNOME project.
http://www.gnome.org/projects/gedit/

5.3.2.3. Text editing supporting utf-8

Gedit
Lightweight but powerful text editor of the GNOME project.
http://www.gnome.org/projects/gedit/

Kate
The Kate project develops two main products: KatePart, the advanced editor component
which is used in numerous KDE applications requiring a text editing component, and Kate, a
MDI text editor application. In addition, we provide KWrite, a simple SDI editor shell which
allows the user to select his/her favourite editor component.
http://kate-editor.org/

Mousepad
A simple text editor for Xfce based on Leafpad ("...and everything foes faster").
http://www.xfce.org/projects/mousepad/

Back to TOC 801

 5.3.2.4. Blog posting

BloGTK
A weblog client that allows you to post to your weblog from Linux without the need for a
separate browser window.
http://blogtk.sourceforge.net/

5.3.2.5. Image editing and screenshot capturing

gThumb
An image viewer and browser for the GNOME Desktop.
http://gthumb.sourceforge.net/

Ksnapshot
a simple applet for taking screenshots. It is capable of capturing images of the whole desktop,
a single window, a section of a window or a selected region. The images can then be saved in
a variety of formats.
http://freshmeat.net/projects/ksnapshot/

5.3.2.6. Screencasting or Desktop Session recording

Istanbul
a desktop session recorder for the Free Desktop. Istanbul project records your session into an
Ogg Theora video file. To start the recording, you click on its icon in the notification area. To
stop you click its icon again. It works on Gnome, KDE, XFCE and others.

http://live.gnome.org/Istanbul

5.3.2.7. File Transfer (ftp, sftp)

gFTP
gFTP is a free multithreaded ftp client for *NIX based machines running X11R6 or later.
http://gftp.seul.org/

Konqueror
A web browser, file manager and file viewer designed as a core part of the K Desktop
Environment.
http://www.konqueror.org/

802 Back to TOC

 Tikiwiki Documentation 1.9+

5.3.2.8. File compression/decompression

Ark
A graphical program for managing various archive formats within the KDE environment.
Archives can be viewed, extracted, created and modified from within Ark. The program can
handle various formats such as tar, gzip, bzip2, zip, rar and lha (if appropriate command-line
programs are installed). Ark can work closely with Konqueror in the KDE environment to
handle archives, if you install the Konqueror Integration plugin available in the konq-plugins
package.
http://linuxappfinder.com/package/ark

5.3.3. Windows tools

This page lists the free software tools that can only be found under a MS Windows platform.
Please check first the Multiplatform tools, which are mostly ported to Windows also, and they are
recommended since they can be used by your colleagues using free software operating systems.

5.3.3.1. CVS GUI's:

Tortoise CVS
An extension for Microsoft Windows Explorer that makes using CVS fun and easy. Features
include: coloured icons, tight integration with SSH, and context-menu interactivity.
http://www.tortoisecvs.org/

5.3.3.2. Web development local environment

(apache, mysql, php, phpmyadmin)

EasyPHP
A complete software package allowing to use all the power and the flexibility that offers the
dynamic language PHP and the efficient use of databases under Windows. Package includes
an Apache server, a MySQL database, a fully PHP execution, as well as easy development
tools for your web site or your applications
http://www.easyphp.org/

5.3.3.3. PHP Editors:

Dev-PHP
A well-featured IDE for PHP. Fast and powerful, it is easy to use and has a lot of cool
features : class browser, scripts preview, integration with PHP parsers, PHP-GTK library, and
Xdebug of course. Dev-PHP-usb slips even into your pocket.

Back to TOC 803

 http://devphp.sourceforge.net/

5.3.3.4. Text editing supporting utf-8

UniRed
Unicode (utf-8) editor for Windows 95/98/NT/2000.
http://www.esperanto.mv.ru/UniRed/

5.3.3.5. Image editing and screenshot capturing

CamStudio
Record all screen and audio activity on your computer and create industry-standard AVI video
files and using its built-in SWF Producer can turn those AVIs into lean, mean, bandwidth-
friendly Streaming Flash videos (SWFs)
http://www.camstudio.org/

5.3.3.6. File compression/decompression

7-zip
A program with high compression ratio in new 7z format with LZMA compression, but which
also provides those supported formats for Packing / unpacking: 7z, ZIP, GZIP, BZIP2 and
TAR, or for Unpacking only: RAR, CAB, ISO, ARJ, LZH, CHM, Z, CPIO, RPM, DEB and
NSIS. For ZIP and GZIP formats, 7-Zip provides a compression ratio that is 2-10 % better
than the ratio provided by PKZip and WinZip. Self-extracting capability for 7z format,
Integration with Windows Shell, Powerful File Manager, Powerful command line version,
Plugin for FAR Manager, Localizations for 63 languages
http://7-zip.org

5.3.3.7. Freeware (but not free software) tools

Blog posting
w.Bloggar
An application that acts as an interface between the user and one or more blog(s); in other
words, it is a Post and Template editor, with several features and resources that the browser
based blog editors do not offer.
http://www.wbloggar.com/
For more information, press on the [+] below.

804 Back to TOC

 Tikiwiki Documentation 1.9+

[+]
• The w.bloggar is an application that acts as an interface between the user and one or more
blog(s); in other words, it is a Post and Template editor, with several features and resources
that the browser based blog editors do not offer.
.
Because w.bloggar runs over the Windows GUI, it allows the user to edit posts without
being connected to the Internet. Posts can be saved locally; and anytime the user wants to
publish a new text, one click on the w.bloggar icon in the system tray brings up the editor,
and one more click will post it to the weblog.
.
Another great advantage of w.bloggar is that it is compatible with most of the weblog
systems available, allowing an advanced user to have only one interface to several accounts
hosted on several different sites, using different publishing systems.
.
To communicate with the weblog, w.bloggar requires that the blog system have
implemented an API (Application Programming Interface.) Currently, w.bloggar is
compatible with all tools that implements Blogger API, metaWeblog API, MovableType
API and b2 API; all based on the XML-RPC definition.

Image editing
Irfanview
A very fast, small, compact and innovative FREEWARE (for non-commercial use) graphic
viewer for Windows 9x/ME/NT/2000/XP/2003/Vista. Simple for beginners and powerful for
professionals. Many screenshots in this documention pages were captured, cropped and saved
with Irfanview in a few clicks and on old machines
http://www.irfanview.com/

5.3.4. Mac tools

Back to TOC 805

 6. ANNEXES

806 Back to TOC

 Tikiwiki Documentation 1.9+

(page intentionally left blank)

Back to TOC 807

6. Annexes

6.1. About the Tikiwiki Documentation

Since the tikiwiki project started in 2002 there have been over 200 different developers working on
34 separate releases, creating hundreds of features with tens of thousands of lines of code and 7500
wiki pages created in the tikiwiki.org domain.

Needless to say, developing an authoritative documentation for this open source project is
challenging. From the begining until version 1.6, tikiwiki documentation was a one-man effort. The
1.6 Documentation complete with 350 fully illustrated pages with screenshots provided the basis
for what exists at doc.tikiwiki.org today.

Since that version, the tikiwiki project has chosen to eat its own dogfood. Not unlike a baby
learning to feed itself, the results have been a little messy. We now have more than 2300 wiki pages
on http://tikiwiki.org with several pictures and miscellaneous useful content. But as it's wide open
to collaboration, it's sometimes also unsorted (or sorted in too many various different ways), and
with an unpredictable degree of updating.

Since the end of 2006, a new effort has been put from Tikiwiki community to have another updated
single file for printing (pdf) with all relevant Tikiwiki documentation for 1.9 branch, relative to
installation, configuration, features available and tunning process (see Table of contents). Some
more pages relative to the new Tikiwiki 1.10.0 have been added already in http://doc.tikiwiki.org.
By the time of this writing, this pdf document contained more than 850 numbered and indexed
pages, to ease your off-line reading of documentation either in paper or pdf format. Morevoer, this
allow you make easier and faster searches of information in such a broad amount of pages covering
most aspects of Tikiwiki.

Current download links (document with 850+ pages)

http://doc.tikiwiki.org/files/Tiki19beta.pdf (12+ Mb)

pdf

http://doc.tikiwiki.org/files/Tiki19beta.odt (15+ Mb)

odt

A method for creating current and well organized documentation

Despite the chaotic fertility tiki hackers demonstrate at tikiwiki.org, there is a real need for a real
classic linear documentation for easy reference. Many tiki contributors asked for a direction where
they can help, and the fact is that such collaborative documentation work requires a strong focal

808 Back to TOC

 Tikiwiki Documentation 1.9+

point so people can work in effective synchronicity. The tikiwiki documentation is a collaborative
writing project.

The documentation plan.

The secret to a well made wiki? is having a logical structure so everybody can figure out the
structure of the objects (pages) in the project and process? by which they are developed.

Document Structure
The document structure evolves organically. There is a Table of Contents, but lately, effort has been
focused on developing a knowledge base from keywords. As such, the table of contents does not
necessarily link to every page in the documentation, but it links to all the major topics, which may
have their own sub-pages.

Anyone who has editing privileges in http://doc.tikiwiki.org can and should edit the table of
contents page with the intention of making it better.

Documentation Procedure

The rules about how to document are controlled by via two important pages: the Style Manual and
the Editorial Board. Documentation Status monitors requests for help etc.
• The Style Manual contains the current rules/guidelines of how the pages should look when
complete.
• The Editorial Board decides on questions that need to be decided.
• Documentation Status is a dashboard that monitors status tags in use in the documentation.

• you can change the style manual.

• you can join the editorial board.

The best example of a constructive change to the style manual is to create a specific rule that obeys
a general rule that already exists. If you try to change an existing rule, expect some push-back,
because you would be implying that all extant? pages of the documentation should now be
refactored to comply.
example: if the general rule is that an example should appear before the third paragraph, then you
could amend the style manual to state that all examples should appear in a text box with "example:"
in bold

• you can join the editorial board

The editorial board is not a secret society. Anyone can join the editorial board by learning what the
role? entails and then linking to editorial board from their user page. Unless this person has
displayed a strong tendency toward being a bad editor?, this link will not be removed, and if the title
sticks? they can request and receive the necessary permissions.

Getting Support/Help

See: get help

Back to TOC 809

6.1.1. Welcome Authors
Thanks for joining the effort to document the progress of Tikiwiki!

6.1.1.1. Getting Started as an Author

1. Register at tikiwiki.org , then login here .

2. Read About the Tikiwiki Documentation.
3. Read the page on our Documentation Lifecycle.
4. Learn How To Tag documentation pages effectively.
5. Browse the Documentation Status page.
6. Choose a page to improve (likely something you need help with yourself!, or look for them
at stub, for instance).
7. If content exists on tikiwiki.org (tw.o) , transfer the content to documentation page. Be sure
to:
• Correctly format the page (based on the How To Tag page).
• Link the documentation page to/from the two.o page.
8. Learn by doing. Newbies are welcome.
9. If in doubt, ask in the Author Coffeeshop forum .

6.1.1.2. Sources of wisdom

In order to improve the documentation, you need wisdom about how the software works. Here are
places to look.
1. tikiwiki.org — If you can't find it here, do a search there first. Tikiwiki.org was formerly
the main center for documentation, but much of it is now out of date.
2. Tikiwiki.org forums — Post a question in the appropriate forum.
3. The 1.6 documentation — Check the last comprehensive publication of Tikiwiki
documentation, which still provides a good overview and information on many features.
4. dev.tikiwiki.org — Search the Tikiwiki developers site.
5. irc.tikiwiki.org — Developers and other users can often be found on IRC chat, but activity
varies according to time of day, etc., so please be patient if you ask a question.

6.1.1.3. Becoming an expert

If you have read and understand the following pages, you will be well on your way to becoming an
expert.
• Naming conventions?
• Tikiwiki manual of style
• Documentation status
• Documentation categories
• Documentation structure?
• Documentation templates

810 Back to TOC

 Tikiwiki Documentation 1.9+

Suggested pages
Each feature could require at least four pages of documentation.
• Main Page
Example Main Page: Blog
This is the primary page for the feature and should be named based on the feature. It defines
and provides a brief overview of the feature. The page should link to any related resources
(internal or external).
• User Help
Example User Page: Blog User
This page is for end-users of the feature, this also includes Admins who use their own sites.
Organize the User page by tasks — what the user wants to accomplish (such as "Creating a
New Blog" or "Preventing Other Users From Posting"). Use lots of screenshots and graphics
to convey the information.
• Admin Configuration
Example Admin Page: Blog Config
This page provides information that Admins need in order to enable, configure, maintain,
and troubleshoot the feature. Include system requirements information, potential impact to
other features, or anything else useful to a system administrator.
• Reference
Example Reference Page: Blog Ref
This is page is for additional reference documentation. It includes the following information:
• Permissions relevant to the feature
• Pertinent database tables
• Administrative configuration options
• User options

6.1.2. Tikiwiki Manual of Style

6.1.2.1. The Imperatives.

The following rules are very important.

• Do not use HTML.
• Dont hide URLs - the documentation will be available in printed form as well as online.
• Use the Documentation Templates!
• All pages must link to relevant Keywords.

discuss this page at talk: Manual of Style

6.1.2.2. Naming Conventions

General
• As short as possible.

Back to TOC 811

 • Page names should contain action verbs that clearly describe what the end user wants to do.
Use "Configuring Blogs" instead of "Blog Config"
• Use Keywords whenever possible. Dont say "about the features" when "features" will do.
Imagine what will be typed in the search engine and use that.
• Use the terms and menu options that appear in the end-user version of the software.
Avoid non-alphanumeric characters. (especially punctuation)

Capitalization
In Page Names: Capitalize all significant words.
In Section/Heading Titles: Capitalize all significant words.

No WikiWords
Whether you're naming a new page or referring to one, don't use WikiWords (CamelCase). To link
to a Wiki page, spell and capitalize the page name correctly and enclose the name within double
parentheses.
example, ((Wiki Style)) ).

No Jargon
Since this is targeted to Grade 8 English, use complete words and avoid jargon. Use Administer,
Configure, Development instead of
Admin, Config, and dev.

6.1.2.3. Headings

Use the exclamation mark at the beggining of a line to create headings. Do not use bold, centered
text or anything else.
• ! for page titles
• !!major headings
• !!!minor headings

Capitalization
In titles, capitalize all nouns, pronouns, adjectives, verbs, adverbs, and first and last words. Don't
capitalize articles (unless used as the first word), coordinate conjunctions, and prepositions. Do not
add dots in titles as they are not sentences but labels. Separate the heading tag (!) from the first
letter of the heading for easy double-click word select and fast visual source reading.
Wrong |

!Adding a new user

Right |

812 Back to TOC

 Tikiwiki Documentation 1.9+

! Adding a New User

Line Spacing
Except for the page title, leave a blank line BEFORE a heading or subheading but don't leave a
blank line AFTER.
Wrong |

! Adding a New User

!!Fill the form

Fill and click.

!!Check the perms

Go to admin panel.

Right |

! Adding a New User

!! Fill the Form

Fill and click.

!! Check Permissions
Go to admin panel.

Page Titles
At the top of the page, type ! followed by a decent title for the Wiki page you're editing. That can be
different than the wiki pagename to provide more information, but only in some case, and generally
a title identical to pagename is better.
Proposed Alternative: Do not repeat Page Title.
Reasons:
• Plain language page name (see above) makes restating the page title redundant.
• Pagename should (and can) be displayed by CMS rather than repeated in content.
• If page is renamed, content doens't necessarily have to change.
(learned this the hard way)

6.1.2.4. Emphasis

Back to TOC 813

 Bold
Except for headings, use bold very sparingly.
Use bold in table headings (recommended).
use bold to provide heading items in bulleted lists (like those in this page).
Use bold to refer to actions, buttons, text that appears on-screen, or the name of a configuration
option.
Use bold or all caps: not both.
Example: "In Blog, click Use WYSIWYG Editor to edit your post in an easy-to-use, "what-you-
see-is-what-you-get" formatting window."

Examples
Use the formatting above, with a text box and Example: in bold.

Italic
Use Italic for indicating personal point of view, quoting, citation, or comments.

Source Code
Pieces of code source, either html, smarty, php, javascript or any other require the use of CODE
plugin for proper escaping and design. Try to separate code clearly from text content, on a separate
line when possible, like if it was an illustration.

6.1.2.5. Links

Remember, the documentation will be printed. Don't hide Wiki page links or URLs!

Wiki Page Names

Don't hide page names with label text. Wrong: "Read the ((Tikiwiki Manual of Style)) |rules)) !"
Right: Read the rules, which you'll find in ((Tikiwiki Manual of Style)) .

External Links

Add relevant useful external links on a separate line. Don't put them in the body of a paragraph.
Use a bulleted (*) list with a label on first line and one or many URLs beneath, one on each line;
hide long lists using the list continuation code (+). For an example, see Blog.
Never obfuscate an external URL with descriptive text.
• Wrong:
For more information, see the
[http://www.computer.org/author/style/capitals.htm|IEEE Style
Guide].

• Right:
For more information, see the IEEE Style Guide, located at

814 Back to TOC

 Tikiwiki Documentation 1.9+

[http://www.computer.org/author/style/capitals.htm].

• InterWiki Links To link to external Wiki pages at tikiwiki.org, use the tw: prefix.

6.1.2.6. Lists

Whenever possible, use bulleted (*) or numbered (#) lists. Do not number (or letter) lists by hand.

Numbered Lists
Always use a numbered list when you are describing a series of steps that must be followed in a
certain sequence.

Bulleted Lists
Use bulleted (*) lists liberally!

6.1.2.7. Graphics

• Storage Use attached images rather than image gallery. To attach an image, use Upload
Picture (an option that appears when you're editing a Wiki page).
Possible Alternative: Use of the image gallery may be preferred because
• graphics may be used in more than one place
• graphics should be tracked and catalogued to speed updates when features change

• Filenames Name your picture with the name of the page, stripping spaces, indexed with the
rank number in the page, like in WikiUser1.png, WikiUser2.png, etc .. for images in the
page Using Wiki Pages
• Tag Include images with the Wiki {img} tag (not the HTML tag).
• Border To help differentiate the graphic from surrounding text, place the graphic in a box
(here's how: ^{img}^).
• Size Maximum width is 600 pixels.
• Format GIF is forbidden. True color (16 or 24 bit) PNG doesn't offer good compression on
large image sizes. If the image is not an icon or similar in size please use JPG only.
• Position Place images after the related text (not before).
• In-Text Reference Within the text, always refer to the image (for example, "In the
following illustration, note...").

6.1.2.8. Plugins

Avoid using plugins unless they are necessary, or it is a page about the plugin.

Back to TOC 815

 6.1.2.9. Icons

• Only use icons is exceptional situation and always take in account that it maybe cannot be
displayed for any reason, so marking a special content with icon should also be done with
some formatting.
• {picture file=img/icons/cool.gif} is used to indicate a Tip, an hint or a special quote.
• no s'ha trobat la imatge img/icons2/alert.gif {picture file=img/icons2/alert.gif} is used to
indicate a warning.

6.1.2.10. Footnotes, Questions, Comments.

• My footnotes are only visible to the user who edited them, therefore, it's only useful as your
personal footnotes about the page. Do not use page content for asking a question or making
a remark to collaborators! Use comments area instead. This will make the job of final text
cleanup much easier.
• When you transfer pages from tikiwiki.org, add a link to the doc page to the moved page,
and add a link to the old page in the doc page. This will help housecleaning, too.
• Always indicate the inter-wiki link to the related tikiwiki.org pages.

6.1.3. Documentation Lifecycle

An overview of how pages develop at doc.tikiwiki.org
This document is complete and needs review.

6.1.3.1. Tagging pages: from Stub to Review

Each page has a documentation status which is indicated by the presence (or absence) of "tags"
which are actually just links to other pages.

Each page of the documentation wiki is conceived as an open link?, born as a stub, and is probably
a messy collection of notes and clippings at the beginning.

If a page is lucky it will find some editors to refactor it, apply the appropriate documentation
templates and finally say "this needs review." When the appropriate experts have given the page a
once over they will likely apply the updated for 1.10 tag or something similar and should be
considered a mature, trustworthy resource. If the page is not so lucky, a user will come along and
place a cry for help on the page, even and urgent cry for help, and hopefully this will mobilize some
action.

For a complete list of the status tags and how to use them see: how to tag

816 Back to TOC

 Tikiwiki Documentation 1.9+

New Features, Stubs, and Structures

When one of our developers comes up with a completely new feature, we want to have a wiki page
documenting that feature. Sometimes the developers will create a page on the documentation site,
sometimes not. If a page is created, we need to get it integrated into the current documentation
structure. We use the structure tag to call attention to the fact it needs to be integrated. New
features that aren't documented at all are tagged as a stub.

Handling Feature Changes

Sometimes a feature is substantially re-written to improve it. When this happens, a refactor tag is
applied so an editor will review the documentation and add words and pictures to describe the new
functionality. When the user interface changes, a screenshot
tag is used to mark the obsolete image. When changes are complete, the tag is set back to needs
review. When review is complete and the changes are verified, all tags are again removed

Showing Mistakes and Asking For Help

If a mistake is found in a document, the errors tag is used to flag it for correction. The error is then
fixed by an editor and the document goes back to needs review status to have the fix checked.
Sometimes an editor needs more information about a feature from a developer or other user. The
editor uses a help tag to request more information. Again, when the changes are complete, the
document goes to needs review status. When the review is complete, the tags are removed.

Modifier Tags
The urgent, tag is not part of the lifecycle, but can be used call the attention of the editors to an
important page that needs work. The needed for 1.10 tag is being used to show pages that need to
be completed prior to the next release.

For more information

See How to Tag for detailed explanation of how to use tags to mark up doc pages. See the
Documentation Status page to see the current state of our documentation.

This paragraph doesn't fit the flow of the article. The article is about doc lifecycle and does not need
to bring up history. We should refactor it.

6.1.3.2. The doc site leaves the nest.

Prior to 2005, most of the documentation of tikiwiki was happening at tikiwiki.org itself. When it
was decided that the documentation site would leave the nest, it doesn't mean that all of a sudden all
that content jumped up and walked to a different server, it was carried over page by page, in a
process that is still not quite complete.

Back to TOC 817

 6.1.3.3. How To Tag

In doc.tikiwiki.org pages can be "tagged" internally (to the wiki) by simply linking to the page
which names the category or status you wish to apply. It is a simple, fast and effective way to keep
track of things like documentation status. This has been dubbed the Backlinks to index method,
since it uses the BacklinksPlugin? to achieve a category or status index.
Example: placing a "refactor" tag on a page.

To do so, you would edit the page and add

^This page needs to be ((refactor))ed.^

Tagging like this will notify other users who are watching the Documentation Status page that
refactoring help is needed.

Note: This informal method should not be confused with the Category or Tags features in Tikiwiki.

Editors can use and create tags to index what work needs to be done on each page. As pages move
through the Documentation Lifecycle, their status changes. When they are complete and in
production, the tags are removed. It's important to tag things properly, so that you communicate
clearly with your fellow editors.

Tagging Conventions
Tags are always placed inside of a text box to call attention to them like this:
This is a sample tag?. It's inside a text box

Use your tag in a sentence, and add a sentence or two about why you placed the tag, like this:
This is my sample tag?. I've put it here because I need to show a sample tag.

More Examples

Stub
The stub tag is placed at the top of an otherwise empty page, it should always invite participation to
complete it with a link to the Welcome Authors page, like this:
This is a stub. You can help fill it in!.

Refactor
The Refactor tag is a request to make substantial changes to a page. It should be placed at the top
of the page. The tag should include the reasons why the change is needed. For example
Please add this page to the refactor list. The feature was completely written for version 1.11 and
there are several new permissions that need to be included

818 Back to TOC

 Tikiwiki Documentation 1.9+

Screenshot
The Screenshot tag is also a request for a change. It should be placed
• just before the screenshot that needs to be replaced
• at the point where a screenshot needs to be created
This tag should also include the reason why a change is needed. For example:
The screenshot of the admin panel should be replaced because we have new icons in version 1.10

Structure
The Structure tag is a request to add a page to a documentation structure, so it will be included in
Table of Contents and PDF's created from those structures. When you use this tag, please place it at
the top of the page and indicate which structure the page should be added to, like this:
This page is needs to be added to the main Documentation structure

Errors
If you think that you have found errors in the document, place an error tag at the point where the
error was found, with an explanation of the error:
Add this page to the errors list. The procedure for creating a tracker does not include setting group
permissions

Needs Review
This tag is used many times in the Documentation Lifecycle:
• After new documentation is created
• After screenshots have been added or replaced
• After errors have been corrected
• After refactoring

In short, after every major edit the document should go back to needs review status. Please give a
brief description of what was changed to save the review editor the time of digging through page
history, like this:
This is new documentation that needs review.

or
I've added a screenshot of the newsreader admin page that needs review

or
The permissions setup section has been re-written and needs review

Help
The help feature is used to tag a feature or setting that requres more info from a developer or more
experienced user. Place the tag at the point where help is needed. If you are tagging at item inside a

Back to TOC 819

wiki table, place a tag in the table at the spot you need help and put a box underneath the table:
Upper Case Allowed? Allows upper case if checked
I need help understanding what superformat
Superformat?
does

I need help understanding what the superformat feature does.

Urgent
If you feel a page needs to be worked on ahead of others, you can tag it as urgent. Valid reasons for
using urgent would be highly used page with errors, key new feature, security info, etc. There's no
guarantee the other editors will share your sense of urgency, so it's best to edit the page yourself.
Please add the urgent tag at the top of the page.
Many users are asking this question in IRC. Updating this page is an urgent requirement.

Needed for Next Release

This tag is a note that the page needs to be updated or constructed for the next version of Tikiwiki.
Place this tag along with others on the page to indicate the page needs to be edited soon.
This page is needed for Next Release?

6.1.3.4. Creating New Tags

Tags can be created for any reason, but realistically only the top 10 or so will make it on the
Documentation Status page - and thus be watched. Other similar Dashboard? pages can be created
however for special projects. If you'd like to implement a new tag, you should first tag the tag by
linking it to tag. Get it?

Please consult with the Editorial Board before you set new tags up.

6.1.4. Documentation Templates

TikiWiki editorial board recommends using templates for all documentation pages. All of the
template pages listed below are examples. Users who can edit should see an Apply Template drop
down in the edit window?.

Currently recommended:
There are templates provided for each type of page defined by the documentation structure?, plus
(eventually) a sampling of "special" pages as well.

Feature Pages
Describe a feature and give examples of when to use it. Feature Page Template

820 Back to TOC

 Tikiwiki Documentation 1.9+

User Pages
Instructions on how to use the feature for an end user. Example Using Blogs

Configuration
Instruction on how to initially enable and configure the feature for use. Example Configuring Blogs

Administration:
Instructions on ongoing administrative tasks for the feature. May not be needed for simpler features.
Example: Administering Blogs

Technical Reference Pages

Technical Documentation of each feature for the developer. Example: Blogs Technical Reference
Technical Reference Page Template

Topic Pages
Narrative pages that explain a broader topic from start to finish. Example: Quick Setup Guide,
Performance Tuning Guide.

6.1.5. Feature Page Template

Use this content template in any feature page as per the Tikiwiki Manual of Style

Feature Name
• Use Heading 2 for the Feature Name. (Because we don't add the page titles automatically).
• Describe what the feature is for in 100-200 words. Give a couple of examples how the
feature would be used.
• Include a half page size (about 300 pixels wide) cropped image of the feature in action.
• backlink to index? related pages, related features, general concepts etc. Don't use a bulleted
list here because it takes up too much vertical space.

Using Multiple Pages to Document a Feature

If multiple pages are used to document a feature, list them here with a brief explanation. Use plain
language to name additional pages.
((Create a Feature))
((Configure a Feature))
((Add Permissions to a Feature))

How to use Feature

Enable the Feature: (explain how to find this feature's admin panel with both breadcrumbs and a
direct local url)
Administration-->Feature-->Page local url:yoursite.com/url

Back to TOC 821

Explaining the "Create" Form
Create a table which explains the form that is used to create the instance of the feature.
Option Choices You have Default Behavior What this does in plain language
Turns on a noisy dinger that dings
Turn on Dinger? Yes,No No
when you ping
exact text from acceptable values,comma what happens if you choose
what difference it makes
form separated not to choose
Dinger Name alphanumeric required field You have to give the dinger a name.

Modify/Customize the instance

(explain how to find this feature's admin panel with both breadcrumbs and a direct local url)

Administration-->Feature-->Page local url:yoursite.com/url

Explaining the next form

Create a table which explains the form or options that customize the instance.
Option Choices You have Default Behavior What this does in plain language
Turns on a noisy dinger that dings
Turn on Dinger? Yes,No No
when you ping
exact text from acceptable values,comma what happens if you choose
what difference it makes
form separated not to choose
Dinger Name alphanumeric required field You have to give the dinger a name.

Permissions
Explain what permissions can be applied to the feature and what they mean.
Try it out
please link to the live Feature on tikiwiki.org

Developer Notes
Notes on the ongoing development of this feature, please indicate the latest released stable version,
identified bugs, links to development pages, etc.

Developers Contact
Developers who worked on or understand this feature should leave a contact link and indicate if
they are available for paid or free help.

Feature FAQ
Any Questions? Edit this page and someone will respond!

822 Back to TOC

 Tikiwiki Documentation 1.9+

Related Category
Include the appropriate category display using the Category Plugin?.

External Links
A list of links outside of tw.o (Wikipedia, RFC's, Other Manuals)

6.1.6. Documentation Status

(Do you want to help?: Welcome! :-) and read Welcome authors. New to the new tagging system?:
No problem ;-): Read How to tag )

Please edit any of these pages and remove the status link if (in your opinion) the problem is
resolved (or never existed).

help urgent errors refactor

10 planes que apunten a help 4 planes que apunten a 2 planes que apunten a errors 12 planes que apunten a refactor
urgent
• Using Smarty Filters • Install Turk MMCache • Windows IIS Install
• Translating to a new language • Users • Content Creation and Management • Users Management
• Module Admin Management Tools • Upgrade
• Login Config • Editorial • TroubleShooting
Board
• Login Authentication Methods Meeting July • Structure
• Installation Problems 2007 • Status
• help • Comments • Login Problems
• Get Help • Comment • Login Config
• Editorial Board Meeting July User • Installation Problems
2007 • DevAboutTheDocument
• Admin Problems ation
• Cache
• About the Tikiwiki
Documentation

screenshot need for 1.10 stub needs review

102 planes que apunten a screenshot 6 planes que apunten a 147 planes que apunten a stub 18 planes que apunten a needs
needed for 1.10 review
• Wysiwyg Editor Admin • Welcome Authors
• Users Management • Wysiwyg • Using Smarty Filters • Wysiwyg Editor Admin
• Upgrade 1.9.7 to 1.10 Editor Admin • tag • Wysiwyg Editor
• Translating to a new language • Wysiwyg • Status • Wiki 3D
Editor • Using Newsletters
• Survey • Stats Details
• Notepad • Upgrade 1.9.x to 1.9.7
• Structure • Shared Hosting
• Contribution • Upgrade 1.9.7 to 1.10
• Notepad • Search Engine Friendly

Back to TOC 823

 • Newsletter User • Calendar • Rating • Translating to a new
• Newsletter Admin • Action Log • Quiz Details language
• Module wiki_last_comments • plugin • Survey User
• Module who_is_there • Platform independence • Survey Details
• Module • PDF • Survey Admin
whats_relatedwhats_related • MyTiki Admin • Site Identity
• Module user_tasks • Module wiki_last_comments • Requirements and Setup
• Module user_pages • Module • Newsletter
• Module user_image_galleries whats_relatedwhats_related • MyTiki
• Module user_bookmarks • Module user_tasks • Mobile Tiki User
• Module user_blogs • Module user_pages • Intertiki
• Module upcoming_events • Module user_image_galleries • Forum Details
• Module top_visited_faqs • Module user_bookmarks • Category Admin
• Module top_visited_blogs • Module user_blogs
• Module top_quizzes • Module upcoming_events
• Module top_pages • Module top_visited_faqs
• Module top_objects • Module top_visited_blogs
• Module top_image_galleries • Module top_quizzes
• Module top_images_th • Module top_pages
• Module top_images • Module top_objects
• Module top_games • Module top_image_galleries
• Module top_forum_posters • Module top_images_th
• Module top_file_galleries • Module top_images
• Module top_files • Module top_games
• Module top_articles • Module top_forum_posters
• Module top_active_blogs • Module top_file_galleries
• Module tail • Module top_files
• Module switch_theme • Module top_articles
• Module switch_lang2 • Module top_active_blogs
• Module switch_lang • Module tail
• Module since_last_visit • Module switch_theme
• Module shoutbox • Module switch_lang2
• Module search_wiki_page • Module switch_lang
• Module search_box_new • Module since_last_visit
• Module search_box • Module shoutbox
• Module random_pages • Module search_wiki_page
• Module random_images • Module search_box_new
• Module quick_edit • Module search_box
• Module online_users • Module random_pages
• Module old_articles • Module random_images
• Module num_submissions • Module quick_edit
• Module • Module old_articles
messages_unread_messages • Module num_submissions
• Module menupage • Module
• Module login_box messages_unread_messages
• Module logged_users • Module menupage
• Module live_support • Module login_box
• Module last_visitors • Module logged_users
• Module last_tracker_items • Module live_support
• Module last_tracker_comments • Module last_visitors
• Module last_submissions • Module last_tracker_items
• Module • Module last_tracker_comments
last_modif_tracker_items • Module last_submissions
• Module last_modif_pages • Module last_modif_tracker_items
• Module last_modif_events • Module last_modif_pages
• Module last_modified_blogs • Module last_modif_events
• Module last_image_galleries • Module last_modified_blogs
• Module last_images_th • Module last_image_galleries
• Module last_images • Module last_images_th
• Module last_file_galleries • Module last_images
• Module last_fileslast_files • Module last_file_galleries

824 Back to TOC

 Tikiwiki Documentation 1.9+

• Module last_created_quizzes • Module last_fileslast_files

• Module last_created_faqs • Module last_created_quizzes
• Module last_created_blogs • Module last_created_faqs
• Module last_category_objects • Module last_created_blogs
• Module last_blog_posts • Module last_category_objects
• Module last_articles • Module last_blog_posts
• Module last_actions • Module last_articles
• Module google • Module last_actions
• Module • Module google
forums_most_visited_forums • Module
• Module forums_most_visited_forums
forums_most_read_topics • Module forums_most_read_topics
• Module • Module
forums_most_commented_foru forums_most_commented_forums
ms • Module forums_last_topics
• Module forums_last_topics • Module forums_best_voted_topics
• Module • Module featured_links
forums_best_voted_topics
• Module events
• Module featured_links
• Module eph
• Module events
• Module directory_top_sites
• Module eph
• Module directory_stats
• Module directory_top_sites
• Module directory_last_sites
• Module directory_stats
• Module comm_received_objects
• Module directory_last_sites
• Module change_category
• Module
comm_received_objects • Module categories
• Module change_category • Module breadcrumb
• Module categories • Module assistant
• Module breadcrumb • Module articles
• Module assistant • Mod xspf_player
• Module articles • Mod wikigraph
• Menus • Mod vtiger
• Integrator User • Mod userprefstats
• Integrator • Mod trackeritemfield
• HTML Page • Mod tinvoice
• Freetags • Mod tikidav
• Drop Down Tracker Field • Mod svg
• Contribution • Mod solve
• Comments • Mod scroll
• Comment User • Mod rcogley
• Comment Admin • Mod phplot
• Cache • Mod perm
• Action Log • Mod nusoap
• Mod mapeditor
• Mod mailman
• Mod listpages
• Mod kamap
• Mod js
• Mod jpgraph
• Mod join
• Mod group
• Mod galaxia_sweet_ui
• Mod fpdf_freefonts
• Mod fpdf_bitstreamvera
• Mod fpdf
• Mod formula
• Mod flowplayer
• Mod ebay
• Mod damian2
• Mod damian1
• Mod cc
• Mod cartoweb

Back to TOC 825

 • Mod blogroll
• Mod aulawiki
• Mobile Tiki User
• Login
• Lite Install
• Js Calendar
• Integrator Admin
• Editorial Board Meeting July 2007
• Design rules
• Date and Time
• Database MySQL
• Database independance
• Cookie
• Contact
• Comment Details
• Charts User
• Charts Details
• Charts Admin
• Charts
• Calendar Details
• Browser Compatibility
• Add-ons

messy
Cap plana apunta a messy

See also: The List of Status Tags

At Tikiwiki.org, the Backlinks to index method can be used to "mark" pages for status. This is a
very simple wiki based method. If you think a tag should apply to a page, just link that page to the
appropriate status page. Authors, please review the lists on this page and fix what you can!
See also: Documentation Status Tracker

826 Back to TOC

 Tikiwiki Documentation 1.9+

6.1.7. Printing the Documentation

If you prefer to print? the documentation, here are some simple steps.

Option 1 (the quickest and easiest, when it succeeds)

1. under the tiki print feature , print the whole documentation structure
2. copy all html printed structure from your browser to your OpenOffice document
3. Break all image links (through option under "Edit > links > break all links") so that images
reside inside your document and not as external referenced images (at this step your
document will increase a lot in size).
4. You can now insert a header (put the doc logo there) and insert a footer with page numbers
5. You can now insert a table of content
6. You may wish to re-set heading levels 1 to 4, at least, and automatic numbering to them, to
follow the same tree as in the Documentation structure. This can take a long while.
7. when you are happy with the result, export to PDF? within OpenOffice

Option 2 (the intermediate solution, safer)

In some cases, the 2nd step in Option 1 makes an OpenOffice document which has most (not all)
images very reduced in size inside the document (we don't know why). If this is your case, you can
re-set original size to images one by one, or, use this small variation that seems to avoid the
previous issue:
1. under the tiki print feature , print the whole documentation structure
2. using Firefox browser, save the page and its contents (make sure first that your browser has
downloaded all included images)
3. open this locally saved copy of the documentation with Firefox again, and copy & paste all
the content from that page to your OpenOffice document
4. Break all image links (through option under "Edit > links > break all links") so that images
reside inside your document and not as external referenced images (at this step your
document will increase a lot in size).
5. You can now insert a header (put the doc logo there) and insert a footer with page numbers
6. You can now insert a table of content
7. You may wish to re-set heading levels 1 to 4, at least, and automatic numbering to them, to
follow the same tree as in the Documentation structure. This can take a long while.
8. when you are happy with the result, export to PDF? within OpenOffice

Option 3 (a bit longer, preferred by some people)

1. under the tiki print feature , print the whole documentation structure
2. using Firefox browser, save the page and its contents (make sure first that your browser has
downloaded all included images)
3. open the html file with OpenOffice Writer
4. under the file menu, export it as an OpenOffice document
5. close and open this new OpenOffice document

Back to TOC 827

 6. Your document content might be inside an annoying table which prevent from showing the
full length of your document. You might avoid this issue through copy the content of that
table from that document and paste it to a new document.
7. Break all image links (through option under "Edit > links > break all links") so that images
reside inside your document and not as external referenced images (at this step your
document will increase a lot in size).
8. You can now insert a header (put the doc logo there) and insert a footer with page numbers
9. You can now insert a table of content
10.You may wish to re-set heading levels 1 to 4, at least, and automatic numbering to them, to
follow the same tree as in the Documentation structure. This can take a long while.
11.when you are happy with the result, export to PDF? within OpenOffice

828 Back to TOC

 Tikiwiki Documentation 1.9+

6.2. Tikiwiki FAQs

Those are the Frequently Asked Questions (FAQs) available at http://doc.tikiwiki.org/tiki-
list_faqs.php (July 2007):

Title Description
Images Frequently Asked Questions (FAQs) and answers about working with images in Tiki.
Users and Groups Frequently Asked Questions (FAQs) and answers about managing Tiki user accounts and
group permissions.
General Troubleshooting Login issues, site down, can't access admin panel, etc.
Security Frequently Asked Questions (FAQs) and answers about Tiki security.
Installation and Setup Frequently Asked Questions (FAQs) and answers about installing and setting up TikiWiki.
Look and Feel Frequently Asked Questions (FAQs) and answers about using TikiWiki's Theme and Site
Identity features.
RSS Feeds Frequently Asked Questions (FAQs) and answers about using TikiWiki's RSS feature.
Wiki Pages Frequently Asked Questions (FAQs) and answers about using TikiWiki's Wiki pages.

6.2.1. FAQs about Images

Q: How can I uploaded multiple images (batch upload)?

A: Compress them using your favorite program to .zip format (see ToolBox pages, if needed), and
upload them to your gallery through the main application menu at "Image Galleries > Upload
image", and the section "Upload from disk / Batch upload:".

Q: How can I upload images larger than XXXX?

A: The maximum upload file size is determined by the upload_max_filesize setting in your php.ini
configuration file.

Refer to the Requirements and Setup documentation for details.

Q: How do I get the automatic thumbnails to work in my image gallery?

A: Since they are automatically generated, you shouldn't do anything special more than checking
that any of the libraries GD or Imagick are installed on your server (check "Admin home > Image
Galleries > Galleries features > Library to use for processing images:", and contact your server
admin if needed).

You can regenerate your thumbails of any gallery with id XXX while browsing it (tiki-
browse_gallery.php?galleryId=XXX) through the option "rebuild thumbnails" (tiki-
browse_gallery.php?galleryId=XXX&rebuild=XXX).

Back to TOC 829

Q: How do I add an image to a wiki page?
A: You can add images (JPG, PNG, GIF, BMP) to a wiki page by using the wiki syntax. See Wiki-
Syntax Images for details.
• If the image file already exists on your webserver, simply include its path and filename.
or
• You can upload an image file while editing the wiki page by using the Upload Picture field.
Tiki will automatically add the necessary wiki syntax to the page.

6.2.2. FAQs about Users and Groups

Q: I lost the admin password. How can I reset the admin account?
A: Go to PhpMyAdmin and run the following command:

UPDATE `users_users` SET `password`='MYNEWPASS', `hash`= md5('adminMYNEWPASS')

WHERE `login`='admin';

Make sure to use something else as a password though!

Q: I accidentally deleted the admin account. How can I restore the admin account?
A: Go to PhpMyAdmin and run the following command:

INSERT INTO `users_users` SET `password`='MYNEWPASS', `hash`=

md5('adminMYNEWPASS') WHERE `login`='admin';

Make sure to use something else as a password though!

Q: Can I change the "admin" username to something else?

A: No. Tiki requires the usename admin for your administrator account. However, you can easily
add a new user (with any name) and grant this use all admin permissions.

6.2.3. FAQs about General Troubleshooting

Q: I received a "Fatal error: Allowed memory size of XXXXXX" message. How can I fix this?
A: Tiki needs more memory. Increase the memory_limit setting in your PHP.INI file.

See PHP requirements for more information.

Q: My Tiki shows blank pages. What's wrong?

A: Tiki needs more memory. Increase the memory_limit setting in your PHP.INI file.

See PHP requirements for more information.

830 Back to TOC

 Tikiwiki Documentation 1.9+

Q: Ooops! I lost my one and only admin password! What can i do?
A: Assuming you are not using external user authentication - the password you seek is logded
firmly in your database. If you have access to CPanel, you can retreive it. From Cpanel, goto
MySQL Databases, then PHPMyAdmin. Select your database (usually somthing_tiki) scroll the list
of tables way down to users_users table in the ti the password will be in there.
These are not encrypted in most dbs.

In case your tiki encrypts password you can use the following SQL command: (cut and paste the
following exactly into the SQL window in PHPMyAdmin.

UPDATE `users_users` SET `password`='admin', `hash`= md5('adminadmin') WHERE

`login`='admin';

this will set the password to "admin" again. You are saved.

6.2.4. FAQs about Security

Q: What is CSRF and how can I protect my Tiki?

A: Cross Site Request Forgery (CSRF) — sometimes called "sea surfing" — is a method of
attacking a PHP-powered site (such as TikiWiki).

To protect your Tiki, enable the Protect against CSRF... options on the Login Config page.
For more information, see Tiki Security page .

Q: I think found a security vulnerabilty in TikiWiki. How should I report it?

A: To allow us time to patch the system, please report the vulnerability using the bug tracking
system using the category "security" but without detailing the vulnerability so it cannot be
exploited AND please contact [email protected] and we'll deal with your input.

For more information, see Tiki Security page .

Q: How can I secure my Tiki?

A: Security is very important to the Tiki development team. Some recommened security steps
include:

1. Kee your Tiki up-to-date. Security patches are included with each update.
2. Remove (or rename) your tiki-install.php file.
3. Verify your directory permisions. Remember, 7-7-7 allows complete read/write/execution
rights!

For more information, see Tiki Security page .

Back to TOC 831

6.2.5. FAQs about Installation and Setup

Q: Where can I download TikiWiki?

A: You can download all official TikiWiki releases from Sourceforge . Please read the complete
Installation information (which includes the requirements and setup information) first.

If you have problems, please consult the Installation forum .

Q: Can I test TikiWiki without installing it on my webhost?

A: Yes! OpensourceCMS hosts a TikiWiki test installation that allows you to "try out" TikiWiki.
The software is already installed and configured... ready to go! You can login as an administrator
and get a feel for how TikiWiki works.

Q: Is there a Fantastico installer for TikiWiki?

A: Yes! Fantastico is a control panel script, offered by some webhosts, that will perform a full
TikiWiki installation, including database configurtion. Contact your webhost, or review our list of
Tiki-friendly webhosts for more information.

Q: How can I convert wiki pages from another CMS package (such as PHPNuke) to Tiki?
A: There are migration utilities avilable for several common CMS packages, including:

• PhpNuke
• Phpwiki
• Postnuke
• TWiki
• and others.

See the Tiki migration documentation for details.

Q: How can I download the CVS version (for development)?

A: You can download the latest (pre-release) version of Tiki from CVS by using one of the
following methods:
• Anonymous access
export
CVSROOT=":pserver:[email protected]:/cvsr
oot/tikiwiki"
cvs login
#type enter

• Developer Account
export CVS_RSH=ssh
export
CVSROOT=":ext:[email protected]:/cvsroo
t/tikiwiki"

832 Back to TOC

 Tikiwiki Documentation 1.9+

See Developer Download for details.

Q: How can I change the Home Page of my Tiki?

A: By default, Tiki will create a wiki page named HomePage and use it as the Home Page for your
Tiki. However, you can change the Home Page to be anything that you want, by using one of the
following options:
• Use the Home Page option on the General Admin page to specify a specific Tiki feature
page (wiki, articles, forums, etc.) be used as the site's Home Page.
• Select the Use URI as Home Page option to specify any page to be used as the site's Home
Page.
For example, selecting this option and using tiki-index.php?page=Foo will use a wiki page
named Foo as your site's Home Page.

Q: How can I move my existing Tiki to a new server or host?

A: You can eaily move your Tiki (including your database) to a new host or server:
1. Create a full backup of your existing database.
2. Copy all the Tiki files and directories from your old server to your new server.
3. Restore your database (from the old server) to the new server.
4. Open your web browser to: http://yournewhost/tiki-install.php.
You will be prompted to enter the admin password that you used for the existing site.
The Tiki Installer page appears.
5. At the bottom of the page, click Reset database connection settings.
Enter the database information for the new server and click Submit Query
Tiki connects to the new database and the Tiki Installer page appears.
6. Click Do nothing and enter Tiki.

You're done!

6.2.6. FAQs about Look and Feel

Q: How can I specify which features are available on my Tiki?

A: The feature list for TikiWiki is quite impressive... and growing each day! To customize which
features are available on your Tiki:

1. Enable the feature on the Feature Admin page.

2. Then configure that specific feature by using the feature's Configuration page.

For example, to use TikiWiki's Wiki feature on your site, you would enable the Wiki feature, then
use the Wiki Configuration page to configure the wiki.

For more information, see the Feature Admin page .

Back to TOC 833

Q: How can I add features (modules) to my Tiki?
A: The boxes of "content" (such as the Shoutbox that appear in the left and right columns (also in
wiki and article pages) are called modules. To add modules to your Tiki, use the Module Admin
page. You can also specify that certain modules appear for only specific security groups.

Notes:
1. Some modules require that an associated feature must be enabled. For example, to use the
mod-articles module, you must enable the Articles feature.
2. The display of the left or right columns may be overridden by General Layout Options on
the Features Admin page.

Q: How can I change the appearance (theme) of my Tiki?

A: Use the General Admin page to select a default theme (set of templates and CSS style sheet) for
your Tiki. Any CSS file in your /styles directory can be selected.

In addition to the themes included with the TikiWiki installation, you create your own custom
themes.

For more information, see http://themes.tikiwiki.org .

6.2.7. FAQs about RSS Feeds

Q: What types of RSS feeds does Tiki support?

A: Tiki can create two types of RSS modules:

• An RSS feed of a specific Tiki feature (wiki, blog, etc.) that other people subsribe to.
• A subscribtion to an RSS feed from another site.

Q: How can I create an RSS feed for a Tiki feature?

A: Use the RSS Config page to configure your Tiki's RSS feeds, including number of items to
include, name, title, and so on. Your Tiki will now include an RSS link the bottom bar (if it is
enabled) allowing users to subsribe to the RSS feed.

For additional information, see: RSS Config.

Q: How can I syndicate an RSS feed from another site into my Tiki?
A: RSS feeds from other sites can be included in Tiki modules. Use the RSS Modules to create a
new RSS module. After creating the RSS module, you can include the module in any wiki page,
Tiki module, or article by using:

{rss id=xx}

Where xx is the ID that was assigned when you created the RSS module.

834 Back to TOC

 Tikiwiki Documentation 1.9+

6.2.8. FAQs about Wiki Pages

Q: How do I create a new wiki page?

A: There are two methods to create a new wiki page:

1. Create a link from an existing page.

TikiWiki will automatically create the new (destination) page when you click the link.
2. Create a new page by using the Quick Edit module?.

Q: Why are all my words in CaMeL CaSe turning into wiki links?
A: By default, TikiWiki uses the WikiWords feature. This is a quick and easy way to create links
(and create) other wiki pages. See Use Wiki Words for more information about WikiWords,
including how to turn this feature on or off.

To have a word in CaMeL CaSe not create a wiki link (even if the WikiWords feature is on),
simply surround the word with two inverse parenthesis.

For example: ))NotALink((

Even though the text NotALink is in CaMel CaSe, it is not a link.

Q: How do I turn off the wiki syntax processing?

A: By default, TikiWiki will always interpret wiki syntax:
• === for underlining
• '' for italic
• etc.

To turn off wiki syntax processing, simply use the ~np~ syntax. See WikiSyntax for more
information about TikWiki wiki syntax.

For example:~126~~110~~112~~126~__not bold__~126~~47~~110~~112~~126~

Even though the text is surrounded by double underscores (the wiki syntax for bold), the text is not
bold.

Q: How can I include Javascript in a wiki page?

A: For security reasons, TikiWiki will remove all Javascript () from a wiki page. To include
Javascript code, or to include a .JS file, use the JS Wiki Plugin .

Q: How do I enable the spell checker?

A: To enable the spellchecker:

Back to TOC 835

 1. Download the spelling database table and add it to your database.
2. Enable the spellchecking? option on the Wiki Config page.

For more information, see Spellchecking?.

Q: How can I convert wiki pages from another CMS package (such as PHPNuke) to Tiki?
A: There are migration utilities avilable for several common CMS packages, including:
• PhpNuke
• Phpwiki
• Postnuke
• TWiki
• and others.

See the Tiki migration documentation for details.

Q: How do I add an image to a wiki page?

A: You can add images (JPG, PNG, GIF, BMP) to a wiki page by using the wiki syntax. See Wiki-
Syntax Images for details.
• If the image file already exists on your webserver, simply include its path and filename.
or
• You can upload an image file while editing the wiki page by using the Upload Picture field.
Tiki will automatically add the necessary wiki syntax to the page.

Q: What is a "minor" edit?

A: When you edit a wiki page, there is an option for a minor edit. If selected, other users who are
watching the page will not receive email notifications.

See Using Wiki Pages#_Page_Monitoring? for more information.

Q: What is the maximum wiki page size?

A: By default, Tiki stores the wiki page data as a TEXT datatype in the DESCRIPTION column of
the TIKI_PAGES table. This will hold 64K of data.

You can change this datatype to to MEDIUMTEXT or LONGTEXT (16MB and 4GB, respectively)
to have longer wiki pages. Refer to the (MySQL documentation ) for details.

836 Back to TOC

 Tikiwiki Documentation 1.9+

6.3. Mods list

(Please see http://mods.tikiwiki.org for the most updated list of mods)

6.3.1. TikiWiki Mods Repository

(From http://mods.tikiwiki.org )
More information at the Annex
Red : recent < 1 week
Orange : fresh < 1 month
Green : current < 3 month
Blue : old > 3 months
Grey : archive > 1 year
This public repository lists the mods packages available from tikiwiki.org server. It's used by
tikiwiki admins to update features that are not included in the public release of Tikiwiki. see
TikiMods page on tw.o

Last
Type Dl Name Vers. License Description
Update
Collection of 31 avatars from the Dragon Ball Z
dragonballz 2004.09.29 1.3 unknown
(tm) series.
Collection of 16 avatars from the Gnumes
gnumes 2007.07.02 1.2 Free Images
collection
Collection of 19 avatars from Goldorak (tm)
goldorak 2004.09.29 1.3 unknown
avatars series.
mcdonald 2004.09.29 1.3 unknown Collection of 19 avatars from McDonald (tm).
Collection of 46 avatars from the Xmen (tm)
xmen 2004.09.29 1.3 unknown
series.
This is a meta package containing all avatars
all 2007.03.15 1.1 unknown
package.

Back to TOC 837

 Last
Type Dl Name Vers. License Description
Update
cc 2007.07.02 1.3.10 GNU/LGPL Multi-currencies management system
Public
config 2005.09.28 1.1 Domain (no A work-in-progress Config menu
license)
import-phpwiki 2004.10.29 1.1 GNU/LGPL Import content from PHP Wiki
solve 2005.10.11 1.8 GNU/LGPL Tiki Helpdesk/CRM portal
userprefstats 2004.10.25 1.2 GNU/LGPL Simple stats for User preferences
Public kamap adds a tiled map interface to tikiwiki
kamap 2007.04.23 0.0.3
Domain maps feature.
tikidav 2006.01.14 1.1 GNU/LGPL WedDav access to the TikiWiki resources
AulaWiki offers team collaboration
features aulawiki 2007.03.04 1.5 GNU/LGPL environments (workspaces), allowing you to
manage sets of Tiki resources in an easy way.
Cartowebs mod intend to add Postgis layer /table
cartoweb 2007.02.22 0.0.1 GNU/LGPL creation to add point / line / polygon to tikiwiki
used with cartoweb GIS Framework
phpCAS documentation can be found at
phpcas 2006.12.22 1.1 GNU/LGPL
http://esup-phpcas.sourceforge.net
Tinvoice mod intend to add invoice management
tinvoice 2007.07.02 1.21 GNU/LGPL
and generation to tikiwiki.
Map Editor mod intend to add Postgis layer
/table creation to add point / line / polygon to
mapeditor 2007.04.23 0.0.2 GNU/LGPL
tikiwiki used with mapserver (tiki or ka-map or
cartoweb ) GIS Framework
nusoap 2005.09.02 1.1 GNU/LGPL Web Services Toolkit for PHP
Mozilla
vtiger 2005.09.27 1.2 Public Support for solve Helpdesk / vtiger CRM
License 1.1
JpGraph is a Object-Oriented Graph creating
library for PHP >= 5 The library is completely
jpgraph 2007.06.14 1.4 QPL 1.0 written in PHP and ready to be used in any PHP
scripts (both CGI/APXS/CLI versions of PHP
are supported).
lib FPDF is a PHP class which allows to generate
PDF files with pure PHP, that is to say without
fpdf 2007.06.14 1.4 Free using the PDFlib library. F from FPDF stands for
Free: you may use it for any kind of usage and
modify it to suit your needs.
fpdf_bitstreamvera 2007.06.14 1.0 Free Bitstream Vera fonts converted for fpdf mods
Fonts from the FreeFont project
fpdf_freefonts 2007.06.14 1.1 GNU/GPL http://savannah.nongnu.org/download/freefont/
converted for fpdf mods
The menu including all tiki sites. hardstamped to
menus tikiring 2005.09.08 1.3 GNU/LGPL
menuId=41
calculator 2005.09.08 1.5 GNU/LGPL Kewl little calculator for your right or left
modules column within TikiWiki
clock 2005.09.08 1.4 GNU/LGPL Very neat borderless module holding a ticking
clock
extcalculator 2005.09.08 1.1 GNU/LGPL Kewl little calculator for your right or left

838 Back to TOC

 Tikiwiki Documentation 1.9+

Last
Type Dl Name Vers. License Description
Update
column within TikiWiki
Public
join 2005.09.26 1.2 Domain (no A simple "join now" box
license)
Works with the excellent www.plazes.com to
plazes 2005.09.08 1.2 GNU/LGPL show your current connection location, through a
module.
worldclock 2005.09.27 1.2 GNU/LGPL World Clock for a module
A module, that takes an OPML-file from your
blogroll 2006.09.06 1.3 GNU/LGPL
file-gallery and renders it as a blogroll
Plugin to enable integrated mailman multi-list
services mailman 2004.10.07 1.6 GNU/LGPL
panel, using iframe
upgrade_0.95to1.0 2004.10.28 1.1 GNU/LGPL Upgrades from Tiki 0.95 to 1.0
upgrade_0.9to0.95 2004.10.28 1.1 GNU/LGPL Upgrades from Tiki 0.9 to 0.95
upgrade_1.0to1.1 2004.10.28 1.1 GNU/LGPL Upgrades from Tiki 1.0 to 1.1
upgrade_1.1to1.2 2004.10.28 1.1 GNU/LGPL Upgrades from Tiki 1.1 to 1.2
upgrade_1.2to1.3 2004.10.28 1.1 GNU/LGPL Upgrades from Tiki 1.2 to 1.3
upgrade_1.3to1.4 2004.10.28 1.1 GNU/LGPL Upgrades from Tiki 1.3 to 1.4
sql
upgrade_1.4to1.5 2004.10.28 1.1 GNU/LGPL Upgrades from Tiki 1.4 to 1.5
upgrade_1.5to1.6 2004.10.28 1.1 GNU/LGPL Upgrades from Tiki 1.5 to 1.6
upgrade_1.6to1.7 2004.10.28 1.1 GNU/LGPL Upgrades from Tiki 1.6 to 1.7
upgrade_1.7to1.8 2004.10.28 1.1 GNU/LGPL Upgrades from Tiki 1.7 to 1.8
upgrade_1.8to1.9 2005.09.08 1.1 GNU/LGPL Upgrades from Tiki 1.8 to 1.9
upgrade_1.9to1.9.1 2005.09.08 1.1 GNU/LGPL Upgrades from Tiki 1.9 to 1.9.1
damian1 2005.09.08 1.1 Unknown A Collection of taglines
damian2 2005.09.08 1.1 Unknown A Collection of taglines
taglines
A collection of taglines from TikiWiki
rcogley 2005.09.08 1.2 Unknown
Developer R.Cogley
3dblue 2004.10.25 1.2 GNU/LGPL Blue and 3D
themes akwa 2004.11.01 1.3 GNU/LGPL Looking like MacOSX
bluemetal 2004.11.04 1.2 GNU/GPL Theme borrowed to another cms.
classicblue 2004.09.29 1.1 GNU/GPL Variation of BlueMetal
greenjelly 2004.10.25 1.2 GNU/LGPL British taste
greenmetal 2004.11.04 1.2 GNU/GPL Theme borrowed to another cms.
isabelsworld 2004.09.30 1.1 GNU/LGPL The theme of Isabel.
m508 2004.11.05 1.1 GNU/LGPL Originally aimed for 508 compliance, but not
very successful
matrix 2004.11.04 1.2 GNU/LGPL Requires a high powered workstation, light
version also included.
nhs 2004.09.30 1.1 GNU/LGPL A style sheet by sdl of the Tiki Community
conforming to the NHS colour schemes
purplemetal 2004.11.04 1.3 GNU/GPL Theme borrowed to another cms. Purple version.
redgrey 2004.11.04 1.3 Unknown! A rip of the Fedora* themes
redmetal 2004.11.04 1.2 GNU/GPL Theme borrowed to another cms.

Back to TOC 839

 Last
Type Dl Name Vers. License Description
Update
specialsauce 2004.10.25 1.1 GNU/LGPL Black, Yellow and Grey
tarynsworld 2004.10.25 1.2 GNU/LGPL This is the theme in action of TarynsWorld
underworld 2004.10.25 1.2 GNU/LGPL Underworld theme, very dark colours
veryorange 2004.10.25 1.2 GNU/LGPL Orange version of moreneat
zaksworld 2004.09.29 1.3 GNU/LGPL This is the theme in action at Zaks site
Simple theme, conservative colors. Designed for
ztheme 2004.09.29 1.3 GNU/LGPL
easy "readability" and use.
This is a Tiki adaptation of the Kubrick theme
(http://mambo.rhuk.net/) originally done by
Michael Heilemann for the WordPress blog
software. It's been tested with Tiki 1.9.3(CVS).
kubrik 2006.02.19 1.1 GNU/GPL Maintained by Gary Cunningham-Lee
(chibaguy). For the latest information on and
updates of the Kubrick theme for TikiCMS, visit
http://zukakakina.com or
http://themes.tikiwiki.org.
This is a Tiki adaptation of the Planetfall theme
(http://mambo.rhuk.net/) originally done by rhuk
for the Mambo CMS (now Joomla). It's been
tested with Tiki 1.9.2. Maintained by Gary
planetfall 2006.02.19 1.1 GNU/GPL
Cunningham-Lee (chibaguy). For the latest
information on and updates of the Planetfall
theme for TikiCMS, visit http://zukakakina.com
or http://themes.tikiwiki.org.
ebay 2004.10.03 1.1 GNU/LGPL Currently only works with ebay.co.uk
Wiki formula 2004.10.23 1.1 GNU/LGPL This plugin renders mathematical formulas in
plugins wiki pages. The formulas should be written in
LaTeX format, simple ones will be in plain html
and complex ones will render a graphic.
Requires latex installed, or at least path-accesible
installed latex, dvips, and Imagemagic's convert.
galaxia_sweet_ui 2004.12.27 1.2 GNU/LGPL This package provides a set of wiki plugins that
allow Galaxia workflow developers to make user
interfaces that abstract galaxia concepts from
final user. So, user will run the activities from
the wiki pages and don't have to know what's an
instance, activity or proccess, they just click and
go through application.
group 2004.11.18 1.1 GNU/LGPL Shows content only for desired group(s)
js 2006.02.19 1.2 GNU/LGPL Insert a javascript file or/and some javascript
code
perm 2004.11.18 1.1 GNU/LGPL Shows content only if user has desired
permission(s)
phplot 2004.11.02 1.2 GNU/LGPL Uses an existing installation of phplot to draw
charts. Data is entered in the same way as in the
fancytable plugin.
plazes 2005.09.08 1.2 GNU/LGPL Works with the excellent www.plazes.com to
show your current connection location.
redirect 2004.10.25 1.2 GNU/LGPL In wiki syntax type {
REDIRECT(page=>pagetodirectto)/}
scroll 2004.10.03 1.1 GNU/LGPL no description

840 Back to TOC

 Tikiwiki Documentation 1.9+

Last
Type Dl Name Vers. License Description
Update
svg 2004.09.29 1.3 GNU/LGPL Wiki Plugin to include SVG file.
Wikiplugin using Graphviz to generate dynamic
wikigraph 2004.11.16 1.2 GNU/LGPL
graph-maps of Wiki pages
Wikiplugin using Freemind flash plugin or java
mindmap 2006.12.10 1.4 GNU/LGPL
applet to browse mind maps
Displays an flv (flash video) file with controls
generated by FlowPlayer. For further info on
flowplayer 2006.11.26 1.1 GNU/LGPL FlowPlayer see
http://flowplayer.sourceforge.net/ . FlowPlayer is
Apache version 2.0 licensed.
Displays a flash object with controls generated
by xspf player to put mp3-s or a playlist of mp3s
xspf_player 2006.11.29 1.1 GNU/LGPL into any wiki-enabled tikiwiki object. For further
info on xspf_player see
http://musicplayer.sourceforge.net/ .
Shows the content of a tracker item field or the
wiki text of the plugin if the tracker item field is
set and not empty. If itemId is not set, will test
the user tracker. test default is 0(disply mode and
trackeritemfield 2007.02.22 1.2 GNU/LGPL
not test mode) {
TRACKERITEMFIELD(itemId=>1, fieldId=>1,
test=>1|0)}Wiki text{TRACKERITEMFIELD}
Exists also a smarty block version
List wiki pages. Some option can work only in
listpages 2007.03.13 1.1 GNU/LGPL
1.10
In wiki syntax type {MOUSEOVER(text="how
mouseover 2007.03.29 1.1 GNU/LGPL
are you")}Hello{MOUSEOVER}

6.3.2. Mods Type Avatars

Related pages
• User Preferences (Pick user Avatar)

6.3.2.1. Mod dragonballz

This mod installs a Collection of 31 avatars from the Dragon Ball Z (tm) serie.

Install
See Mods Admin for instructions on how to install a Mod.

Back to TOC 841

 Usage

Once installed, you will see these avatars under "My Tiki > Preferences > Personal Information >
Avatar > Pick user avatar" (tiki-pick_avatar.php).

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.2.2. Mod gnumes

This mod installs a Collection of 16 avatars from the Gnumes collection

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see these avatars under "My Tiki > Preferences > Personal Information >
Avatar > Pick user avatar" (tiki-pick_avatar.php).

Related pages
• Mods
• Mods User

842 Back to TOC

 Tikiwiki Documentation 1.9+

• Mods Admin
• Mods Details
• Mods List

6.3.2.3. Mod goldorak

This mod installs a Collection of 19 avatars from Goldorak (tm) serie.

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see these avatars under "My Tiki > Preferences > Personal Information >
Avatar > Pick user avatar" (tiki-pick_avatar.php).

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.2.4. Mod mcdonald

This mod installs a Collection of 19 avatars from McDonald (tm).

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see these avatars under "My Tiki > Preferences > Personal Information >

Back to TOC 843

Avatar > Pick user avatar" (tiki-pick_avatar.php).

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.2.5. Mod xmen

This mod installs a Collection of 46 avatars from the Xmen (tm) serie.

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see these avatars under "My Tiki > Preferences > Personal Information >
Avatar > Pick user avatar" (tiki-pick_avatar.php).

844 Back to TOC

 Tikiwiki Documentation 1.9+

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.2.6. Mod all avatars

This is a meta package containing all avatars package.

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see these avatars under "My Tiki > Preferences > Personal Information >
Avatar > Pick user avatar" (tiki-pick_avatar.php).

You will all the avatars provided by:

• Mod dragonballz
• Mod gnumes
• Mod goldorak
• Mod mcdonald

Back to TOC 845

 • Mod xmen

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.3. Mods Type Features

Related pages
• Features

6.3.3.1. Mod aulawiki

Aulawiki is a Mod for Tiki 1.9+, which includes some features specially designed for educational
scenarios (grade book, academic periods, ...), plus the core feature of Workspaces (suitable for
educational scenarios and many many others).

Thus, the work spaces (Tiki Workspaces), represent one of the main functionalities of AulaWiki.
This functionality offers collaborative contexts to user groups of Tiki and can be applied to different
processes. The workspaces can be courses, personal management of projects, portfolios, projects for
team work, …

Workspaces allow the easy creation of new resources, groups + permissions and modules assigned,
based on workspace templates (called "workspace types"), which have

1. some pre-assigned resources,

2. some pre-defined roles (groups) which serve to define the permissions to be applied by
default to the resources at resource creation time.
3. some pre-assigned modules for the workspace desktop

846 Back to TOC

 Tikiwiki Documentation 1.9+

Sample Workspace usage on edu.tw.o (join us! :-)

Once created from a "workspace type" template, you can keep customizing your specific workspace
to suite your needs.

Structures can also be printed in whole directly from the structure toc from the module workspaces
structures (see a live example below, in the structure of the workspaces documentation at
http://edu.tikiwiki.org/tiki-workspaces_view_structure.php?print=4.

Moreover, some exciting new features were introduced in the latest versions of Aulawiki mod,
which comprise copy & paste capability of resources from one workspace to another, through the
usage of the workspace module clipboard.

Install
See Mods Admin for instructions on how to install a Mod.

Usage
See more information about Aulawiki Mod and the Workspaces feature at: http://edu.tikiwiki.org
Documentation of AulaWiki and Workspaces
Language Page by page All in one page
English AulaWiki-Tutorial http://edu.tikiwiki.org/tiki-workspaces_view_structure.php?print=4
Spanish AulaWiki-Tutorial,es ( pdf ) http://edu.tikiwiki.org/tiki-workspaces_view_structure.php?print=15
Catalan AulaWiki-Tutorial,ca http://edu.tikiwiki.org/tiki-workspaces_view_structure.php?print=26

Related pages
• Mods
• Mods User

Back to TOC 847

 • Mods Admin
• Mods Details
• Mods List
http://edu.tikiwiki.org/tiki-workspaces_desktop.php?workspaceId=2&moduleId=35

6.3.3.2. Mod cartoweb

This is a stub

6.3.3.3. Mod cc (Community Currencies)

You can get it when you install the "CC" Mod (Community Currencies) in a Tiki site (how to
install Mods in Tiki? ).

With this feature you can perform some basic actions to support the community currencies system:
.
''General menu of ''Initial help screen of the "Community Currencies''
Community system
Currencies in a a
Tiki''

848 Back to TOC

 Tikiwiki Documentation 1.9+

''List of all existing currencies in the system''

''List of all personal currencies''

''List of all transactions in the system''

Back to TOC 849

 ''List of my transactions''

''Creating a new currency''

''Record a new transaction performed''

850 Back to TOC

 Tikiwiki Documentation 1.9+

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

• http://cc.tikiwiki.org/Mod+Community+Currencies

6.3.3.4. Mod import-phpwiki

PhpWiki is a wiki engine written in PHP. The first version, by Steve Wainstead, was in December
1999 and was the first Wiki written in PHP to be publicly released. See phpwiki for more details.

Install
See Mods Admin for instructions on how to install a Mod.

However, this mod is currently (July 2007) not well packed under mods.tikiwiki.org, and you need
to fetch it from sf.net cvs area:
http://tikiwiki.cvs.sourceforge.net/tikiwiki/_mods/features/import-phpwiki/tikiroot/

You need tiki-import_phpwiki.php set in your tiki root directory, and tiki-import_phpwiki.tpl
under your templates directory.

Usage
Once installed, you will see a new option at "Admin > Import PHPWiki Dump"

Have you installed it? Could you help us improve this documentation with your report on how you
made it work? (and some screenshot of the output after import would be welcome)

Related pages
• Mods
• Mods User

Back to TOC 851

 • Mods Admin
• Mods Details
• Mods List

• http://www.phpwiki.org/
• http://en.wikipedia.org/wiki/Phpwiki

6.3.3.5. Mod kamap

This is a stub

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.3.6. Mod mapeditor

This is a stub

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.3.7. Mod phpcas

phpCAS documentation can be found at http://esup-phpcas.sourceforge.net

This is a stub. This module is currently no installing.
See bug report:
http://dev.tikiwiki.org/tiki-view_tracker_item.php?itemId=1229&trackerId=5

Install
See Mods Admin for instructions on how to install a Mod.

852 Back to TOC

 Tikiwiki Documentation 1.9+

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

• http://esup-phpcas.sourceforge.net

6.3.3.8. Mod solve

Solve is a Tiki Helpdesk/CRM portal, using vtiger CRM, a 100% Open Source Customer
Relationship Management solution built over LAMP/WAMP stack and other third-party open
source packages. See more information in http://vtiger.com/

Back to TOC 853

 Install
See Mods Admin for instructions on how to install a Mod.

Configuration
After you click on install, you have to provide the settings required in the configuration screen:

Usage
Once installed, you will see ...
help needed

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.3.9. Mod tikidav

This is a stub

TikiDav allow access to the TikiWiki resources ( wiki pages, blogs, Articles...) through the
WebDav protocol. A lot of author tools like OpenOffice and M$Office, implements that protocol to
access remote document repositories.

854 Back to TOC

 Tikiwiki Documentation 1.9+

http://www.escire.com/escire2/tiki-index.php?page=WDAVE1-Videos : A flash video and more

info of using TikiDav at eScire.com

TikiDav features
• Tiki Categories as repository folder structure
• Wiki pages,Blogs, and Articles as files in the repository
• Locking of Tiki resources (different from wiki pages locks)
• User access control to the webdav operations and information (Categories and wikipages)
• Properties for Tiki resources
• Read-only access to user calendar (csv format)
• Wiki-to-DocBook and DocBook-to-Wiki conversion
• Wiki-to-OpenOffice and OpenOffice-to-Wiki (WYSIWYG) conversion (OpenOffice 1.x
only)

Access to TikiDav at edu.tiki.org

You can test TikiDav at edu.tw.o site, using a webdav client. For instance, you can use
OpenOffice.org 1.0x.

URL to access:
http://edu.tikiwiki.org/tikidav.php/

a TikiDavTestPage can be found at /development category.

See more information at http://tikiwiki.org/TikiDavDev

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.3.10. Mod tinvoice

Tinvoice mod intend to add invoice management and generation to Tikiwiki.

It's under heavy development currently (summer 2007), and it requires Tiki 1.10, php5 and ajax.

Install
See Mods Admin for instructions on how to install a Mod.

Back to TOC 855

 Usage
Not ready for production yet.

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.3.11. Mod userprefstats

This module reports simple stats for User preferences.

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you have to write this url in the browser: http://yourdomain/stats.php, to see
something like:

Then, you can click to any of the options listed (Countries, Languages, Timezones and Themes) to
see the preferences of the tiki users on this site.

Countries

856 Back to TOC

 Tikiwiki Documentation 1.9+

Languages

Timezones

Themes

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.4. Mods Type Lib

Related pages
• Hacking Tikiwiki
• Mods

6.3.4.1. Mod fpdf

This is a stub

Related pages

Back to TOC 857

 • Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.4.2. Mod fpdf_bitstreamvera

This is a stub

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.4.3. Mod fpdf_freefonts

This is a stub

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.4.4. Mod jpgraph

This is a stub

JpGraph - PHP Graph Creating Library

JpGraph is a Object-Oriented Graph creating library for PHP >= 4.3.1 The library is completely
written in PHP and ready to be used in any PHP scripts ...

See http://www.aditus.nu/jpgraph/ for more information on jpgraph.

Related pages

858 Back to TOC

 Tikiwiki Documentation 1.9+

• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.4.5. Mod nusoap

This is a stub

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.4.6. Mod vtiger

This is a stub

6.3.5. Mods Type Menus

Related pages
• Menus
• Modules
• Mods

6.3.5.1. Mod tikiring

tikiring is the menu including all tiki sites. hardstamped to menuId=41....

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see it under "Admin > Menus":

Back to TOC 859

Then you can assign a new Module to a column, for instance, and include this menu inside (See
Module Admin page if needed).

Then you will be able to see this module:

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.6. Mods Type Modules

Related pages
• Modules
• Mods

6.3.6.1. Mod blogroll

The Mod blogroll install s a module, that takes an OPML-file from your file-gallery and renders it
as a blogroll. OPML (Outline Processor Markup Language) is an XML format for outlines.
Originally developed by Radio UserLand as a native file format for an outliner application, it has
since been adopted for other uses, the most common being to exchange lists of web feeds between

860 Back to TOC

 Tikiwiki Documentation 1.9+

web feed aggregators. The OPML specification defines an outline as a hierarchical, ordered list of
arbitrary elements. The specification is fairly open which makes it suitable for many types of list
data. For more information, see http://en.wikipedia.org/wiki/OPML .

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see it under ""Admin > Modules > Assign new module > Module Name
(drop down)" (tiki-admin_modules.php):

You can assign a this Module to a lateral column (See Module Admin page if needed), or you can
include it within a wiki page, using the PluginModule. This module requires to add the parameter
fileId=X, being X the number of the Id of the file in the file gallery.

For instance, lets assume that I upload an example opml file (see below) as file 1 in the file gallery:
you need to add "filedId=1" at the parameters field. The assign module screen would look like:

The content of that file (http://static.userland.com/gems/radiodiscuss/playlist.opml ) is:

<?xml version="1.0" encoding="ISO-8859-1"?>

<opml version="1.0">
<head>
<title>playlist.xml</title>
<dateCreated>Thu, 27 Jul 2000 03:24:18 GMT</dateCreated>
<dateModified>Fri, 15 Sep 2000 09:01:23 GMT</dateModified>
<ownerName>Dave Winer</ownerName>
<ownerEmail>[email protected]</ownerEmail>
<expansionState>1,3,17</expansionState>
<vertScrollState>1</vertScrollState>
<windowTop>164</windowTop>
<windowLeft>50</windowLeft>
<windowBottom>672</windowBottom>
<windowRight>455</windowRight>
</head>
<body>
<outline text="Background">
<outline text="I've started to note the songs I was listening to as I was writing DaveNet pieces. "/>
</outline>
<outline text="The Last Napster Sunday?">
<outline text="Heart of Glass.mp3" type="song" f="Blondie - Heart of Glass.mp3"/>
<outline text="Manic Monday.mp3" type="song" f="Bangles - Manic Monday.mp3"/>

Back to TOC 861

<outline text="Everybody Have Fun Tonight.mp3" type="song" f="Wang Chung - Everybody Have Fun
Tonight.mp3"/>
<outline text="She Blinded Me With Science.mp3" type="song" f="Thomas Dolby - She Blinded Me With
Science.mp3"/>
<outline text="Rivers of Babylon (HTC).mp3" type="song" f="Jimmy Cliff - Rivers of Babylon (HTC).mp3"/>
<outline text="The Tide Is High.mp3" type="song" f="Blondie - The Tide Is High.mp3"/>
<outline text="Back to the Island.mp3" type="song" f="Leon Russell - Back to the Island.mp3"/>
<outline text="Lucky Man.mp3" type="song" f="Emerson Lake &amp; Palmer - Lucky Man.mp3"/>
<outline text="Up on Cripple Creek.mp3" type="song" f="The Band - Up on Cripple Creek.mp3"/>
<outline text="Crackerbox Palace.mp3" type="song" f="George Harrison - Crackerbox Palace.mp3"/>
<outline text="Taxi.Mp3" type="song" f="Harry Chapin - Taxi.Mp3"/>
<outline text="Thick As A Brick.mp3" type="song" f="Jethro Tull-Thick As A Brick.mp3"/>
<outline text="Riding With the King.mp3" type="song" f="B. B. King &amp; Eric Clapton - Riding With the King - 11
- Hold On Im Coming.mp3"/>
</outline>
<outline text="The Thrill is Gone?">
<outline text="Shaft.MP3" type="song" f="Isaac Hayes - Shaft.MP3"/>
<outline text="Superfly.mp3" type="song" f="Curtis Mayfield -- Superfly.mp3"/>
<outline text="Rivers of Babylon (HTC).mp3" type="song" f="Jimmy Cliff - Rivers of Babylon (HTC).mp3"/>
<outline text="The Harder They Come.mp3" type="song" f="Jimmy Cliff - The Harder They Come.mp3"/>
<outline text="The Revolution Will Not Be Televised.mp3" type="song" f="Gil Scott Heron - The Revolution Will Not
Be Televised.mp3"/>
<outline text="The Thrill Is Gone.mp3" type="song" f="BB King - The Thrill Is Gone.mp3"/>
<outline text="Hit Me with Your Rhythm Stick.mp3" type="song" f="Ian Drury &amp; the Blockheads - Hit Me with
Your Rhythm Stick.mp3"/>
</outline>
</body>
</opml>

The assigned module looks like this:

862 Back to TOC

 Tikiwiki Documentation 1.9+

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Type modules

• Modules Admin
• http://en.wikipedia.org/wiki/OPML

6.3.6.2. Mod calculator

calculator is a Kewl little calculator for your right or left column within TikiWiki

Install
See Mods Admin for instructions on how to install a Mod. This mod is called calc

Usage
Once installed, you will see it under "Admin > Modules" (tiki-admin_modules.php):

You can assign a this Module to a lateral column (See Module Admin page if needed), or you can
include it within a wiki page, using the PluginModule.

The assigned module looks like this:

And you can compute simple mathematical operation with it.

Related pages
• Module
• Module User
• Module Admin
• Module Details

• Mods Type Modules

• Mod extcalculator

Back to TOC 863

 6.3.6.3. Mod clock

Mod clock is a very neat borderless module holding a ticking clock.

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see it under "Admin > Modules" (tiki-admin_modules.php):

You can assign a this Module to a lateral column (See Module Admin page if needed), or you can
include it within a wiki page, using the PluginModule.

The assigned module looks like this:

And if you click on the button with the time, you will get some message like this:

See Mod worldclock to get another type of clock on you tiki site.
Related pages
• Module
• Module User
• Module Admin
• Module Details

• Mods Type Modules

• Mod worldclock

6.3.6.4. Mod extcalculator

Extcalculator is a kewl little calculator for your right or left column within TikiWiki.

Install
See Mods Admin for instructions on how to install a Mod. This mods is called extcalc

864 Back to TOC

 Tikiwiki Documentation 1.9+

Usage
Once installed, you will see it under "Admin > Modules" (tiki-admin_modules.php):

You can assign a this Module to a lateral column (See Module Admin page if needed), or you can
include it within a wiki page, using the PluginModule.

The assigned module looks like this:

And you can compute simple mathematical operation with it.

help By the time of this writing (July 2007) the mod didn't show completely under many theme
styles (last column of buttons on the right was hidden by dentral column in Tiki.

not fully shown

Screenshot of complete module extcalc was taken with simple.css theme style.

Related pages
• Module
• Module User
• Module Admin
• Module Details

Back to TOC 865

 • Mods Type Modules
• Mod calculator

6.3.6.5. Mod join

join box is a simple "join now".

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see it under "Admin > Modules" (tiki-admin_modules.php):

You can assign a this Module to a lateral column (See Module Admin page if needed), or you can
include it within a wiki page, using the PluginModule.

The assigned module looks like this:

Related pages
• Module
• Module User
• Module Admin
• Module Details

• Mods Type Modules

6.3.6.6. Mod plazes

help. The PLAZES plugin seem to be outdated and currently not working anymore on current
www.plazes.com . PLAZESWHEREIS seems to work (Xavi)

866 Back to TOC

 Tikiwiki Documentation 1.9+

Plazes is a web site that will allow you to:

• Share where you are right now and what you are doing there
• Let others know where you will be later today, tomorrow or next week
• Stay on top of your friends' activities and plans
• Update your activities and plans on-the-go with Plazes Text Messaging
• Join a Plazes Group to stay connected with your favorite people and Plazes - or, better yet,
create one of your own

This plug is used with www.plazes.com to show your current connection location.

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see some new lines under the Wiki "edit > wiki help > Show Plugins
Help":

Displays your Plazes info:

{PLAZES(key=your_plazes_key,map=>1 or 0)/}

and
PLAZESWHEREIS Displays your Plazes WhereIs page:
{PLAZESWHEREIS(name=your_name)/}

You'll need an account on plazes and to be running the Desktop Launcher for it to work correctly.

For plazes plugin, you will need your plazes Key, and option map = 0 / 1 to show your location map
or not.
For plazeswhereis, you will need you plazes name.

Example

Displays your Plazes info:

Back to TOC 867

{PLAZESWHEREIS(name=xavi)/}

Would produce:
Whereis xavi
Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.6.7. Mod worldclock

worldclock is a World Clock for a module.

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see it under "Admin > Modules" (tiki-admin_modules.php):

You can assign a this Module to a lateral column (See Module Admin page if needed), or you can
include it within a wiki page, using the PluginModule.

The assigned module looks like this:

By default it shows your local time. but you can change it to the time of any country from the drop
down list (shifted to Argentina time two minutes after the previous image was taken):

868 Back to TOC

 Tikiwiki Documentation 1.9+

See also the Mod clock, which is much smaller.

Related pages
• Module
• Module User
• Module Admin
• Module Details

• Mods Type Modules

• Mod clock

6.3.7. Mods Type Services

Related pages
• Mods

6.3.7.1. Mod mailman

Mailman is free software for managing electronic mail discussion and e-newsletter lists. Mailman
is integrated with the web, making it easy for users to manage their accounts and for list owners to
administer their lists. Mailman supports built-in archiving, automatic bounce processing, content
filtering, digest delivery, spam filters, and more. See its features page for more details
(http://www.gnu.org/software/mailman/features.html )

Back to TOC 869

 Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see ...
help and screenshots needed

Example
help and screenshots needed

Would produce:

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.8. Mods Type SQL

Related pages
• Upgrade
• Mods

870 Back to TOC

 Tikiwiki Documentation 1.9+

6.3.8.1. Mod upgrade_1.7to1.8

6.3.8.2. Mod upgrade_1.8to1.9

6.3.8.3. Mod upgrade_1.9to1.9.1

6.3.9. Mods Type Taglines

Taglines are like Fortune Cookies: you can enter taglines or upload from a textfile, the "When just a
wiki is not enough..." syntax can be used to display a random cookie in articles, posts, wiki
pages,etc or any template.

From here:
• Mod damian1
• Mod damian2
• Mod rcogley

• Cookie (taglines)

6.3.9.1. Mod damian1

This mod installs a collection of taglines (Cookies).

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see 526 new taglines inserted under "Admin > Cookies" (tiki-
admin_cookies.php):

Back to TOC 871

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

• Cookie
• Mods Type Taglines

6.3.9.2. Mod damian2

This mod installs a collection of taglines (Cookies).

Install
See Mods Admin for instructions on how to install a Mod.

872 Back to TOC

 Tikiwiki Documentation 1.9+

Usage
Once installed, you will see 100 new taglines inserted under "Admin > Cookies" (tiki-
admin_cookies.php):

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

• Cookie
• Mods Type Taglines

6.3.9.3. Mod rcogley

This mod installs a collection of taglines from TikiWiki Developer R.Cogley

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see 739new taglines inserted under "Admin > Cookies" (tiki-
admin_cookies.php):

Back to TOC 873

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

• Cookie
• Mods Type Taglines

6.3.10. Mods Type Themes

These mods will install new themes on you tiki site.

Alternatively, you install themes by hand from http://themes.tikiwiki.org . See Styles and Themes
for more information.
Related pages

• Styles and Themes

• Mods

874 Back to TOC

 Tikiwiki Documentation 1.9+

6.3.11. Mods Type Wikiplugins

Related pages
• Plugins
• Mods

6.3.11.1. Mod ebay

This is a stub

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.11.2. Mod flowplayer

This is a stub

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.11.3. Mod formula

This is a stub

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

Back to TOC 875

 6.3.11.4. Mod galaxia_sweet_ui

This is a stub

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.11.5. Mod group

This is a stub

6.3.11.6. Mod js

js stands for javascript. This mod install the plugin JS, which inserts a javascript file and/or some
javascript code in a wiki page. See PluginJS for more details.

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.11.7. Mod listpages

This is a stub

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

876 Back to TOC

 Tikiwiki Documentation 1.9+

6.3.11.8. Mod mindmap

This mod install the plugin mindmap. See PluginMindmap for more details.

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.11.9. Mod mouseover

This mod installs the plugin Mouseover in your Tiki. See the PluginMouseover for more details.
Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.11.10. Mod perm

This is a stub

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.11.11. Mod phplot

PHPlot is a PHP class for on the fly graphs generation. It was started by Afan Ottenheimer in 1998
as an opensource project, and is now co-developed with Miguel de Benito thanks to sourceforge. It
is distributed under the terms of the GNU General Public License, and the PHP license. For further
information, please check their website: http://www.phplot.com/
.

Back to TOC 877

Example line graph with labels, legend and left Example 3d pie chart
and lower axis titles
Examples from http://www.phplot.com/doc/

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see some new lines under the Wiki "edit > wiki help > Show Plugins
Help":
Plots a graph on the data using PHPlot:
{PHPLOT(which_data_type=>text-linear|linear-linear|function|linear-linear-error,
which_plot_type=>bars|lines|pie|linepoints|points|area)}cells{PHPLOT} - cells separated by ~|~

However, the code itself contains a more detailed description of parameters:

help needed to identify which parameters are usable

// This plugin plots a graph of the input data using PHPLOT's create_chart.php
example script.
//
// Parameters:
// head -- the column header row
//
// Usage:
// The data (and the head paramter) is given one row per line, with columns
// separated by ~|~.
//
// Parameters:
//
// Mandatory:
// XSIZE_in=size x of the graph
// YSIZE_in=size y of the graph
// which_data_type=text-linear|linear-linear|function|linear-linear-error
// datarowM[N]=data on cell[M,N]
// which_plot_type=bars|lines|pie|linepoints|points|area
//
// Optional:

878 Back to TOC

 Tikiwiki Documentation 1.9+

// which_dot=diamond|rect|circle|triangle|dot|line|halfline
// maxy_in=max height of graph in units of Y axis
// miny_in=min height of graph in units of Y axis
// ylbl=Y axis label
// xlbl=X axis label
// title=graph title
// which_vti=vertical tick increment
// which_hti=horizontal tick increment
// which_xap=x axis position
//
// {PHPLOT( head => header column 1 ~|~ header column 2 ~|~ header column 3 )}
// row 1 column 1 ~|~ row 1 column 2 ~|~ row 1 column 3
// row 2 column 1 ~|~ row 2 column 2 ~|~ row 2 column 3
// {PHPLOT}

Example 1: data type text-linear, plot type bars

This code:

{PHPLOT(which_data_type=>text-linear,which_plot_type=>bars, head=>header_column_1~|
~header_column_2~|~header_column_3)}
a~|~0~|~0~|~0
b~|~1~|~2~|~3
c~|~5~|~6~|~7
d~|~11~|~12~|~13
e~|~8~|~7~|~6{PHPLOT}

Would produce:

Back to TOC 879

 Example 2: data type text-linear, plot type lines
This code:

{PHPLOT(which_data_type=>text-linear,which_plot_type=>lines, head=>header_column_1~|
~header_column_2~|~header_column_3)}
a~|~0~|~0~|~0
b~|~1~|~2~|~3
c~|~5~|~6~|~7
d~|~11~|~12~|~13
e~|~8~|~7~|~6{PHPLOT}

Would produce:

880 Back to TOC

 Tikiwiki Documentation 1.9+

Example 3: data type linear-linear, plot type lines

This code:

{PHPLOT(which_data_type=>linear-linear,which_plot_type=>lines)}
a~|~0~|~0~|~0
b~|~1~|~2~|~3
c~|~5~|~6~|~7
d~|~11~|~12~|~13
e~|~8~|~7~|~6{PHPLOT}

Would produce:

Back to TOC 881

 Example 4: data type linear-linear, plot type linepoints
This code:

{PHPLOT(which_data_type=>linear-linear,which_plot_type=>linepoints)}
a~|~0~|~0~|~0
b~|~1~|~2~|~3
c~|~5~|~6~|~7
d~|~11~|~12~|~13
e~|~8~|~7~|~6{PHPLOT}

Would produce:

882 Back to TOC

 Tikiwiki Documentation 1.9+

Example 5: : data type text-linear, plot type pie

This code:

{PHPLOT(which_data_type=>text-linear,which_plot_type=>pie)}
a~|~0~|~0~|~0
b~|~1~|~2~|~3
c~|~5~|~6~|~7
d~|~11~|~12~|~13
e~|~8~|~7~|~6{PHPLOT}

Would produce:

Back to TOC 883

 Example 6: : data type function, plot type linepoints
This code:

{PHPLOT(which_data_type=>function,which_plot_type=>linepoints)}
a~|~0~|~0~|~0
b~|~1~|~2~|~3
c~|~5~|~6~|~7
d~|~11~|~12~|~13
e~|~8~|~7~|~6{PHPLOT}

Would produce:

884 Back to TOC

 Tikiwiki Documentation 1.9+

Example 7: : data type linear-linear, plot type points

This code:

{PHPLOT(which_data_type=>linear-linear,which_plot_type=>points)}
a~|~0~|~0~|~0
b~|~1~|~2~|~3
c~|~5~|~6~|~7
d~|~11~|~12~|~13
e~|~8~|~7~|~6{PHPLOT}

Would produce:

Back to TOC 885

 Example 8: : data type linear-linear, plot type area
This code:

{PHPLOT(which_data_type=>linear-linear,which_plot_type=>area)}
a~|~0~|~0~|~0
b~|~1~|~2~|~3
c~|~5~|~6~|~7
d~|~11~|~12~|~13
e~|~8~|~7~|~6{PHPLOT}

Would produce:

886 Back to TOC

 Tikiwiki Documentation 1.9+

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

• PHPlot: http://www.phplot.com/

6.3.11.12. Mod plazes

6.3.11.13. Redirect

In general IT vocabulary, a redirect automatically relays a user from one location (URL) to another
for some reason, typically because the document has been moved.

Tikiwiki as of Tikiwiki 1.10? has a plugin called the PluginRedirect which currently redirects users
from one internal page to another.

A version of this redirect which can include an internal link would assist Tikiwiki Documentation?
project greatly, since it would prevent users from using and editing old doc pages in Tikiwiki.org.

Back to TOC 887

Tikiwiki's Manual of Style? contains rules for using redirects in doc.tikiwiki.org.

Mod redirect
This mods installs the Plugin Redirect. See PluginRedirect for more information.
Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.11.14. Mod scroll

Scroll allows a user to ...

This is a stub. help needed

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see some new lines under the Wiki "Edit > Wiki help > Plugins help":
Scroll:
{SCROLL(width=> height=> speed=> left=> top=>)}text{SCROLL}

Example
{SCROLL(width=>"100px", height=>"10px", speed=>, left=>"2px", top=>"2px" )}
See this list of items:
# Item
# Item
# Item
# Item
# Item
# Item
# Item
# Item
# Item
# ...
{SCROLL}

888 Back to TOC

 Tikiwiki Documentation 1.9+

Would produce:

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.11.15. Mod svg

svg is a type of vectorial image. You can produce your own svg images or drawings through
multiplatform free software programs like Inkscape.

And you can get plenty of public domain svg's image files from http://openclipart.org

Install
See Mods Admin for instructions on how to install a Mod.

Usage
Once installed, you will see some new lines under the Wiki "edit > wiki help > Show Plugins
Help":

Svg:
{SVG(width=, height=, src=> )}text{SVG}

Params width and height are mandatory. If size from those parameters is smaller than size of
original svg, some scroll bars will show up to help the user move around the whole image within
that small frame sized from specified parameters.

Example

{SVG(width="400px", height="400px",
src=>http://openclipart.org/people/gopher/gopher_Redhead_anime_girl.svg )}text{SVG}

Back to TOC 889

Would produce:

However, if your give smaller size for width or height parameters than the svg size, (for instance,
width="250px", height="250px"), only a portion of the whole image would be seen by default on
the page:

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

890 Back to TOC

 Tikiwiki Documentation 1.9+

6.3.11.16. Mod trackeritemfield

This is a stub

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.11.17. Mod wikigraph

This is a stub

It makes a graph with all the linked pages from your page.

Example:

Related pages
• Mods

Back to TOC 891

 • Mods User
• Mods Admin
• Mods Details
• Mods List

6.3.11.18. Mod xspf_player

This is a stub

Related pages
• Mods
• Mods User
• Mods Admin
• Mods Details
• Mods List

892 Back to TOC

 Tikiwiki Documentation 1.9+

6.4. Third Party code

6.4.1. Smarty

6.4.2. Adodb

6.4.3. SmartIrc

6.4.4. Wollabot

6.4.5. Mapserver
The mapserver is an application that has been originaly designed by the University of Minnesota,
but is now maintained by many contributors. The university still holds the web site: http://
mapserver.gis.umn.edu/ .

Recently the mapserver has been exporting functions and methods to other languages. This
extension is calle d Mapscript. Mapscript can be linked to perl, python, java and php.

TikiWiki can use the mapscript module to display and manage maps? and become a Geospastial
Content Management System (GeoCMS).

Geographic image galleries, user preferences (latitude/longitude) are some features that can take
advantage of the maps?

6.4.6. SpellChecker

Back to TOC 893

6.5. Download using CVS
2 methods to connect
Anonymous access
export
CVSROOT=":pserver:[email protected]:/cvsroot/tikiwiki"
cvs login
#type enter

Developer Account
export CVS_RSH=ssh
export CVSROOT=":ext:[email protected]:/cvsroot/tikiwiki"

(You can create your developer account here )

Choose the proper branch

get HEAD: the future 1.10
cvs -z3 co tikiwiki

or the 1.9.x branch

cvs -z3 co -r BRANCH-1-9 tikiwiki

Keeping up to date
update HEAD: the future 1.10
cvs -q up -dP

or the 1.9.x branch

cvs -q up -dP -r BRANCH-1-9

Committing code
before you commit
cvs diff

894 Back to TOC

 Tikiwiki Documentation 1.9+

when you are ready

cvs commit -m "message for commit log" nameoffile.php template/nameoffile.tpl

If you plan on editing from Windows, of course the setup will be more complicated. You need some
apache / mysql / php bundle (xampp or wamp5 or other) to debug, and you need an ssh client and
CVS client (putty with tortoiseCVS is documented at sourceforge ). Also, when you're using a
graphical client, ignore the bewildering array of modules (only tikiwiki matters to you) and
branches (only HEAD and the latest version branch, currently BRANCH-1-9, matter; if you plan on
doing merges, please talk to someone.)

Some more detailed information on how to download latest version of mods through cvs, for
instance, can be found at: http://tikiwiki.org/TikiCVSHowTo

Pre-release tarballs

Some pre-release tarballs are available from the CVS version (updated every 6 hours):
• Future 1.9.x (BRANCH-1-9) : http://de.tikiwiki.org/tar/lastiki_BRANCH-1-9.zip
• Future 1.10 (Head) : http://de.tikiwiki.org/tar/lastiki_HEAD.zip

Back to TOC 895

6.6. History

6.6.1. Changelog 1.9

1 Tikiwiki Changelog
2 ------------------
3
4 Changelog is now generated by cvs2cl.pl
5 http://cvsbook.red-bean.com/cvsbook.html#cvs2cl%20--%20Generate%20GNU-
Style%20ChangeLogs
6 This script lists chronologically the comments made with cvs commits.
7 For example, for 1.9.7 : cvs2cl -F BRANCH-1-9 --delta REL-1-9-6:BRANCH-1-9
8 produces a file named Changelog, then in vim :%s/\n\(\s*\*\)/\1/
9
10 Use the following tags to distinguish changes :
11 * [NEW] apply if something new was added in tikiwiki
12 * [MOD] is an enhancement; not really new but makes things work better
13 * [FIX] can be used for bug fixes of any sort
14 * [SEC] for security fix operations
15 * [REL] changes for release process only
16 * [KIL] removal of unused or obsolete files
17 * -[DB] for changes in the database
18 when possible, it's also nice to indicate what feature is concerned by
19 the change.
20
21
22 ----------------------------------------------------------------------
23 Version 1.9.7
24 <http://tikiwiki.org/ReleaseProcess197>
25 ------------------
26
27 2006-11-25 15:58 mose
28 * db/tiki-secdb_1.9_mysql.sql: [REL] updated secdb
29
30 2006-11-25 15:41 mose
31 * styles/tikineat.css: [FIX] jscalendar: fixed style for better
32 display of the button
33
34 2006-11-25 15:32 mose
35 * templates/tiki-view_tracker.tpl: [FIX] trackers: backported fixes
36 for jscalendar display
37
38 2006-11-23 22:56 marclaporte
39 * templates/tiki-view_tracker_item.tpl: information (name, comment,
40 version and description) about files attached to trackers was not
41 visible in file listing
42
43 2006-11-23 14:33 sylvieg
44 * lang/fr/language.php: translation update
45
46 2006-11-23 02:23 franck
47 * tiki-list_articles.php, templates/tiki-list_articles.tpl: [MOD]
48 Can find articles by categories
49
50 2006-11-23 02:07 franck
51 * lib/: calendar/calendarlib.php,

896 Back to TOC

 Tikiwiki Documentation 1.9+

52 wiki-plugins/wikiplugin_events.php: [MOD] EVENTS wikiplugin to

53 use with tiki calendar
54
55 2006-11-23 02:02 franck
56 * lib/wiki-plugins/wikiplugin_rss.php: [MOD] multiple RSS in the
57 wikiplugin
58
59 2006-11-23 01:51 franck
60 * lib/wiki-plugins/wikiplugin_rss.php: [MOD] multiple RSS in the
61 wikiplugin
62
63 2006-11-22 03:13 lmoss
64 * categorize_list.php: Show only categories for which the user has
65 permissions
66
67 2006-11-21 16:56 marclaporte
68 * templates/tiki-browse_gallery.tpl: [FIX] correct the link to the
69 user information
70
71 2006-11-21 16:23 mose
72 * tiki-setup_base.php: [SEC] stronger protection against js
73 injection
74
75 2006-11-21 05:48 franck
76 * lib/wiki-plugins/wikiplugin_events.php: [FIX] events wikiplugin
77
78 2006-11-21 05:48 franck
79 * lib/wiki-plugins/wikiplugin_events.php: file
80 wikiplugin_events.php was added on branch BRANCH-1-9 on
81 2006-11-23 01:07:09 +0000
82
83 2006-11-21 00:52 franck
84 * lib/wiki-plugins/wikiplugin_events.php: [Feature]
85 Events(calendar) list wiki plugin
86
87 2006-11-20 08:46 josefgc
88 * lang/langmapping.php: Added gl language
89
90 2006-11-20 08:39 josefgc
91 * lang/gl/: index.php, language.php: Galician language files
92
93 2006-11-19 14:29 mose
94 * README, templates/tiki-top_bar.tpl,
95 templates/styles/neat/tiki-top_bar.tpl,
96 templates/styles/simple/tiki-top_bar.tpl: [MOD] incremented
97 version number
98
99 2006-11-19 13:03 mose
100 * styles/smartiki.css, templates/styles/smartiki/tiki.tpl: [MOD]
101 smartiki theme improvement
102
103 2006-11-16 14:56 mose
104 * tiki-setup_base.php: [SEC] more power even, for the javascript
105 shield
106
107 2006-11-15 20:40 sylvieg
108 * lib/userslib.php: [FIX]:user - rename user was missing
109 lastUserModif in tiki_files
110

Back to TOC 897

 111 2006-11-15 15:18 sylvieg
112 * tiki-setup.php, lib/userslib.php: [FIX]ldap: the stupid rename
113 was not done everywhere. DO NOT DO rename only for pretty reason
114 in 1.9
115
116 2006-11-15 12:08 mose
117 * tiki-setup_base.php: [SEC] strengthening javascript shield
118
119 2006-11-12 23:45 sylvieg
120 * lang/fr/language.php: rollback: please do not run get_strings if
121 you do not plan to translate
122
123 2006-11-12 18:28 sampaioprimo
124 * lang/: ar/language.php, ca/language.php, cn/language.php,
125 cs/language.php, da/language.php, de/language.php,
126 el/language.php, en/language.php, en-uk/language.php,
127 es/language.php, fi/language.php, fr/language.php,
128 he/language.php, hr/language.php, hu/language.php,
129 it/language.php, ja/language.php, ko/language.php,
130 nl/language.php, no/language.php, pl/language.php,
131 pt/language.php, pt-br/language.php, ru/language.php,
132 sb/language.php, sk/language.php, sr/language.php,
133 sr-latn/language.php, sv/language.php, tv/language.php,
134 tw/language.php, uk/language.php: update language.php files using
135 get_strings.php script
136
137 2006-11-12 00:09 sylvieg
138 * tiki-view_tracker.php: [FIX]tracker: field1 hidden, field2
139 mandatory, field3 madatory, save only with filed3 value. the
140 error pannel will put field3 value in field3 and not field2
141
142 2006-11-10 23:08 sylvieg
143 * tiki-import_tracker.php: [FIX]tracker: export perm is
144 tiki_p_admin_trackers and not tiki_p_admin
145
146 2006-11-10 17:27 sylvieg
147 * lib/tikilib.php: [FIX]perm: a tiki_p_admin can see all the
148 options of the menu even if assigned to another group
149
150 2006-11-10 04:06 mose
151 * tiki-register.php: [SEC] added a minimal check on email for new
152 registration, even if check is not requested in prefs, to avoid
153 notification-spam
154
155 2006-11-09 21:10 mose
156 * lib/pear/CMD.php: [KIL] removed unused file
157
158 2006-11-09 17:23 mose
159 * tiki-admin_include_intertiki.php,
160 templates/tiki-admin-include-intertiki.tpl: [FIX] admin panel was
161 not working properly, it should now (especially the
162 tiki_preferences checkbox)
163
164 2006-11-08 19:52 mose
165 * lib/tikilib.php, tiki-login.php: [FIX] enabled logins to accept @
166 even when using intertiki slave mode
167
168 2006-11-07 23:07 xavidp
169 * lang/ca/language.php: a few more strings translated

898 Back to TOC

 Tikiwiki Documentation 1.9+

170
171
172 ----------------------------------------------------------------------
173 Version 1.9.6
174 <http://tikiwiki.org/ReleaseProcess196>
175 ------------------
176
177 2006-11-06 02:36 mose
178 * styles/smartiki.css (BRANCH-1-9): minor style improvement
179
180 2006-11-05 18:27 mose
181 * tiki-setup_base.php (BRANCH-1-9): adapted filter for url var, as
182 url can be relative
183
184 2006-11-05 18:25 mose
185 * fixperms.sh (BRANCH-1-9): synced list of dirs with setup.sh
186
187 2006-11-05 10:32 mose
188 * tiki-setup_base.php (BRANCH-1-9): avoiding error when highlight
189 is an array (cannot happen)
190
191 2006-11-05 10:08 mose
192 * tiki-setup_base.php (BRANCH-1-9): better security against XSS
193
194 2006-11-03 15:34 sylvieg
195 * tiki-setup_base.php (BRANCH-1-9): username can be empty (come
196 from the admin login box)
197
198 2006-11-03 06:12 sampaioprimo
199 * templates/tiki-edit_help.tpl (BRANCH-1-9): the command ... page ...
200 should not be translated on wiki help
201
202 2006-11-02 19:37 sylvieg
203 * lib/tikidblib.php (BRANCH-1-9): do not reveal a part of the path
204 if error
205
206 2006-11-02 15:35 sylvieg
207 * messu-archive.php, messu-mailbox.php, messu-sent.php,
208 tiki-admin_banning.php, tiki-admin_calendars.php,
209 tiki-admin_categories.php, tiki-admin_chart_items.php,
210 tiki-admin_charts.php, tiki-admin_chat.php,
211 tiki-admin_content_templates.php, tiki-admin_cookies.php,
212 tiki-admin_drawings.php, tiki-admin_dsn.php,
213 tiki-admin_external_wikis.php, tiki-admin_forums.php,
214 tiki-admin_hotwords.php, tiki-admin_html_page_content.php,
215 tiki-admin_html_pages.php, tiki-admin_include_trackers.php,
216 tiki-admin_include_wikiatt.php, tiki-admin_menu_options.php,
217 tiki-admin_menus.php, tiki-admin_newsletter_subscriptions.php,
218 tiki-admin_newsletters.php, tiki-admin_notifications.php,
219 tiki-admin_polls.php, tiki-admin_quicktags.php,
220 tiki-admin_rssmodules.php, tiki-admin_shoutbox_words.php,
221 tiki-admin_structures.php, tiki-admin_survey_questions.php,
222 tiki-admin_surveys.php, tiki-admin_tracker_fields.php,
223 tiki-admin_trackers.php, tiki-admingroups.php,
224 tiki-adminusers.php, tiki-assignpermission.php,
225 tiki-assignuser.php, tiki-browse_categories.php,
226 tiki-browse_gallery.php, tiki-browse_image.php, tiki-charts.php,
227 tiki-directory_add_site.php, tiki-directory_admin_categories.php,
228 tiki-directory_admin_related.php, tiki-directory_admin_sites.php,

Back to TOC 899

 229 tiki-directory_browse.php, tiki-directory_ranking.php,
230 tiki-directory_search.php, tiki-directory_validate_sites.php,
231 tiki-edit_programmed_content.php, tiki-edit_question_options.php,
232 tiki-edit_quiz.php, tiki-edit_quiz_questions.php,
233 tiki-edit_quiz_results.php, tiki-eph.php, tiki-eph_admin.php,
234 tiki-faq_questions.php, tiki-file_galleries.php,
235 tiki-forum_queue.php, tiki-forums.php, tiki-forums_reported.php,
236 tiki-friends.php, tiki-g-admin_graph.php,
237 tiki-g-admin_processes.php, tiki-g-admin_roles.php,
238 tiki-g-monitor_activities.php, tiki-g-monitor_instances.php,
239 tiki-g-monitor_processes.php, tiki-g-monitor_workitems.php,
240 tiki-g-user_activities.php, tiki-g-user_instances.php,
241 tiki-g-user_processes.php, tiki-galleries.php,
242 tiki-lastchanges.php, tiki-list_articles.php,
243 tiki-list_banners.php, tiki-list_blogs.php, tiki-list_cache.php,
244 tiki-list_contents.php, tiki-list_faqs.php,
245 tiki-list_file_gallery.php, tiki-list_gallery.php,
246 tiki-list_posts.php, tiki-list_quizzes.php,
247 tiki-list_submissions.php, tiki-list_surveys.php,
248 tiki-list_trackers.php, tiki-list_users.php, tiki-listpages.php,
249 tiki-live_support_transcripts.php, tiki-minical.php,
250 tiki-my_tiki.php, tiki-newsletter_archives.php,
251 tiki-newsletters.php, tiki-newsreader_servers.php,
252 tiki-notepad_list.php, tiki-old_polls.php, tiki-orphan_pages.php,
253 tiki-quiz_stats.php, tiki-quiz_stats_quiz.php,
254 tiki-received_articles.php, tiki-received_pages.php,
255 tiki-referer_stats.php, tiki-search_stats.php,
256 tiki-send_newsletters.php, tiki-sheets.php, tiki-shoutbox.php,
257 tiki-survey_stats.php, tiki-survey_stats_survey.php,
258 tiki-syslog.php, tiki-theme_control.php,
259 tiki-theme_control_objects.php, tiki-userfiles.php,
260 tiki-usermenu.php, tiki-view_articles.php, tiki-view_blog.php,
261 tiki-view_faq.php, tiki-view_tracker.php,
262 tiki-view_tracker_item.php, tiki-webmail.php,
263 tiki-webmail_contacts.php (BRANCH-1-9): rollback - the url
264 doesn't be longer only to deal with error
265
266 2006-11-02 00:44 mose
267 * lib/wiki-plugins/wikiplugin_box.php (BRANCH-1-9): removed a extra
268 parsing unneeded in wikiplugin
269
270 2006-11-01 23:54 sylvieg
271 * messu-archive.php, messu-mailbox.php, messu-sent.php,
272 tiki-admin_banning.php, tiki-admin_calendars.php,
273 tiki-admin_categories.php, tiki-admin_chart_items.php,
274 tiki-admin_charts.php, tiki-admin_chat.php,
275 tiki-admin_content_templates.php, tiki-admin_cookies.php,
276 tiki-admin_drawings.php, tiki-admin_dsn.php,
277 tiki-admin_external_wikis.php, tiki-admin_forums.php,
278 tiki-admin_hotwords.php, tiki-admin_html_page_content.php,
279 tiki-admin_html_pages.php, tiki-admin_include_trackers.php,
280 tiki-admin_include_wikiatt.php, tiki-admin_menu_options.php,
281 tiki-admin_menus.php, tiki-admin_newsletter_subscriptions.php,
282 tiki-admin_newsletters.php, tiki-admin_notifications.php,
283 tiki-admin_polls.php, tiki-admin_quicktags.php,
284 tiki-admin_rssmodules.php, tiki-admin_shoutbox_words.php,
285 tiki-admin_structures.php, tiki-admin_survey_questions.php,
286 tiki-admin_surveys.php, tiki-admin_tracker_fields.php,
287 tiki-admin_trackers.php, tiki-admingroups.php,

900 Back to TOC

 Tikiwiki Documentation 1.9+

288 tiki-adminusers.php, tiki-assignpermission.php,

289 tiki-assignuser.php, tiki-browse_categories.php,
290 tiki-browse_gallery.php, tiki-browse_image.php, tiki-charts.php,
291 tiki-directory_add_site.php, tiki-directory_admin_categories.php,
292 tiki-directory_admin_related.php, tiki-directory_admin_sites.php,
293 tiki-directory_browse.php, tiki-directory_ranking.php,
294 tiki-directory_search.php, tiki-directory_validate_sites.php,
295 tiki-edit_programmed_content.php, tiki-edit_question_options.php,
296 tiki-edit_quiz.php, tiki-edit_quiz_questions.php,
297 tiki-edit_quiz_results.php, tiki-eph.php, tiki-eph_admin.php,
298 tiki-faq_questions.php, tiki-file_galleries.php,
299 tiki-forum_queue.php, tiki-forums.php, tiki-forums_reported.php,
300 tiki-friends.php, tiki-g-admin_graph.php,
301 tiki-g-admin_processes.php, tiki-g-admin_roles.php,
302 tiki-g-monitor_activities.php, tiki-g-monitor_instances.php,
303 tiki-g-monitor_processes.php, tiki-g-monitor_workitems.php,
304 tiki-g-user_activities.php, tiki-g-user_instances.php,
305 tiki-g-user_processes.php, tiki-galleries.php,
306 tiki-lastchanges.php, tiki-list_articles.php,
307 tiki-list_banners.php, tiki-list_blogs.php, tiki-list_cache.php,
308 tiki-list_contents.php, tiki-list_faqs.php,
309 tiki-list_file_gallery.php, tiki-list_gallery.php,
310 tiki-list_posts.php, tiki-list_quizzes.php,
311 tiki-list_submissions.php, tiki-list_surveys.php,
312 tiki-list_trackers.php, tiki-list_users.php, tiki-listpages.php,
313 tiki-live_support_transcripts.php, tiki-minical.php,
314 tiki-my_tiki.php, tiki-newsletter_archives.php,
315 tiki-newsletters.php, tiki-newsreader_servers.php,
316 tiki-notepad_list.php, tiki-old_polls.php, tiki-orphan_pages.php,
317 tiki-quiz_stats.php, tiki-quiz_stats_quiz.php,
318 tiki-received_articles.php, tiki-received_pages.php,
319 tiki-referer_stats.php, tiki-search_stats.php,
320 tiki-send_newsletters.php, tiki-sheets.php, tiki-shoutbox.php,
321 tiki-survey_stats.php, tiki-survey_stats_survey.php,
322 tiki-syslog.php, tiki-theme_control.php,
323 tiki-theme_control_objects.php, tiki-userfiles.php,
324 tiki-usermenu.php, tiki-view_articles.php, tiki-view_blog.php,
325 tiki-view_faq.php, tiki-view_tracker.php,
326 tiki-view_tracker_item.php, tiki-webmail.php,
327 tiki-webmail_contacts.php, db/tiki-1.9-mysql.sql,
328 db/tiki-1.9-oci8.sql, db/tiki-1.9-pgsql.sql,
329 db/tiki-1.9-sqlite.sql, db/tiki-1.9-sybase.sql, db/tiki.sql
330 (BRANCH-1-9): change isset to empty for sort_mode
331
332 2006-11-01 22:09 ohertel
333 * lib/tikidblib.php (BRANCH-1-9): [fix] removed debug code
334
335 2006-11-01 21:48 ohertel
336 * tiki-setup_base.php (BRANCH-1-9): [sec] type check improvement
337 (empty parameters), cleanup
338
339 2006-11-01 18:40 ohertel
340 * tiki-setup_base.php (BRANCH-1-9): [sec] security fix: fix for XSS
341 mentioned in
342 http://dev.tikiwiki.org/tiki-view_tracker_item.php?
trackerId=5&offset=0&sort_mode=lastModif_desc&itemId=927
343
344 2006-11-01 18:33 ohertel
345 * tiki-setup_base.php (BRANCH-1-9): [sec] security fix: let's have

Back to TOC 901

 346 at least 1 character for type checked variables, as empty
347 variables are typeless and we don't want them anyway. fixes
348 http://dev.tikiwiki.org/tiki-view_tracker_item.php?
trackerId=5&offset=0&sort_mode=lastModif_desc&itemId=927
349
350 2006-10-31 23:47 sampaioprimo
351 * lib/tikilib.php (BRANCH-1-9): [FIX] image uploaded from wiki
352 wasn't displayed if it has quote in the sintax and feature wiki
353 allow html = y
354
355 2006-10-31 22:36 marclaporte
356 * lang/fr/language.php (BRANCH-1-9): better expression
357
358 2006-10-31 01:02 marclaporte
359 * templates/tiki-admin-include-login.tpl (BRANCH-1-9): fix doc link
360
361 2006-10-30 21:43 xavidp
362 * lang/ca/language.php (BRANCH-1-9): a few more strings translated
363
364 2006-10-30 10:08 xavidp
365 * lib/smarty_tiki/function.menu.php (BRANCH-1-9): patched by jreyes
366 to allow longer menu names (workspaces)
367
368 2006-10-27 18:18 mose
369 * lib/wiki-plugins/wikiplugin_trackerlist.php (BRANCH-1-9): [FIX]
370 proper display of number of attachments in trackerlist wikiplugin
371
372 2006-10-25 16:22 sylvieg
373 * templates/tiki-list_file_gallery.tpl (BRANCH-1-9): some center
374 align
375
376 2006-10-24 23:45 sylvieg
377 * templates/tiki-list_file_gallery.tpl (BRANCH-1-9): split each
378 info in different columns to be able to sort each column
379
380 2006-10-23 17:08 sylvieg
381 * tiki-view_tracker.php (BRANCH-1-9): OOPs let a trace
382
383 2006-10-23 15:57 sylvieg
384 * tiki-view_tracker.php (BRANCH-1-9): a message if the trackerId is
385 set but incorrect
386
387 2006-10-23 15:54 sylvieg
388 * categorize_list.php (BRANCH-1-9): include categ only if feature
389 active
390
391 2006-10-23 15:53 sylvieg
392 * tiki-admin_trackers.php (BRANCH-1-9): trackers were badly
393 categorized and were shown if the categ gave no perm
394
395 2006-10-22 18:16 mose
396 * doc/devtools/tikimerge.sh (BRANCH-1-9): warning, mergers :
397 changed the name of the moving tag because the old one have been
398 borked
399
400 2006-10-22 17:35 cfreeze
401 * lib/bablotron.php (BRANCH-1-9): Make spell checking work for
402 words that have different case than that in the dictionary
403

902 Back to TOC

 Tikiwiki Documentation 1.9+

404 2006-10-22 06:16 cfreeze

405 * lib/pear/Auth/: Auth.php, index.php, Container/LDAP.php
406 (BRANCH-1-9): Added missing Auth.php file. Should complete
407 upgrade of new PEAR::Auth module.
408
409 For using IMAP and Courier, the following settings worked for me.
410
411 Set authentication method to "Tiki and PEAR Auth" Check "Create
412 user if not in Tiki" Uncheck "Create user if not in Auth" Set
413 "Auth Type" to IMAP Set the Host and Port to your IMAP server Set
414 the IMAP BaseDSN to "/imap/notls" if not using SSL, or
415 "/imap/ssl" if using SSL
416
417 2006-10-21 22:01 mose
418 * tiki-admin_include_login.php, tiki-setup.php,
419 db/tiki-1.9-mysql.sql, db/tiki-1.9-oci8.sql,
420 db/tiki-1.9-pgsql.sql, db/tiki-1.9-sqlite.sql,
421 db/tiki-1.9-sybase.sql, db/tiki.sql, db/tiki_1.8to1.9.sql,
422 db/profiles/default-inserts.sql, lib/userslib.php,
423 templates/tiki-admin-include-login.tpl, lib/pear/Auth/Auth.php,
424 lib/pear/Auth/index.php, lib/pear/Auth/Container/LDAP.php
425 (BRANCH-1-9): auth improvement including pear-auth upgrade for
426 security reasons (involving ldap auth), and possible auth against
427 pop/imap server via that lib as well, brought to you by cfreeze
428
429 2006-10-21 21:31 mose
430 * doc/devtools/myspell_dic_2_tikiWiki_sql.pl (BRANCH-1-9): changed
431 dict script generation to accept words with quotes
432
433 2006-10-21 14:23 mose
434 * lib/wiki/wikilib.php (BRANCH-1-9): added notification when a file
435 is attached to a watched wiki page
436
437 2006-10-19 21:25 awolfff
438 * tiki-download_file.php (BRANCH-1-9): NEW: tiki-download_file can
439 now retrieve a file by name from a file gallery. Parameters:
440 galleryId and name
441
442 2006-10-19 21:20 awolfff
443 * lib/tikilib.php (BRANCH-1-9): NEW: added new function
444 get_file_by_name to get the most recent version of a file with a
445 given name from a given file gallery. NEW: added maxdepth=<num>
446 to {toc} to control the maximum depth of the toc to be generated.
447
448 2006-10-19 21:14 awolfff
449 * lib/structures/structlib.php (BRANCH-1-9): NEW: extended get_toc
450 and fetch_toc to handle the maxdepth of the toc to be generated.
451
452 2006-10-19 20:43 awolfff
453 * show_image.php (BRANCH-1-9): NEW: if called with a galleryId
454 only, a random picture of the gallery is chosen.
455
456 2006-10-19 20:29 awolfff
457 * lib/wiki-plugins/wikiplugin_sql.php (BRANCH-1-9): FIX: Empty
458 passwords in a DSN confused the parser. Now checking for empty
459 password.
460
461 2006-10-19 12:51 xavidp
462 * lang/ca/language.php (BRANCH-1-9): some more strings

Back to TOC 903

 463
464 2006-10-19 02:36 mose
465 * tiki-wiki_rss.php (BRANCH-1-9): fixed again the rss behaviour
466 with wiki when no diff is requested
467
468 2006-10-18 21:59 sylvieg
469 * lib/wiki-plugins/wikiplugin_trackerlist.php (BRANCH-1-9): to
470 avoid multiple trackerlist on the same page
471
472 2006-10-18 21:11 xavidp
473 * lang/ca/language.php (BRANCH-1-9): install strings translated
474
475 2006-10-18 21:08 xavidp
476 * templates/tiki-install.tpl (BRANCH-1-9): 2 strings were missing
477 (tr tags added now)
478
479 2006-10-18 20:30 sylvieg
480 * lib/wiki-plugins/wikiplugin_trackerlist.php (BRANCH-1-9): an
481 error message is filterfield is incorrect
482
483 2006-10-18 19:59 xavidp
484 * templates/tiki-install.tpl (BRANCH-1-9): added tr tags to allow
485 install strings in other languages (thanks sylvie)
486
487 2006-10-18 19:59 sylvieg
488 * lib/trackers/trackerlib.php (BRANCH-1-9): a global xxxlib must
489 have an include ( situation often needs for tracker)
490
491 2006-10-18 16:58 luciash
492 * htaccess.sh (BRANCH-1-9): [FIX] activate/deactivate tiki root
493 .htaccess too (backport from HEAD)
494
495 2006-10-18 13:30 xavidp
496 * lang/ca/language.php (BRANCH-1-9): some new admin strings
497 translated
498
499 2006-10-18 04:09 marclaporte
500 * lang/: no/language.php, pl/language.php, pt/language.php,
501 pt-br/language.php, ru/language.php, sk/language.php,
502 sr/language.php, sr-latn/language.php, sv/language.php,
503 tv/language.php, tw/language.php, uk/language.php (BRANCH-1-9):
504 missing .sh
505
506 2006-10-18 04:06 marclaporte
507 * lang/: es/language.php, en-uk/language.php, it/language.php,
508 ar/language.php, ca/language.php, cn/language.php,
509 cs/language.php, da/language.php, de/language.php,
510 el/language.php, en/language.php, fi/language.php,
511 he/language.php, hr/language.php, hu/language.php,
512 ja/language.php, ko/language.php, nl/language.php (BRANCH-1-9):
513 missing .sh
514
515 2006-10-18 00:55 marclaporte
516 * templates/tiki-mods.tpl (BRANCH-1-9): missing .sh
517
518 2006-10-18 00:51 marclaporte
519 * lang/fr/language.php (BRANCH-1-9): issing .sh in instructions
520
521 2006-10-17 02:07 mose

904 Back to TOC

 Tikiwiki Documentation 1.9+

522 * lib/trackers/trackerlib.php (BRANCH-1-9): fixed item link field

523 type and cache issue (thx sean)
524
525 2006-10-16 20:50 sylvieg
526 * templates/tiki-assignpermission.tpl (BRANCH-1-9): missing escape
527 for group name with special chars
528
529 2006-10-16 20:10 sylvieg
530 * tiki-directory_redirect.php (BRANCH-1-9): do not redirect for a
531 non validated site
532
533 2006-10-16 15:36 sylvieg
534 * lib/tikilib.php (BRANCH-1-9): avoid a notice
535
536 2006-10-16 15:19 sylvieg
537 * lib/tikilib.php (BRANCH-1-9): avoid a notice
538
539 2006-10-16 00:40 sylvieg
540 * lang/fr/language.php (BRANCH-1-9): some more
541
542 2006-10-15 21:16 xavidp
543 * lang/ca/language.php (BRANCH-1-9): a few more strings translated
544
545 2006-10-13 21:04 xavidp
546 * lang/ca/language.php (BRANCH-1-9): a few more strings I forgot
547 previously from admin screens
548
549 2006-10-13 15:39 sylvieg
550 * tiki-install.php (BRANCH-1-9): possibilty to add a param
551 tiki-install.php?lang=ca - next step add the {tr}
552
553 2006-10-13 11:16 xavidp
554 * lang/ca/language.php (BRANCH-1-9): some new strings translated
555 (some admin interfaces, tips, etc.)
556
557 2006-10-09 21:05 marclaporte
558 * tiki-pagepermissions.php (BRANCH-1-9): alphabetical sort of group
559 names is nicer
560
561 2006-10-06 16:02 sylvieg
562 * lib/trackers/trackerlib.php (BRANCH-1-9): backport 1.9
563
564 2006-09-27 20:22 sylvieg
565 * styles/transitions/1.8to1.9.css (BRANCH-1-9): imgs are a step
566 above
567
568 2006-09-27 12:54 sylvieg
569 * lib/wiki-plugins/wikiplugin_titlesearch.php (BRANCH-1-9):
570 list_pages is in tikilib
571
572 2006-09-27 12:42 xavidp
573 * db/tiki_1.8to1.9.sql (BRANCH-1-9): removed actions of creating
574 and deleting tiki_project* tables
575
576 2006-09-27 12:24 xavidp
577 * _htaccess (BRANCH-1-9): removed references to workspaces
578
579 2006-09-27 11:41 xavidp
580 * _htaccess (BRANCH-1-9): added entries for workspaces

Back to TOC 905

 581
582 2006-09-26 15:11 sylvieg
583 * lib/search/: refresh-functions.php, refresh.php (BRANCH-1-9):
584 global search functions
585
586 2006-09-26 14:00 luciash
587 * tiki-browse_categories.php (BRANCH-1-9): [FIX] removed duplicate
588 CVS header
589
590 2006-09-26 12:56 luciash
591 * templates/header.tpl (BRANCH-1-9): [FIX] removed duplicate js
592 block
593
594 2006-09-26 11:45 makenai
595 * tiki-setup_base.php (BRANCH-1-9): Fix for updating lastlogin
596 information for users when using website authorization
597
598 2006-09-26 06:23 marclaporte
599 * tiki-calendars_rss.php (BRANCH-1-9): typo reported on IRC by
600 Makenai
601
602 2006-09-25 21:15 sylvieg
603 * templates/poll.tpl (BRANCH-1-9): highlight also in poll view div
604 the user vote
605
606 2006-09-23 21:17 mose
607 * tiki-wiki_rss.php (BRANCH-1-9): fixed rss to make optional the
608 link to the diff (default go to page)
609
610 2006-09-19 19:39 ohertel
611 * tiki-setup_base.php (BRANCH-1-9): [fix] less restrict
612 typechecking on 'type', not only used in galaxia
613
614 2006-09-19 16:36 ohertel
615 * lib/: feedcreator/feedcreator.class.php, rss/rsslib.php
616 (BRANCH-1-9): [mod] added simply style 0.9 RDF feed for old style
617 rss feeds (e.g. Object Desktop Silica RSS Reader), use ?ver=a or
618 or ?ver=RSS0.9
619
620 2006-09-19 03:38 ohertel
621 * tiki-setup_base.php (BRANCH-1-9): [sec] security fix (type check)
622
623 2006-09-19 02:25 ohertel
624 * lib/Galaxia/src/ProcessManager/ProcessManager.php,
625 tiki-g-admin_processes.php, tiki-setup_base.php (BRANCH-1-9):
626 [sec] security fix (type check), typo fixed
627
628 2006-09-19 00:49 ohertel
629 * tiki-calendars_rss.php, tiki-tracker_rss.php (BRANCH-1-9): [fix]
630 misc fixes on rss feeds (visibility, speed, general bugs, cache),
631 caching time configurable now
632
633 2006-09-19 00:43 ohertel
634 * tiki-admin_include_rss.php, tiki-articles_rss.php,
635 tiki-blog_rss.php, tiki-blogs_rss.php, tiki-directories_rss.php,
636 tiki-directory_rss.php, tiki-file_galleries_rss.php,
637 tiki-file_gallery_rss.php, tiki-forum_rss.php,
638 tiki-forums_rss.php, tiki-image_galleries_rss.php,
639 tiki-image_gallery_rss.php, tiki-map_rss.php, tiki-setup.php,

906 Back to TOC

 Tikiwiki Documentation 1.9+

640 tiki-wiki_rss.php, lib/rss/rsslib.php,

641 templates/tiki-admin-include-rss.tpl, lang/de/language.php
642 (BRANCH-1-9): [fix] misc fixes on rss feeds (visibility, speed,
643 general bugs, cache), caching time configurable now
644
645 2006-09-18 19:30 sylvieg
646 * templates/tiki-editpage.tpl (BRANCH-1-9): not to recreate the
647 poll each time you edit a page with a poll
648
649 2006-09-18 19:26 sylvieg
650 * lib/categories/categlib.php (BRANCH-1-9): must keep the
651 tiki_categorized object when removing categorization because poll
652 can use it
653
654 2006-09-18 15:37 sylvieg
655 * templates/tiki-listpages.tpl (BRANCH-1-9): syntax error
656
657 2006-09-16 14:16 ohertel
658 * templates/modules/mod-random_images.tpl (BRANCH-1-9): [fix]
659 random image thumbnail should be centered and have no border
660
661 2006-09-16 02:58 mose
662 * lib/smarty_tiki/outputfilter.highlight.php (BRANCH-1-9): still
663 not perfect highlight regexp, but this one is not buggy at least
664
665 2006-09-16 01:10 mose
666 * lib/smarty_tiki/outputfilter.highlight.php (BRANCH-1-9): cleaned
667 dirtiness and maybe fixed the onmouseover regexp in highlight
668
669 2006-09-15 22:23 mose
670 * lib/smarty_tiki/outputfilter.highlight.php (BRANCH-1-9): dirty
671 fix, onmouseover is still not saved from highlight, but at least
672 user popup do not break now
673
674 2006-09-15 22:06 sylvieg
675 * tiki-login.php (BRANCH-1-9): when you log in from
676 tiki-login_validate do not go back in this page because the
677 password has been changed and you will have an error
678
679 2006-09-15 19:31 mose
680 * templates/tiki-calendar.tpl (BRANCH-1-9): fixed link to calendar
681 item from list view
682
683 2006-09-15 15:52 sylvieg
684 * lib/smarty_tiki/function.phplayers.php,
685 tiki-browse_categories.php (BRANCH-1-9): a phplayer icon
686 tree_expand_corner_first.png was in another directory - it
687 changes the look but at least the logs are not filled
688
689 2006-09-15 15:19 sylvieg
690 * lib/notifications/notificationemaillib.php (BRANCH-1-9): the
691 outbound url was bad for a topic post
692
693 2006-09-14 18:27 sylvieg
694 * lib/trackers/trackerlib.php (BRANCH-1-9): filter can have
695 multiple category filters
696
697 2006-09-13 19:39 ohertel
698 * tiki-admin_include_metatags.php,

Back to TOC 907

 699 templates/tiki-admin-include-metatags.tpl (BRANCH-1-9): [fix] fix
700 for collision between global metatag setting and setting for that
701 specific page (robots: noindex, nofollow set for admin pages)
702
703 2006-09-13 17:58 sylvieg
704 * tiki-view_tracker_item.php (BRANCH-1-9): some confusion with perm
705 between closed and pending
706
707 2006-09-13 15:57 sylvieg
708 * lib/wiki-plugins/wikiplugin_category.php (BRANCH-1-9): fix help
709 on sub
710
711 2006-09-11 15:43 sylvieg
712 * lib/shoutbox/shoutboxlib.php (BRANCH-1-9): instead of not being
713 able to post 2 times the same message/same user in shoutbox,
714 update the timestamp... (ex: message hellp or post). Perhaps the
715 solution is to controlled timing?
716
717 2006-09-10 20:06 ohertel
718 * templates/styles/moreneat/tiki.tpl (BRANCH-1-9): rollback of
719 toggg edit: the page bar is hardcoded into
720 templates/moreneat/tiki-show_page.tpl, with those lines you just
721 doubled the comments zone
722
723 2006-09-10 07:44 toggg
724 * templates/styles/moreneat/tiki.tpl (BRANCH-1-9): Get wiki help
725 button in there
726
727 2006-09-09 11:43 ohertel
728 * styles/: olive-blue.css, olive-red.css, olive.css (BRANCH-1-9):
729 move away external link icon from text
730
731 2006-09-09 11:41 ohertel
732 * styles/moreneat.css (BRANCH-1-9): fix: content killing the border
733
734 2006-09-08 13:04 sylvieg
735 * lib/wiki/wikilib.php (BRANCH-1-9): limit a little bit the bug, if
736 you delete an attachment, the file is deleted only if no more
737 referenced - BUT it does not solve the problem that a
738 filedownloaded with the same name than an already attached file
739 in another page erased the olf file
740
741 2006-09-08 10:51 sylvieg
742 * lib/wiki-plugins/wikiplugin_attach.php (BRANCH-1-9): use also the
743 filename extension to show the icon as it is done in attachment
744 list
745
746 2006-09-07 19:24 sylvieg
747 * templates/tiki-editpage.tpl (BRANCH-1-9): add a name on the form
748 to be able to do javascript on the form
749
750 2006-09-06 17:04 wesleywillians
751 * templates/tiki-view_blog_post.tpl (BRANCH-1-9): [MOD] Adding
752 title to blog's post
753
754 2006-09-06 13:40 sylvieg
755 * tiki-download_item_attachment.php (BRANCH-1-9): if the attached
756 file doesn't exist for some errors, out a message in the download
757 instead of a php error

908 Back to TOC

 Tikiwiki Documentation 1.9+

758
759
760
761 Version 1.9.5
762 <http://tikiwiki.org/ReleaseProcess195>
763 ------------------
764
765 [SEC] Security: fix in tiki-editpage.php
766 [SEC] Security: fixes in jhot.php
767 [SEC] Security: Parameter highlight may not countain & , " , ' , < or >
768 [SEC] Security: Script htaccess.sh for dis/enabling .htaccess files
769 [FIX] Avoid some messages due to undefined variables
770 [FIX] Tracker: fixed tracker data import when no status indicated in csv
771 [FIX] Trackers: check we have a right image handle before taking its info
772 [FIX] Avoid notice and insert message case id xxx does not exist in {rss
id=xxx}
773 [FIX] Optional 's' for $groupHome protocol as https://... ,correct the
774 https: goup home case for logout too
775 [FIX] Installer shows memory limit warning
776 [FIX] No more take offset from cookies
777 [FIX] Image Gallery: Check we have a right image handle before taking its
info
778 [FIX] Image Gallery: Strengthen get_one_image_from_disk() to refuse non
image data
779 [FIX] Image Gallery: Check and get image sizes even if .gif or no
780 imagecreatefromstring()
781 [FIX] Image Gallery: All files are now checked against being right images
782 [FIX] Image Gallery: Double link to image gallery when returning from edit
783 [FIX] Image Gallery: Get optional thumbnail image size so it works if same
scale
784 as thumbs scale from gallery
785 [FIX] Image Gallery: Double link to image gallery when returning from edit
786 [FIX] Image Gallery: Use gallery's default for image scale or sort order
787 if none in browse and show images
788 [FIX] Image Gallery: Image permissions
789 [FIX] Image Gallery: Navigation / scale control in image browsing
790 [FIX] Image Gallery: Once image gallery saved, avoid double create link
display
791 [FIX] Image Gallery: small change in images batch upload to respect name
792 order in batch
793 [FIX] Keep menus wide open if javascript or cookies not allowed
794 [FIX] Styles: Simple style fixes for PLM and other enhancements
795 [FIX] Tiki-index_p.php: typo feature_wiki_usrlock
796 [FIX] Blogs: Trackback pings for blog posts accepted only if the feature
797 blog is enabled
798 [FIX] Blogs: Secured and fixed blogs trackback pings display
799 [FIX] Wikiplugin snarf: don't change line feeds in <br />
800 [FIX] Wikiplugin code: uses proper <br />
801 [FIX] mk_profile.sh: accepts optionals backticks around table names,
802 better autodoc
803 [FIX] Module quick_edit: fixed collision with edit article: 'heading'
804 used in both of them, thus preventing 'heading' showing up in
805 edit article, if you have quick_edit module activated
806 [FIX] Admin/login: fixing 1 day bug & adding more options
807 [FIX] pcllib: removed call by reference to functions
808 [FIX] Broken links to documentation
809 [FIX] Some fixes in display of country flag
810 [FIX] Galaxia: conformed to db abstract
811 [FIX] Wiki RSS Feed: avoid sql error, show whole file for new wiki pages,

Back to TOC 909

 812 cleanup of output in rss data
813 [FIX] Wiki: fixed undefined 'index' variable in page history
814 [FIX] Wikiplugin TrackerFilter: fix sort and pagination
815 [FIX] Wikiplugin Trackerlist: several fixes
816 [MOD] Smarty updated to 2.6.14
817 [MOD] Modules allow user to create a module without title and display
error
818 message if no name or data is given to a new module
819 [MOD] Trackers: add the fulltext index for tracker search with mysql
820 [MOD] Trackers: many fixes and enhancements
821 [MOD] change in the message body messu-compose to messu-mailbox to be
822 directly in the mailbox when notification from the message box
823 [MOD] Some clean up and organization on wiki help
824 [MOD] Trackers: added a new optional behaviour for isHidden field
825 type, to make hidden fields only editable by tracker admin
826 but still visible to modifier
827 [MOD] Admin survey questions: longer options field and hint box for
828 multiple answer questions where to places those answers
829 [MOD] at least yahoo and google ignore our robots.txt entries completely,
830 so we set META ROBOTS tags on all pages we don't want
indexed/followed.
831 Thats all admin/submit/print/rename/remove/send pages and pages that
832 will make search box go wild (categories, lengthy lists, calendar,
...)
833 [MOD] Hide MultiTiki info when not in use
834 [MOD] lang/de, lang/ca, lang/pt-br, lang/fr updates
835 [MOD] Edit article: allow to preselect categories when creating a new
836 article, like this:
837 /tiki-edit_article.php?cat_categories[]=1&cat_categorize=on for
838 category '1'
839 [MOD] Plugins: Extended div wikiplugin to accept justify text align
840 [MOD] Blogs: Possibility to delete blog post level trackback pings
841 [MOD] Changed behaviour for description label when no desc is provided
842 [MOD] Enables relative url for group home as http:tiki-xxx.php...
843 (no double slash after ":" )
844 [MOD] Enables included php to ask extra external js
845 [MOD] Image slideshow in page , controlled by feature slideshow in admin
846 image galleries
847 [MOD] Images slideshow preloads images and works autonomous when
848 cycle complete
849 [MOD] Images galleries links simplified, only scalesize controls the scale
850 (0=original size)
851 [MOD] Images galleries controls enhanced
852 [MOD] Update to latest version of PhpLayersMenu (3.2.0-rc)
853 [MOD] New files (copy for Tiki for modifications) to prevent overriding
854 of original files of the PLM package
855 [MOD] Calendar: added categories support for theme control purpose
856 [MOD] Imagegal: added a way in admin panel to move images from db
857 to filesystem
858 [MOD] Users: added an option to have new users accept internal messages
859 by default
860 [MOD] Users: switch on receiving internal messages by default
861 [MOD] Blogs: Added feature/allow blogs trackback pings enabling general
and
862 on a blog basis
863 [MOD] Blogs: View blogs post refactored
864 [MOD] Clearer install & upgrade intructions. Moving 1.7.x stuff to a wiki
865 page. Add information about secdb
866 [NEW] Plugins: Skype plugin to create a clickable link to call or chat

910 Back to TOC

 Tikiwiki Documentation 1.9+

867 with a Skype user

868
869 Version 1.9.4
870 <http://tikiwiki.org/ReleaseProcess194>
871 ------------------
872
873 [MOD] cms: added an option for availability of print option in cms
874 [NEW] google-map: new feature, used for usermap and self-location
875 [FIX] polls: changed polls admin access permission to be distinct from
876 admin one
877 [MOD] user: added an option to remove all pages from user when deleting
user
878 [NEW] trackers: new export page in csv format
879 [FIX] trackers: made filter work with categ field type
880 [FIX] trackers: fixed trackers to accept zero when a numeric field type
881 is mandatory
882 [FIX] galaxia: added a check for name of start activity
883 [FIX] maps: freeing now image memory after request to avoid bloating
884 [FIX] cms: fixed db commpat for print view (reads->nbreads)
885 [FIX] newsletter: set up the from address to default from when sending
886 newsletter
887 [MOD] multi: added $local_php and $multi optional vars for geeks only
888 [SEC] several vars added to sanitization to avoid cross-site scripting
889 [FIX] devtools: improved sqlupgrade script for when password includes a
quote
890 [MOD] lang: major improvement of finnish translation
891 [MOD] lang: update of de, fr, it
892 [MOD] wiki: changed lock icon
893 [FIX] wiki: made sorting respect find filter
894 [MOD] pear: replaced clone() by cloneNode() because reserved in some
recent php
895 [MOD] styles: improvement of mose.css style
896 [MOD] styles: improvement of trollparty.css style
897 [FIX] html: made alternate link displayed only if perms ok
898 [FIX] tabs: fixed cycle with a reset
899 -[DB] added 3 perms and 1 pref
900 [FIX] Enables download of file galery 's files bigger than 2MB
901
902
903 Version 1.9.3.1
904 <http://tikiwiki.org/ReleaseProcess193>
905 - 04/30/2006
906 ------------------
907
908 [FIX] PHP Notice: Only variable references should be returned by reference
909 in /lib/adodb/adodb.inc.php on line 2797 - ohertel
910 [FIX] basic profile: Notice: unserialize(): Error at offset 23 of 27 bytes
911 in /tikiwiki-1.9.3/tiki-modules.php on line 67 - ohertel
912 [FIX] MD5 values for tiki secdb - ohertel
913 [FIX] What-you-see-is-what-you-can-access fix: a not accessable feature is
914 hidden - marclaporte
915 [FIX] trackers: get the right number of items - sylvie
916 [MOD] update fr translation - sylvie
917 [MOD] trackers: give the possibility to move the fields more
918 than 1 step - sylvie
919 [MOD] another crosslink feature -> documentation - marclaporte
920 [MOD] default_wiki_diff_style: minsidediff - marclaporte
921 [MOD] some features disabled by default: feature_wiki_export,
922 feature_galleries, feature_help, feature_multilingual,

Back to TOC 911

 923 feature_user_watches_translations, feature_dump,
924 feature_view_tpl - marclaporte
925
926 Version 1.9.3
927 <http://tikiwiki.org/ReleaseProcess193>
928 - 04/29/2006
929 ------------------
930 [FIX] fix of multiple layout and translation issues - various authors
931 [FIX] '... but need admin validation:' must work even if 'Validate users
932 by email:' is not checked - sylvie
933 [FIX] admin user: multiple actions on a page other than the first
934 one - sylvie
935 [FIX] article: category kept at approval - sylvie
936 [FIX] blog: blog pagination - sylvie
937 [FIX] blog: find now finds also in post title - sylvie
938 [FIX] blog: reset blog activity if activity too old at each blog post -
sylvie
939 [FIX] bookmark: replace split space in link with <br /> - sylvie
940 [FIX] category: anon can edit categorized pages - redflo
941 [FIX] category: browse category on image show up images - sylvie
942 [FIX] category: display category name for a deep category browse - sylvie
943 [FIX] cleanups for php 5 compatibility - various authors
944 [FIX] comment: all comments shown after a post - sylvie
945 [FIX] forum: new post subject set after a post - sylvie
946 [FIX] gallery: check object perm - sylvie
947 [FIX] group: a non admin user can also assign a user to one of his groups
if
948 he has tiki_p_admin_users - sylvie
949 [FIX] group: can use username or groupname with the character & in
950 assign group - sylvie
951 [FIX] group: respect perm in tiki_p_admin_user and not tiki_p_admin on
952 multiple actions in admin user - sylvie
953 [FIX] image: current gallery selected in the gallery choice - sylvie
954 [FIX] image: system gallery images are not shown in last_images modules if
955 no gallery is selected - sylvie
956 [FIX] jscalendar: spanish utf8 calendar - sylvie
957 [FIX] login: user home page considered at login - sylvie
958 [FIX] module since_last_visit_new: faqs are displayed - sylvie
959 [FIX] module since_last_visit_new: fix list index unknown for a comment in
960 image gallery - sylvie
961 [FIX] multilingual: switch lang on default homepage (+bl param with
962 value) - sylvie
963 [FIX] neat.css: upload image in a page - sylvie
964 [FIX] newsletter: cleanup outgoing newsletter templates - marclaporte
965 [FIX] newsletter: more perm checking on archived newsletters - sylvie
966 [FIX] parsing: to be able to have plugin param with a & - sylvie
967 [FIX] plugin article: respect perms - sylvie
968 [FIX] plugin wantedpages: accept site settings for dashes in WikiWords.
969 Possible filtering of output to get rid of
970 "rubbish page names" - markusvk
971 [FIX] prefer get_user_default_homepage to get_user_preference homePage -
ang23
972 [FIX] quiz: avoid some notices if store quiz results on + error if
attachment
973 empty - (sylvie)
974 [FIX] search: do no search if no search words are given - sylvie
975 [FIX] securing adodb for postgres - mose
976 [FIX] setup.sh: Use filesystem acls instead of sgid or 777 mode is much
977 more safe - redflo

912 Back to TOC

 Tikiwiki Documentation 1.9+

978 [FIX] template: anon can view/edit templates - ohertel

979 [FIX] template: can edit in some case + can save only for the style -
sylvie
980 [FIX] tiki search: include wiki page name like in fulltext search and the
file
981 data extracted by the command associated to the type - sylvie
982 [FIX] tiki search: when refreshing fix an undefined dcslib + attach
983 warning - sylvie
984 [FIX] tracker plugin: category - sylvie
985 [FIX] tracker plugin: highlight name of fields with error - sylvie
986 [FIX] tracker: better support for special character or string (ex: xml) in
987 textarea field - sylvie
988 [FIX] tracker: mandatory category - sylvie
989 [FIX] tracker: fix notification message header for gmail server for long
990 update notif and comment notificaton - sylvie
991 [FIX] tracker: fixed bugged for () loop that prevented non-admin users
from
992 updating certain fields values - lorfds
993 [FIX] tracker: image in tracker plugin - sylvie
994 [FIX] tracker: main item value displayed in the window title - sylvie
995 [FIX] tracker: mandatory fields in trackers - rv540
996 [FIX] tracker: sort the country names in a country field - sylvie
997 [FIX] tracker: to be able to have 2 category fields in a tracker - sylvie
998 [FIX] user: admin can change prefs of the third tab - sylvie
999 [FIX] user: batch load can not add a user to a group the current user has
1000 if only tiki_p_admin_user and not tiki_p_admin perm is set - sylvie
1001 [FIX] wiki: backlink: respect perms - sylvie
1002 [FIX] wiki: don't show edit buttom if looking at a user page of
1003 another user - sylvie
1004 [FIX] wiki: don't show the edit buttom when looking at another user's
1005 userpage - sylvie
1006 [FIX] wiki: download wiki file respects individual perms on a page -
sylvie
1007 [FIX] wiki: force server readable perm for img upload - sylvie
1008 [FIX] wiki: highlight name of fields with error - sylvie
1009 [FIX] wiki: if 'display the title' is on and breadcrumb feature off, the
1010 title must be displayed - sylvie
1011 [FIX] wiki: if ask for a userpage is not yet created go to tiki-editpage
1012 instead of displaying an invalid page - sylvie
1013 [FIX] wiki: likepage: respect perms - sylvie
1014 [FIX] wiki: page creators are admin of their pages + tiki_p_admin_wiki
1015 back for editpage - sylvie
1016 [FIX] wiki: watch on 'page change' works again - ohertel
1017 [FIX] wiki: the page named UserPage redirects to the user's UserPage if
1018 possible - sylvie
1019 [FIX] wiki: wiki discussion now redirects to the same thread for 2 users
1020 with different languages - sylvie
1021 [FIX] xhtml: <br/> transformed into <br /> - damian
1022 [MOD] added &reg; to special character table - sylvieg
1023 [MOD] added link to [http://dev.tikiwiki.org/tiki-index.php
1024 ?page=Features|evaluation of each feature] to inform about
1025 maturity of features - ohertel
1026 [MOD] CAS: note about a required lib installtion on admin/login - ohertel
1027 [MOD] cleanup and improvement of robots.txt - various authors
1028 [MOD] groups/permissions: 'levels' hidden by default - ohertel
1029 [MOD] groups/permissions: show all permissions by default - marclaporte
1030 [MOD] install: added some notes to the installation page tiki-install
about
1031 memory reqirements and more

Back to TOC 913

 1032 [MOD] lang: nearly complete finnish translation - hartsa
1033 [MOD] lang: several updates to de/ca/fr - ohertel/xavidp/sylvie/jmaspons
1034 [MOD] many new 'tip' boxed on several pages - marclaporte/ohertel
1035 [MOD] mods: hacked to allow chmodding files to 644 on servers with suphp
1036 security installed (for instance: ourproject.org, where edu.tw.o is
1037 installed) - xavidp
1038 [MOD] most admin pages are accessable from tiki-admin.php
1039 now - marclaporte/ohertel
1040 [MOD] note in tiki-backup section that it's better to use mysqldump or
1041 phpmyadmin - ohertel
1042 [MOD] param my to last_image_galleries module to limit the
1043 user's gallery - sylvie
1044 [MOD] removing users from groups -> directly from user listing.
1045 dev.two #503 - marclaporte
1046 [MOD] tracker: a button to increment the field position from a field
1047 to the end - sylvie
1048 [MOD] tracker: added tracker filter for category plugin - mose
1049 [MOD] wiki: page renames are monitored with watch on page change - ohertel
1050 [NEW] calendar: RSS feed for upcoming events from calendar:
1051 [tiki-calendars_rss.php?ver=2] - ohertel
1052 [NEW] intertiki: use the user db of one tiki for several tiki
1053 installations - mose
1054 [NEW] perl script to recover wiki data from google cache in case you
1055 lose data - lfagundes
1056 [NEW] plugin: html tag plugin TAG - sylvie
1057 [NEW] smarty: simple smarty plugin function.count.php for return the
1058 count of a var - mose
1059 [NEW] switchlang param in the url changes the language - sylvie
1060 [NEW] wiki: new table of contents, wikipedia style: {maketoc:table} -
ohertel
1061 [NEW] wiki: search & replace feature - sampaioprimo
1062
1063 Version 1.9.2
1064 <http://tikiwiki.org/ReleaseProcess192>
1065 - 10/30/2005
1066 ------------------
1067 [FIX] Added alt text to menu folders to enable browsing with image
downloads
1068 disabled in your browser - Damian
1069 [FIX] Fixed a regression with "...but requires admin approval"
registration type
1070 - mdavey
1071 [FIX] wiki: Fix the closing / in an openning tag
ex:~np~{ARTICLE(id=1)/}~/np~ -
1072 sylvie
1073 [FIX] wiki: http: and www. follows the same rule (icon+new frame) than
1074 ~np~[http]~/np~ - sylvie
1075 [FIX] wiki: fix preview in history on a page using ~np~ {file} ~/np~
plugin -
1076 sylvie
1077 [FIX] calendar: calendar is not created anymore with 3 special perms -
sylvie
1078 [FIX] calendar: filter button is always displayed even if only one
calendar -
1079 sylvie
1080 [FIX] tracker: translate country name in a country field - sylvie
1081 [FIX] wiki: can't edit a page if its belongs to a category you don't have
perm -
1082 sylvie

914 Back to TOC

 Tikiwiki Documentation 1.9+

1083 [FIX] tracker: mandatory scrolling list doesn't propose an empty value -
sylvie
1084 [FIX] plugin: snarf allows the text body without been the html tag body -
sylvie
1085 [FIX] plugin: category new option value sort=shuffle mose) new option one
to
1086 display one categ per line - sylvie
1087 [FIX] wiki: ~np~<img src="img/wiki_up/xx.gif">~/np~ fixed in article -
sylvie
1088 [FIX] wiki: fix my pages in My Tiki by adding the pages where I am not the
last
1089 editor - sylvie
1090 [FIX] remind password message: fix url - sylvie
1091 [FIX] WYSIWYCA regarding tiki_p_vote_poll - amette
1092 [FIX] When no cookies, menus are now wide unfolded, if javascript, by
first
1093 close, all will fold
1094 [FIX] Return and passing by reference for PHP4.4.0 and PHP5 - mose amette
1095 [FIX] Import wiki pages put back in service
1096 [FIX] Edit trackers status (messed with list option status) - digao
1097 [FIX] html_entity_decode(), floatval() for PHP4 compatibility
1098 [FIX] 2 WikiWords separated by an unique space should link
1099 [FIX] Fix non closing ~np~ ~np~ ~pp~ or <pre> ~/np~, when the closing
miss,
1100 takes up to the end (as considering the closing tag is put at the end)
1101 [FIX] Initial condition whith where for search articles
1102 [FIX] Undefined offset: 0 in multitiki:
1103 lib/notifications/notificationemaillib.php
1104 [FIX] Various warnings in searchlib
1105 [FIX] Refactored output filter highlight, no more memory overflow
1106 [FIX] Refactored wikiplugins help loading by edit (1 MBytes saved)
1107 [FIX] Module ephemerides fatal error (Call to a member function on a non-
object)
1108 [FIX] Warning when tracker empty removed
1109 [FIX] Proper $groupHome URL if running Tiki in SSL
1110 [FIX] HawHaw PHP5 compatibility - Norbert Huffschmid, amette
1111 [FIX] Plugin WANTEDPAGES ignore pages separated by "+"
1112 [FIX] Removed dead code for gender-feature - luciash
1113 [FIX] Parse trackers textarea the same as wiki pages
1114 [FIX] When using admin validation for new account registration requests,
users
1115 are informed by email when their account is activated. - luciash
1116 [FIX] performance optimisation in category admin, orphan pages, stats -
sylvie
1117 [FIX] remove unused images a little less greedy - sylvie
1118 [FIX] users upload batch: some improvment and errors messages - sylvie
1119 [FIX] forum: the list has always the same number of forums whatever the
perms
1120 are - sylvie
1121 [FIX] wiki: page name with special characters browseable in categories -
sylvie
1122 [FIX] forum perms are distinguish from comments perms - sylvie
1123 [FIX] since_last_visit_new module checks for object perms - sylvie
1124 [FIX] ranking checks for object perms - sylvie
1125 [FIX] calendar: tighter perm when accessing calendar item - sylvie
1126 [FIX] forum plain style doesn't display while lines - sylvie
1127 [FIX] forum: a post just after a post delete is no more lost - sylvie
1128 [FIX] forum: keep topic order, comment view param when going next/previous
topic

Back to TOC 915

 1129 - sylvie
1130 [FIX] forum: lots of permission fixes - sylvie, rv540
1131 [FIX] mods directory gets taken into account by fixperms.sh - mose
1132 [FIX] Messu: Allow messages from other users is by default Yes - digao
1133 [FIX] calendar: Calendars were created with perms only for registered -
sylvie
1134 [FIX] tracker: fixed a bug, that let you only vote, when you had the same
1135 language set as the one enabling rating for the tracker - amette
1136 [FIX] RSS: removed tiki-atom.php, it's unused - amette
1137 [FIX] more reliable way to determine admin's email in Contact Us - mdavey
1138 [FIX] fixed download of tracker attachments - lfagundes
1139 [FIX] wiki: editpage urlencodes pagenames - sylvie
1140 [FIX] wiki: undefined templates if wiki templates not set - sylvie
1141 [FIX] wiki: editpage checks category permissions - sylvie
1142 [FIX] imagegal: System Gallery accessible with PHP > 4.1 - amette
1143 [FIX] imagegal: Better GalleryId-check and other fixes - redflo
1144 [FIX] maps: layer manager gets shown by default and various fixes - Franck
1145 [FIX] myTiki: pages, where one is not the last editor, get shown, too -
sylvie
1146 [FIX] calendar: tiki_p_admin_calendar is sufficient for admining calendar
-
1147 amette
1148 [FIX] wiki: corrected path for pdf-lib - luciash
1149 [FIX] xmlrpc: performance boost for listing pages in send wiki pages and
show
1150 number of articles as it is shown later - sylvie
1151 [FIX] xmlrpc: use the new Pear xmlrpc lib in tiki-send_objects.php -
amette
1152 [FIX] removed link to tw.o on site unavailable error page - mose
1153 [FIX] tracker: images can be removed from trackers - rv540
1154 [FIX] MySQL 4.1 compatibility - mose
1155 [FIX] index in database for speeding up article-queries - mose
1156 [FIX] PostgreSQL compatibility functions for max() and right()
1157 [FIX] tracker: added icon as placeholder, when no image in image field -
rv540,
1158 yoni
1159 [FIX] fixes and more translated words in catalan - xavidp
1160 [FIX] corrected typo in german translation - amette
1161 [FIX] corrections to french translation - sylvie, marclaporte
1162 [FIX] more translated strings in Hungarian - ang
1163 [FIX] more translated strings in Norwegian - gunnarre
1164 [FIX] more translated strings in Brazilian - lfagundes, digao
1165 [FIX] more translated strings in Russian - dimaz
1166 [FIX] fixed blog post for non admin - sylvie
1167 [FIX] database Oracle/PostgreSQL compat, added backticks to query colinmo
1168 [FIX] PostgreSQL compatibility, replaced last_insert_id() - mdavey, mo0co0
1169 [FIX] calendar: fixed a bug, that was listing upcoming events since 1969 -
1170 thenano
1171 [FIX] calendar: upcoming events sorts start_asc instead of desc - fmathias
1172 [FIX] hawhaw: tiki doesn't need to be on the server root no more - sylvie
1173 [FIX] mods: fixed the case when list is not existing at install - mose
1174 [FIX] PostgreSQL compat - Edgar Holleis, sylvie
1175 [FIX] PHP 4.4 compat issue fixed - atooni, mose
1176 [FIX] fix bug, that made function find_exact_all() mix up trackers and
files -
1177 amette
1178 [FIX] sheets: added SUMIF function - lfagundes
1179 [FIX] Smarty upgraded to 2.6.10 - mose
1180 [FIX] wellformed XHTML in structure-tocs - ang

916 Back to TOC

 Tikiwiki Documentation 1.9+

1181 [FIX] surveys: fixed a bug, that messed up the user defined order when
having
1182 multiple options - rv540
1183 [FIX] tracker: fixed array-initialization bug with mirror table trackers -
rv540
1184 [FIX] wiki: only available plugins get used for building wiki-plugin-help
1185 [FIX] wiki: CODE-plugin - optional RTL-param now and displays text by
default
1186 LTR - luciash
1187 [FIX] wiki: moved risky plugins to dist
1188 [FIX] wiki: QUOTE-plugin - was missing EXTR_SKIP - sylvie
1189 [FIX] wiki: SNARF-plugin - allows <div id='tbody' - khinckley, sylvie
1190 [FIX] wiki: SPLIT-plugin - more browser-independent - Patrick Allard,
1191 marclaporte
1192 [FIX] wiki: THUMB-plugin - additional URL-param - mose
1193 [FIX] wiki: TRACKERLIST-plugin - new option showstatus=>n - amette
1194 [FIX] wiki: VERSION-plugin - use_best_language capability and fixed
problem with
1195 parsing first line - mose
1196 [FIX] wiki: WANTEDPAGES-plugin - ignored pages are seperated by +
1197 [FIX] module: ephemerides - fixed "Call to a member function on a non-
object in
1198 multitiki"
1199 [FIX] module: Last Directory Sites/Forum Topics/Articles/Modif Pages/
Tracker
1200 Items/Since Last Visit New have additional option absurl=>n - yoni
1201 [FIX] BrTiki - added theme of br.tikiwiki.org - wesleywillians, lfagundes
1202 [FIX] damian.css - show links in module-titles more nicely, fixed problem
with
1203 field surrounding with ' - dimaz, sylvie
1204 [FIX] simple.css - better RTL-language compatibility, better reading by
1205 .postbody/.articlebody/.messureadbody, mod_assistant left aligned,
alignment of
1206 menu-separatorlines fixed, scrollbar when mid-column content is too wide,
1207 overflow:auto fix for modules, adjusted look and feel of widgets - amette,
1208 luciash
1209 [FIX] forum: fixed attachment perm issue - wulle, amette
1210 [FIX] wiki: if no like pages, then don't say "perhaps your are looking
for:" -
1211 sylvie
1212 [FIX] don't show debug in footer, if it is not enabled - mose
1213 [FIX] module: basic module.tpl - div class="box-{$module_name¦escape} for
CSS
1214 and display problem fix - ang, mose
1215 [FIX] admin: Added note about the not finished documentation and link to
1216 'Restore Help Pages' on doc.tw.o - amette
1217 [FIX] admin: fixed some missing ~np~<td>~/np~s and cleaned out
1218 feature_experimental part - sylvie
1219 [FIX] escape forum name to allow for a name with double quotes - sylvie
1220 [FIX] admin: users - add groups to the csv upload help string, same place
for
1221 batch result strings and feedback strings, warning message when changing
1222 user-name, that the user has to change his password - sylvie
1223 [FIX] directory: fixed offset calculation - wog
1224 [FIX] added missing poll to tiki-edit_help.tpl - sylvie
1225 [FIX] fixed help-page link in tiki-edit_translation.tpl - amette
1226 [FIX] file gallery: wellformed XTHML, table closing was wrong
1227 [FIX] file gallery: fixed display of empty colspan - mose
1228 [FIX] install: corrected a typo - amette

Back to TOC 917

 1229 [FIX] community: when searching for users, say "users like", not "users
1230 registered" - amette
1231 [FIX] Don't show cleartext password in newsreader, show asterisks - amette
1232 [FIX] linebreaks and htmlspecialchars in "Normal"-mode of MyTiki notepad -
1233 amette
1234 [FIX] wiki: fixed the display of page title being optional - mose
1235 [FIX] image gallery: galleryId can be null - sylvie
1236 [FIX] Added "edit css" button in Admin->General panel and show it in
1237 user_preferences only if permission - sylvie
1238 [FIX] Added missing tooltips to accept/reject/trash-icons in user_tasks -
amette
1239 [FIX] tracker: fixed table messup in list items view, when activating
1240 tracker-rating - amette
1241 [FIX] traker: list view - don't show date if field is empty, mandatory
scrolling
1242 list doesn't display empty value, translation of country names - sylvie
1243 [FIX] tracker: default size for placeholder image - rv540
1244 [FIX] RTL language fix in tiki.tpl - luciash
1245 [FIX] fixed the blank image for xhtml compliant style closing of tag and
1246 height-property - ang
1247 [FIX] removed HTML-code from validation mail, since it's plain text -
luciash
1248 [FIX] password reminder mail fix - wog, damian
1249 [FIX] better structured/readable tracker-changed-notification-mail and
better
1250 stripping of field-names from simplified tracker-notification-mails -
amette
1251 [FIX] blog-notification-mails have post title in addition to blog title -
xavidp
1252 [FIX] bottom bar updated - damian
1253 [FIX] added missing blanks in tiki.tpls - sylvie
1254 [FIX] minor fix to module wiki last comments - luciash
1255 [FIX] fixed two wrong messages considering tracker-feature disabled -
ohertel
1256 [FIX] Fixed name of admin ephemerides in menu - ohertel
1257 [FIX] more translated strings in German - ohertel
1258 [FIX] maps: working with Windows - Franck
1259 [FIX] changed tiki-install.tpl to reflect the new upgrade-script-paradigm
-
1260 amette
1261 [FIX] Tiki-version 1.9.2 is a valid version in security admin - amette
1262 [FIX] Tiki-mobile is in main menu - ohertel
1263 [FIX] added missing function view_blog to tiki-mobile - ohertel
1264 [FIX] forums/articles/threads etc. only in mobile mode, if tiki-mobile is
1265 activated - ohertel
1266 [MOD] wikistr

6.6.2. Changelog 1.8

1 Tikiwiki Changelog
2 ------------------
3
4 Changelog is now generated by cvs2cl.pl
5 http://cvsbook.red-bean.com/cvsbook.html#cvs2cl%20--%20Generate%20GNU-
Style%20ChangeLogs
6 This script lists chronologically the comments made with cvs commits.

918 Back to TOC

 Tikiwiki Documentation 1.9+

7 For example, for 1.9.7 : cvs2cl -F BRANCH-1-9 --delta REL-1-9-6:BRANCH-1-9

8 produces a file named Changelog, then in vim :%s/\n\(\s*\*\)/\1/
9
10 Use the following tags to distinguish changes :
11 * [NEW] apply if something new was added in tikiwiki
12 * [MOD] is an enhancement; not really new but makes things work better
13 * [FIX] can be used for bug fixes of any sort
14 * [SEC] for security fix operations
15 * [REL] changes for release process only
16 * [KIL] removal of unused or obsolete files
17 * -[DB] for changes in the database
18 when possible, it's also nice to indicate what feature is concerned by
19 the change.
20
(...)
2042 Version 1.8.6 - Polaris -
2043 <http://tikiwiki.org/ReleaseProcess186>
2044 * [FIX] user bookmarks using httpRequest rather than fopen
2045
2046
2047 Version 1.8.5 - Polaris -
2048 <http://tikiwiki.org/ReleaseProcess185>
2049 * [FIX] Header redirections now die; afterwards to prevent other code
being
2050 executed.
2051 * [FIX] More Path Disclosure fixes
2052 * [FIX] Remove the old password from being displayed on the tiki-
change_password
2053 routine.
2054 * [NEW] Tiki security admin, a control panel to check internal tiki
security
2055 settings and tiki files integrity.
2056 * [NEW] Added .htaccess files to most directories to disallow direct
access
2057 * [FIX] Remove file from temp after upload
2058 * [FIX] More secure map uploads
2059 * [MOD] Latest ADODB for MySQL 4.1 support
2060 * [FIX] Wiki renaming fixes and enhancements
2061 * [NEW] moves custom permissions and user watches.
2062 * [FIX] Email notifications and theme control objects.
2063 * [FIX] WikiSyntax : Definition list "eats" character
2064 * [FIX] version in the diff of a wiki page changed notification to the
previous
2065 message not the current"
2066 * [FIX] forum post notification with the right url
2067 * [FIX] monthview on year change
2068 * [FIX] fixed content disclosure through user watches.
2069 * [FIX] filename check in map editing code.
2070 * [FIX] REQUEST variable sanitation now works.
2071 * [FIX] fixed the check on filename uploaded on wiki pages
2072 * [FIX] fixed check of filename for upload_image
2073 * [FIX] fixed the article submission image id sanity
2074
2075 Version 1.8.4 - Polaris -
2076 <http://tikiwiki.org/ReleaseProcess184>
2077 * [FIX] individual wiki page permissions could be bypassed
2078 * [FIX] path disclosure vulnerabilities in the smarty_tiki area
2079 * [FIX] removing any parent categories of an object caused the object to
2080 become uncategorized even if there are other parent categories

Back to TOC 919

 2081 * [FIX] version conflicts related to wiki tag restorations
2082 * [FIX] wiki edit permission shouldn't depended on global wiki view
permission
2083 even if individual permissions are assigned for a wiki page
2084 * [FIX] duplicate version numbers when editing wiki pages
2085 * [FIX] scrollbar of textarea jumped to the top after using a quicktag in
2086 Gecko-based browsers
2087 * [FIX] articles plugin ignored displayed 0 comments all the time
2088 * [FIX] default groups for users were displayed even when they were not
set
2089 * [FIX] bugged display of the rating field when selecting article type
2090 "Review"
2091 * [FIX] workaround for environments where $_SERVER['SERVER_NAME'] is
undefined
2092 * [MOD] added RSS feeds with optional authentication
2093 * [FIX] reply icons were displayed in forum threads even if user has no
2094 permission to post
2095 * [FIX] forum stats aren't updated after moving a thread (until someone
enters
2096 the affected forum)
2097 * [FIX] broken find function for orphan wiki pages
2098 * [FIX] tracker categorization broken on tiki-admin_trackers.php
2099 * [FIX] avoid login problems when tiki-index.php is the DirectoryIndex
2100 * [FIX] current page was deleted without a trace when rolling back to a
2101 previous version, resulting in the inability to undo a rollback
and a
2102 gap in version numbers
2103 * [FIX] CATEGORY() plugin couldn't handle type=directory or type=forum
2104 * [FIX] a forum home was selected even when none is set in Admin/Forums
2105 * [FIX] directory category removal function left zombie subcategories and
2106 member sites
2107 * [FIX] buggy wiki page edit-conflict feature
2108 * [FIX] users logging in from the Tiki homepage were not sent to their
group
2109 homepages
2110 * [FIX] users logging in from any wiki page were redirected to the wiki
2111 homepage
2112 * [FIX] inner boxes created by embedding BOX plugins within each other had
2113 messed up line spacing
2114 * [FIX] author of a shoutbox msg changed to the shoutbox admin who edits
the
2115 message
2116 * [FIX] name inputted by an anonymous user in Live Support was lost
2117 * [FIX] overlib tooltips in moreneat.css extended across the entire screen
2118 * [MOD] diff engine was replaced with LGPL code to avoid licensing issues
2119
2120 Version 1.8.3 - Polaris -
2121 <http://tikiwiki.org/ReleaseProcess183>
2122 * [FIX] sort_mode problem on FAQ questions (tiki-setup_base)
2123 * [FIX] error message on tiki-faq_questions was reporting no menu
2124 * [MOD] phplayers horizontal menu support added
2125 * [FIX] tiki-modules cannot be called directly
2126 * [MOD] Objects with set permissions show a green key icon instead
2127 of ( ) around the yellow key icon.
2128
2129 Version 1.8.2 - Polaris -
2130 <http://tikiwiki.org/ReleaseProcess182>
2131 * [MOD] enhanced ticketlib in a second version
2132 * [NEW] added check on vars to avoid XSS attacks

920 Back to TOC

 Tikiwiki Documentation 1.9+

2133 * [NEW] added an option in wiki admin panel to make use of dashes and
2134 underscores optionnal in WikiWords
2135 * [NEW] Confirmation on all destructive actions
2136 * [NEW] index.php everywhere, which calls ../index.php until the top level
2137 which will call tiki-index.php as normal
2138 * [NEW] Some scripts cannot be called directly, so we divert to the
index.php
2139
2140 Version 1.8.1 - Polaris -
2141 <http://tikiwiki.org/ReleaseProcess181>
2142 * [FIX] File and Image Galleries: Directory value shouldn't need "/"
2143 * [MOD] Wiki Forum Discuss Broken with dropdown on Wiki Admin page
2144 * [FIX] Forums : Show posts by age sorting broken
2145 * [FIX] Wiki Split! (both the @@@ and the line breaks in columns)
2146 * [FIX] forum attachment doesn't work
2147 * [FIX] Taglines uploaded display with escapes
2148 * [FIX] Shoutbox module's delete link doesn't work everywhere
2149 * [FIX] WikiSyntax : Center- if colon in-line, centering breaks
2150 * [FIX] search_box with Fulltext Search
2151 * [FIX] Misspelled link in file /lib/calendarlib.php
2152 * [FIX] Incorrectly specified wiki 'h4' heading
2153 * [FIX] Blog Pagination links were out of sync
2154 * [FIX] moreneat debug console has hard to see colours
2155 * [FIX] Forums : individual RSS feeds not working
2156 * [FIX] RSS not properly processing blogId
2157 * [FIX] FANCYTABLE plugin generates wrong TD format
2158 * [FIX] RSS feeds are sent with Wiki Formatting instead of HTML
2159 * [FIX] RSS feed brakes in 1.8 RC3 - httprequest() in tikilib didnt return
2160 any data
2161 * [FIX] Newsletters: Subscribers get same unsubscribe code
2162 * [NEW] topic filtering in wikiplugin_articles
2163 * [FIX] File Gals:IIS REQUEST_URI not set in file download
2164 * [FIX] lastLogin was the same as currentLogin
2165 * [MOD] forums' new icon to show for topics new since last login
2166 * [FIX] ARTICLES plugin wasnt showing the topic images.
2167 * [FIX] mod-who_is_there Fixed missing quote marker
2168 * [FIX] commzone/attzone area JS flip link fixed for all themes (comments
and
2169 attachments weren't staying to show in Konqueror) with more accessible
2170 solution
2171 * [FIX] Contact Anonymous fixed
2172 remember to enabled the Contact Us and user Messaging features, set a
2173 contact name on Admin->General and let anonymous use the messaging
system
2174 permission
2175 * [FIX] Integrator that was unable to save new repository
2176 * [FIX] iframe width in featured-link feature
2177 * [FIX] Wiki quick help SQL plugin documentation
2178 * [MOD] translation of 'by' and displaying of 'Anonymous' in
2179 last_modif_pages module
2180 * [MOD] translation of 'by' in wiki_last_comments module
2181 * [FIX] breaks in the BOX plug-in
2182 * [NEW] dropdown navigation for backlinks and structures in wiki pages
2183 * [MOD] the module last_modif_pages so it don't display minor changes
2184 * [NEW] Javascript added to shoutbox forms to limit
2185 input to the 255 character table column width
2186 * [MOD] diff to ignore newline characters
2187 * [FIX] missing ?forumId= in tiki-forum(s)_rss.php
2188 * [FIX] SPLIT and BOX plugins to render all wiki syntax properly

Back to TOC 921

 2189 * [FIX] diff and source view to display special characters properly
2190 * [FIX] external RSS feeds: first entry was not shown
2191 * [FIX] more XHTML fixes (some ported from 1.7.x branch)
2192 * [NEW] ARTICLES now includes Topic Filtering
2193 * [NEW] new module last_category_items
2194 * [MOD] Spelling Mistakes corrected
2195 also modified the language files to reflect those changes, so not to
2196 break the language translations
2197 * [NEW] Added a check on Tiki Backup to remind you if your file and image
2198 galleries are set to file system storage
2199 German translation
2200 * [NEW] RSS 2.0 output feeds support the author tag now
2201 * [MOD] RSS: better looking stylesheet
2202 * [MOD] RSS: Blogs now show title instead of a timestamp
2203 * [MOD] RSS: if there is an empty item title, it gets replaced with a
creation
2204 timestamp of that item
2205 * [MOD] RSS: forums rss shows author names now
2206 * [NEW] avatars: user can choose to have no avatar if he has one currently
2207 * [NEW] Added <>[]|)({}'"_-*#;:& to special character input marclaporte
2208 * [MOD] Replaced the powered by RDF button with better quality one and
aligned
2209 all buttons vertically to middle
2210 * [NEW] Belarus now has a tiki flag!
2211 * [NEW] en-uk Language file, mainly because we british love our colour
2212 * [NEW] adding a powered by Tiki logo on bottom bar
2213 * [NEW] Added support for Atom output feeds, details see
2214 http://bitworking.org/rfc/draft-gregorio-07.html
2215 * [NEW] Added support for external Atom feeds, just add them on the rss
feeds
2216 page!
2217 * [NEW] Added new module forums_last_posts, that shows the newest posts in
2218 forums. prefixes like Re: or Aw: are removed prior to output
2219 * [FIX] Corrected the alignment in neat theme for wiki page icons
2220
2221 Version 1.8 -Polaris-
2222 <http://tikiwiki.org/ReleaseProcess18>
2223 * [FIX] removed invalid maxlength attribute and added js_maxlength to
shoutbox
2224 * [MOD] added js_maxlength smarty function
2225 * [FIX] fixed a bug where the lastLogin wasn't updated when using
2226 Pear::Auth (LDAP) and no passwords are in Tiki DB
2227 * [FIX] fixed installer: structures upgrade
2228 * [FIX] fixed installer: tiki_1.7to1.8.sql don't have to be run after
comments
2229 fix
2230 * [FIX] fixed installer: security problems where unauthorized users could
2231 break database settings and even could empty all tables.
2232 * [FIX] structures creation fixed (mose)
2233 * [FIX] fixed Forums - queued and reported messages broken (OneOfMany)
2234 * [FIX] fixed tiki-user_bookmarks was missing a semicolon (jpf)
2235 * [FIX] color in linkbut on tceti theme changed so its readable (dgd)
2236 * [FIX] changed potentially dangerous defaults (link caching)
2237 * [MOD] added option whether mail address should be checked at
registration
2238 (may not work on windows or may not work at all, so default is off).
This
2239 option was before hidden in the "system_os" setting.
2240 * [FIX] fixed missing end quotes backported from 1.9 (Damian)

922 Back to TOC

 Tikiwiki Documentation 1.9+

2241 * [FIX] Error messages in RSS feeds are now readable in RSS readers
2242 * [FIX] fixed the jspop issue in Image Galleries - identified by bnuz,
commit
2243 by damian
2244 * [FIX] fixed the calendar to show the right weekdays applying the
2245 CalendarBug2004 fix by rpg - gmuslera
2246 * [NEW] added the tikiticket anti-CSRF system mose + Damian - more details
on
2247 TikiSecurity
2248 * [NEW] added tiki-admin_system page for cache and compile operations
(mose,
2249 flo)
2250 * [MOD] enabled fulltext search in search_new(flo)
2251 * [MOD] added error_ticket templates for the metal themes and fixed
error.tpls
2252 Damian + Colorado
2253 * [NEW] added check if cookies are switched on on browsers (if session is
2254 handled via cookies) at logon time (flo)
2255 - (rc3) ------------------------------------------------------------
2256 * [FIX] fixed thumbnail generation in image galleries
2257 * [FIX] structures moving items now works
2258 * [FIX] fixed thread ordering setting in forum administration
2259 * [MOD] extracted html from structure {toc} tree function,
2260 and made 2 templates to manage that.
2261 * [FIX] Reoccured problem with email_isPublic not honoured
2262 * [NEW] Module to display pages where last comments added
2263 * [MOD] added optionnal numebr of entries displaye in module titles
2264 * [MOD] navigation buttons added to structures
2265 * [MOD] refactoring modules templates system to be more generic
2266 * [FIX] fixd some bugs in edit language admin panel
2267 * [FIX] fixed a strange bug with images in articles
2268 * [FIX] fixed user menu that had problem creating a new one
2269 * [FIX] fixed bugs in quicktages
2270 * [MOD] some refactoring : creation of initlib, cachelib, tablelib
2271 * [MOD] improved global xhtml compatibility with more & changed in &amp;
2272 * [FIX] fixed automatic url building in register site form
2273 * [MOD] upgraded Smarty to 2.6 final version
2274 * [FIX] fixed minor error handling in maps feature
2275 * [MOD] enhancement of change textarea size in edit forms
2276 * [NEW] added a new function in smarty for including phplayer
2277 # [MOD] changed the way dropdoiwn lists are displayed in tracker admin
2278 * [NEW] BlueMetal added by colloradoweb.com
2279 - (rc2) ------------------------------------------------------------
2280 * [MOD] Partly introduced customizable Quicktags
2281 * [MOD] Wiki Structures provide more flexible relationships to wiki pages
2282 * [MOD] Shoutbox enhanced to auto-replace URLs starting with 'http(s)|
ftp(s)'
2283 to active links and URLs starting with 'www' string. It's made
optional.
2284 * [MOD] All modules with numbers at left side (like ''last_...smth'' and
2285 ''top_...smth'') now have -+nonums+- parameter which is inhibit numbers
2286 output
2287 * [MOD] The select list of countries in User Preferences is translantable
now
2288 and sorted alphabetically by translated strings
2289 * [MOD] SPLIT wiki plugin now have two parameters: -+fixedsize+- and
2290 -+joincols+-. Also it can split text by rows (use -+@@@+- as rows
2291 delimiter)
2292 * [MOD] New mail-in method: ''PREPEND'' -- opposite to ''APPEND''

Back to TOC 923

 2293 * [MOD] Czech and Italian translations
2294 * [NEW] TikiIntegrator
2295 * [FIX] Calendar: no year input fixed
2296 * [FIX] Fixed bug that caused changes to admin settings sometimes require
a
2297 page reload to appear
2298 * [FIX] renamed lang/sp folder to lang/es for spanish language
2299 * [MOD] Enhanced user menus so that the menu items only show if a
2300 feature/permission/group is on. Added new application menu as sample.
2301 * [FIX] fixed pagination in forums
2302 * [FIX] fixed computation of number of queries
2303 * [MOD] Trackers are now faster if you have a large number of
2304 registred users
2305 * [NEW] new search engine with background collecting of searchwords.
2306 This search engine is database independent. Use the "new_search"
2307 module to be able to use the new search engine.
2308 * [MOD] all links that were displayed with [ link ] now use
2309 linkbut css style for a more homogen navigation
2310 * [FIX] fixed rankings for authors in wiki and cms
2311 * [MOD] made possible for comments to rate articles
2312 * [MOD] total rewrite of the search engine with reverse index
2313 powers the search a lot ! uses highlighting feature.
2314 * [FIX] fixed smileys not displayed in chat
2315 * [NEW] added tikibot, the irc extension of tikiwiki, that uses
2316 third party modules : wollabot and smartirc
2317 * [NEW] site registering feature now make new tiki be added more easily
2318 in tikiwiki.org directlory links
2319 * [NEW] added an admin panel for custimisation of quicktags
2320 those like icons in edit page that insert text with javascript
2321 * [FIX] removed all unused duplicate templates from styles
2322 * [FIX] removed all hardcoded path from smarty display method
2323 so it will never complain about lacking tiki.tpl anymore
2324 * [NEW] WebHelp generation from Tiki structures, you can dump a structure
to
2325 generate a webhelp static version with search capabilities that can be
2326 distributed as a standalone version of the selected tiki pages.
2327 * [NEW] Added 2 prefs cookie_domain and cookie_path for remember me cookie
2328 * [MOD] An alternative module-switch_lang2
2329 * [MOD] Allow article creators to edit their articles even if they don't
have
2330 the p_edit_article permission. Default behavior is unchanged, must be
turned
2331 on via the article types.
2332 * [MOD] submissions can now be edited by the creator, even if they do not
2333 have the p_edit_submission permission.
2334 * [FIX] Fixed bug that caused all subscriptions to a newsletter to be
deleted
2335 if a new address was added.
2336 * [FIX] lots of tempfile naming fixes
2337 * [FIX] Avatars in articles now show correctly
2338 - (rc1) ------------------------------------------------------------
2339 * [MOD] tiki-install.php now tries to create the dirs it needs. Less need
to run
2340 setup.sh
2341 * [NEW] Installation profiles allow for a pre-configured site at install
time.
2342 * [MOD] added a simple cache system for topic_image.php with optionnal
2343 reload=1 as argument for forcing cache reload (performance gain in
articles)

924 Back to TOC

 Tikiwiki Documentation 1.9+

2344 * [NEW] Customizable article types. Default types are Articles, Reviews,
Events,
2345 and Classifieds
2346 * [MOD] some module info removed from tiki_user_assigned_modules, now it
comes
2347 from tiki_modules, as you would expect.
2348 * [MOD] added an anchor jump to comments on comments and attachment links
2349 * [NEW] Plugin to include information from an article.
2350 * [MOD] Improved thread display of comments
2351 * [NEW] newsletter enhancements - per newsletter determine whether users
can
2352 subscribe, whether the address must be validated, and whether to
include an
2353 unsubscribe msg when a newsletter is sent. Removed frequency as unused.
2354 * [NEW] plugin for automatic link building of sourceforge tracker items
2355 using {SF(aid=>xxxxxx)}{SF}
2356 * [NEW] Editable dynamic variables can be added to tiki objects using
%name%.
2357 This allows quick editing and displaying of short information in wiki
pages
2358 and other objects.
2359 * [NEW] Last n messages posted in a forum can be displayed when listing
forum
2360 topics to provide a quick access to the last posts in the forum
regardless if
2361 they are new topics or replies to an existing thread. This is optional
and
2362 the
2363 number of post titles to display can be configured.
2364 * [NEW] Wiki pages can be cached or not cached individually, this setting
2365 overrides the global setting for caching wiki pages. (Allows to have
all
2366 pages
2367 cached but one or no pages cached but some, refresh times can differ
too)
2368 * [FIX] Article topics no longer require an image file to be uploaded
2369 * [MOD] Article pages now accepts type and topic parms to filter articles
2370 * [NEW] Added a Jabber plugin {JABBER()} Needs local jabber server to run.
2371 * [NEW] Basic error handling in function "query" in lib/tikilib.php
2372 * [NEW] assign page permissions to whole structures
2373 * [NEW] added an optional &highlight=word+otherword to highlight some
words in
2374 any page
2375 * [NEW] admin topics now allows existing topics to be changed
2376 * [FIX] fixed galaxia bugs while porting to adodb queries
2377 * [NEW] added a module to switch themes
2378 * [FIX] moved wiki table parse code behind link parse code
2379 * [NEW] function targetBlank in tiki-js.lib
2380 * [MOD] CODE plugin now accepts php syntax highlighting
{ CODE(colors=>php) }
2381 * [NEW] Replace PEAR::DB with ADOdb to support PostgreSQL, Oracle, MSSQL,
etc.
2382 * [NEW] Added Real-time IRC (Internet Relay Chat) logging
2383 * [MOD] Wiki pages can now belong to multiple structures

Back to TOC 925

6.6.3. Changelog 1.7
This page will be the final place for the feature related content in ReleaseProcess17, summing up all
relevant and interesting features additions hopefully.
Version 1.7 -Eta Carinae-
• FIX Added form to edit groups and change included groups
• NEW Added an Edit CSS feature, with fancy display of css and fast editor form
• NEW Added a setup_virtual.sh for virtual hosting, and changed internal code accordingly
• NEW Added a general Calendar feature for tiki content browsing and groups calendar
management. Uses overlib and some javascript enhancements.
• NEW Added a MODULE plugin to display modules inside wiki pages
• NEW Added copyrights management system.
• NEW Authentication: Tiki can use the Web Server authentication if admin wants, the user is
automatically logged to Tiki once the Web Server authentication is used.
• NEW Mechanism to prevent script/robotic user registration is supported, Tiki generates a
graphical number that the user must enter in the registration form to be registered. This
feature is optional and can be enabled/disabled from the admin->login menu.
• NEW New theme added: neat based on plone.
• NEW A single wiki-page can be a multi-page page using ... page ... to separate pages,
individual pages can be viewed using navigation links or a slideshow.
• NEW A wiki structure can be created/imported from a text representation of the tree where
structure levels are depicted by indenting the text with single spaces.
• NEW All pages in a structure can be exported from the admin structures page
• NEW A text representation of a Wiki structure can be exported then it can be used to create
(recreate) the structure in another system.
• NEW Blogs: Blog posts now support multi-page posts, the first page will be displayed when
listing blog posts (can be used as a heading) and the other pages are navigable when reading
a blog post.
• NEW Articles: Multi-page articles are now supported, use ... page... to separate pages in a
multi-page article. Navigation links to article pages automatically added.
• NEW Articles: The permission tiki_p_autoapprove_submission was added, groups with that
permission can submit articles that are automatically approved.
• NEW Articles: The list of articles can be configured choosing which columns should be
displayed when listing articles.
• NEW Wiki: Optionally admin can choose if the user who creates a page has admin
privileges over that page (remove, assign perms, etc)
• NEW Wiki: The listpages feature can be configured choosing what columns will be
displayed in the listing.
• NEW MyTiki page reformatted to a tabbed interface.
• FIX Lethal bug in tikilib that caused cache engine to infinitely recurse has been resolved.
• NEW Forums: Posts can be reported to moderator.
• NEW File galleries: Up to 6 files can be uploaded at once.
• NEW Forums control to view posts from the last X hours/days only.
• NEW File galleries dupes are now prevented.
• NEW File galleries improved, listings are configurable, files can be moved and deleted.
Better interface. etc
• NEW Banning system: Admin can ban users or IPs from specific sections of Tiki, rules
accept dates (suspensions). Usernames accept regexes, IPs accept wildcards example:

926 Back to TOC

 Tikiwiki Documentation 1.9+

23.*.*.*
• NEW Forums: Tiki distinguishes between read and unread posts
• NEW WML&PDA Integration using HawHaw: Use tiki-wap.php to access a Phone/PDA
friendly version of the Wiki.
• NEW Forum attachments added, you can setup which forums admit attachments and who
can attach files to forum posts.
• NEW Added forum discussion button to wiki page view: allows users to go straight to forum
for page discussion.
• NEW Drawings history added. From the admin drawings panel you can view the history,
remove versions, etc.
• NEW Drawings jGraphPad replaced jHotDraw, lot of new features and tools to edit
drawings which can be included in any parsed tiki object.
• NEW Forums: Breadcrumb added. Links to next/prev topic when browsing threads added.
• NEW Forums: Topic summaries added and can be used (optional)
• NEW Forums: Topic smileys can be used
• NEW File galleries: you can edit the name/description of files (Joan)
• NEW File galleries: duplicate uploads are prevented.
• NEW Articles: topic or article image can 'float' around text optionally.
• NEW Forums: columns to be listed in topic listing can be configured per-forum.
• NEW Forums: columns to be listed in forum listing can be configured.
• NEW Notes in notepad remember parsing mode.
• NEW Notes in notepad can be viewed as smarty templates
• NEW Forum posts can be saved to the notepad.
• NEW Weblog posts can be saved to the notepad.
• NEW Notepad: A note can be converted in a wiki page or update the content of any wiki
page (if permitted)
• NEW Notepad: notes can be merged into a single note.
• NEW Weblogs: Trackback pings implemented, you can send a ping from any weblog post to
any URI accepting trackback pings. Tiki will also accept trackback pings the tiki-
view_blog_post.php script implements the discovery mechanism, then Tiki can display a list
of trackback pings to your blog posts from other sites. Compatible with geeklog,
movabletype and other wonderful weblogging packages that are-now-eclipsed-by-the-
amazing-tiki-machine!
• NEW Weblogs: interface added to add images to a weblog post, this works with the
traditional editor or the brand-new WYSIWYG editor.
• NEW Customizable heading (all the html before posts) for weblogs.
• NEW You can control if individual weblogs accept comments
• NEW Weblogs: blog posts can use titles if the blog is configured to use titles.
• NEW Weblogs: admin can select what columns to list in the blog listing, the blog owner can
be listed as an avatar, link or text. Improved the look and fell of the blog listing.
• NEW WYSIWYG editor added for blog posts, you can now edit an HTML post for a blog
using a full-featured Wysiwyg editor (IE only in 1.7)
• NEW Workflow engine added. Create processes, monitor processes and execute processes.
Processes are mapped to PHP scripts. Please read the workflow documentation for a detailed
overview of the Workflow engine.
• NEW The special Smarty plugin {helplink page="PageName"} can be used to create a link
that will display a wiki page as a help popup. This allows your site to create an online help
system based on Wiki pages.

Back to TOC 927

 • NEW In file galleries, the file title and description now can be edited.
• FIX In file galleries, when a file had a title the filename was showed instead. Now it shows
title correctly, and title itself is not forced to be entered, the filename is shown when no file
title has been provided.
• NEW New popup window to see images in image galleries. It autosizes to the image's size.
• NEW Batch user import in Users administration. Now you can import users from a CSV
file. The CSV file needs to have the column names in the first record. The column titles
must match with fields in "users_users" table. Login, password and mail are forced. If an
unexistant field is specified, it's ignored.
• NEW Default .htaccess contains many apache/mod_rewrite commands: http://ex.com/tiki-
index.php?page=HomePage => http://ex.com/HomePage, http://ex.com/tiki-
view_blog.php?blogId=1 => http://ex.com/blog/1, etc.

6.6.4. Changelog 1.6

• Wiki structures added. You can organize wiki pages in structures and pages belonging to a
structure will show a navigation bar to the next-prev page in the structure. A tag was added
to display a table of contents for the current structure (in the first page of the structure for
example)
• Directory added. A link directory was added, you can classify links in categories and let the
user browser the categories or find links using a search engine. Users can suggest links that
may need to be validated by an admin.
• Permissions levels added, you can set-up the level of each permission and then you can
assign all level x permissions to a specific group. This can be used to quickly setup group
permissions using packs of permissions around a level.
• Inter-user messages. Users of a Tiki site can send messages to other users and receive
messages, privacy settings added as well as options to flag messages, mark them, reply, etc.
Admin can broadcast messages to all the users in the site. A module to display new
messages was added.
• Contact-us module. A module where the user can contact the admin using the ineternal
messaging system (if enabled) or an email.
• Who's online module. A module diplsying the names of the registered users that are online.
• Permissions interface improved. Permissions are now assigned/removed using checkboxes,
you can now assign/remove many permissions in one post.
• Mail-In feature added for the Wiki. An email account can be configured to manipulate wiki
pages. Several account types supported. Users can receive wiki pages by email, update pages
by email or append text to wiki pages sending emails to the configured accounts.
• Remember-me feature added to the ligin box (if enabled) the lifetime of the cookie used to
remember the user can be configured.
• New themes added: tceti,elegant,whitebluegray,bluegreen and others
• You can now view the source of any version in the page history listing and remove many
versions of a page using checkboxes.
• Inter-Wiki links were added admin can setup sites that can be used as external wikis and
then the syntax ((WikiName:PageName)) can be used to link to external pages in other
wikis.
• Optionally admin can implement user-level locks of pages, when activated users with
permission to lock pages can lock pages and only the user who locked a page or an admin
can unlock it. The user who locked the page is displayed as a tooltip of the locked page icon.

928 Back to TOC

 Tikiwiki Documentation 1.9+

• Handlers can be defined by the user to run some custom PHP functions before parsing wiki
pages or after parsing.
• A mini calendar was added users can enter events and view the calendar as a list of events,
as a weekly calendar or as a daily calendar. Reminders can be used no notify the user before
an event occurs. Calendars can be imported/exported to/from Outlook.
• A theme can now redefine any Tiki template, if a theme is found in templates/$theme then
that template is used, if not the template in templates/ is used.
• As an alternative Wiki table rows can now be separated by a new line instead of || making
the table syntax more readable.
• Users can add personal items to the application menu, as an option toplevel bookmars can be
automatically added to the menu.
• User notepad added, users can write notes or upload notes, read them and download them.
• Newsreader added, users can read news from any NNTP site.
• New wiki plugins added see the Wiki plugins section in this manual for information.
• Wiki page footnotes added, a footnote can contain user-level comments about the page. The
footnote is only displayed to the user that created it.
• Plugins are now re-entrant and recursive. Plugins can be nested and plugins can generate
other plugins code or wiki markup code.
• Wiki structures can be used to generate slide shows.
• User tasks added, including a module that can be used to enter new tasks display actiuve
tasks and remove tasks or mark them as done.
• Theme control center added: when activated admin can make sections, categories or
individual objects use a particular theme. Your site can then use multiple themes cahnging
the look and feel of the site as the users navigate it.
• Performance increased by reducing the size of libraries and making the string translation
phase a compile-level task.
• User files added, users can upload personal files and download them, admin can set up a
quota for users.
• Ephemerides added, text/images can be entered for each day in the calendar and the users
can browse them, a module to display today tetx/image if it exist is also provided.
• Many new minor features, improvements and enhancements were also added for this release.

6.6.5. Changelog 1.5

• You can select the name of your Wiki home page. Can be other than HomePage.
• Now admin has an option to enable full wiki page names allowing spaces and accents and
other characters to be part of a wiki page.
• Quick image uploads to wiki pages, you can upload a picture from the editpage feature and
have it displayed in the page immediately.
• Added a phpinfo link to check your php installation in the admin menu.
• Now you can make batch uploads of zip files for file galleries. If you have the right
permission just upload a zip file and all the files will be added to the gallery.
• Now you can use comments for individual blog posts.
• Tikilib code reduced splitting it into smaller libraries reducing memory consumption.
(stage1)
• Added a description field for Wiki pages (optional) when this feature is disabled the
description is displayed below the page name and as the title of a link to the page (form
other pages).

Back to TOC 929

 • Added direct link to pages in paginations (optional) if enabled you can jump to any page of a
multipage listing by following a link.
• Newsletters added, admins can setup newsletters and users can subscribe, emails are
required to confirm subscriptions and prevent spamming. Then admin can simply send an
HTML based newsletter to the subscribed (and confirmed) users. Users can unsubscribe
using a URL.
• Added an option to generate gzipped output to the browser.
• Base templates can now be defined by theme so you can create a theme presenting a whole
different layout for Tiki. You can also use this to create themes including images and other
decoration elements in Tiki. Since only base templates are classified by theme you can do it
changing just a few files. If you don't want to change the layout just copy the templates from
the templates directory if you are creating a theme.
• Changed wiki page names to support up to 150 characters.
• Menus now preserve their state between pages (using cookies) if cookies are disabled then
menus wont preserve state but will still work as they did before.
• Added plugins to the Wiki, now you can create your own plugins for the wiki to suit your
needs. The syntax is simple, see lib/wiki_plugins/example.php for a description and
example.
• Admin can choose if passwords are stored in plaintext or not. If not, a hash will be used to
authenticate users and the remind-password feature will generate a new password and send it
by email. The new password will be immediately due so the user will be forced to change it.
• All the JavaScript code has been packed into a library.
• Tiki can now be run on any Web server port.
• HTTPS protocol is now supported. Tiki can now run over HTTPS connections.
• BiDi support. Added support for BiDi languages. Added BiDi.css file to control BiDi
directionality and layout.
• Added ~ns~ ~/ns~ syntax to the Wiki to make page sections unparsed. Can be used to put
HTML code or anything that you want as-is without wiki syntax being parsed.
• Full text searching added (optional). By enabling this feature, results will be sorted by the
relevance of the match to the search query. Also, search results will be ordered first by
relevance, and then by section (wiki, blog, etc.). Non-fulltext searching continues to sort first
by section, and then by 'hits'.
• PHPWikiImport feature. You can export pages from a PHPWiki dump into tiki even
versions will be created.
• Export all wiki feature. As admin you can export the whole wiki as a text dump that can
later be imported into this or another Tiki site.
• Import/export wiki pages. Wiki pages can now be exported to a .txt Mimealike format and
imported from an exported file.
• Slideshows added, if a wiki page contains more than one -=titlebar=- then you can display it
as a slide show. This is a very cool feature.
• Admin can select the minimum length for a password to be valid.
• Admin can choose if user passwords must include letters and numbers to be valid.
• Admin can setup passwords lifetime and Tiki will force the user to change his password
once the password is expired.
• Challenge-response authentication added, if enabled and the browser support JavaScript then
user passwords are never send across the network being replaced by a challenge-response
authentication algorithm. This improves security since the chance of password
eavesdropping is reduced a lot.

930 Back to TOC

 Tikiwiki Documentation 1.9+

• Added sections to forums, now you can put forums into sections and the forums listing will
list forums for each existing section. (As phpBB and other forum software does).
• Improved forum layout to be nicer (Roger)
• Avatars added to forums. Users can configure their avatars from their user preferences
screen, pick an avatar from the library (more than 500) or upload an image to be used as
your avatar.
• Surveys, create surveys to get a better understanding on your users opinions, many survey
question types, users can fill surveys and stats are stored.
• Many bugs fixed, google module now works, definition lists fixed, wiki lists fixed, etc., etc.
• Webmail, set-up as many POP-accounts as you want, select a "current" account and you will
be able to read mails, write emails, delete emails, download attachments, use attachments,
write or read HTML based emails. Manage your address book, automatically add addresses
to your address book and all the regular cool webmail features.
• Trackers, trackers are a flexible way to track user-requests and groupware tasks, you can
define the fields for each tracker. Many field-types supported. Tracker items can be
commented and can have file attachments, tracker items can be assigned to a user or group
and will appear in the user preferences page (the user's home). Trackers and tracker items
can be monitored and Tiki will send you an email when something is changed. You can
open-close tracker items.
• Dates and times are displayed in the time zone specified by the user and/or the administrator.
The administrator (but not the user) can also specify the date and time format strings. Month
and weekday names are also localized, if locales are configured correctly on the server.

6.7. Changelog 1.4

• Quizzes added, you can create quizzes with any number of multiple choice questions, you
can assign points to each question and show an Quiz result to the user depending on his
score. Quiz results can be stored and stats are kept about Quizzes. You can also indicate a
time limit for each quiz and if the quiz can be repeated or not.
• HTML pages added, you can create and display static or dynamic HTML pages that can be
used as subhomes, special sections, credits page, live scores for spots, stock values, live
news coverage, etc. A very flexible addition and dynamic pages are very interesting.
• Now templates can be edited and applied to wiki pages, articles, submissions and HTML
pages.
• Shout box screen and shout box module added a nice way for users to communicate and
send shot messages to other users in the site.
• Now admin can choose to store files for file galleries on the database or a directory, using
directory requires some extra configuration but may be more comfortable to handle large
files.
• Optionally a passcode can be used to let user register into the system, this is useful for semi-
public or private sites.
• You can now specify how featured links will open with three options: replace current
browser window, open in a new window or open in a iframe inside the window.
• New syntax to underline text in wiki pages.
• New syntax to next lists in wiki pages you can use *,**,***,#,##,### etc
• New {showdate} function available to display the current date in modules.
• New top games module.
• New syntax to display a random image from any gallery {gallery id=n} in modules.

Back to TOC 931

 • Now groups can include other groups inheriting the included groups permissions.
• New syntax for internal links in the wiki: ((page|description))
• New theme: jalist
• Now you can select individual layout per sections if you want for example to remove a
column or a top bar only in the forums, faqs, etc.
• New since your last visit module showing new objects since the user last visit.
• You can now indicate the default ordering for weblogs in the weblog listing.
• You can use any URL as your home page so you can put any tiki section as the home page.
• Improved forums section showing more information for the last post in forums and forum
topics.
• Now you can collect stats about search terms and as admin see the most searched terms in
your site.
• Added a usage graph showing the activity for each section of your site (Wiki, Forums, etc).
• You can enable/disable the user ability to change the theme and language from the user
preferences screen.
• You can add regular expressions to filter filenames for file uploads, you can do positive
checks (filename must match regex) and negative checks (filename must not match regex).
• Added google search module.
• Added an option to prevent counting the admin page views for site stats.
• Modules can now accept parameters in the form of a URL query string (example
foo=1&bar=3) this can be used to tweak the behavior of modules so you don't need a zillion
different modules you can use only one with parameters for the same kind of task.
• Added raw navigation mode to the wiki. You can use tiki-index_raw.php instead of tiki-
index.php to get a raw representation of the Wiki without columns bars and decorations this
can be used to feed a program that automatically navigates wikis such as the Touchgraph
wiki browser.
• Improved forums listing more information about the last post.
• New syntax for wiki table accepting colspanning ||r1c1|r1c1||r2c1c2||
• Option added in the admin screen to prevent counting admin page views.
• Editable drawings can be included in Wiki pages, articles and blog posts using {draw
name=foo}, a permission is needed to be able to edit_drawings. Drawings are stored in a
directory and identified by their name. The drawings are edited using a Java applet called
jHotDraw. This feature can be disabled.
• Referrer stats, you can enable an option to store statistics about referrers to your site, a
screen where the referrers are listed is provided to see the stats.
• Batch upload of Images. If you have the permission you can upload .zip files and all the
images in the zip file are automatically added to the gallery.
• File attachments for wiki pages, with the right permissions you can upload files to wiki
pages and a list of attached files will be displayed at the bottom of the wiki page and they
can be downloaded.
• Now images for the image galleries can be stored optionally in a directory instead of the
database, the same recommendations and tips about storing file uploads should be observed.
• Improved spellchecker, now the spellchecker suggest several options for miss-spelled words
and you can choose the option that you prefer from the list.
• Icons are displayed for file extensions when listing files.
• You can enable/disable an option to display the page title for wiki pages.
• Improved menu builder.
• You can now choose if hotword links are opened in a new window.

932 Back to TOC

 Tikiwiki Documentation 1.9+

• Reduced the number of queries that tiki makes when loading preferences, if not changed
preferences are loaded from a file now this is controlled automatically and you don't have to
do anything.
• Integrated search feature you can now search for words on the entire site.

6.7.1. Changelog 1.3

• Spell checking, now you can spell check your articles, submissions, wiki_pages and
blog_posts before saving them, the spell checking dictionary for your language must be
downloaded and installed to make this work, dictionaries will be provided as simple .sql
dumps and can be downloaded from SourceForge. In this edition the english dictionary is
provided. (Read the documentation to learn how to install the dictionary). Spell checking
can be enabled/disabled for Articles, Submissions, WikiPages and blogs from the admin
screen.
• Orphan pages listing, list pages that are not linked from any other wiki page.
• RSS feeds for forums listing the last post to any forum in your site.
• RSS feed for individual forums listing the last posts to a given forum.
• New Diff routine taken from PHPWiki in the Wiki history for a page, now you can see the
diff or compare two versions side-by-side as before.
• New syntax for colored text in the Wiki ~~#0000FF:text~~ to insert text using colors.
• Syntax to center text ::text:: will center the text.
• Relevance ranking for WikiPages based on a PageRanking algorithm.
• You can now send/receive articles from/to other Tiki sites from the communications center.
• You can now search deep into subcategories from the category browser.
• Added a tool to produce a printable version of multiple Wiki pages.
• Now you can preview comment postings in any "commentable" area or in the forums.
• BreadCrumb navigation module listing the last "n" pages that you visited.
• New feature: FAQs, create and edit faqs, list faqs, popular faqs module and last faqs module,
search for text in faqs.
• Several fixes regarding "find" functions in listings.
• Find feature in the listing of Wiki pages.
• New syntax for WikiPages ((any)) can be used to create the "any" page, now page names are
NOT limited to the CapitalizedWordsSmashedTogether rule.
• Syntax to prevent converting Smashed words into wiki names use: ))SomeIdea((
• Now you can double-click on a wiki page to edit it (some browsers only).
• Filter added in the communication center to find specific objects to be sent.
• A tool to autogenerate passwords was added in the resgistration screen for lazy users.
• New feature: Backups, you can create backups of your entire Tiki base, download backups
to be saved in some safe place, upload a backup and restore backups. Backups are encrypted
to prevent a user from stealing information from your site.
• New registration mode, now you can make Tiki validate users email address by sending
them an email with a link to first-login in Tiki, once activated the user will login normally
with his password. Of course this feature is optional and can be enabled/disabled from the
Admin screen.
• QuickEdit module, where you can type the name of a WikiPage and quickly edit/create the
page without finding a link to the page, this can create a lot of orphan pages but can also be
very very helpful to people mantaining the Wiki to quickly create pages and edit them.
• Optionally Tiki can display a "I forgot my password link" for unregistered users to allow

Back to TOC 933

 users that have forgotten their password to get it by email. You can enable/disable this
feature from the Admin screen.
• User Bookmarks, users with the proper permission can create bookmarks and store them in
folders, they can admin their bookmarks as they want, a cache is provided for user
bookmarks. A user module to display bookmarks with an option to quick-add a Tiki page to
the bookmarks is also included.
• Users with the right permission can configure the modules that will be displayed in the
left/right columns and the order in which modules will appear. This can be used to let users
configure their modules as they want, as an admin you must make all the modules that the
users can configure available by default.
• Statistics, a page where you (or anyone with permission) can view a lot of statistics about
the site including a graph showing the number of page views per day. Statistics can be
enabled/disabled from the admin screen, please suggest new (useful) statistics that can be
added in future versions.
• Fortune cookies (taglines), you can enter taglines or upload from a textfile, the "How many
feature is too much?" syntax can be used to display a random cookie in articles, posts, wiki
pages,etc or any template.
• Games section to play flash games, upload games or use the provided additional game-pack.
You can upload new games, edit the descriptions and play.
• Added a new theme: dblue.
• Now the list of users in the current chat channel is displayed in the chatrooms.
• Now you can send private messages in the chatrooms using ":username:message"
• Reviews added, now articles can be normal articles or reviews, for reviews the editor can
rate whatever he is reviewing.
• Undo feature in the wiki, if a user can edit pages then he can undo what he edited pressing
an undo button, users without permission to remove versions won't be able to undo what
other users edited only his editions can be undone.
• Individual permissions for CMS topics added, you can now control who can read some
topics, if the topic has no individual permissions then it will be displayed to all the groups.
But if you want you can assign the tiki_p_read_topic permission to some groups for a topic
and only those groups will be able to read that topic.
• A mini-popup window can be opened when editing objects to help the user insert special
characters in the text, specially latin characters, accents, etc. This is taken from the horde
project and submited by Marc Laporte.
• Tiki is now using Smarty 2.3.1 the last stable Smarty release.

6.7.2. Changelog 1.2

• Added a find feature to the lastchanges section in the Wiki (Ramiro).
• Added Categories: You can create categories and subcategories building a category tree,
objects (pages, forums, blogs, image galleries, file galleries, etc) can be assigned to
one/many categories, the user can browse categories finding objects for each specific
category.
• Communications center: Now you can send/receive Wiki pages from/to other Tiki-enabled
sites using a simple XMLRPC API, received pages are stored in an "ibox" where an admin
can view,edit,remove,accept the pages. This new feature can be used to send a Tiki page
from one site to another one!
• Consolidated CSS file, there're two CSS files in this distribution: subSilver and default2, if

934 Back to TOC

 Tikiwiki Documentation 1.9+

you wantto produce a new theme you can change any of these, subSilver is longer and uses
an individual style for every element in Tiki while default2 applies the same style to
multiple elements (ie: tables) and thus is a faster way to get a theme ready.
• Forums!, now you can set-up mesage forums, forums are organized by topics and topics by
threads, users can post, reply and quote messages in forums, messages can be voted using
the same karma system used in comments. Many features are "copied" from phpBB since it
is the best forum software for PHP, we copied those features and integrated the forums with
the Tiki permission system, rankings, modules and search engine.
• Now you can upload th thumbnail of an image when uploading an image, this will prevent
automatic thumbnail generation. Some users wanted this feature because thumbnail
generation didn't work or theywanted to upload their own thumbnails. Maybe you want to
have a thumbnail that is not the same as the full image so you can use this feature.
Thumbnails will be displayed using the size assignated for thumbnails to the image gallery.
• Now you can set up how old must a version be at least to be removed from the history, this
can prevent a user from saving a page "n" times destroying a previous version. (Thanks to
tesla2k for the tip)
• Links to help including objects in user modules where added to the admin_modules screen.
• Next and prev buttons where added to view the next/prev image when browsing images
from a gallery (Ramiro).
• Now you can control which groups can view image galleries and filegalleries.
• Individual permissions for image galleries, as an admin you can control which groups can
view,admin, upload to a specific gallery overriding global permissions.
• Individual permissions for file galleries, as an admin you can control which groups can
view,admin, upload and download to a specific gallery overriding global permissions.
• Individual permissions can be set up by admins to weblogs, so you can control which groups
can read, admin and post to specific weblogs.
• From the page-permissions screen admins can set up email addresses that will receive an
email when the page changes. If you want to remotely monitor some page this is for you.
• Chatrooms feature (experimental), you can create chatrooms and the users can enter
chatrooms and chat, the refreshing time for each chatroom can be configured and the page is
not reloaded, only an invisible frame with size 0 is reloaded to get fresh chat messages.
• RSS modules, create RSS modules to display news/events from other sites, you can display
RSS feeds in user modules using {rss id=n}, you can set up which feeds can be displayed
and the refreshing time for each feed. RSS 0.91 and 1.0 are supported.
• Polls, you can create polls, set polls to be "active,closed,current". Polls can be displayed in
modules using {poll id=n} or {poll} to select a random poll from the "current" polls. There's
a page to view poll results and old poll results and old polls not closed can be voted. A
mechanism to prevent a user from voting many times is also included.
• Menu builder section, you can build menus using sections and options, menus can be static
(no javascript) or dynamic. Menus can be displayed in user modules using {menu id=n}
• Comments can now be filtered by threshold.
• Comments for weblogs,articles, image galleries, file galleries and polls.
• A selected file gallery can be used as the home page for the site.
• Now you can enable/disble RSS feeds from the admin screen and limit the maximum
number of items for any feed.
• New RSS feed for individual file galleries listing the last images uploaded to a given gallery.
• New RSS feed for individual image galleries listing the last images uploaded to a given
gallery.

Back to TOC 935

 • New RSS feed for weblogs listing last posts to any weblog.
• New RSS feed for file galleries listing last files uploaded.
• New RSS feed for image galleries listing last images uploaded.
• Random pages module.
• Now you can include dynamic content blocks in wiki pages using {content id=n} or
{rcontent id=n}.
• Now you can use {rcontent id=n} to select a random content from a dynamic block content,
the syntax can also be used to select the last current content for a block.
• New Wiki element: ^some^ will render "some" inside a simple box.
• The layout can be configured from the admin screen you can enable disable the columns, top
bar and footer.

6.7.3. Changelog 1.1

• The edit button now shows on red if someone may be editing the page, this helps
preventingtwo users from editing the same page. This feature can be enabled/disabled from
the admin menu.
• Now HTML tags are filtered out from weblog posts except normal tags such as
a,p,img,br,table,i,b,etc.
• Link added to edit the page from the wiki pagelist.
• Page generation time was added below the footer.
• The featured links admin screen has been revamped, now featured links can be
enabled/disabled and ordered as you want, an automatic ordering feature by link -hits was
also added. Hits are now counted and displayed for featured links.
• The titlebars in wikipages are now brown instead of the terrible blue ones.
• File galleries, create galleries, add files to galleries, download files. Permissions
configurable, rankings for file galleries and modules available.
• Module names are now sorted in the admin modules screen.
• Now you can see permissions according to categories when assigning permissions to groups,
the assign permissions screen was revamped.
• Wiki page comments, now you can activate/deactivate comments for wiki pages, comments
can be voted and replied, configurable permissions and karma system for comment points(!)
• Fixed minor layout problems and xhtml glitches.
• Several bugfixes and minor improvements on the code.

6.7.4. Changelog 1.0

• Added blogs to Tiki, users can create blogs, post entries in blogs, find entries, etc.
• The calendar can be now used to navigate blogs watching the posts for a given day.
• Added an XMLRPC interface compatible with blogger, users can use desktop applications
such as blogbuddy or bloggar to send posts to weblogs.
• Added a CMS system to Tiki, topics and articles can be edited and published or programmed
to be published.
• Added submissions to Tiki, users can send submissions, admins can approve them and make
them articles.
• Improved the search engine, now you can search in pages, galleries, images, blogs and/or
articles, added pagination to the search results page.
• Added an option to select the home page of the application, it can be the Wiki HomePage, a

936 Back to TOC

 Tikiwiki Documentation 1.9+

blog, the articles homepage (listing last n articles) or an Image Gallery.

• Make the main application menu expandable/collapsable per section.
• Added banners (Beta version) admins can add banners classified in zones, a banner can be
displayed in any template using a simple syntax (including user modules) banners can
display HTML code, an image or text (text adds) a page with banner stats accessible by
users (clients) is also available.
• Templates can now be edited from Tiki.
• Added a dynamic content system, this allo ws to edit blocks that can be included in any
template or user module using a simple syntax. Blocks can be programmed for the future
and are automatically changed by Tiki. This feature adds a lot of flexibility to the
application.

Back to TOC 937

6.8. Tikiwiki Community

6.8.1. From http://tikiwiki.org/TikiCommunity

Members of the community (on Saturday 06 December, 2003 )

• registered on tikiwiki.org 2474,
• dev on tikiwiki.org 118,
• dev on sourceforge.net 153

6.8.2. From http://tikiwiki.org/CommunityWorldmap

Our Tiki Map features the community worldmap here on tikiwiki.org semi-dynamically from now
on: in a nice zoomable, panable, layered fashion.

If you feel like adding your spot, edit your location in User Preferences.

Thanks to Franck, Spatialguru, Mose, the users and developers of the Mapserver community , and
all others who inspired and worked on these features!

Click for live map!

For some quick-overview links and starters, check out these:

• Europe
• North America
• South America
• Africa

938 Back to TOC

 Tikiwiki Documentation 1.9+

• Oceania
• Asia

Please participate!
Look up your longitude & latitude! and enter your location in your Personal Information tab in
User Preferences ! Once you add your coordinates, please drop by the IRC chatroom and ask an
admin to regenerate the maps.

If you are interested in more detail about this feature, read up on TikiMap!

6.8.3. From http://cvs.tikiwiki.org

6.8.3.1. Activity by Author

Author Karma Commits Added Removed Change

mose 1,157,101 3,165 709,584 605,434 104,150
sylvieg 746,176 3,596 210,052 170,633 39,419
lrargerich 532,686 473 292,311 53,707 238,604
damosoft 463,506 1,251 155,415 325,457 -170,042
redflo 305,646 684 256,312 123,263 133,049
ohertel 302,272 976 102,529 73,362 29,167
luciash 248,479 619 82,073 84,400 -2,327
teedog 151,732 665 39,141 30,372 8,769
lfagundes 132,356 371 45,404 18,547 26,857
musus 120,003 199 67,112 23,027 44,085
zaufi 116,184 497 33,526 25,825 7,701
rossta 108,734 118 160,787 91,993 68,794
rlpowell 106,112 295 163,630 127,577 36,053
awcolley 94,115 68 60,536 66,796 -6,260
franck 78,249 173 35,585 15,694 19,891
nyloth 77,149 205 10,791 5,115 5,676
xavidp 66,161 76 33,848 32,700 1,148
amette 60,998 263 17,166 5,094 12,072
ang23 55,798 78 25,008 15,505 9,503
toggg 53,501 253 13,110 16,913 -3,803
lphuberdeau 52,334 156 28,754 1,268 27,486
michael_davey 47,907 351 10,375 4,709 5,666
chris_holman 44,028 56 39,472 18,331 21,141
ggeller 43,324 177 16,971 7,232 9,739
marclaporte 38,779 387 3,677 23,929 -20,252
dheltzel 38,259 153 10,670 11,911 -1,241

Back to TOC 939

 Author Karma Commits Added Removed Change
gunnarre 34,677 13 16,439 11,654 4,785
sampaioprimo 34,130 59 100,270 60,312 39,958
gongo 33,798 66 13,147 9,771 3,376
dgdaniels 33,505 172 9,872 7,316 2,556
chealer 32,690 209 1,851 29,432 -27,581
nhuffschmid 32,609 75 16,648 14,724 1,924
mikespub 30,162 16 25,054 16,093 8,961
rv540 29,038 73 11,064 1,886 9,178
gmuslera 28,358 70 11,666 9,855 1,811
gimpster 27,154 39 9,432 9,088 344
patvdv 24,845 18 11,299 7,688 3,611
jreyesg 23,432 14 10,199 310 9,889
techtonik 23,333 34 9,508 8,191 1,317
jmjuzan 20,785 136 3,379 3,036 343
nikchankov 20,726 3 68,691 161 68,530
xenfasa 20,639 13 16,221 16,165 56
josefgc 20,213 6 10,424 0 10,424
docekal 18,121 11 7,389 6,493 896
dimaz-z 15,752 8 9,282 9,003 279
gilshwartz 15,315 53 5,001 2,841 2,160
lechuckdapirate 14,929 15 6,583 5,231 1,352
papercrane 14,846 62 5,855 308 5,547
rcogley 14,811 24 6,378 5,639 739
nkoth 14,787 99 1,207 516 691
yuzhenxin 13,492 11 6,391 5,687 704
jburleyebuilt 12,353 20 1,926 1,682 244
niclone 11,502 61 2,619 1,566 1,053
wolff_borg 11,290 95 2,536 11,693 -9,157
filmil 11,290 9 7,184 3,759 3,425
wesleywillians 11,032 32 4,177 192 3,985
moresun 11,006 54 3,452 2,236 1,216
lueders 10,929 24 3,408 3,301 107
coloradoweb 10,926 27 3,538 515 3,023
dmytro 10,671 7 5,114 1,718 3,396
gillesm 10,371 52 1,752 569 1,183
mcfarland 10,116 3 23,565 8 23,557
melmut 10,089 15 4,088 6,648 -2,560
jorgercosta 9,992 13 4,721 920 3,801
troworld 9,890 8 4,728 2,839 1,889
fukuchi 9,619 13 4,479 1,422 3,057

940 Back to TOC

 Tikiwiki Documentation 1.9+

Author Karma Commits Added Removed Change

traivor 9,407 43 2,403 1,932 471
mikelcu 9,349 1 4,583 0 4,583
dim_m 8,882 3 4,381 3,557 824
cyantree 8,845 1 4,406 1,049 3,357
gene203 8,281 10 3,823 346 3,477
aurel42 7,623 15 3,376 3,366 10
garygriffin 7,396 38 2,041 1,527 514
pmichelazzo 7,131 1 3,553 2,816 737
giottomx 6,952 16 2,917 647 2,270
damienmckenna 6,622 7 2,971 472 2,499
mhausi 6,320 54 1,498 1,011 487
georger_br 6,291 45 907 702 205
jyhem 6,247 34 1,852 588 1,264
florianlink 5,726 4 2,755 2,729 26
markusvk 5,692 12 1,889 1,501 388
hartsa1 5,608 4 2,724 2,393 331
fmathias 5,528 27 651 402 249
cdx 5,328 23 952 495 457
ingesol 5,325 6 2,269 125 2,144
telenieko 5,166 29 1,165 565 600
hangerman 4,957 27 1,345 491 854
lmoss 4,746 43 544 223 321
jmaspons 4,404 11 1,956 1,678 278
fr_rodo 4,403 22 765 144 621
bburgaud 4,207 16 1,251 898 353
halon 3,824 27 863 156 707
btodoroff 3,784 13 174 46 128
gravesweeper 3,653 6 1,404 92 1,312
thenano 3,449 17 296 175 121
djnz 3,350 31 502 231 271
cfreeze 3,193 3 1,158 2 1,156
runix2 3,125 26 274 134 140
axonrg 3,117 7 1,092 278 814
pkdille 3,108 22 224 175 49
laetzer 3,038 6 1,281 996 285
afahlvik 2,756 6 1,235 1,234 1
tna 2,703 17 732 492 240
anope 2,697 5 1,245 1,243 2
kyori 2,504 7 735 166 569
tombombadilom 2,414 26 341 37 304

Back to TOC 941

 Author Karma Commits Added Removed Change
caustin_ats 2,243 6 635 222 413
dcengija 2,011 14 239 21 218
yonixxx 1,856 11 250 16 234
jdrexler 1,791 6 325 100 225
ice8878 1,746 3 809 550 259
uiprncss 1,655 8 424 263 161
cbowman 1,571 10 95 57 38
pippone 1,560 2 718 718 0
jpgimenez 1,511 16 291 218 73
xaman 1,499 3 620 523 97
marcmont 1,478 8 321 48 273
jjongsma 1,473 9 257 155 102
darzee 1,468 5 313 18 295
awolfff 1,330 9 82 41 41
karneevor 1,294 7 489 486 3
as6o 1,285 8 360 43 317
mashmorgan 1,222 8 417 417 0
dabright 1,205 2 261 73 188
avgasse 1,176 5 259 67 192
zcecil 1,054 4 418 6,673 -6,255
jenolan1701 1,049 4 158 137 21
drieschner 1,016 8 186 51 135
hsaelens 983 10 30 30 0
avdwheel 974 10 152 63 89
jkring 950 4 66 1 65
marylly 939 6 32 15 17
rabiddog 896 2 301 209 92
jasondiceman 885 4 364 704 -340
gertdewit 805 7 55 33 22
jeanhabib 798 2 361 439 -78
agorski 773 5 38 64 -26
russwilde 731 8 66 39 27
popovich 726 4 31 31 0
koobla 701 4 138 40 98
bluestrain 697 8 22 15 7
epolidor 695 13 23 15 8
rhwinter 687 2 182 2 180
gregmartin 685 5 38 11 27
xeno_tt 683 6 14 13 1
rischconsulting 681 8 79 58 21

942 Back to TOC

 Tikiwiki Documentation 1.9+

Author Karma Commits Added Removed Change

jaw959 622 9 117 114 3
mitchmurphy 620 4 17 6 11
jwigdahl 609 3 192 186 6
philwhipps 595 3 214 7 207
illori 562 2 24 7 17
berryweb 540 8 19 2,746 -2,727
connermo 529 2 1 1 0
roysinn 521 7 28 22 6
lorfds 513 2 100 95 5
stuartd 506 5 26 13 13
bligneri 506 4 19 19 0
rbschmidt 472 6 26 11 15
k2s 462 3 20 5 15
beuc 441 4 94 69 25
penny336 412 6 35 24 11
vinsz 406 1 60 11 49
vulgrin 405 4 23 8 15
ksumacgyver 392 2 45 15 30
spiderr 383 5 16 13 3
fmk_ca 367 2 16 22 -6
shiroitenshi 361 3 78 89 -11
rleibman 360 5 68 108 -40
squee-d 352 1 6 7 -1
aneuhaus 332 3 23 20 3
wings-of-glory 298 2 12 6 6
aigarius 276 3 23 13 10
swillie 258 1 34 15 19
mchurch 253 2 23 19 4
jcwinnie 245 1 99 98 1
gspira 230 3 27 23 4
jjolly 228 2 5 4 1
deragon 226 2 12 6 6
orionrobots 218 2 6 3 3
zibas 211 2 3 9 -6
marcius 197 4 15 14 1
brab 180 2 16 9 7
freevic 180 2 21 5 16
ragnvald 159 2 0 0 0
chibaguy 159 3 6 3 3
atooni 149 1 24 4 20

Back to TOC 943

 Author Karma Commits Added Removed Change
alex_freire 144 1 20 5 15
colinmo 131 2 2 2 0
makenai 118 1 11 1 10
lnewby 116 1 1 1 0
sept_7 110 1 9 2 7
guideweb 108 2 19 18 1
lack 97 1 1 0 1
fhcorrea 96 1 10 2 8
garfield-sf 76 1 1 1 0
johan_mx 67 1 1 1 0
sabdelma 67 1 3 3 0
joeyhartmann 66 1 2 2 0
fmjrey 65 1 0 3 -3
ace_mtp 54 1 2 2 0
broubrou 52 1 1 0 1
benjf 51 1 2 0 2
pyrotknix 50 1 1 1 0
isotopp 22 1 1 1 0

944 Back to TOC

 Tikiwiki Documentation 1.9+

6.9. Copyrights: CC-by-sa

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License by Tikiwiki
Community, 2007.

See below for more details.

6.9.1. Human-readable summary

Creative Commons
This page is available in the following languages:
Afrikaans български Català Dansk Deutsch English English (CA) English (GB) English (US) Esperanto Castellano Castellano (AR) Español (CL)
Castellano (MX) Euskara Suomeksi français français (CA) Galego ‫ עברית‬hrvatski Magyar Italiano 日本語 한국어 Macedonian Melayu Nederlands
Sesotho sa Leboa polski Português Português (PT) svenska slovenski jezik 简体中文 華語 (台灣) isiZulu

Creative Commons License Deed: Attribution-ShareAlike 2.5

You are free:

• to Share — to copy, distribute and transmit the work
• to Remix — to adapt the work

Under the following conditions:

• Attribution. You must attribute the work in the manner specified by the author or licensor
(but not in any way that suggests that they endorse you or your use of the work).
• Share Alike. If you alter, transform, or build upon this work, you may distribute the
resulting work only under the same or similar license to this one.
• For any reuse or distribution, you must make clear to others the license terms of this work.
The best way to do this is with a link to this web page.
• Any of the above conditions can be waived if you get permission from the copyright holder.
• Nothing in this license impairs or restricts the author's moral rights.
Disclaimer

Back to TOC 945

 Your fair dealing and other rights are in no way affected by the above.
This is a human-readable summary of the Legal Code (the full license).
Learn how to distribute your work using this license

6.9.2. Legal Code (Full License)

THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS
CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS
PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE
WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS
PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND
AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS
YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF
SUCH TERMS AND CONDITIONS.

6.9.2.1. 1. Definitions

• "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in

which the Work in its entirety in unmodified form, along with a number of other
contributions, constituting separate and independent works in themselves, are assembled into
a collective whole. A work that constitutes a Collective Work will not be considered a
Derivative Work (as defined below) for the purposes of this License.
• "Derivative Work" means a work based upon the Work or upon the Work and other pre-
existing works, such as a translation, musical arrangement, dramatization, fictionalization,
motion picture version, sound recording, art reproduction, abridgment, condensation, or any
other form in which the Work may be recast, transformed, or adapted, except that a work
that constitutes a Collective Work will not be considered a Derivative Work for the purpose
of this License. For the avoidance of doubt, where the Work is a musical composition or
sound recording, the synchronization of the Work in timed-relation with a moving image
("synching") will be considered a Derivative Work for the purpose of this License.
• "Licensor" means the individual or entity that offers the Work under the terms of this
License.
• "Original Author" means the individual or entity who created the Work.
• "Work" means the copyrightable work of authorship offered under the terms of this License.
• "You" means an individual or entity exercising rights under this License who has not
previously violated the terms of this License with respect to the Work, or who has received
express permission from the Licensor to exercise rights under this License despite a previous
violation.
• "License Elements" means the following high-level license attributes as selected by Licensor
and indicated in the title of this License: Attribution, ShareAlike.

6.9.2.2. 2. Fair Use Rights

Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first
sale or other limitations on the exclusive rights of the copyright owner under copyright law or other

946 Back to TOC

 Tikiwiki Documentation 1.9+

applicable laws.

6.9.2.3. 3. License Grant

Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide,
royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to
exercise the rights in the Work as stated below:
• to reproduce the Work, to incorporate the Work into one or more Collective Works, and to
reproduce the Work as incorporated in the Collective Works;
• to create and reproduce Derivative Works;
• to distribute copies or phonorecords of, display publicly, perform publicly, and perform
publicly by means of a digital audio transmission the Work including as incorporated in
Collective Works;
• to distribute copies or phonorecords of, display publicly, perform publicly, and perform
publicly by means of a digital audio transmission Derivative Works.
• For the avoidance of doubt, where the work is a musical composition:
• Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right
to collect, whether individually or via a performance rights society (e.g. ASCAP,
BMI, SESAC), royalties for the public performance or public digital performance
(e.g. webcast) of the Work.
• Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to
collect, whether individually or via a music rights society or designated agent (e.g.
Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover
version") and distribute, subject to the compulsory license created by 17 USC
Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
• Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the
Work is a sound recording, Licensor waives the exclusive right to collect, whether
individually or via a performance-rights society (e.g. SoundExchange), royalties for
the public digital performance (e.g. webcast) of the Work, subject to the compulsory
license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in
other jurisdictions).

The above rights may be exercised in all media and formats whether now known or hereafter
devised. The above rights include the right to make such modifications as are technically necessary
to exercise the rights in other media and formats. All rights not expressly granted by Licensor are
hereby reserved.

6.9.2.4. 4. Restrictions

The license granted in Section 3 above is expressly made subject to and limited by the following
restrictions:
• You may distribute, publicly display, publicly perform, or publicly digitally perform the
Work only under the terms of this License, and You must include a copy of, or the Uniform
Resource Identifier for, this License with every copy or phonorecord of the Work You
distribute, publicly display, publicly perform, or publicly digitally perform. You may not
offer or impose any terms on the Work that alter or restrict the terms of this License or the
recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You

Back to TOC 947

 must keep intact all notices that refer to this License and to the disclaimer of warranties. You
may not distribute, publicly display, publicly perform, or publicly digitally perform the
Work with any technological measures that control access or use of the Work in a manner
inconsistent with the terms of this License Agreement. The above applies to the Work as
incorporated in a Collective Work, but this does not require the Collective Work apart from
the Work itself to be made subject to the terms of this License. If You create a Collective
Work, upon notice from any Licensor You must, to the extent practicable, remove from the
Collective Work any credit as required by clause 4(c), as requested. If You create a
Derivative Work, upon notice from any Licensor You must, to the extent practicable,
remove from the Derivative Work any credit as required by clause 4(c), as requested.
• You may distribute, publicly display, publicly perform, or publicly digitally perform a
Derivative Work only under the terms of this License, a later version of this License with the
same License Elements as this License, or a Creative Commons iCommons license that
contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan).
You must include a copy of, or the Uniform Resource Identifier for, this License or other
license specified in the previous sentence with every copy or phonorecord of each
Derivative Work You distribute, publicly display, publicly perform, or publicly digitally
perform. You may not offer or impose any terms on the Derivative Works that alter or
restrict the terms of this License or the recipients' exercise of the rights granted hereunder,
and You must keep intact all notices that refer to this License and to the disclaimer of
warranties. You may not distribute, publicly display, publicly perform, or publicly digitally
perform the Derivative Work with any technological measures that control access or use of
the Work in a manner inconsistent with the terms of this License Agreement. The above
applies to the Derivative Work as incorporated in a Collective Work, but this does not
require the Collective Work apart from the Derivative Work itself to be made subject to the
terms of this License.
• If you distribute, publicly display, publicly perform, or publicly digitally perform the Work
or any Derivative Works or Collective Works, You must keep intact all copyright notices for
the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of
the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original
Author and/or Licensor designate another party or parties (e.g. a sponsor institute,
publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or
by other reasonable means, the name of such party or parties; the title of the Work if
supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that
Licensor specifies to be associated with the Work, unless such URI does not refer to the
copyright notice or licensing information for the Work; and in the case of a Derivative
Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French
translation of the Work by Original Author," or "Screenplay based on original Work by
Original Author"). Such credit may be implemented in any reasonable manner; provided,
however, that in the case of a Derivative Work or Collective Work, at a minimum such
credit will appear where any other comparable authorship credit appears and in a manner at
least as prominent as such other comparable authorship credit.

6.9.2.5. 5. Representations, Warranties and Disclaimer

UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS

THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY

948 Back to TOC

 Tikiwiki Documentation 1.9+

KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR

OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE,
MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR
THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF
ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO
NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY
NOT APPLY TO YOU.

6.9.2.6. 6. Limitation on Liability.

EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL

LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL,
INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT
OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

6.9.2.7. 7. Termination

• This License and the rights granted hereunder will terminate automatically upon any breach
by You of the terms of this License. Individuals or entities who have received Derivative
Works or Collective Works from You under this License, however, will not have their
licenses terminated provided such individuals or entities remain in full compliance with
those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
• Subject to the above terms and conditions, the license granted here is perpetual (for the
duration of the applicable copyright in the Work). Notwithstanding the above, Licensor
reserves the right to release the Work under different license terms or to stop distributing the
Work at any time; provided, however that any such election will not serve to withdraw this
License (or any other license that has been, or is required to be, granted under the terms of
this License), and this License will continue in full force and effect unless terminated as
stated above.

6.9.2.8. 8. Miscellaneous

• Each time You distribute or publicly digitally perform the Work or a Collective Work, the
Licensor offers to the recipient a license to the Work on the same terms and conditions as
the license granted to You under this License.
• Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to
the recipient a license to the original Work on the same terms and conditions as the license
granted to You under this License.
• If any provision of this License is invalid or unenforceable under applicable law, it shall not
affect the validity or enforceability of the remainder of the terms of this License, and without
further action by the parties to this agreement, such provision shall be reformed to the
minimum extent necessary to make such provision valid and enforceable.
• No term or provision of this License shall be deemed waived and no breach consented to
unless such waiver or consent shall be in writing and signed by the party to be charged with
such waiver or consent.

Back to TOC 949

 • This License constitutes the entire agreement between the parties with respect to the Work
licensed here. There are no understandings, agreements or representations with respect to the
Work not specified here. Licensor shall not be bound by any additional provisions that may
appear in any communication from You. This License may not be modified without the
mutual written agreement of the Licensor and You.

950 Back to TOC

 Tikiwiki Documentation 1.9+

6.10. Alphabetical Index

3 RULES......................................................................... 22, 760 914
ACTION LOG.....16,
.....16, 19, 21, 114, 496, 554, 557, 558, 642, 644, Live Support...........................15, 168, 489, 491, 496
651, 727, 729, 730, 738, 824, 825 Localization (l10n)......... 22, 168, 646, 782, 823, 824
ACTION LOG............................................................................... Login................................. 20, 86, 168, 660, 823, 831
User Action log..................................................... 19, 642 Mail notifications........... 21, 656, 657, 717, 836, 919
ACTIVITY..... 12, 26, 31, 35, 114, 119, 255, 258, 263, 268, 269, Mail-in..... 21, 112, 283, 651, 687, 717-719, 923, 928
271, 297, 346, 411, 412, 415, 417-421, 424-429, 432, 553, Maps (Mapserver). 15, 168, 498, 499, 515, 522, 526
557, 558, 595, 598, 599, 729, 737, 738, 803, 804, 810, 840, Menus.....59, 114, 147, 158, 247, 248, 272, 302, 326,
911, 912, 932, 939 407, 451, 454, 486, 549, 575, 577, 586, 595, 600,
ADMIN....................................................................................... 602, 612, 628, 632, 633, 710, 712, 714, 717, 720,
Advanced Configuration................................. 4, 91, 168 726, 929, 936
Advanced Settings............................................3, 61, 168 Mobile Tiki..................................................... 16, 530
Articles............................................................ 8, 252, 567 Mods..... 4, 95, 99, 104, 181, 194, 195, 714, 841-848,
Backups...........................................1, 279, 706, 709, 933 851-861, 863, 864, 866-868, 870-878, 887-892
banner.12, 13, 29, 91, 111, 119, 158, 450-455, 463, 467, Modules..88, 169, 191, 456, 460, 471, 589, 640, 657,
469, 651, 654, 687, 900, 901, 937 823, 834, 860, 861, 863-866, 868, 869
Banning users...... 21, 113, 114, 602, 653, 687, 710, 711, MyTiki............................................ 18, 168, 611, 824
899, 900, 926 Newsletter............................................................. 824
Blogs........ 8, 255, 256, 261, 262, 265, 268, 688, 811, 812 Panels...................................................... 19, 650, 760
Calendar....................................... 12, 169, 401, 407, 408 Phpinfo........21, 47, 71, 114, 168, 241, 340, 726, 929
Categories................... 170, 439, 442, 693, 695, 824, 915 PHPWiki Dump................................... 147, 851, 930
Charts............................................................11, 390, 826 Polls............................................................... 194, 582
Chat................................................................15, 484-486 Quizzes..................................................169, 321, 322
Comments........................................................... 168, 825 Redirect On Error......................................... 17, 569
Communication Center....................... 16, 113, 562, 933 Remember me................ 68, 663, 664, 666, 667, 924
Copyright....................................................................560 Rewrite Rules................................. 3, 50, 68, 69, 168
Details....................................................................21, 727 RSS..........................................................17, 168, 591
Directory................................. 9, 294, 300, 302, 310, 313 Score........................................................18, 595, 598
Drawings............................................................... 17, 573 Search............................................. 18, 168, 605, 606
DSN....... 21, 185, 204-206, 343, 670, 675, 692, 700, 899, Shoutbox................................................. 18, 603, 920
900, 903 Site Identity................ 4, 91, 110, 169, 651, 824, 829
Dynamic Content......................................... 17, 168, 577 Slideshow........................................................ 16, 546
Ephemerides......................................................... 11, 388 Statistics..........................................11, 168, 394, 395
FAQ..................................................... 168, 314, 474, 482 Structure (Wiki book).......................... 169, 532-534
Features. 4, 19, 46, 47, 85, 104, 168, 256, 519, 645, 650, Survey............................................. 11, 169, 379, 824
655, 657, 658, 767, 834 system gallery.......................7, 8, 238, 243, 912, 916
Forum and List Synchronization......... 9, 169, 281, 291 Theme Control Center.. 22, 724, 725, 757, 774, 929
Forums................................ 281, 282, 288, 292, 688, 923 Tikibot.............................................................16, 527
Games............................................................11, 397, 400 Trackers................168, 332, 334, 335, 346, 910, 923
General.20, 169, 230, 238, 243, 247, 249, 255, 256, 332, Translation..................... 22, 168, 646, 782, 823, 824
334, 343, 655, 717, 833, 834 User management........................................ 918, 929
Groups........................ 20, 87, 88, 94, 168, 656, 679, 681 Users Management.......... 20, 87, 168, 169, 679, 823
HTML Pages........................................................ 17, 576 Wiki..6, 118, 133, 143, 145, 146, 536, 567, 656, 833,
I18n..............................................................................168 836
Image Galleries.................................................. 244, 688 Workflow........................................................12, 433
Image Gallery...................................8, 71, 230, 238, 239 Wysiwyg Editor......22, 169, 222, 228, 229, 738, 823
ImageMagick......................................................3, 70, 71 ADODB.... 25, 115, 133, 168, 766, 893, 911, 912, 919, 925
individual permissions7, 9, 21, 123, 237, 284, 288, 693, ANNEXES......................................................... 23, 806, 808
920, 934, 935 ARTICLES............................................................................
Integrator......................................................12, 436, 826 Article Details...................................................8, 254
Internationalization................................................... 168 Article User...................................................... 8, 247
Intertiki...21, 22, 113, 651, 733-736, 782, 783, 824, 898, Articles.......6, 8, 13, 14, 17, 20, 29, 68, 69, 107, 109,

Back to TOC 951

 111-113, 116, 127, 130, 131, 133, 134, 162-164, 169, 699, 725-727, 729-731, 757, 772, 781, 818, 823-825,
184, 205, 206, 243, 246-254, 272, 325, 438, 442, 456- 831, 855, 907, 908, 910, 912-916, 920, 922, 933, 934
458, 460, 470, 471, 473, 476, 478, 480, 528, 549, 562, Category Admin...170, 439, 442, 693, 695, 824, 915
565, 567, 574, 586, 587, 592, 594, 595, 604, 640-642, Category Tracker Field.................................10, 355
648, 651, 655, 656, 689, 696, 712, 717, 725, 776, 812, Category User...................................... 439, 446, 448
824, 825, 833, 834, 854, 855, 871, 896, 900, 901, 906, CHANGELOG........................................................................
915-918, 920-927, 931-937 Changelog 1.0................................................. 26, 936
Articles Config............................................... 8, 252, 567 Changelog 1.1................................................. 26, 936
submission. 8, 14, 20, 107, 246, 247, 252, 254, 256, 294, Changelog 1.2................................................. 26, 934
298, 324, 458, 460, 475, 476, 641, 689, 696, 712, 824, Changelog 1.3................................................. 26, 933
900, 901, 919, 924, 926, 931, 933, 936 Changelog 1.4................................................. 26, 931
ATTACHMENTS 6, 107, 146, 147, 184, 187, 220, 221, 283, 291, Changelog 1.5................................................. 26, 929
329, 330, 336, 339, 340, 347, 574, 616, 641, 687, 696, 697, Changelog 1.6................................................. 26, 928
700, 707, 716, 719, 902, 908, 912, 916, 917, 921, 925, 927, Changelog 1.7................................................. 26, 926
931, 932 Changelog 1.8................................................. 26, 918
AVATARS................................................................................... Changelog 1.9................................................. 26, 896
Mod all avatars.................................................... 24, 845 CHARTS...............................................................................
BACKUP......1,
......1, 4, 21, 54, 57, 73, 75-77, 79, 114, 117, 279, 700, chart..11, 21, 34-36, 50, 69, 108, 109, 136, 151, 157,
703, 706, 707, 709, 710, 833, 914, 922, 933 364, 371-374, 390, 393, 652, 655, 692, 698, 826,
BANNERS................................................................................... 840, 878, 899-901
Banner 12, 13, 29, 91, 111, 119, 158, 450-455, 463, 467, Charts 11, 21, 69, 108, 109, 151, 157, 364, 371, 390,
469, 651, 654, 687, 900, 901, 937 393, 652, 655, 692, 698, 826, 840, 899-901
BANNING. 21, 113, 114, 602, 653, 687, 710, 711, 899, 900, 926 Charts Admin.........................................11, 390, 826
BATCH.....9,
.....9, 244, 275, 387, 423, 608, 688, 696, 697, 777, 829, Charts Details.........................................11, 390, 826
909, 913, 915, 917, 928, 929, 932 Charts User............................................ 11, 390, 826
BLOGS....................................................................................... CHAT..................................................................................
Blog Config............. 8, 255, 256, 261, 262, 265, 811, 812 channel......15, 17, 108, 485, 486, 587-591, 690, 697,
blog listing...................................................268, 927, 932 760, 934
blog post23, 177, 221, 235, 260, 262-264, 272, 457, 479, Chat......15, 20, 29, 69, 109, 168, 180, 185, 198, 199,
549, 581, 604, 652, 802, 804, 909, 910, 912, 916, 926, 460, 483-489, 494, 577, 597, 651, 655, 690, 698,
927, 929, 932, 936 699, 784, 785, 810, 899, 900, 910, 924, 925, 934,
Blog Reference........................................... 265, 268, 811 935, 939
Blog User.........................................8, 168, 255, 256, 811 Chat Admin.............................................15, 484-486
weblog 255, 256, 263, 271, 471, 592, 639, 687, 693, 802, Chat Details.................................................... 15, 487
805, 927, 932, 935, 936 chat room..............................................483, 485, 486
BOOKMARK. 1, 15, 19, 108, 110, 113, 168, 459, 482, 612, 614, Chat User........................................................15, 485
632, 637-639, 654, 690, 697, 824, 912, 919, 922, 934 COMMENTS..........................................................................
CACHE.... 21, 52, 53, 64, 66, 75, 110, 113, 126, 127, 152, 183, Comment Admin..........................................168, 825
210, 217, 241, 297, 309, 341, 436, 462, 464, 509, 510, 588, Comment Details..................................................826
589, 637, 640, 647, 657, 690, 712, 772, 786, 789-793, 823, Comment User..................................... 168, 823, 825
825, 900, 901, 905-907, 914, 923-926, 934 Comments.. 2, 6, 8, 14-16, 24, 42, 68, 108, 112, 115,
CALENDAR................................................................................. 118, 119, 145, 146, 148, 152, 154, 155, 168, 186,
Calendar.... 9, 12, 13, 19, 21, 29, 69, 108, 111, 168, 169, 191, 193, 240, 243, 244, 254, 255, 260, 262, 268,
184, 260, 270, 294, 300, 310, 313, 387, 401-410, 456, 269, 278, 317, 326, 329, 330, 333, 336, 345, 347,
458-460, 470, 471, 586, 592, 612, 614, 628-631, 649, 450, 456-458, 475, 479, 483, 502, 518, 549-551, 598,
651, 683, 690, 693, 697, 824, 826, 855, 896, 897, 899, 599, 604, 640, 641, 688, 689, 691, 696, 697, 719,
900, 906, 907, 910, 912, 914-916, 921, 923, 924, 926, 762, 814, 816, 823-825, 896, 908, 912, 915, 918,
929, 936 920-925, 927, 929, 935, 936
Calendar Admin...........................12, 169, 401, 407, 408 COMMUNICATION CENTER.........................16,
.........................16, 113, 562, 933
Calendar Details...........................12, 168, 401, 410, 826 COMMUNITY........................................................................
Calendar User...................................... 12, 168, 401, 402 Tikiwiki Community 26, 29, 85, 168, 172, 582, 637,
CATEGORIES.............................................................................. 733, 760, 762, 808, 938, 945
Categories Details................................ 12, 169, 439, 448 CONFIGURATION...................................................................
Category.... 6, 9, 10, 13, 29, 94, 109, 117, 124, 163, 167- Advanced Configuration...........................4, 91, 168
170, 175, 184, 211, 215, 233, 246, 262, 294, 296-298, Advanced Settings......................................3, 61, 168
302-307, 309, 311, 314, 315, 321, 336, 346, 352, 355, Configuration.... 4, 6, 8, 9, 12, 21, 22, 29, 45, 48, 53,
356, 438-449, 456, 457, 471, 473, 536, 540, 544, 565, 54, 61, 63, 69, 83, 85, 86, 89, 91, 97, 98, 100, 102,
583, 597, 608, 642, 651, 655, 659, 681, 686, 693-695, 103, 145, 146, 148, 168, 219, 243, 255-257, 261,

952 Back to TOC

 Tikiwiki Documentation 1.9+

262, 268, 279, 283, 301, 309, 343, 358, 398, 434, 446, 516, 517, 566, 598, 627, 628, 641, 687, 688, 696-
450, 457, 465, 515-517, 562, 581, 586, 587, 615, 616, 700, 714-716, 742-744, 750-754, 795, 808, 827, 832,
647, 670, 671, 675, 695, 718, 719, 721, 726, 727, 731, 833, 836, 838, 894, 895, 903, 908, 911, 913, 914,
733, 736, 808, 811, 814, 821, 829, 833, 854, 931 916, 921, 929, 931-933, 935, 936
Database Performance............................ 23, 43, 73, 793 Download using CVS...............................26, 51, 894
Hacking Tikiwiki................................. 22, 168, 760, 857 DRAWINGS...........................................................................
Tikiwiki Performance Tuning................ 23, 43, 73, 788 Drawing..... 17, 20, 29, 112, 133, 158, 168, 187, 501,
Tuning Tikiwiki................................................... 22, 742 570, 572, 573, 652, 690, 889, 899, 900, 927, 932
CONTENT TEMPLATE................................ 20, 113, 249, 690, 821 Drawings Admin............................................ 17, 573
CONTRIBUTION........................................................................... Drawings Details............................................ 17, 573
Contribution.16, 22, 37, 62, 86, 111, 210, 496, 552-554, Drawings User........................................17, 168, 570
557-559, 651, 664, 729, 731, 732, 736-738, 766-768, DSN.......
DSN.......21,
21, 185, 204-206, 343, 670, 675, 692, 700, 899,
774-776, 778, 779, 823, 825, 946 900, 903
COOKIE.... 21, 68, 90, 112, 241, 341, 378, 463, 663, 664, 667, DYNAMIC CONTENT..............................................................
687, 713, 714, 765, 826, 871-874, 899, 900, 909, 915, 923, Dynamic Content.. 17, 112, 158, 168, 169, 463, 467,
924, 928, 930, 934 468, 577-580, 652, 687, 714, 715, 791, 936, 937
COPYRIGHT................................................................................ DYNAMIC CONTENT ADMIN...................................................
Copyright.....6, 16, 26, 37, 154, 168, 172, 184, 235, 560, Dynamic Content Admin...................... 17, 168, 577
561, 652, 654, 687, 697, 926, 945-949 DYNAMIC CONTENT BLOCK.....................................................
Copyright Admin....................................................... 560 dynamic content block.........467, 577, 578, 714, 936
Copyright Details................................................. 16, 561 DYNAMIC CONTENT DETAILS................................................
Copyrights...................... 26, 37, 561, 687, 697, 926, 945 Dynamic Content Details.............................. 17, 579
DCS......................................................
DCS......................................................17,
17, 468, 577-579, 913 DYNAMIC CONTENT USER.....................................................
DESIGN...................................................................................... Dynamic Content User.................................. 17, 577
Design...2, 4, 22, 29, 35, 37, 57, 61, 86, 87, 91, 102, 104, DYNAMIC VARIABLE.............................................................
116-118, 125, 135, 168, 179, 294, 335, 358, 412, 415, Dynamic Variable.......... 17, 113, 174, 577, 580, 925
425, 438, 442, 483, 574, 640, 676, 726, 742, 743, 754, ECLIPSE...........................23,
...........................23, 169, 785, 794, 796, 797, 927
757, 761, 802, 814, 826, 840, 846, 893, 947, 948 EPHEMERIDES......................................................................
Design rules.......................................... 22, 168, 757, 826 Ephemerides..11, 169, 388, 389, 456, 651, 687, 915,
Styles and Themes.22, 75, 168, 472, 473, 726, 742, 757, 917, 918, 929
874 Ephemerides Admin...................................... 11, 388
DEVELOPERS.............................................................................. Ephemerides Details.............................. 11, 169, 388
Adding a new feature...................................22, 168, 763 Ephemerides User..........................................11, 388
DIRECTORY (OF LINKS)............................................................... EXTERNAL WIKI.... 5, 21, 112, 117, 125-127, 168, 186, 715,
Directory Admin.................... 9, 294, 300, 302, 310, 313 716, 815, 928
Directory Details.................................... 9, 294, 300, 308 FAQ..................................................................................
FAQ..................................................................................
Directory User........................ 9, 294, 295, 313, 670, 675 FAQ........1, 9, 10, 14, 15, 20, 24, 29, 41, 47, 69, 108,
DOCUMENTATION........................................................................ 167-170, 184, 201, 314-317, 337, 458, 459, 474, 479,
Documentation Lifecycle.....24, 163, 810, 816, 818, 819 481, 482, 533, 543, 549, 551, 565, 604, 639, 651,
Documentation Status.. 24, 73, 162, 163, 168, 169, 809, 655, 686, 690, 698, 773, 776, 777, 795, 822, 824,
810, 816-818, 820, 823, 826 825, 829-835, 900, 901, 912, 920, 932, 933
Documentation Templates.................. 24, 811, 816, 820 FAQ Admin.................................. 168, 314, 474, 482
Feature Page Template................................24, 820, 821 FAQ Details............................ 10, 168, 317, 474, 482
Goals..................3, 29, 31, 33, 34, 36, 168, 321, 338, 762 FAQ User..............................................169, 474, 482
How To Tag...........................24, 163, 810, 816-818, 823 FEATURED LINKS.................................................................
Printing the Documentation................................24, 827 featured link.. 21, 108, 168, 456, 651, 652, 655, 698,
Quick Start....................................................... 4, 85, 168 716, 717, 724, 931, 936
Social Contract.............................................3, 29, 32, 37 FEATURES............................................................................
The 3 rules............................................................ 22, 760 Features..... 5, 46, 105, 107, 115, 549, 582, 644, 650,
Tikiwiki Documentation. 2, 23, 172, 640, 808-810, 823, 651, 750
887 Features Admin.......4, 19, 46, 47, 85, 104, 168, 256,
Tikiwiki Manual of Style.....23, 169, 810, 811, 814, 821 519, 645, 650, 655, 657, 658, 767, 834
Welcome Authors.........................23, 169, 810, 818, 823 Tiki feature....46, 459, 549, 567, 582, 644, 650, 651,
DOWNLOAD................................................................................ 750, 833, 834
Download. 3, 9, 26, 41, 43, 51, 55, 57, 58, 60, 68, 69, 71, FILE GALLERIES..................................................................
72, 75, 77, 79, 85, 89, 95, 98, 100, 101, 107-109, 116, File Gallery.9, 86, 108, 168, 272-274, 278, 280, 434,
144, 168, 177, 179, 188, 194, 213, 221, 272, 274, 275, 586, 592, 598, 639, 641, 651, 697, 773, 861, 903,
283, 291, 361, 396, 397, 399, 400, 458, 501, 509, 512, 917, 935

Back to TOC 953

 File Gallery Details................................................ 9, 280 236, 496, 537, 574-576, 691, 698, 713, 764, 825, 931
File Gallery User............................................ 9, 168, 272 HTML Pages Admin..................................... 17, 576
FLOODING.............................................................................282
.............................................................................282 HTML Pages Details..................................... 17, 576
FOLDER..... 72, 74, 85, 110, 131, 178, 194, 235, 238, 241, 340, HTML Pages User......................................... 17, 576
477, 483, 632, 637-639, 657, 679, 707, 714, 720, 721, 742, HTML TAG. 131, 132, 173, 185, 207, 381, 509, 590, 815,
787, 855, 914, 924, 934 914, 915, 936
FORUMS..................................................................................... IMAGE GALLERIES................................................................
Admin..................................................................292, 923 Image Gallery....5, 7, 8, 20, 29, 70, 71, 86, 107, 134,
Admin topics.......................................246, 248, 630, 925 168, 208, 230, 237-240, 243, 244, 458, 459, 586,
forum....9, 13, 14, 20, 29, 68, 69, 85, 107, 112, 116, 127, 639, 651, 688, 696, 773, 815, 829, 909, 912, 918,
130, 134, 148, 167-170, 177, 184, 221, 281-293, 389, 935, 937
438, 442, 444, 457, 458, 472, 473, 479, 480, 528, 552, Image Gallery Config................ 8, 71, 230, 238, 239
553, 559, 586, 587, 592, 594, 595, 599, 604, 640, 641, Image Gallery Details...................... 8, 238, 243, 244
651, 652, 654, 655, 686, 688, 689, 693, 696, 736, 738, Image Gallery User..................7, 168, 230, 238, 243
756, 773, 781, 810, 824, 825, 832, 833, 899-901, 906, Image Tracker Field...................................... 10, 354
912, 915-927, 931-935 Images.........................................................................
Forum Admin.....................................................292, 923 rotate................................................................ 582
Forum and List Synchronization......... 9, 169, 281, 291 scaled image.....................................208, 209, 233
Forum Details.............................................................824 system gallery.......................7, 8, 238, 243, 912, 916
forum post......9, 177, 221, 283, 290, 457, 458, 479, 553, thumbnail....... 50, 186, 208, 209, 230, 232-236, 238,
604, 689, 919, 927 396, 399, 400, 456, 458, 459, 829, 907, 909, 923,
forum topic......................... 457, 552, 640, 736, 917, 932 935
moderator................................................... 283, 689, 926 IMAGE LIBRARIES.................................................................
FREETAGS...................................... 17, 110, 168, 581, 651, 825 GD...............................................................................
GAMES...................................................................................... GD..... 35, 50, 60, 70, 71, 126, 235, 242-244, 263,
Games... 11, 12, 14, 20, 69, 109, 168, 169, 396-400, 458, 503, 512, 515, 516, 518, 584, 719, 829, 831, 922,
480, 651, 655, 686, 689, 699, 824, 931, 934 940, 943
Games Admin...............................................11, 397, 400 ImageMagick..............................................................
Games Details.......................................................12, 400 ImageMagick..... 3, 50, 70, 71, 235, 243, 435, 829
Games User...................................................11, 169, 396 IMPORT....... 1, 19, 21, 24, 29, 35, 114, 116, 122, 127, 130,
GENERAL ADMIN...20, ...20, 169, 230, 238, 243, 247, 249, 255, 256, 147, 203, 278, 286, 293, 322, 325, 335, 336, 360, 361,
332, 334, 343, 655, 717, 833, 834 364, 388, 413-415, 425, 429, 504, 506, 543, 562, 575,
GMAP (GOOGLE MAPS).............................................................. 578, 589, 617, 631, 693, 707, 708, 710, 713, 726, 762,
Gmap..................... 15, 109, 519-522, 633, 698, 723, 897 786, 787, 809, 811, 817, 818, 831, 838, 851, 898, 909,
GRAPHVIZ................................................................................. 915, 926, 928-930
GraphViz.............................3, 4, 50, 60, 71-73, 168, 841 INLINE FRAME................................................................. 302
GraphViz Install.......................................... 3, 4, 71, 168 INSTALLATION......................................................................
GROUPS..................................................................................... GraphViz Install.................................... 3, 4, 71, 168
Groups.....4, 10, 20, 24, 33-37, 53, 59, 86-88, 90, 93, 94, ImageMagick Install....................................3, 70, 71
113, 114, 116, 123, 124, 151, 168, 178, 185, 192, 206, Install on Debian........................................3, 53, 168
246, 273, 287, 293, 302, 314, 324, 327, 330, 345, 347, Install on Gentoo................................................3, 55
351, 358, 386, 398, 402, 414, 421, 423, 438, 439, 442, Install with RPM................................................3, 53
443, 460-462, 464, 470, 474, 477, 481, 483, 502, 508, Installation 3, 4, 24, 29, 39, 41-44, 47, 51, 53, 55-57,
518, 539, 562, 582, 590, 593, 600, 620, 623, 640-642, 62, 66, 71, 73-77, 79, 85, 86, 88, 89, 91, 95, 101,
656, 657, 664, 667, 669, 674, 679-684, 693-695, 722, 103, 114, 147, 156, 169, 179, 180, 194, 230, 235,
723, 729, 736, 770, 771, 829, 830, 834, 846, 899, 900, 241, 340, 344, 391, 414, 424, 459, 474, 481, 504,
912-914, 917, 920, 926, 932, 934-936 515, 516, 524, 563, 578, 634, 646, 650, 663, 700,
Groups Management. 20, 87, 88, 94, 168, 656, 679, 681 707, 756, 788, 791, 808, 823, 829, 832, 834, 840,
Registered user....86, 108, 116, 123, 186, 198, 262, 321, 913, 914, 924, 929
378, 444, 450, 460, 465, 501, 512, 518, 549, 550, 598, Lite Install.................................................. 3, 61, 826
611, 612, 633, 647, 653, 657, 661, 662, 666, 683, 694, Multitki.......................................................................
697, 698, 720, 784, 928, 933 MultiTiki.............3, 42, 61-66, 168, 910, 915, 917
HOMEPAGE.... 72, 85, 147, 163, 168, 179, 184, 186, 188, 448, MultiTiki 1.9...................................................... 61
468, 534, 656, 679, 681, 682, 684, 789-791, 833, 912, 920, MultiTiki Akira........................................3, 42, 66
928, 929, 936, 937 Profiles........................................................................
HOTWORDS........................................................... 652, 899, 900 Using profiles...................................4, 86, 90, 168
HTML PAGES.......................................................................... Requirements and Setup.. 3, 41, 43, 44, 47, 54, 168,
HTML Page... 17, 21, 109, 113, 114, 127, 228, 229, 235, 824, 829, 832

954 Back to TOC

 Tikiwiki Documentation 1.9+

Shared Hosting...........................................3, 49, 61, 823 LOGOUT................................................................. 457, 909

Upgrade...... 4, 25, 41, 43, 47, 50, 73-80, 94, 95, 99, 100, LOGS...................................................................................
102-104, 107, 111, 131, 168, 169, 191, 543, 550, 767, Action log...16, 19, 21, 114, 496, 554, 557, 558, 642,
823, 839, 870, 871, 903, 910, 911, 916, 918, 922, 923 644, 651, 727, 729, 730, 738, 824, 825
Windows Desktop Install.................................. 3, 42, 57 Tiki log.................................................................. 922
INTEGRATOR.............................................................................. MAIL NOTIFICATIONS............................................................
Integrator....... 12, 70, 114, 168, 434-437, 651, 825, 826, Mail notifications........... 21, 656, 657, 717, 836, 919
921, 924 MAIL-IN..............................................................................
Integrator Admin.........................................12, 436, 826 mail-in......21, 112, 283, 651, 687, 717-719, 923, 928
Integrator Details.........................................12, 168, 436 mailin.... 8, 36, 37, 168, 260, 281, 291-293, 593, 687,
Integrator User.....................................12, 168, 434, 825 761
INTERNATIONALIZATION (I18N).................................................... MAPS (MAPSERVER)..............................................................
i18n................................ 19, 111, 168, 646, 656, 782, 786 Maps.15, 21, 26, 50, 60, 64, 108, 109, 111, 168, 188,
i18n Admin................................................................. 168 230, 232, 234, 425, 498-503, 505, 506, 508, 509,
Internationalization..... 19, 111, 168, 646, 656, 782, 786 512, 513, 515-520, 522-526, 633, 651, 663, 664, 697,
Translating to a new language...22, 168, 646, 782, 823, 698, 700, 719, 723, 794, 838, 841, 893, 911, 916,
824 918, 923, 938, 939
INTERTIKI. 21, 22, 113, 651, 733-736, 782, 783, 824, 898, 914 Maps Admin...........15, 168, 498, 499, 515, 522, 526
KARMA.................. 18, 112, 551, 595, 597-599, 935, 936, 939 Maps Config..................... 15, 21, 498, 515, 518, 719
LANGUAGE................................................................................. Maps Details...................................15, 168, 498, 502
Translating to a new language...22, 168, 646, 782, 823, Maps Editor............................................15, 498, 501
824 Maps Install....................................15, 168, 498, 515
LANGUAGES............................................................................... Maps Layer Management..................... 15, 498, 501
Internationalization (i18n). 19, 111, 168, 646, 656, 782, Maps Mapfile Tutorial. 15, 168, 498, 502, 513, 515,
786 518
LAYOUT..................................................................................... Maps Mapfiles Manager....................... 15, 498, 501
layout....1, 19, 22, 71, 228, 310, 470, 534, 538, 540, 541, Maps MapView............................ 498, 502, 506, 513
574, 590, 654, 655, 726, 742, 744, 754, 755, 758, 759, Maps User.......................15, 168, 498, 500, 520, 526
834, 912, 930-932, 936 Mapserver..26, 50, 60, 108, 168, 498, 499, 509, 512,
layout per section....................................... 654, 655, 932 513, 515-517, 519, 697, 838, 893, 938
LDAP...........
LDAP........... 48, 114, 666, 668-671, 673-676, 898, 903, 922 MENUS................................................................................
LIBRARY.... 50, 60, 71, 115, 191, 240, 242, 243, 508, 515, 516, Menu HOWTO.......................................... 4, 87, 168
528, 581, 593, 672, 766, 769, 803, 829, 838, 858, 930, 931 Menus.......19, 21, 25, 68, 87, 88, 102, 110, 119, 169,
LINUX........................................................................................ 438, 442, 456, 460, 463, 632, 646, 654, 657, 720,
Linux.... 2, 3, 23, 42, 43, 51, 53, 61, 62, 74, 75, 115, 168, 724, 762, 769, 770, 797, 825, 838, 859, 899, 900,
243, 280, 343, 353, 357, 671, 705, 715, 782, 783, 785, 909, 915, 924, 930, 935
787, 794-796, 800-803 MESSAGES...........................................................................
Linux tools............................................ 23, 168, 796, 800 broadcast........ 18, 108, 617, 619, 620, 691, 698, 928
LIVE SUPPORT............................................................................ Inter-User Messages...... 18, 108, 616, 697, 698, 928
live support.... 15, 21, 109, 168, 459, 488, 489, 491, 492, MOBILE TIKI.......................................................................
494, 496, 651, 692, 698, 920 Mobile 16, 69, 111, 168, 528-531, 651, 824, 826, 918
Live Support Admin.................... 15, 168, 489, 491, 496 Mobile Tiki Admin........................................ 16, 530
Live Support Details.................................... 15, 168, 496 Mobile Tiki Details........................................ 16, 531
Live Support User................................15, 168, 488, 494 Mobile Tiki User.................... 16, 168, 529, 824, 826
operator......................... 15, 314, 369, 488, 489, 491-497 MODS..................................................................................
transcript.............................................. 35, 497, 900, 901 List...............................................................................
LOGIN....................................................................................... Mod all avatars...........................................24, 845
LDAP......48, 114, 666, 668-671, 673-676, 898, 903, 922 Mod aulawiki..................................... 24, 826, 846
Login Authentication Methods........... 20, 660, 672, 823 Mod blogroll...................................... 25, 826, 860
Login Config...........................20, 86, 168, 660, 823, 831 Mod calculator................................... 25, 863, 866
logout...................................................................457, 909 Mod cartoweb.................................... 24, 825, 848
passcode...................................................... 660, 666, 931 Mod cc............................................... 24, 825, 848
password.....20, 35, 43-46, 51, 53, 54, 58, 59, 64, 66, 73, Mod clock.......................................... 25, 864, 869
75, 85, 283, 292, 562, 564, 611, 612, 633, 659, 661-663, Mod damian1..................................... 25, 825, 871
666, 667, 669, 671, 672, 674, 676, 680, 681, 699, 700, Mod damian2............................. 25, 825, 871, 872
706, 709, 718, 830, 831, 833, 903, 907, 911, 915, 917- Mod dragonballz................................ 24, 841, 845
919, 922, 928, 930, 933, 934 Mod ebay........................................... 25, 825, 875
Remember me...................... 68, 663, 664, 666, 667, 924 Mod extcalculator.............................. 25, 863, 864

Back to TOC 955

 Mod flowplayer........................................25, 825, 875 860, 868, 870, 872-877, 887-892
Mod formula............................................ 25, 825, 875 Mods List 24, 100, 715, 837, 842-846, 848, 851-860,
Mod fpdf.................................... 24, 25, 825, 857, 858 868, 870, 872-877, 887-892
Mod fpdf_bitstreamvera...........................24, 825, 858 Mods User... 4, 95, 104, 714, 842-847, 851-860, 863,
Mod fpdf_freefonts.................................. 25, 825, 858 868, 870, 872-877, 887-892
Mod galaxia_sweet_ui............................. 25, 825, 876 package.. 3, 29, 42, 51, 53, 54, 56, 71, 75, 91, 94, 95,
Mod gnumes.............................................24, 842, 845 97, 98, 100, 102, 103, 107, 116, 117, 235, 243, 257,
Mod goldorak........................................... 24, 843, 845 515, 516, 518, 668, 671, 673, 742, 790, 791, 795,
Mod group................................................25, 825, 876 803, 832, 836, 837, 840, 845, 853, 910, 927
Mod import-phpwiki........................................ 24, 851 MODULES............................................................................
Mod join................................................... 25, 825, 866 assigned module.... 13, 460, 461, 464, 477, 483, 591,
Mod jpgraph............................................. 25, 825, 858 640, 846, 862-866, 868
Mod js...................................................... 25, 825, 876 List...............................................................................
Mod kamap.............................................. 24, 825, 852 Module assistant.................................13, 470, 825
Mod listpages........................................... 25, 825, 876 Module breadcrumb........................... 13, 470, 825
Mod mailman........................................... 25, 825, 869 Module categories..............................13, 471, 825
Mod mapeditor......................................... 24, 825, 852 Module comm_received_objects....... 13, 471, 825
Mod mcdonald......................................... 24, 843, 845 Module directory_last_sites............... 13, 471, 825
Mod mindmap.................................................. 25, 877 Module directory_stats.......................13, 471, 825
Mod mouseover................................................25, 877 Module directory_top_sites............... 13, 471, 825
Mod nusoap..............................................25, 825, 859 Module eph........................................ 13, 472, 825
Mod perm................................................. 25, 825, 877 Module events....................................13, 472, 825
Mod phpcas...................................................... 24, 852 Module featured_links....................... 13, 472, 825
Mod phplot............................................... 25, 825, 877 Module google................................... 13, 473, 825
Mod plazes............................................... 25, 866, 887 Module last_actions........................... 13, 473, 825
Mod rcogley..................................... 25, 825, 871, 873 Module last_blog_posts..................... 13, 473, 825
Mod redirect........................................................... 888 Module last_created_blogs................ 13, 474, 825
Mod scroll................................................ 25, 825, 888 Module last_created_quizzes............. 14, 474, 825
Mod solve.................................................24, 825, 853 Module last_file_galleries..................14, 474, 824
Mod svg................................................1, 25, 825, 889 Module last_fileslast_files. 14, 458, 474, 824, 825
Mod tikidav.............................................. 24, 825, 854 Module last_image_galleries............. 14, 475, 824
Mod tikiring..................................................... 25, 859 Module last_images........................... 14, 475, 824
Mod tinvoice............................................ 24, 825, 855 Module last_images_th...................... 14, 475, 824
Mod trackeritemfield................................25, 825, 891 Module last_modif_events.................14, 475, 824
Mod userprefstats..................................... 24, 825, 856 Module last_modif_pages..........14, 475, 824, 921
Mod vtiger................................................25, 825, 859 Module last_modif_tracker_items..... 14, 475, 824
Mod wikigraph......................................... 25, 825, 891 Module last_modified_blogs............. 14, 475, 824
Mod worldclock....................................... 25, 864, 868 Module last_tracker_items.................14, 475, 824
Mod xmen................................................ 24, 844, 846 Module last_visitors...........................14, 476, 824
Mod xspf_player...................................... 25, 825, 892 Module live_support.......................... 14, 476, 824
Mods Type Avatars.................................. 24, 634, 841 Module logged_users......................... 14, 476, 824
Mods Type Features.....................................1, 24, 846 Module login_box..............................14, 476, 824
Mods Type Lib.................................................24, 857 Module menupage..............................14, 476, 824
Mods Type Services.........................................25, 869 Module messages_unread_messages. 14, 476, 824
Mods Type SQL...............................................25, 870 Module online_users..........................14, 476, 824
Mods Type Taglines................. 25, 714, 715, 871-874 Module quick_edit..................... 14, 477, 824, 909
Mods Type Themes..........................................25, 874 Module random_images.....................14, 477, 824
Mods Type Wikiplugins.. 25, 159-161, 163, 167, 169, Module random_pages.......................14, 477, 824
170, 172, 173, 175, 179, 181, 194, 195, 198, 200, Module search_box....................14, 479, 607, 824
206, 207 Module search_box_new................................. 824
Mods.. 1, 3, 4, 24, 25, 51, 68, 94-104, 111, 156, 159-161, Module search_wiki_page................. 14, 479, 824
163, 167, 169, 170, 172, 173, 175, 179, 181, 188, 191, Module shoutbox............................... 14, 479, 824
192, 194, 195, 198, 200, 206, 207, 213, 634, 646, 700, Module since_last_visit..... 14, 478, 479, 824, 912
714, 715, 742, 750, 771, 837, 838, 841-848, 851-861, Module switch_lang...........................14, 479, 824
863, 864, 866-878, 887-892, 895, 904, 914, 916 Module switch_lang2.........................14, 479, 824
Mods Admin......4, 95, 99, 104, 181, 194, 195, 714, 841- Module switch_theme........................14, 480, 824
848, 851-861, 863, 864, 866-868, 870-878, 887-892 Module tail......................................... 14, 480, 824
Mods Details...... 4, 95, 99, 102, 715, 842-846, 848, 851- Module top_active_blogs...................14, 480, 824

956 Back to TOC

 Tikiwiki Documentation 1.9+

Module top_file_galleries........................ 14, 480, 824 User Preferences... 19, 108, 168, 462, 498, 519, 612,
Module top_files...................................... 14, 480, 824 613, 615, 617, 624, 633, 637, 647, 654, 697, 722,
Module top_image_galleries....................14, 481, 824 755, 765, 769, 838, 841, 856, 893, 923, 931, 932,
Module top_images..................................14, 480, 824 938, 939
Module top_images_th.............................14, 480, 824 NEWSLETTERS......................................................................
Module top_objects..................................14, 481, 824 Newsletter.... 11, 21, 29, 69, 108, 113, 167, 168, 170,
Module top_pages.................................... 14, 481, 824 184, 293, 384-387, 651, 691, 693, 698, 823, 824,
Module top_quizzes................................. 15, 481, 824 869, 899-901, 911, 912, 921, 924, 925, 930
Module top_visited_blogs........................15, 481, 824 Newsletter Admin................................................ 824
Module upcoming_events........................ 15, 482, 824 Newsletter Details.......................................... 11, 386
Module user_blogs................................... 15, 482, 824 Newsletter User............................................ 384, 824
Module user_bookmarks..........................15, 482, 824 NEWSREADER.......................................................................
Module user_image_galleries.................. 15, 482, 824 news server........................................................... 641
Module user_pages.................................. 15, 482, 824 Newsreader....19, 109, 168, 612, 614, 641, 651, 655,
Module user_tasks....................................15, 482, 824 690, 699, 819, 900, 901, 918, 929
Module whats_relatedwhats_related15, 457, 482, 824 NICKNAME...................................................................... 616
Module who_is_there...............................15, 482, 824 PASSCODE....................................................... 660, 666, 931
Module Admin.... 88, 169, 191, 456, 460, 471, 589, 640, PASSWORD 20, 35, 43-46, 51, 53, 54, 58, 59, 64, 66, 73, 75,
657, 823, 834, 860, 861, 863-866, 868, 869 85, 283, 292, 562, 564, 611, 612, 633, 659, 661-663,
Module Control............................................ 13, 169, 470 666, 667, 669, 671, 672, 674, 676, 680, 681, 699, 700,
Module User..15, 168, 482, 582, 595, 824, 863-866, 869 706, 709, 718, 830, 831, 833, 903, 907, 911, 915, 917-
Modules..4, 6, 8, 9, 13, 17, 19, 25, 64, 70, 75, 87, 88, 94, 919, 922, 928, 930, 933, 934
110, 155, 158, 168, 169, 183, 190, 245, 268, 270, 272, PERMISSIONS........................................................................
291, 294, 299, 308-310, 317, 386, 388, 411, 412, 417, Groups Management..20, 87, 88, 94, 168, 656, 679,
433, 438, 448, 449, 456-470, 472, 476, 477, 482, 483, 681
492, 543, 547, 550, 577, 581, 582, 585-587, 589-591, individual permissions..7, 9, 21, 123, 237, 284, 288,
594, 607, 612, 614, 615, 639, 640, 648-650, 654, 657, 693, 920, 934, 935
672, 676, 677, 690, 697, 714, 717, 724, 756, 764, 765, PHPINFO.............. 21, 47, 71, 114, 168, 241, 340, 726, 929
770, 771, 775, 778, 779, 834, 838, 846, 859-861, 863- PHPWIKI DUMP........................................... 147, 851, 930
866, 868, 869, 895, 899, 900, 907, 910-912, 917, 920, PLUGINS..............................................................................
923-926, 931, 932, 934-937 PluginAgentinfo............................................... 6, 158
MONITOR..... 5, 10, 12, 116, 117, 120, 123, 154, 329, 332, 337, PluginDiv.......................................................... 6, 173
345, 347, 411, 412, 418, 429-432, 478, 654, 809, 836, 900, PluginFiles........................................................ 6, 175
901, 914, 927, 931, 935 PluginFlash.......................................7, 176, 177, 221
MULTITIKI................................................................................. PluginGoogleVideo.................................. 7, 177, 222
MultiTiki....................... 3, 42, 61-66, 168, 910, 915, 917 PluginGroup.....................................................7, 178
MultiTiki 1.9.................................................................61 PluginJS....................................................7, 181, 876
MultiTiki Akira..................................................3, 42, 66 PluginLang............................................... 7, 183, 649
MYTIKI..................................................................................... PluginManager.............................1, 7, 156, 183, 185
bookmark...1, 15, 19, 108, 110, 113, 168, 459, 482, 612, PluginMindmap............................... 7, 187, 794, 877
614, 632, 637-639, 654, 690, 697, 824, 912, 919, 922, PluginMiniQuiz................................................7, 188
934 PluginModule............7, 113, 190, 861, 863-866, 868
My Tiki 55, 331, 332, 634, 727, 729, 730, 757, 830, 831, PluginMouseover..................................... 7, 191, 877
833, 834, 842-845, 915 PluginPerm.......................................................7, 192
MyTiki. 18, 108, 117, 120, 133, 168, 332, 401, 459, 460, PluginRedirect............................................. 887, 888
520, 611-615, 632, 636, 639, 640, 642, 647, 655, 656, PluginRSS.........................................7, 169, 195, 591
685, 697-699, 727, 742, 824, 916, 918, 926 PluginSkype......................................................7, 198
MyTiki Admin......................................18, 168, 611, 824 PluginSplit........................................................ 7, 200
MyTiki Details..............................................18, 168, 611 PluginThumb................................................... 7, 207
Notepad18, 108, 109, 117, 120, 153, 612, 614, 621, 654, PluginTracker.. 7, 209, 210, 213-215, 217-219, 324,
690, 697, 699, 823, 900, 901, 918, 927, 929 358, 359, 361, 362
User Files..... 19, 108, 109, 168, 612, 614, 621, 627, 628, PluginTrackerFilter.................7, 210, 324, 361, 362
654, 697, 698, 929 PluginTrackerItemField......................... 7, 213, 324
User Files.......................................................................... PluginTrackerList................... 7, 214, 217, 218, 324
quota......109, 132, 134, 215, 361, 621, 628, 699, 783, PluginTrackerStat........................... 7, 215, 219, 324
929 PluginTranslated..................................... 7, 216, 649
User Menu... 19, 108, 110, 168, 632, 649, 654, 697, 770, PluginVersions......................................... 7, 216, 649
771, 923 PluginVote................................................ 7, 218, 324

Back to TOC 957

 PluginWMV....................................................7, 220, 221 254, 258, 268-270, 272, 278, 281, 288, 289, 291,
PluginYouTube.............................................. 7, 177, 221 298, 302, 310-313, 462, 595, 599, 605, 606, 721,
WikiPlugins..25, 159-161, 163, 167, 169, 170, 172, 173, 900, 901, 915, 924, 933, 935, 936
175, 179, 181, 194, 195, 198, 200, 204, 206, 207 SCORES................................................................................
POLLS........................................................................................ Score.......18, 108, 111, 135, 139, 148, 229, 283, 287,
Poll......7, 17, 29, 109, 112, 113, 151, 167, 170, 184, 185, 321, 322, 550, 551, 595-599, 651, 697, 766, 835,
193, 194, 218, 219, 325, 377, 438, 467, 469, 479, 549, 921, 931
551, 582-585, 595, 651, 687, 698, 899-901, 906, 907, Score Admin...........................................18, 595, 598
911, 915, 917, 935 Score Details...........................................18, 595, 596
Poll Admin.......................................................... 194, 582 SEARCH...............................................................................
POPUP.. 208, 209, 236, 259, 493-495, 566, 567, 630, 648, 765, full text search................................18, 608, 609, 930
907, 927, 928, 934 Search.... 1, 10, 11, 14, 18, 22, 33, 47, 72, 73, 87, 91,
PRINTING................................................................................... 109-111, 119, 120, 126, 155, 168, 169, 178, 186,
Printing the Documentation................................24, 827 250, 255, 257, 260, 262, 270, 280, 294, 296, 297,
PRIVACY............................................................................... 928 299, 303, 308-312, 314, 335, 336, 346, 353, 361,
PROFILES................................. 4, 63, 86, 89, 90, 168, 903, 924 362, 388, 395, 435, 438-441, 459, 460, 479, 519,
PROFILES................................................................................... 542, 574, 604-611, 621, 651, 654, 668-670, 674, 675,
Using profiles..............................................4, 86, 90, 168 681, 699, 766, 774-777, 786, 796, 797, 808, 810,
QUEUE..................................................283,
..................................................283, 291, 900, 901, 922 812, 823, 824, 900, 901, 905, 906, 910, 912-915,
QUICKLINK........................................................................... 264 918, 921, 923, 924, 928, 930, 932, 933, 935, 936
QUIZZES.................................................................................... Search Admin.................................18, 168, 605, 606
Quiz.... 7, 10, 14, 15, 20, 29, 69, 108, 167, 169, 170, 184, Search Details.........................................18, 168, 608
185, 188, 318-323, 325, 458, 459, 474, 481, 582, 651, Search Stats.............................. 11, 18, 111, 395, 610
655, 689, 693, 697, 772, 773, 824, 825, 900, 901, 912, Search User.................................................... 18, 605
931 SHOUTBOX...........................................................................
Quiz Admin................................................ 169, 321, 322 Shoutbox...14, 18, 109, 456, 479, 600-603, 651, 690,
Quiz Details.................................................. 10, 323, 824 699, 824, 834, 899-901, 908, 920-923
quizzes.10, 14, 15, 69, 318-322, 325, 458, 459, 474, 481, Shoutbox Admin.................................... 18, 603, 920
689, 693, 697, 824, 825, 900, 901, 931 Shoutbox Details............................................ 18, 603
QUOTA......... 109, 132, 134, 215, 361, 621, 628, 699, 783, 929 Shoutbox User................................................ 18, 603
RANKING. 5, 8, 9, 112, 119, 121, 151, 230, 240, 247, 251, 254, SITE IDENTITY......................4,
......................4, 91, 110, 169, 651, 824, 829
258, 268-270, 272, 278, 281, 288, 289, 291, 298, 302, 310- SLIDESHOWS.........................................................................
313, 462, 595, 599, 605, 606, 721, 900, 901, 915, 924, 933, slideshow.. 16, 70, 108, 153, 169, 545-548, 656, 698,
935, 936 910, 926, 930
REDIRECT... 7, 17, 25, 185, 194, 195, 300, 310, 569, 604, 615, Slideshow Admin........................................... 16, 546
840, 887, 888, 905, 913, 919, 920 Slideshow Details........................................... 16, 547
REDIRECT ON ERROR................................................................. Slideshow User....................................... 16, 169, 545
Redirect On Error............................................... 17, 569 SMARTY...............................................................................
Redirect On Error Admin...................................17, 569 SmartIrc................................................. 25, 893, 924
Redirect On Error Details...................................17, 569 Smarty..22, 25, 64, 73, 113, 114, 142, 168, 263, 425,
Redirect On Error User...................................... 17, 569 461, 463, 525, 649, 726, 742, 755, 757, 758, 763-
REWRITE RULES............................................ 3, 50, 68, 69, 168 766, 768, 771-773, 776, 778-781, 791, 814, 823, 841,
RSS FEEDS............................................................................... 893, 902, 907, 910, 914, 916, 919, 922-924, 927, 934
feed... 2, 17, 18, 24, 63, 65, 111, 158, 168, 179, 184, 185, Smarty Templates.22, 114, 168, 461, 726, 742, 757,
188, 195, 196, 309, 310, 315, 322, 324, 377, 410, 467, 763, 927
469, 474, 481, 558, 575, 586-594, 760, 762, 777, 808, SMILEY.................. 113, 229, 264, 283, 286, 652, 924, 927
829, 834, 860, 861, 906, 907, 909, 914, 917, 920-923, SOCIAL CONTRACT........................................... 3, 29, 32, 37
932, 933, 935, 936 SPAM............................. 352, 384, 653, 710, 869, 898, 930
RSS....... 7, 17, 18, 24, 111, 158, 168, 169, 184, 185, 195, SPELLCHECK........................................................................
196, 244, 245, 255, 263, 269, 270, 291, 309, 310, 410, Spellcheck..16, 17, 26, 113, 152, 169, 264, 269, 566-
467, 469, 474, 481, 586-591, 593, 594, 654, 829, 834, 568, 835, 836, 893, 932
897, 899, 900, 904, 906, 907, 909, 910, 914, 916, 920- Spellcheck User.................................................... 169
923, 933, 935, 936 SpellChecker.................. 26, 152, 566, 835, 893, 932
RSS Admin................................................... 17, 168, 591 SPREADSHEETS.....................................................................
RSS User..................................................... 168, 586, 590 Edit Interface................................................. 11, 365
SCORE....................................................................................... Spreadsheet... 11, 108, 168, 196, 198, 324, 325, 361,
Karma............18, 112, 551, 595, 597-599, 935, 936, 939 364-366, 368, 370-372, 556, 698
ranking...5, 8, 9, 112, 119, 121, 151, 230, 240, 247, 251, STATISTICS...........................................................................

958 Back to TOC

 Tikiwiki Documentation 1.9+

referer................... 11, 394, 395, 609, 653, 687, 900, 901 Tikibot...............................................15, 16, 527, 924
Statistics. 11, 13, 18, 21, 24, 69, 111, 168, 215, 219, 270, Tikibot Admin................................................16, 527
272, 297-299, 303, 308, 310, 312, 318, 319, 321, 377, Tikibot Details................................................16, 527
379, 383, 391, 393-395, 399, 436, 450, 452, 454-457, Tikibot User....................................................16, 527
471, 610, 612, 633, 653, 654, 657, 687, 689, 691, 697, TIME ZONE..................................................... 633, 659, 931
717, 729, 731, 732, 772, 823, 825, 838, 856, 900, 901, TOOLS.................................................................................
915, 920, 931, 932, 934, 937 Linux tools...................................... 23, 168, 796, 800
Stats Admin.......................................... 11, 168, 394, 395 Mac Tools............................................... 23, 796, 805
Stats Details.......................................... 11, 168, 395, 823 Multiplatform Tools.............. 23, 168, 794, 800, 803
Stats User...................................................... 11, 168, 391 ToolBox...................................23, 168, 705, 794, 829
STRUCTURES (WIKI BOOKS)........................................................ Windows tools................................ 23, 168, 796, 803
Structure.......1, 11, 16, 32, 36, 71, 74, 75, 108-110, 116, TOP 10..................................................................
10.................................................................. 258, 820
119, 123, 151, 153, 158, 168, 169, 205, 324, 366, 438, TRACKERS...........................................................................
442, 443, 467, 502, 516, 532-543, 545, 659, 687, 694, Adding fields to a tracker.... 10, 324, 325, 327, 347,
695, 697-699, 703, 754, 762, 795, 796, 809, 810, 817, 353, 358
819, 820, 823, 827, 828, 847, 855, 899, 900, 903, 916, Adding items to a tracker................... 324, 325, 347
918, 921-926, 928, 929 Creating a Tracker.10, 324-326, 344, 347, 358, 819
Structure Admin.........................................169, 532-534 Fields...........................................................................
Structure Details.................................. 16, 169, 532, 542 Category Tracker Field.............................. 10, 355
Structure User............................ 532, 533, 539, 541, 542 Checkbox field................................................. 188
STYLES AND THEMES 22, 75, 168, 472, 473, 726, 742, 757, 874 Drop Down Tracker Field..................10, 354, 825
SUPPORT TICKET................................................................... 324 Dynamic items list...................... 10, 353, 356-358
SURVEYS.................................................................................... Items List and Item Link Tracker Fields....10, 355
survey..11, 21, 29, 69, 108, 167-170, 184, 218, 219, 325, Subscription Tracker Field.........................10, 356
377-383, 582, 651, 655, 691, 693, 697, 773, 823, 824, text field........... 188, 211, 344, 350, 351, 355, 366
899-901, 910, 917, 931 tracker field10, 210, 214, 327, 333, 348, 353-356,
Survey Admin.......................................11, 169, 379, 824 825
Survey Details.......................................11, 168, 383, 824 Tracker Field Type.....10, 327, 348, 353, 354, 356
Survey User........................................................ 168, 824 tracker......1, 7, 10, 14, 15, 20, 21, 25, 29, 69, 73, 76,
TASKS....................................................................................... 108, 109, 111, 115, 167-170, 184-186, 188, 206,
Tasks..... 15, 18, 19, 32-36, 108, 169, 325, 412, 420, 459, 209-220, 308, 324-348, 350, 352-363, 377, 388, 401,
482, 612-615, 623, 624, 626, 627, 636, 654, 690, 698, 443, 458, 475, 478, 479, 523, 549, 582, 612, 615,
757, 794, 811, 821, 824, 918, 929, 931 641, 651, 653, 655, 660, 664, 667, 685, 691, 693,
TELL A FRIEND.............................................................. 19, 645 696, 700, 773, 793, 819, 824-826, 841, 852, 891,
TEMPLATES................................................................................ 896, 898-902, 904-911, 913-918, 920, 923-925, 931
Content Template. 20, 21, 113, 249, 386, 575, 690, 712, Tracker Admin.... 168, 332, 334, 335, 346, 910, 923
713, 821 Tracker Details.................................... 168, 332, 343
Documentation Templates.................. 24, 811, 816, 820 tracker item. 1, 10, 15, 109, 111, 188, 209, 213, 214,
Edit Template...............................21, 114, 652, 715, 913 219, 327, 329, 331-333, 335, 337, 346-348, 352-356,
Smarty Templates....... 22, 114, 168, 461, 726, 742, 757, 358, 361, 458, 478, 479, 523, 685, 691, 793, 841,
763, 927 925, 931
Templates.12, 17, 21, 22, 24, 64, 65, 74, 75, 77, 94, 114, Tracker User........................................ 168, 332, 343
152, 168, 183, 210, 228, 245, 249, 269, 270, 291, 310, TROUBLESHOOTING. 4, 24, 72, 73, 179, 241, 242, 340, 474,
384, 386-388, 412, 424, 449, 461, 520, 525, 543, 547, 481, 498, 788, 793, 823, 829, 830
575, 584, 647, 649, 651, 652, 656, 677, 687, 690, 700, UPGRADE.............................................................................
712, 713, 715, 726, 742, 755-758, 763-765, 767, 771, Upgrade 4, 25, 41, 43, 47, 50, 73-80, 94, 95, 99, 100,
773, 775, 776, 778, 786, 811, 816, 820, 834, 846, 851, 102-104, 107, 111, 131, 168, 169, 191, 543, 550,
896-900, 902-908, 912, 913, 916, 923, 924, 927, 929- 767, 823, 839, 870, 871, 903, 910, 911, 916, 918,
931, 937 922, 923
THEMES..................................................................................... Upgrade 1.8 to 1.9........................................ 4, 74, 75
Styles and Themes.22, 75, 168, 472, 473, 726, 742, 757, Upgrade 1.9.7 to 1.10................... 4, 74, 79, 169, 823
874 Upgrade 1.9.x to 1.9.7.. 4, 74, 76, 169, 191, 550, 823
Theme Control................................................................. USER...................................................................................
Theme Control.. 21, 22, 113, 168, 448, 653, 724, 725, avatar..... 1, 24, 51, 75, 102, 133, 184, 613, 633, 634,
757, 774, 910, 919, 929 837, 841-845, 922, 924, 927, 931
Theme Control Center......22, 724, 725, 757, 774, 929 USERS.................................................................................
THIRD PARTY CODE........................................................ 25, 893 Users Management.......... 20, 87, 168, 169, 679, 823
TIKIBOT..................................................................................... VOTES.................................................................................

Back to TOC 959

 Votes............................................................193, 219, 598 919, 936
WEBMAIL.................................................................................. Wiki Config...... 6, 118, 133, 143, 536, 567, 656, 836
webmail...... 18, 21, 29, 50, 109, 133, 168, 191, 550, 612, Wiki Details...................................... 6, 118, 155, 538
614-616, 651, 655, 691, 699, 900, 901, 931 Wiki feature... 5, 6, 85, 105, 107, 115-117, 125, 134,
WIKI......................................................................................... 145, 149, 532, 567, 568, 715, 738, 774, 833, 930
Admin... 91, 110, 117, 118, 146, 257, 259-262, 265, 402, WikiPlugins....25, 159-161, 163, 167, 169, 170, 172,
585, 784, 837, 921 173, 175, 179, 181, 194, 195, 198, 200, 204, 206,
Backlinks 5, 117, 119, 123, 151, 163, 184, 818, 826, 921 207
block....... 17, 70, 102, 114, 141, 142, 184, 386, 467, 468, WINDOWS............................................................................
484, 577-579, 652, 710, 714, 758, 841, 862, 906, 936, Windows Desktop Install............................ 3, 42, 57
937 Windows tools................................ 23, 168, 796, 803
External Wikis.... 21, 112, 117, 126, 168, 186, 715, 716, WOLLABOT..........................................................................
928 Wollabot................................................. 26, 893, 924
History..... 5, 6, 11, 26, 36, 108, 109, 117, 119, 121, 122, Workflow.......1, 12, 21, 85, 114, 325, 345, 347, 411,
150-152, 154, 364, 365, 432, 511, 542, 553, 555, 574, 412, 414, 421, 425, 427, 429, 433, 651, 655, 692,
641, 696-699, 737, 762, 817, 819, 896, 910, 914, 927, 840, 927
928, 933, 935 Workflow Admin........................................... 12, 433
Permissions................................................................. 687 Workflow Details........................................... 12, 433
Plugins....74, 94, 102, 112, 116, 117, 156, 157, 183, 187, Workflow User...............................................12, 411
188, 198, 200, 207, 216, 218-221, 324, 347, 358, 377, WORKFLOW.........................................................................
438, 439, 449, 456, 463, 574, 739, 779, 815, 840, 875, Instances. 57, 412, 414, 418, 420, 421, 426-430, 432,
897, 900, 902-905, 908, 910, 915, 917, 920, 921, 929, 692, 900, 901
930 WYSIWYG............................................................................
Subscribe.................................................................... 154 Editor..........................................................................
Syntax................................................................................ Wysiwyg Editor.....7, 22, 169, 191, 222-224, 228,
Wiki-Syntax Images...................5, 130, 168, 830, 836 229, 255, 263, 264, 550, 590, 652, 738, 739, 814,
Wiki-Syntax Links............................................. 5, 125 823, 927
Wiki-Syntax Lists...................... 5, 127, 168, 191, 550 Wysiwyg Editor Admin.... 22, 169, 222, 228, 229,
Wiki-Syntax Special Characters........................ 6, 142 738, 823
Wiki-Syntax Text............................... 5, 134, 165, 169 Wysiwyg Editor Details.......................7, 222, 228
title bar................................108, 164, 165, 463, 598, 698 Wysiwyg Editor User...................7, 169, 222, 229
Using Wiki Pages.... 5, 87, 118, 168, 169, 537, 540, 815, wysiwyg...... 7, 22, 169, 191, 222-224, 228, 229, 255,
836 263, 264, 550, 590, 652, 738, 739, 814, 823, 855,
Watch....... 6, 19, 108, 111, 152, 154, 168, 179, 222, 270, 927
517, 640, 641, 654, 697, 818, 820, 836, 903, 912-914,

960 Back to TOC