From: MikeMannix Date: Fri, 7 Sep 2001 11:10:16 +0000 (+0000) Subject: none X-Git-Url: https://git.openafs.org/?p=openafs-wiki.git;a=commitdiff_plain;h=a95932c6bbe57c23b49018ed96db3f5dba335401 none --- diff --git a/TWiki/ManagingTopics.mdwn b/TWiki/ManagingTopics.mdwn index db78624..e368bfc 100644 --- a/TWiki/ManagingTopics.mdwn +++ b/TWiki/ManagingTopics.mdwn @@ -18,11 +18,11 @@ -## Managing Topics +# Managing Topics _Browser-based rename, move, and delete for individual topics_ -### Overview +## Overview Select **Rename/move** when viewing a topic to change its name, move it to another TWiki web, or delete it: @@ -33,7 +33,7 @@ Select **Rename/move** when viewing a topic to change its name, move it to anoth - If any of the referring pages are locked then they will be listed - You can correct these later by again pressing Rename/Move -#### Referring Topics +### Referring Topics Referring topics are found using the the %SEARCH% variable, see the template **searchrenameview.tmpl**. First, matching topics in the current Web are listed - matches are to _topic_. Next, all Webs (including the current one) are listed that match _web.topic_. Because %SEARCH% is used, Webs marked in [[WebPreferences]] as NOSEARCHALL will not show up in the search for refernces to the _topic_ being changed. @@ -41,25 +41,25 @@ Changed references are kept are as short as possible, i.e. _topic_ is used in pr -#### Deleting a Topic +### Deleting a Topic Deleted topics are moved to the `Trash` web - NOT physically erased from the server. All webs share `Trash` - in case of a name conflict with a topic already `Trash`, the user is alerted and asked to choose a new name. -##### Clearing the Trash +#### Clearing the Trash **_NOTE:_** The `Trash` web should be be cleared periodically, by archiving the contents if required (recommended), then deleting the files from the `Trash` directory. -### Redirecting from an Old Topic +## Redirecting from an Old Topic You can use [[TWikiMetaData]] to place a command in [[WebTopicViewTemplate]] and [[WebTopicNonWikiTemplate]] that will show if a topic has moved by searching for the tag %META:TOPICMOVED\{...\}%. Customize something like this: > %METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}% -### Impact of Topic Access Settings +## Impact of Topic Access Settings Permissions affect the rename function in various ways. To rename a topic, you need both change and rename permissions. To alter refer4ing topics, you need change permission. See [[TWikiDocumentation#TWiki_Access_Control]] for information on setting up access permissions. -### How Rename/move Works +## How Rename/move Works - %SEARCH% is used with a special template to show text in topics that requires updating to point to the new topic and/or web name. This includes relevent [[MetaData|Main/TWikiDocumentation#Meta_Data_Definition]] - User chooses which topics will be altered @@ -68,7 +68,7 @@ Permissions affect the rename function in various ways. To rename a topic, you n - References are changed (locks and permissions permitting) - Any referring topics that can't be changed due to locks are listed - user can change them at another time. -### Known Limitations +## Known Limitations **Rename/move** in is fairly complicated due to the dynamic generation of links. Ideally, it would be possible to run the required part of rendering in a way that would allow identification of the text to be changed. Unfortunately, these hooks don't exist in TWiki at present. Instead, %SEARCH% is used with a special template to show the text to be changed, and the selected topics are then altered. One drawback is that `search` can show matches that will not be updated because of case differences. Other mismatches to actual rendered output are also possible as the approaches are so different. diff --git a/TWiki/ManagingWebs.mdwn b/TWiki/ManagingWebs.mdwn index 0a3787d..be00c66 100644 --- a/TWiki/ManagingWebs.mdwn +++ b/TWiki/ManagingWebs.mdwn @@ -9,19 +9,19 @@ -## Managing Webs +# Managing Webs _Adding, renaming and deleting webs is done directly on the server_ -### Overview +## Overview Managing TWiki webs requires direct access to the installation files on the host server. There are no browser-based web tools. -### How to Add a New Web +## How to Add a New Web - See [[TWikiInstallationGuide|Main/TWikiDocumentation#TWikiInstallationGuide]] -### How to Rename or Delete a Web +## How to Rename or Delete a Web **NOTE:** Think twice if you intend to rename the %WIKITOOLNAME%.Main web, since many files point to it. If you rename it, you also have to change all occurrences of `Main` to the new web name (like the web prefixes for all user signatures, `Main.SomeName`). (On the other hand, if the `%MAINWEB%` variable is used throughout, you won't have that problem.) diff --git a/TWiki/TWikiForms.mdwn b/TWiki/TWikiForms.mdwn index ab58736..b5a2e03 100644 --- a/TWiki/TWikiForms.mdwn +++ b/TWiki/TWikiForms.mdwn @@ -2,16 +2,13 @@ -## TWiki Plugins +# TWiki Plugins Plugin use and development; about the Plugin API. -### Overview +## Overview You can add Plugins to greatly extend TWiki's functionality, without alering the program core. With a plug-in approach, you can: @@ -46,7 +46,7 @@ You can add Plugins to greatly extend TWiki's functionality, without alering the Everything to do with TWiki Plugins - demos, new releases, downloads, development, general discussion - is available at TWiki.org, in the **[[TWiki.org Plugins web|Main/TWiki:Plugins]]**. -### Preinstalled Plugins +## Preinstalled Plugins TWiki comes with three Plugins as part of the standard installation. @@ -58,7 +58,7 @@ TWiki comes with three Plugins as part of the standard installation. -### Installing Plugins +## Installing Plugins Each TWikiPlugin comes with full documentation: step-by-step installation instructions, a detailed description of any special requirements, version details, and a working example for testing. @@ -76,7 +76,7 @@ Each Plugin has a standard release page, located in the TWiki:Plugins web at TWi - **Dev page:** Post feature requests, bug reports and general dev comments; topic title ends in **Dev** (**SomePluginDev**). - **User support:** Post installation, how to use type questions (and answers, if you have them) in the TWiki:Support web. -#### On-Site Pretesting +### On-Site Pretesting To test new Plugins on your installation before making them public, you may want to use one of these two approaches: @@ -87,11 +87,11 @@ To test new Plugins on your installation before making them public, you may want - **Method 2:** List the Plugin under **Test** in the DISABLEDPLUGINS variable in [[TWikiPreferences]]. Redefine the DISABLEDPLUGINS variable in the Test web and do the testing there. -### Managing Plugins +## Managing Plugins Ideally, after you've [[installed a Plugin|Main/WebHome#InstallPlugin]], just read the instructions and you're set. In fact, some Plugins require additional settings or offer extra options that you can modify on Preferences pages. You may want to make a Plugin available only in certain webs, or temporarily disable it. And having to list all available Plugins will probably come up. You can handle all of these with simple procedures. -#### Setting Preferences +### Setting Preferences Installed Plugins can be **toggled on or off**, site-wide or by web, through TWikiPreferences and individual WebPreferences: @@ -110,7 +110,7 @@ Installed Plugins can be **toggled on or off**, site-wide or by web, through TWi - The settings can be retrieved as Preferences variables like **%<pluginname>\_<var>%**, ex: **%DEFAULTPLUGIN\_SHORTDESCRIPTION%** shows the description of the DefaultPlugin. -#### Listing Active Plugins +### Listing Active Plugins Plugin status variables let you list all active Plugins wherever needed. There are two list formats: @@ -135,11 +135,11 @@ Plugin status variables let you list all active Plugins wherever needed. There a -### The TWiki Plugin API +## The TWiki Plugin API The Application Programming Interface (API) for TWikiPlugins provides the specifications for hooking into the core TWiki code from your external Perl Plugin module. The Plugin API is new to the Production version of TWiki with the TWikiReleaseSpring2001. -#### Available Core Functions +### Available Core Functions The **lib/TWiki/Func.pm** implements ALL official Plugin functions. Plugins should ONLY use functions published in this module. @@ -147,13 +147,13 @@ The **lib/TWiki/Func.pm** implements ALL official Plugin functions. - For best performance, enable only the functions you really need. NOTE: **outsidePREHandler** and **insidePREHandler** are particularly expensive. -#### Predefined Hooks +### Predefined Hooks In addition to TWiki core functions, Plugins can use **predefined hooks**, or **call backs**, listed in the **lib/TWiki/Plugins/EmptyPlugin.pm** module. - All but the initPlugin are disabled. To enable a call back, remove **DISABLE\_** from the function name. -#### Plugin Version Detection +### Plugin Version Detection To eliminate the incompatibility problems bound to arise from active open Plugin development, a Plugin versioning system and an API **GetVersion** detection routine are provided for automatic compatibility checking. @@ -166,15 +166,15 @@ To eliminate the incompatibility problems bound to arise from active open Plugin -### Creating Plugins +## Creating Plugins With a reasonable knowledge of the Perl scripting language, you can create new Plugins or modify and extend existing ones. Basic plug-in architecture uses an Application Programming Interface (API), a set of software instructions that allow external code to interact with the main program. The [[TWiki Plugin API|Main/WebHome#PluginAPI]] Plugins by providing a programming interface for TWiki. -#### The DefaultPlugin Alternative +### The DefaultPlugin Alternative - **DefaultPlugin** can handle some outdated TWiki variables, found, for example, in sites recently updated from an old version. Settings are in [[TWikiPreferences]]. You can also add your own simple custom processing rules here, though in all but very simple cases, writing a new Plugin is preferable. -#### Anatomy of a Plugin +### Anatomy of a Plugin A basic TWiki Plugin consists of two elements: @@ -185,13 +185,13 @@ The Perl module can be a block of code that connects with TWiki alone, or it can The Plugin API handles the details of connecting your Perl module with main TWiki code. When you're familiar with the [[Plugin API|Main/WebHome#PluginAPI]], you're ready to develop Plugins. -#### Creating the Perl Module +### Creating the Perl Module Copy file ([`EmptyPlugin.pm`](http://twiki.org/lib/TWiki/Plugins/EmptyPlugin.pm) to **<name>Plugin.pm** **EmptyPlugin.pm** contains no executable code, so it does nothing, but it's ready to be used. Customize it. Refer to the [[Plugin API|Main/WebHome#PluginAPI]] specs for more information. -#### Writing the Documentation Topic +### Writing the Documentation Topic The Plugin documentation topic contains usage instructions and version details. It serves the Plugin files as [[FileAttachments]] for downloading. (The doc topic is also included _in_ the [[distribution package|Main/WebHome#CreatePluginPackage]].) To create a documentation topic: @@ -229,7 +229,7 @@ The Plugin documentation topic contains usage instructions and version details. -#### Packaging for Distribution +### Packaging for Distribution A minimum Plugin release consists of a Perl module with a [[WikiName]] that ends in **Plugin**, ex: **YourPlugin.pm**, and a documentation page with the same name(**YourPlugin.txt**). @@ -244,7 +244,7 @@ A minimum Plugin release consists of a Perl module with a [[WikiName]] that ends -#### Publishing for Public Use +### Publishing for Public Use You can release your tested, packaged Plugin to the TWiki community through the TWiki:Plugins web, where all Plugins submitted to TWiki.org are available for download and further development discussion. Publish your Plugin in three steps: diff --git a/TWiki/WebChangesAlert.mdwn b/TWiki/WebChangesAlert.mdwn index 0c9d7df..3acf11d 100644 --- a/TWiki/WebChangesAlert.mdwn +++ b/TWiki/WebChangesAlert.mdwn @@ -1,7 +1,3 @@ -
- -
- ## Web Changes Notification Service + +Each %WIKITOOLNAME% web has an automatic email notification service for recent changes. You can subscribe and unsubscribe yourself in [[WebNotify]] on each web.