• Do not register here on develop.twiki.org, login with your twiki.org account.
• Use View topic Item7848 for generic doc work for TWiki-6.1.1. Use View topic Item7851 for doc work on extensions that are not part of a release. More... Close
• Anything you create or change in standard webs (Main, TWiki, Sandbox etc) will be automatically reverted on every SVN update.
Does this site look broken?. Use the LitterTray web for test cases.

Item4547: Improve TWiki variables documentation

Item Form Data

AppliesTo: Component: Priority: CurrentState: WaitingFor: TargetRelease ReleasedIn
Engine Documentation Enhancement Closed   minor 4.2.0

Edit Form Data

Summary:
Reported By:
Codebase:
Applies To:
Component:
Priority:
Current State:
Waiting For:
Target Release:
Released In:
 

Detail

Currently each variable has its own topic, and is included in TWikiVariables to create large document. Many variables point to related variables. These references are anchor linked - pointing to other variable descriptions in the same topic. This works for the large include topic TWikiVariables, but not for the individual topics, resulting in lots of broken links.

The variable topics therefore need to distinguish between being standalone or being included.

The syntax for related links would then be:

[[%IF{"'%BASETOPIC%'='TWikiVariables'" then="#"}%VarREVINFO2][REVINFO{"format"}]]

It is a simple change, but I am not sure if this fall within the code freeze.

-- TWiki:Main.ArthurClemens - 04 Sep 2007

This is documentation that cannot break the code. It is always OK to improve docs and this one is a pretty good one to fix.

-- TWiki:Main.KennethLavrsen - 05 Sep 2007

ItemTemplate
Summary Improve TWiki variables documentation
ReportedBy TWiki:Main.ArthurClemens
Codebase

SVN Range TWiki-4.2.0, Thu, 30 Aug 2007, build 14664
AppliesTo Engine
Component Documentation
Priority Enhancement
CurrentState Closed
WaitingFor

Checkins TWikirev:14753
TargetRelease minor
ReleasedIn 4.2.0
Edit | Attach | Watch | Print version | History: r7 < r6 < r5 < r4 < r3 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r7 - 2008-01-22 - KennethLavrsen
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback