Menu
▾
▴
[Tikiwiki-users] Help documentation effort on at least one new page
|
From: Xavier de P. P. <xav...@ub...> - 2007-07-09 14:16:35
|
Hi all: We are getting closer to the release to Tiki 1.9.8., thanks to the tiki devs (thanks heaps! :-) We are getting closer to the release of a new Tiki documentation pdf file, thanks to the tiki documentors (thanks heaps also! :-) Last weeks some of us have been updating many pages in documentation, and adding pages for some plugins, and new pages for all missing modules and mods... (most of them are blank or contain a "((stub))" type of reference). http://doc.tikiwiki.org/Documentation If you want to help on documentation, and you don't know how, please visit: http://doc.tikiwiki.org/Documentation+Status and consider adding some lines and a screenshot to at least one page tagged with the keyword "screenshot" or "stub", for instance. (there are plenty of Modules pages needing somebody to start saying a few sentences about how to use it, etc.), or to pages of more advanced features, if you know about them. I send a copy (below) of the current documentation structure tree (http://doc.tikiwiki.org/Documentation). If you want to have a quick look to all current documentation, there is the "beta" single .pdf file containing those pages (or .odt file, editable with OpenOffice.org, for instance) here: http://doc.tikiwiki.org/files/Tiki19beta.pdf http://doc.tikiwiki.org/files/Tiki19beta.odt (it is updated from time to time, and new uploaded .odt and .pdf files are symlinked to the same file name in server, so this link helps you get the latest file while in this beta stage; last update: this morning): New content should be added to http://doc.tikiwiki.org/Documentation pages, and should be updated later by some of us to the odt -> pdf. Concerning "Mods", it's not urgent but it is important to centralize some place with documentation for them. At mods.tw.o there are links, in some cases, to pages of original devs. But a minimum text explaining what can be used for, some screenshots, and links to places where it's been used would be very suitable. Could you forward this text to authors or power users of mods, if not in this tikiwiki-devel or tikiwiki-users-list? Thanks in advanced to help on the documentation of this nice and broad Community, Xavi ------------------------------------- http://doc.tikiwiki.org/Documentation ..................................... * 1 Introduction o 1.1 Goals * 2 About the Tikiwiki Documentation * 3 Installation o 3.1 Requirements and Setup o 3.2 Download o 3.3 Linux + 3.3.1 Install with RPM + 3.3.2 Install on Debian + 3.3.3 Install on Gentoo o 3.4 Windows Desktop Install o 3.5 Advanced Settings + 3.5.1 Shared Hosting + 3.5.2 Lite Install + 3.5.3 MultiTiki + 3.5.4 Rewrite Rules + 3.5.5 ImageMagick Install + 3.5.6 GraphViz Install o 3.6 TroubleShooting o 3.7 Upgrade + 3.7.1 Upgrade 1.8 to 1.9 + 3.7.2 Upgrade 1.9.x to 1.9.7 + 3.7.3 Upgrade 1.9.7 to 1.10 * 4 Configuration o 4.1 Quick Start o 4.2 Menu HOWTO o 4.3 Profiles + 4.3.1 Using profiles o 4.4 Advanced Configuration + 4.4.1 Site Identity + 4.4.2 Groups o 4.5 Mods + 4.5.1 Mods User + 4.5.2 Mods Admin + 4.5.3 Mods Details * 5 Features o 5.1 Wiki + 5.1.1 Using Wiki Pages # 5.1.1.1 Wiki-Syntax Links # 5.1.1.2 Wiki-Syntax Lists # 5.1.1.3 Wiki-Syntax Images # 5.1.1.4 Wiki-Syntax Text # 5.1.1.5 Wiki-Syntax Special Characters + 5.1.2 Wiki Config + 5.1.3 Wiki Details + 5.1.4 Wiki Plugins # 5.1.4.1 PluginAgentinfo # 5.1.4.2 PluginArticles # 5.1.4.3 PluginCode # 5.1.4.4 PluginDiv # 5.1.4.5 PluginFiles # 5.1.4.6 PluginFlash # 5.1.4.7 PluginGoogleVideo # 5.1.4.8 PluginGroup # 5.1.4.9 PluginJS # 5.1.4.10 PluginLang # 5.1.4.11 PluginManager # 5.1.4.12 PluginMindmap # 5.1.4.13 PluginMiniQuiz # 5.1.4.14 PluginModule # 5.1.4.15 PluginMouseover # 5.1.4.16 PluginPerm # 5.1.4.17 PluginRedirect # 5.1.4.18 PluginRSS # 5.1.4.19 PluginSkype # 5.1.4.20 PluginSplit # 5.1.4.21 PluginThumb # 5.1.4.22 PluginTracker # 5.1.4.23 PluginTrackerFilter # 5.1.4.24 PluginTrackerItemField # 5.1.4.25 PluginTrackerList # 5.1.4.26 PluginTrackerStat # 5.1.4.27 PluginTranslated # 5.1.4.28 PluginVersions # 5.1.4.29 PluginVote # 5.1.4.30 PluginWMV # 5.1.4.31 PluginYouTube + 5.1.5 Wysiwyg Editor # 5.1.5.1 Wysiwyg Editor User # 5.1.5.2 Wysiwyg Editor Details o 5.2 Image Gallery + 5.2.1 Image Gallery User + 5.2.2 Image Gallery Config + 5.2.3 Image Gallery Details o 5.3 Articles + 5.3.1 Article User + 5.3.2 Articles Config + 5.3.3 Article Details o 5.4 Blog + 5.4.1 Blog User + 5.4.2 Blog Config + 5.4.3 Blog Ref o 5.5 File Gallery + 5.5.1 File Gallery User + 5.5.2 File Gallery Config + 5.5.3 File Gallery Details o 5.6 Forum + 5.6.1 Forum User + 5.6.2 Forum Admin + 5.6.3 Forum Details + 5.6.4 Forum and List Synchronization o 5.7 Directory + 5.7.1 Directory User + 5.7.2 Directory Admin + 5.7.3 Directory Details o 5.8 FAQ + 5.8.1 FAQ User + 5.8.2 FAQ Admin + 5.8.3 FAQ Details o 5.9 Quiz + 5.9.1 Quiz User + 5.9.2 Quiz Admin + 5.9.3 Quiz Details o 5.10 Tracker + 5.10.1 Tracker User + 5.10.2 Tracker Admin + 5.10.3 Tracker Details + 5.10.4 Creating a Tracker + 5.10.5 Adding fields to a tracker + 5.10.6 Tracker Field Type # 5.10.6.1 User / Group / IP Selector Tracker Field # 5.10.6.2 Image Tracker Field # 5.10.6.3 Drop Down Tracker Field # 5.10.6.4 Items List and Item Link Tracker Fields # 5.10.6.5 Category Tracker Field # 5.10.6.6 Subscription Tracker Field # 5.10.6.7 Dynamic items list + 5.10.7 Adding items to a tracker o 5.11 Spreadsheet + 5.11.1 Basic Functionality + 5.11.2 Edit Interface + 5.11.3 Graphics and Charts o 5.12 Survey + 5.12.1 Survey User + 5.12.2 Survey Admin + 5.12.3 Survey Details o 5.13 Newsletter + 5.13.1 Newsletter User + 5.13.2 Newsletter Admin + 5.13.3 Newsletter Details o 5.14 Ephemerides + 5.14.1 Ephemerides User + 5.14.2 Ephemerides Admin + 5.14.3 Ephemerides Details o 5.15 Charts + 5.15.1 Charts User + 5.15.2 Charts Admin + 5.15.3 Charts Details o 5.16 Stats + 5.16.1 Stats User + 5.16.2 Stats Admin + 5.16.3 Stats Details o 5.17 Games + 5.17.1 Games User + 5.17.2 Games Admin + 5.17.3 Games Details o 5.18 Calendar + 5.18.1 Calendar User + 5.18.2 Calendar Admin + 5.18.3 Calendar Details + 5.18.4 Js Calendar o 5.19 Workflow + 5.19.1 Workflow User + 5.19.2 Workflow Admin + 5.19.3 Workflow Details o 5.20 Integrator + 5.20.1 Integrator User + 5.20.2 Integrator Admin + 5.20.3 Integrator Details o 5.21 Category + 5.21.1 Category User + 5.21.2 Category Admin + 5.21.3 Categories Details o 5.22 Banner + 5.22.1 Banner User + 5.22.2 Banner Admin + 5.22.3 Banner Details o 5.23 Module + 5.23.1 Module User + 5.23.2 Module Admin # 5.23.2.1 Module Control # 5.23.2.2 Module articles # 5.23.2.3 Module assistant # 5.23.2.4 Module breadcrumb # 5.23.2.5 Module calendar # 5.23.2.6 Module categories # 5.23.2.7 Module change_category # 5.23.2.8 Module comm_received_objects # 5.23.2.9 Module directory_last_sites # 5.23.2.10 Module directory_stats # 5.23.2.11 Module directory_top_sites # 5.23.2.12 Module eph # 5.23.2.13 Module events # 5.23.2.14 Module featured_links # 5.23.2.15 Module forums_best_voted_topics # 5.23.2.16 Module forums_last_posts # 5.23.2.17 Module forums_last_topics # 5.23.2.18 Module forums_most_commented_forums # 5.23.2.19 Module forums_most_read_topics # 5.23.2.20 Module forums_most_visited_forums # 5.23.2.21 Module google # 5.23.2.22 Module last_actions # 5.23.2.23 Module last_articles # 5.23.2.24 Module last_blog_posts # 5.23.2.25 Module last_category_objects # 5.23.2.26 Module last_created_blogs # 5.23.2.27 Module last_created_faqs # 5.23.2.28 Module last_created_quizzes # 5.23.2.29 Module last_fileslast_files # 5.23.2.30 Module last_file_galleries # 5.23.2.31 Module last_images # 5.23.2.32 Module last_images_th # 5.23.2.33 Module last_image_galleries # 5.23.2.34 Module last_modified_blogs # 5.23.2.35 Module last_modif_events # 5.23.2.36 Module last_modif_pages # 5.23.2.37 Module last_modif_tracker_items # 5.23.2.38 Module last_submissions # 5.23.2.39 Module last_tracker_comments # 5.23.2.40 Module last_tracker_items # 5.23.2.41 Module last_visitors # 5.23.2.42 Module live_support # 5.23.2.43 Module logged_users # 5.23.2.44 Module login_box # 5.23.2.45 Module menupage # 5.23.2.46 Module messages_unread_messages # 5.23.2.47 Module num_submissions # 5.23.2.48 Module old_articles # 5.23.2.49 Module online_users # 5.23.2.50 Module quick_edit # 5.23.2.51 Module random_images # 5.23.2.52 Module random_pages # 5.23.2.53 Module search_box # 5.23.2.54 Module search_box_new # 5.23.2.55 Module search_wiki_page # 5.23.2.56 Module shoutbox # 5.23.2.57 Module since_last_visit # 5.23.2.58 Module switch_lang # 5.23.2.59 Module switch_lang2 # 5.23.2.60 Module switch_theme # 5.23.2.61 Module tail # 5.23.2.62 Module top_active_blogs # 5.23.2.63 Module top_articles # 5.23.2.64 Module top_files # 5.23.2.65 Module top_file_galleries # 5.23.2.66 Module top_forum_posters # 5.23.2.67 Module top_games # 5.23.2.68 Module top_images # 5.23.2.69 Module top_images_th # 5.23.2.70 Module top_image_galleries # 5.23.2.71 Module top_objects # 5.23.2.72 Module top_pages # 5.23.2.73 Module top_quizzes # 5.23.2.74 Module top_visited_blogs # 5.23.2.75 Module top_visited_faqs # 5.23.2.76 Module upcoming_events # 5.23.2.77 Module user_blogs # 5.23.2.78 Module user_bookmarks # 5.23.2.79 Module user_image_galleries # 5.23.2.80 Module user_pages # 5.23.2.81 Module user_tasks # 5.23.2.82 Module whats_relatedwhats_related # 5.23.2.83 Module who_is_there # 5.23.2.84 Module wiki_last_comments o 5.24 Chat + 5.24.1 Chat User + 5.24.2 Chat Admin + 5.24.3 Chat Details o 5.25 Live Support + 5.25.1 Live Support User + 5.25.2 Live Support Admin + 5.25.3 Live Support Details o 5.26 Map + 5.26.1 Maps User + 5.26.2 Maps Editor # 5.26.2.1 Maps Layer Management # 5.26.2.2 Maps Mapfiles Manager # 5.26.2.3 Maps Details * 5.26.2.3.1 Maps Mapfile Tutorial * 5.26.2.3.2 Maps MapView + 5.26.3 Maps Admin # 5.26.3.1 Maps Install # 5.26.3.2 Maps Config o 5.27 Gmap + 5.27.1 Gmap User + 5.27.2 Gmap Admin + 5.27.3 Gmap Details o 5.28 Tikibot + 5.28.1 Tikibot User + 5.28.2 Tikibot Admin + 5.28.3 Tikibot Details o 5.29 Mobile + 5.29.1 Mobile Tiki User + 5.29.2 Mobile Tiki Admin + 5.29.3 Mobile Tiki Details o 5.30 Structure + 5.30.1 Structure User + 5.30.2 Structure Admin + 5.30.3 Structure Details o 5.31 Slideshow + 5.31.1 Slideshow User + 5.31.2 Slideshow Admin + 5.31.3 Slideshow Details o 5.32 Comments + 5.32.1 Comment User + 5.32.2 Comment Admin + 5.32.3 Comment Details o 5.33 Contribution o 5.34 Copyright + 5.34.1 Copyright User + 5.34.2 Copyright Admin + 5.34.3 Copyright Details o 5.35 Communication Center o 5.36 Spellcheck + 5.36.1 Spellcheck User + 5.36.2 Spellcheck Admin + 5.36.3 Spellcheck Details o 5.37 Redirect On Error + 5.37.1 Redirect On Error User + 5.37.2 Redirect On Error Admin + 5.37.3 Redirect On Error Details o 5.38 Drawing + 5.38.1 Drawings User + 5.38.2 Drawings Admin + 5.38.3 Drawings Details o 5.39 HTML Page + 5.39.1 HTML Pages User + 5.39.2 HTML Pages Admin + 5.39.3 HTML Pages Details o 5.40 Dynamic Content + 5.40.1 Dynamic Content User + 5.40.2 Dynamic Content Admin + 5.40.3 Dynamic Content Details o 5.41 Dynamic Variable o 5.42 Freetags o 5.43 Poll + 5.43.1 Poll User + 5.43.2 Poll Admin + 5.43.3 Poll Details o 5.44 RSS + 5.44.1 RSS User + 5.44.2 RSS Admin + 5.44.3 RSS Feeds Details o 5.45 Score + 5.45.1 Score Admin + 5.45.2 Score Details + 5.45.3 Karma + 5.45.4 Score vs Karma o 5.46 Shoutbox + 5.46.1 Shoutbox User + 5.46.2 Shoutbox Admin + 5.46.3 Shoutbox Details o 5.47 Search + 5.47.1 Search User + 5.47.2 Search Admin + 5.47.3 Search Details + 5.47.4 Search Stats o 5.48 MyTiki + 5.48.1 MyTiki Admin + 5.48.2 MyTiki Details + 5.48.3 Webmail + 5.48.4 Inter-User Messages + 5.48.5 Notepad + 5.48.6 Task + 5.48.7 User Files + 5.48.8 User Calendar + 5.48.9 User Menu + 5.48.10 User Preferences + 5.48.11 Bookmark + 5.48.12 User Modules + 5.48.13 Watch + 5.48.14 Newsreader + 5.48.15 User Action log o 5.49 Tell a Friend o 5.50 i18n + 5.50.1 i18n Admin o 5.51 Admin Panels + 5.51.1 Features Admin + 5.51.2 General Admin + 5.51.3 Login Config # 5.51.3.1 Login Authentication Methods + 5.51.4 Users Management + 5.51.5 Groups Management + 5.51.6 Permission + 5.51.7 Admin DSN + 5.51.8 Backup + 5.51.9 Banning + 5.51.10 Cache + 5.51.11 Content Template + 5.51.12 Cookie + 5.51.13 Edit Template + 5.51.14 External Wikis + 5.51.15 Featured Links + 5.51.16 Mail notifications + 5.51.17 Mail-in + 5.51.18 Maps Config + 5.51.19 Menus + 5.51.20 Theme Control + 5.51.21 Phpinfo + 5.51.22 Admin Details + 5.51.23 Action Log + 5.51.24 Intertiki + 5.51.25 Contribution Admin + 5.51.26 Wysiwyg Editor Admin * 6 Tuning Tikiwiki o 6.1 Design + 6.1.1 Styles and Themes + 6.1.2 Design rules + 6.1.3 Smarty Templates + 6.1.4 Theme Layout Schema o 6.2 Hacking Tikiwiki + 6.2.1 Adding a new feature + 6.2.2 Using Smarty Filters + 6.2.3 Translating to a new language + 6.2.4 Tikiwiki Performance Tuning + 6.2.5 Database Performance o 6.3 ToolBox + 6.3.1 Linux tools + 6.3.2 Windows tools # 6.3.2.1 wBloggar + 6.3.3 Java Tools # 6.3.3.1 Eclipse * 7 Annexes o 7.1 About the Tikiwiki Documentation + 7.1.1 Welcome Authors + 7.1.2 Tikiwiki Manual of Style + 7.1.3 Documentation Templates # 7.1.3.1 Feature Page Template + 7.1.4 Documentation Status o 7.2 Mods List + 7.2.1 Mods Type Avatars # 7.2.1.1 Mod dragonballz # 7.2.1.2 Mod gnumes # 7.2.1.3 Mod goldorak # 7.2.1.4 Mod mcdonald # 7.2.1.5 Mod xmen # 7.2.1.6 Mod all avatars + 7.2.2 Mods Type Features # 7.2.2.1 Mod aulawiki # 7.2.2.2 Mod cartoweb # 7.2.2.3 Mod cc # 7.2.2.4 Mod config # 7.2.2.5 Mod import-phpwiki # 7.2.2.6 Mod kamap # 7.2.2.7 Mod mapeditor # 7.2.2.8 Mod phpcas # 7.2.2.9 Mod solve # 7.2.2.10 Mod tikidav # 7.2.2.11 Mod tinvoice # 7.2.2.12 Mod userprefstats + 7.2.3 Mods Type Lib # 7.2.3.1 Mod fpdf # 7.2.3.2 Mod fpdf_bitstreamvera # 7.2.3.3 Mod fpdf_freefonts # 7.2.3.4 Mod jpgraph # 7.2.3.5 Mod nusoap # 7.2.3.6 Mod vtiger + 7.2.4 Mods Type Menus # 7.2.4.1 Mod tikiring + 7.2.5 Mods Type Modules # 7.2.5.1 Mod blogroll # 7.2.5.2 Mod calculator # 7.2.5.3 Mod clock # 7.2.5.4 Mod extcalculator # 7.2.5.5 Mod join # 7.2.5.6 Mod plazes # 7.2.5.7 Mod worldclock + 7.2.6 Mods Type Services # 7.2.6.1 Mod mailman + 7.2.7 Mods Type SQL # 7.2.7.1 Mod upgrade_1.7to1.8 # 7.2.7.2 Mod upgrade_1.8to1.9 # 7.2.7.3 Mod upgrade_1.9to1.9.1 + 7.2.8 Mods Type Taglines # 7.2.8.1 Mod damian1 # 7.2.8.2 Mod damian2 # 7.2.8.3 Mod rcogley + 7.2.9 Mods Type Themes + 7.2.10 Mods Type Wikiplugins # 7.2.10.1 Mod ebay # 7.2.10.2 Mod flowplayer # 7.2.10.3 Mod formula # 7.2.10.4 Mod galaxia_sweet_ui # 7.2.10.5 Mod group # 7.2.10.6 Mod js # 7.2.10.7 Mod listpages # 7.2.10.8 Mod mindmap # 7.2.10.9 Mod mouseover # 7.2.10.10 Mod perm # 7.2.10.11 Mod phplot # 7.2.10.12 Mod plazes # 7.2.10.13 Redirect # 7.2.10.14 Mod redirect # 7.2.10.15 Mod scroll # 7.2.10.16 Mod svg # 7.2.10.17 Mod trackeritemfield # 7.2.10.18 Mod wikigraph # 7.2.10.19 Mod xspf_player o 7.3 Third Party code + 7.3.1 Smarty + 7.3.2 Adodb + 7.3.3 SmartIrc + 7.3.4 Wollabot + 7.3.5 Mapserver + 7.3.6 SpellChecker o 7.4 Download using CVS o 7.5 History + 7.5.1 Changelog 1.9 + 7.5.2 Changelog 1.8 + 7.5.3 Changelog 1.7 + 7.5.4 Changelog 1.6 + 7.5.5 Changelog 1.5 + 7.5.6 Changelog 1.4 + 7.5.7 Changelog 1.3 + 7.5.8 Changelog 1.2 + 7.5.9 Changelog 1.1 + 7.5.10 Changelog 1.0 o 7.6 Copyrights o 7.7 Tikiwiki Community ------------------------------------- -- |