r5 - 24 Jul 2002 - 07:03:24 - PeterThoenyYou are here: TWiki >  Codev Web > BumpyWordsForDocumentWriting
Tags:
, create new tag
I was writing documentation using TWiki and had used WikiWords whereever I mentioned a concept.

When I had the document reviewed (on paper) I was told that although it might be nice to be able to click through I must take out most of the WikiWords as the presence of so many Capitalised Words Everywhere was Jarring To The Eye. (NB. I use CanIRenderWikiWordsSpacedOut)

It occurred to me that often I wanted the links but not the capitalisation. And I wanted it cheaply (i.e. I couldn't be bothered to write [[ JarringToTheEye? ] [jarring to the eye]]!)

So, I figured, perhaps we could use BumpyWords? such as jarringToTheEye (hitherto used only as a coding convention) in documents when we want to render without significance but still want to be able to click through to JarringToTheEye? and WikiWords when we want to show prominance.

Thoughts?

-- MartinCleaver - 09 Jun 2001

I think the simplest thing is to just use the [[ ... ]] convention, or the new March beta feature that allows you to have unrelated text appearing instead of the WikiWOrd? - it doesn't take long to type, probably less time than figuring out the right topic name. Rendering jarringToTheEye as a lower case, spaced out link (which I think is what you mean by 'without significance') seems like it would cause problems with some existing text, though it could perhaps be configurable.

An implementation possibility is to use a modified 'view' script, for use when printing only (might be possible using skins and the DefaultPlugin if you can sense which skin was used within the script).

-- RichardDonkin - 09 Jun 2001

Sure, it would need to be a plugin, enableable on a per-web or per-page basis - it would ruin code samples if applied more generally than that!

I can't see why I should need an extra script though. Why can't it be done with the rendering rules in a plug-in? (Is there a PlugInChainingMechanism? ?) Also, I'd like to be able to use BumpyWords? for viewing as well as for printing.

-- MartinCleaver - 11 Jun 2001

Maybe a little off topic, but can somebody who knows the TWiki code real well tell me in which file and around what line is code for checking to see if a TopicExists? and making it yellow with the question mark if it doesn't? (I want to change what happens when a user clicks on the question mark).

-- DavidSachitano - 23 Jul 2002

Look in TWiki::internalLink for the topic exist test.

-- PeterThoeny - 24 Jul 2002

Edit | WYSIWYG | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r5 < r4 < r3 < r2 < r1 | More topic actions
 
Powered by TWiki
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback SourceForge.net Logo