Tags:
documentation1Add my vote for this tag create new tag
, view all tags
ALERT! NOTE: This is a SupplementalDocument topic which is not included with the official TWiki distribution. Please help maintain high quality documentation by fixing any errors or incomplete content. Put questions and suggestions concerning the documentation of this topic in the comments section below! Use the Support web for problems you are having using TWiki.

Supplemental Documents

Supplemental TWiki documentation not included in the latest release:

Installation, Upgrade, & Performance

Security

Authentication, Access Control, Version Control

Plugins, Skins, Templates

TWiki Applications, Admin Tools

Editing, Content, Rendering, Search

Import, Export, Syndication

Navigation, User Interface, Usability

Supplemental Documents sorted by Recent Changes

HowToMakeSimpleTWikiPlugin 2015-04-25 - 16:19 - 7 EmilStepniewski
How to make a simple TWiki Plugin Introduction This topic is written for the absolute beginner that would like to write a simple plugin for TWiki that implements...
TWiki04x02WindowsInstallationGuide 2015-04-16 - 05:19 - 33 PeterThoeny
TWiki 4.2 Windows Installation Guide Purpose Scope This is a step by step TWiki 4.2 Windows installation guide. It should have you running your own TWiki in no...
ApacheConfigGenerator 2014-10-16 - 19:46 - 99 PeterThoeny
Auto generated twiki.conf to be included from httpd.conf NOTE: Some people, including many using web hosts, do not have access to the Apache configure directories...
InstallingTWiki 2014-10-06 - 04:43 - 34 PeterThoeny
Installing TWiki Supplemental Documents Each TWiki release contains an installation guide specific to that release. As of TWiki 4.0, this guide is a basic description...
HowToInstallCpanModules 2014-03-07 - 03:35 - 36 VickiBrown
How to Install CPAN Modules Introduction CPAN (Comprehensive Perl Archive Network) is a large repository of Perl modules. Standard Perl already has many...
TWikiScalability 2013-12-18 - 01:39 - 7 PeterThoeny
TWiki Scalability Sometimes we get the question on how well TWiki can scale. This supplemental document compiles scalability related information so that you can plan...
TWikiUpgradeTo06x00 2013-10-15 - 23:34 - 1 PeterThoeny
TWiki Upgrade to TWiki 6.0 Supplemental Information The upgrade guide that shipped with TWiki 6.0 is at TWikiUpgradeGuide. This topic contains post release extra...
UpgradingTWiki 2013-10-15 - 23:21 - 15 PeterThoeny
Upgrading TWiki Supplemental Documents Tag Cloud on `upgrade` Topics tagged with Tag:upgrade : Upgrade Guide by TWiki Release Each TWiki release contains...
Windows2003Authentication 2013-07-12 - 19:56 - 12 IanBerdei
Windows 2003 Authentication using Kerberos and mod auth kerb This is a discussion of the TWiki I setup on linux that transparently authenticates Windows users. There...
ApacheLdapAuthSetup 2013-06-26 - 22:49 - 9 PeterThoeny
Apache LDAP AD Authentication Setup NOTE: The LdapContrib is likely a better alternative to this manual setup. I m currently trying to get a knowledge base set...
TWikiUpgradeTo05x01 2013-03-18 - 20:56 - 3 JonForrest
TWiki Upgrade to TWiki 5.1 The upgrade guide that shipped with TWiki 5.1 is at TWikiUpgradeGuide. This topic contains post release extra information on upgrading to...
ScreenElementsOfTWikiSkin 2012-10-29 - 21:15 - 4 PeterThoeny
Screen Elements of a TWiki Skin This topic is intended as a guide for TWikiSkins designers. It depicts screen elements of the default skin of TWiki, the TopMenuSkin...
InstallationWithI18N 2012-10-02 - 16:29 - 38 PeterThoeny
Installing TWiki with Internationalisation support (I18N) Introduction This document is useful if you need to use languages other than English for the content...
TWikiSkinsSupplement 2012-08-18 - 01:02 - 5 PeterThoeny
TWiki Skins Supplemental Documents The following documents supplement the TWikiSkins documentation. SkinPackagingHowTo SkinDeveloperFAQ ScreenElementsOfTWikiSkin...
HowToEnableSingleSignOn 2012-06-29 - 07:06 - 4 PeterThoeny
How to Enable Single Sign on with TWiki Overview If your IT organisation has deployed SingleSignOn (SSO, Wikipedia:Single sign on) for the principal servers and applications...
SettingFileAccessRightsLinuxUnix 2012-04-13 - 00:14 - 45 PeterThoeny
File Access Rights on Unix and Linux One of the most common problems people ask about it how to set up the file access rights in Linux/Unix. This small topic answers...
WindowsInstallSummary 2012-02-14 - 19:23 - 18 PeterThoeny
Nutshell Summary of Windows Install Cookbook NOTE The following is out of date, you can no longer download perl 5.6 for Cygwin. For an easy to install TWiki...
WindowsInstallCookbook 2012-02-14 - 19:20 - 67 PeterThoeny
Windows Install Cookbook For a very simple and virtually foolproof installation, with no TWiki or web server knowledge required, see DownloadTWikiVM. For a very...
UsingSslForAuthenticationOnly 2012-02-14 - 19:13 - 7 PeterThoeny
Using SSL For Authentication Only This topic presents a method that is successfully used to avoid transmitting passwords in plain text readable form over a network...
ShorterUrlCookbook 2011-11-18 - 19:48 - 53 BarryLake
How to enable shorter URLs in TWiki This supplemental document describes how to enable shorter URLs on your TWiki site. To do this, all you will need is access to...
HowToMoveTheFormToTheTopOfThePage 2011-08-12 - 01:00 - 11 PeterThoeny
FAQ: How do I move the form to the top of the page? Answer: There are several different ways to implement this change. Globally via Skin Template The easiest way...
TWikiUserAuthenticationSupplement 2011-08-03 - 06:25 - 12 PeterThoeny
TWiki User Authentication Supplemental Documents The following documents supplement the TWikiUserAuthentication documentation. Tag Cloud on `authentication`...
TWikiOnWindowsIISCygwin 2011-04-01 - 18:23 - 7 PeterHoff
Installing TWiki on Windows, using IIS and Cygwin Purpose Scope This is a summary of my experience in installing TWiki 4 using the IIS HTTP server and Cygwin. Familiarity...
TWikiAdminCookBook 2011-02-23 - 23:13 - 65 PeterThoeny
TWiki Admin Cook Book This page has many tips and tricks, particularly useful when you`re installing TWiki for the first time. This guide is most useful before or...
InternationalizationSupplement 2011-01-19 - 22:36 - 6 PeterThoeny
Internationalization Supplemental Documents The following documents supplement the internationalization documentation in the TWikiInstallationGuide. Installing TWiki...
TWikiUpgradeTo04x01 2010-05-29 - 10:43 - 1 PeterThoeny
TWiki Upgrade to TWiki 4.1 The upgrade guide that shipped with TWiki 4.1 is at TWikiUpgradeGuide. This topic here contains post release extra information on upgrading...
TWikiUpgradeTo05x00 2010-05-29 - 10:42 - 1 PeterThoeny
TWiki Upgrade to TWiki 5.0 The upgrade guide that shipped with TWiki 5.0 is at TWikiUpgradeGuide. This topic here contains post release extra information on upgrading...
EmptyPluginDotPm 2010-05-08 - 21:49 - 1 PeterThoeny
Content of EmptyPlugin.pm This is the content of the EmptyPlugin.pm , useful as an reference. Use this as a template to write your own plugin. See also TWikiPlugins...
TWikiPluginsSupplement 2010-05-08 - 21:46 - 8 PeterThoeny
TWiki Plugins Supplemental Documents The following documents supplement the TWikiPlugins documentation. Tag Cloud on `plugin` Topics tagged with Tag:plugin...
AuthenticatedButStillTWikiGuest 2009-11-24 - 19:12 - 6 SeanCMorgan
FAQ: I am a registered user and I have authenticated myself before I edited a topic. But after saving the topic, the left bar and the variable % WIKIUSERNAME% are...
TWikiUpgradeTo04x03 2009-04-11 - 04:27 - 1 PeterThoeny
TWiki Upgrade to TWiki 4.3 The upgrade guide shipped with TWiki is at TWikiUpgradeGuide. This topic here contains post release extra information on upgrading to TWiki...
QuerySearchPatternCookbook 2009-02-13 - 20:22 - 10 StephenHallett
QuerySearch Pattern Cookbook We have the very useful SearchPatternCookbook for regular expression searches. This topic provides tips on the usage of QuerySearch, a...
WindowsInstallCookbookForTWiki04x01 2008-09-18 - 00:05 - 5 RobStanfield
Windows Cookbook for TWiki 4.1.2 I am thankful to the TWiki community for writing this great software. I had installed the Cairo release using the Windows Cookbook...
ConvertTablesFromHTMLToTML 2008-08-12 - 18:23 - 4 SeanCMorgan
FAQ: How do I convert a table from HTML to TML? You often find yourself in the situation that you have a table in HTML. Either because you copy it from another web...
CronOnMacOSX 2008-05-16 - 19:56 - 7 DavidWolfe
FAQ: How do I set up cron jobs on Mac OS X? Answer: Mac OS X 10.4.x and newer recommends launchd instead of cron . The user needs to create a .plist in /System...
TWikiUpgradeTo04x02 2008-04-23 - 03:54 - 2 PeterThoeny
TWiki Upgrade to TWiki 4.2 The upgrade guide shipped with TWiki is at TWikiUpgradeGuide. This topic here contains post release extra information on upgrading to TWiki...
PerformanceSupplement 2008-03-26 - 04:45 - 10 PeterThoeny
TWiki Performance Supplemental Documents The following documents supplement the TWikiInstallationGuide and TWikiUpgradeGuide with tips on how to tune a TWiki installation...
SearchSupplement 2008-02-09 - 07:04 - 5 PeterThoeny
Search Supplemental Documents Supplemental Documents on Search GoogleAjaxSearch experimental API to integrate a dynamic Google search in TWiki topics...
SupplementalDocument 2008-02-02 - 07:39 - 30 PeterThoeny
Supplemental Documents Supplemental TWiki documentation not included in the latest release: Installation, Upgrade, Performance InstallingTWiki installingTWiki...
HowToUpgradeExtensionsWithConfigure 2008-01-25 - 23:21 - 1 KennethLavrsen
FAQ: How do I upgrade an already installed extension like a plugin using configure? Answer: You must be an admin with access to the configure script and you...
PamAuthenticationWithoutApache 2007-12-28 - 06:27 - 6 PeterThoeny
PAM Authentication without Apache Here`s what I had to do to enable PAM authentication in a TWiki running on Lighttpd/FreeBSD. You`ll need and http://www.freshports...
TWikiDirectoryStructure 2007-11-08 - 06:14 - 2 PeterThoeny
TWiki`s Directory Structure This topic is sort of the theory behind SettingFileAccessRightsLinuxUnix , and perhaps helpful if for one or the other reason you can...
TwistyMadeEasy 2007-07-19 - 07:04 - 7 HaraldJoerg
Twisty Made Easy Some of my TWiki users are impressed by the optical effect of what can be done with TWiki:Plugins.TwistyPlugin and they keep asking me: `How do...
UserHomepageSupplement 2007-07-07 - 17:56 - 7 PeterThoeny
User Homepage Customization Supplemental Document Organizations have different needs for user home pages. An administrator can customize the user home pages to the...
RegisterOnViewRestrictedSite 2007-04-19 - 06:02 - 1 PeterThoeny
Register Users on View Restricted Site (To be written; for now see Support.RegisterOnViewRestrictedSite ) Contributors: PeterThoeny 19 Apr 2007 Could someone...
TWikiAccessControlSupplement 2007-04-19 - 05:12 - 4 PeterThoeny
TWiki Access Control Supplemental Documents The following documents supplement the TWikiAccessControl documentation. RegisterOnViewRestrictedSite site is...
UpgradingTWiki04x00PatchReleases 2007-03-19 - 06:21 - 28 YogiParish
Upgrading TWiki 4.X and Maintaining Current Tailoring Introduction TWiki 4.X is a lot easier to install compared with TWiki Cairo (3). But upgrading can still be...
UsingI18NInUsernames 2007-01-31 - 05:53 - 4 PeterThoeny
FAQ: How can I use international (I18N) characters in usernames? Answer: By default, TWiki doesn`t allow you to use international characters (i.e. letters other...
SpecifyingConfigurationItemsForExtensions 2006-12-02 - 08:53 - 3 CrawfordCurrie
How to integrate Extension configuration into bin/configure Note: The description given here works from TWiki version 4.1 onward only! Introduction With TWiki...
TWikiTemplatesSupplement 2006-11-28 - 01:29 - 1 PeterThoeny
TWiki Templates Supplemental Documents The following documents supplement the TWikiTemplates documentation. Tag Cloud on `template system` Topics tagged with...
SkinsAndJavaScript 2006-10-27 - 20:25 - 14 ArthurClemens
Skins and JavaScript Skin authors should load twiki.js from pub/TWikiJavascripts/twiki.js to benefit from a number of utility functions: retrieving class elements...
SecuringTWikiSite 2006-07-06 - 01:00 - 4 PeterThoeny
Securing a TWiki Site Supplemental Documents This topic is intended to help administrators understand the security risks associated with TWiki, and suggests ways...
RenderingSupplement 2006-07-06 - 00:40 - 5 PeterThoeny
Rendering Supplemental Documents TwistyMadeEasy how to easily add text sections that can be opened and closed Tag Cloud on `rendering` Topics...
TWikiSettingsCookie 2006-06-13 - 22:01 - 9 ArthurClemens
TWiki settings cookie When user interface elements such as Twisty store their settings in persistent cookies, the limit of 20 cookies per domain is reached soon (see...
NewTWikiAdminSteps 2006-06-01 - 15:49 - 5 PeterThoeny
New TWiki Admin Steps Introduction I`m creating this as a separate topic for now to get feedback. The content can later be refactored into appropriate topics as...
ExportSupplement 2006-04-18 - 00:06 - 2 PeterThoeny
Data Export Supplemental Documents Tag Cloud on `export` and `publish` Topics tagged with Tag:export : Topics tagged with Tag:publish : Export...
SpecialCharacters 2006-04-13 - 09:49 - 7 FranzJosefSilli
Entities for Special Characters and Symbols Not all characters will display across all browsers. The Hex version in particular does not appear to be very compatible...
TWikiApplications 2006-03-22 - 02:27 - 1 PeterThoeny
TWiki Applications Supplemental Documents TWikiApplication Tag Cloud on `twiki application` Topics tagged with Tag:twiki application : Related...
EditingSupplement 2006-03-22 - 02:20 - 1 PeterThoeny
Editing Supplemental Documents Tag Cloud on `editing` Topics tagged with Tag:editing : Related topics: SupplementalDocuments, HistoricalDocuments...
SyndicationSupplement 2006-03-22 - 02:16 - 1 PeterThoeny
Syndication Supplemental Documents Tag Cloud on `syndication` Topics tagged with Tag:syndication : Related topics: TWikiSyndication, SupplementalDocuments...
ImportSupplement 2006-03-22 - 02:14 - 1 PeterThoeny
Data Import Supplemental Documents Tag Cloud on `import` Topics tagged with Tag:import : Related topics: ExportSupplement, SupplementalDocuments...
UserInterfaceSupplement 2006-03-22 - 02:12 - 1 PeterThoeny
User Interface Supplemental Documents Tag Cloud on `user interface` Topics tagged with Tag:user interface : Related topics: UsabilitySupplement...
UsabilitySupplement 2006-03-22 - 02:12 - 1 PeterThoeny
Usability Supplemental Documents Tag Cloud on `usability` Topics tagged with Tag:usability : Related topics: UserInterfaceSupplement, NavigationSupplement...
NavigationSupplement 2006-03-22 - 02:11 - 1 PeterThoeny
Navigation Supplemental Documents Tag Cloud on `navigation` Topics tagged with Tag:navigation : Related topics: UsabilitySupplement, UserInterfaceSupplement...
VersionControlSupplement 2006-03-22 - 02:10 - 1 PeterThoeny
Version Control Supplemental Documents The following documents supplement the version control documentation. Tag Cloud on `version control` Topics...
HowToCreateABlankHtpasswdFile 2006-03-12 - 20:34 - 3 PeterThoeny
FAQ: How can I create a .htpasswd file that is owned by the webserver user? A common problem is that installers who don`t have root access can`t write files owned...
ErrorPrematureEndOfScriptHeader 2006-03-09 - 06:09 - 2 PeterThoeny
FAQ: When I try to access TWiki, I get the `Premature end of script headers: ...` error. Answer: That message indicates that something went wrong while running the...
TWikiUpgradeTo04x00x00 2006-03-02 - 07:08 - 3 UlfJastrow
TWiki Upgrade to TWiki 4.0.0 The upgrade guide shipped with TWiki is at TWikiUpgradeGuide. This topic here contains post release extra information on upgrading to...
BrowserIssues 2006-02-04 - 05:13 - 6 PeterThoeny
Browser Issues For now see Support.BrowserIssues I`d like to get the Support.BrowserIssues docs into the TWiki web, including the child pages for each...
TWikiLegalNotes 2006-02-04 - 04:05 - 2 PeterThoeny
TWiki Legal Notes This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the...
TWikiUpgradeTo01Feb2003 2006-01-30 - 02:53 - 41 PeterThoeny
# TWiki Upgrade Guide Upgrade from the previous TWiki 01 Dec 2001 production release to TWiki 01 Feb 2003 Overview This guide describes how to upgrade from TWiki...
TWikiUpgradeTo01Dec2001 2006-01-30 - 02:53 - 17 PeterThoeny
# TWiki Upgrade Guide Upgrade from TWiki 01 Dec 2000 or TWiki 01 Sep 2001 to TWiki 01 Dec 2001 (previous to new full release) Overview This guide describes how...
TWikiUpgradeTo01Dec2000 2006-01-30 - 02:52 - 14 PeterThoeny
## TWiki Upgrade Notes (The following upgrade notes apply to the 01 Dec 2000 release. The upgrade notes of this Beta release is pending.) If you are coming from a...
TWikiUpgradeTo01May2000 2006-01-30 - 02:51 - 4 PeterThoeny
To upgrade an earlier TWiki version like 01 Sep 1999 to version 01 May 2000 you should do the following things: Back up your system. Update the templates...
BasicAuthentication 2006-01-30 - 02:50 - 19 PeterThoeny
# Basic Authentication This page explains what Basic Authentication is. Basic Authentication is not a TWiki service, it is a service of your web server. Configuration...
TWikiUpgradeTo01Sep2004 2006-01-29 - 23:26 - 9 PeterThoeny
# TWiki Upgrade Guide Upgrade from the previous TWiki 01 Feb 2003 production release to TWiki 01 Sep 2004 Overview This guide describes how to upgrade from TWiki...
Number of topics: 76

How to create a Supplemental Document

1. Start from an existing supplemental document, linking to your new document

2. Use this content as a template:

%INCLUDE{SupplementalDocHeader}%
%STARTSECTION{"supplementaldoc"}%
...topic content...
%ENDSECTION{"supplementaldoc"}%
%INCLUDE{SupplementalDocComments}%
%COMMENT%

Note: The primary location for supplemental documents is the TWiki web on TWiki.org. Nevertheless, many existing documents in the Codev, Plugins and Support webs contain useful supplemental information. You can refactor and recreate the content in the TWiki web, or you can reference them from one of the existing supplemental documents in the TWiki web.

Related topics: DistributionDocuments, HistoricalDocuments

-- Contributors: PeterThoeny



Comments & Questions about this Supplemental Document Topic

I moved list of security documents under it's own header since this is such an important area of concern for new TWiki administrators. I was looking for it and missed it during first couple of scans of page when it was grouped with Installation, Upgrades & Performance.

-- LynnwoodBrown - 19 Oct 2007

Please use the Support forum if you have questions about TWiki features. This comment section is about the documentation of this topic.
Edit | Attach | Watch | Print version | History: r30 < r29 < r28 < r27 < r26 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r30 - 2008-02-02 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2015 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.