• 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.

Item3788: TWikiDocumentation shows links to topics as code text

Item Form Data

AppliesTo: Component: Priority: CurrentState: WaitingFor: TargetRelease ReleasedIn
Engine Documentation Low No Action Required   n/a  

Edit Form Data

Reported By:
Applies To:
Current State:
Waiting For:
Target Release:
Released In:


Why not write links?

-- TWiki:Main/ArthurClemens - 19 Mar 2007

I also asked that question once until I started releasing TWikis.

TWO topics tries to avoid having links.

The TWikiUpgradeGuide and the TWikiInstallationGuide.

The reason is that these two documents are created as pure HTML documents and placed at the root of the TWiki tree. And you must assume that at that point in time the links will point to a not yet working TWiki.

For this reason those links that are there points to twiki.org are real links. And the "links" that explains where to go in your own TWiki are written as code.

If we can find a way to have the links working when viewed as TWiki topic but not as pure HTML then it would be great. But that will require an update of the build contrib and fix_local_links.pl to see the difference between local anchors, twiki.org links and WikiWord links and translate accordingly. You will have a hard time making the local links work in the static HTML. You need to be able to read these HTML files by directly opening them in your browser as a file open and not have garbage links that leed nowhere.

The Installation Guide and Upgrade Guides must be assumed to be read more often before TWiki is installed and working than after and they should be optimized to function well as HTML versions.

-- TWiki:Main.KennethLavrsen - 19 Mar 2007

Setting to no-action on the basis of Kenneth's analysis.


Summary TWikiDocumentation shows links to topics as code text
ReportedBy TWiki:Main.ArthurClemens

SVN Range TWiki-4.1.2, Sat, 17 Mar 2007, build 13167
AppliesTo Engine
Component Documentation
Priority Low
CurrentState No Action Required


TargetRelease n/a

Edit | Attach | Watch | Print version | History: r3 < r2 < r1 | Backlinks | Raw View |  Raw edit | More topic actions
Topic revision: r3 - 2007-04-17 - CrawfordCurrie
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2021 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback