Module name TWiki TWikiDotPm Location TWIKIROOT/lib/TWiki.pm Summary Single include library for CgiScripts containing a mishmash of functions Primary Author PeterThoeny CVS history CVS:lib/TWiki.pm CVS alpha CVSget:lib/TWiki.pm Contributing authors (see CVS History) Is Class NO - contains many different types of data First Release to be filled out

File Hierarchy   TWIKIROOT   lib   TWiki.pm

Purpose

1. To provide the glue to bind all TWiki libraries together
2. To provide extra CGI functionality
3. To provide username to wikiname mappings
4. To provide miscellaneous date routines
5. To provide the Rendering Pipeline
6. To initialise TWiki (e.g. preferences variables)
7. To provide logging facilities

Used by

This module is included by the CgiScripts to initialise and gain access to the backend libraries.

Please see CodevDocumentationProject and CodevDocumentationProjectDev for comments on the format of these pages.

%PERLDOC{"TWiki"}%

Contributors:
-- MartinCleaver - 23 Jun 2002
-- PeterThoeny - 01 Feb 2004
-- WalterMundt - 01 Feb 2004

Discussions

In my opinion there would be great value in further splitting up this library. See TWikiDotPmProposedFurtherModularisation for some ideas.

-- MartinCleaver - 23 Jun 2002

There is a problem with the evaluation order of (internal) tags:

If a topic includes another, and that other does a database lookup using the name of the including topic, then the database plugin does not receive the expanded INCLUDINGTOPIC within a %DATABASE_SQL_REPEAT% . Therefore I propose an additional handleInternalTags. Here is the diff.

-- OliverKrueger - 07 Dec 2003

Added %PERLDOC{...}% to pull the doc from the TWiki.pm Perl module. Removed PublicMethods and PrivateMethods section since they are no longer needed.

-- PeterThoeny - 01 Feb 2004

Some of these functions are duplicated - for example UiDotPm::oops is a parallel for TWiki::getOopsUrl. Are both methods to be continued indefinitely?

-- MartinCleaver - 18 Oct 2004

They're not actually duplicated, they do different things. Otherwise I would have merged them.

-- CrawfordCurrie - 18 Oct 2004