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

Would be good to have an example


Moved doc to TWikiVariables, where the rest of the INCLUDE doc is

SVN 7556

CC


I suggest to restore IncludeTopicsAndWebPages. Reasons:
  • INCLUDE is a reasonably complex function that warrants its own topic (pattern include, section include, etc)
  • Better to keep TWikiVariables concise
  • Pattern explanation is gone
  • Inconsistent format in TWikiVariables (no bullets)
  • TWiki:Support topics point to it

In return I suggest to remove these topics

And possibly this:

-- PTh

i don't understand how IconSets is obselete---isn't this related to %ICON%? (or was i not paying close enough attention...?)

-- WN

We simplified the icons, there is now only one set, the one in TWikiDocGraphics; the pattern specific TWikiDocGraphicsPattern has been retired, and the icons moved to TWikiDocGraphics.

-- PTh

If you want to have a second topic to cover include, then please be my guest. You might want to look at some of the other complex TWikiVariables at the same time. TWikiVariables is waaaay too big, anything that cuts it down had to be good.

Reprioritising as Low (the doc is there, just in a bad place)

CC

Often I am running my laptop "offline", i.e. apache runs on localhost without external net. I wouldn't have noticed this discussion, but since the inclusion of IncludeTopicsAndWebPages's content in TWikiVariables reading TWikiVariables when "offline" gives me an "attempted hack":

TWiki detected an error or attempted hack - please check your TWiki logs and webserver logs for more information.

Bad arg length for Socket::pack_sockaddr_in, length is 0, should be 4

The reason: TWiki:TWikiVariablesAtoM contains a link to an external URL

Tokyo: %INCLUDE{"http://TWiki.org/cgi-bin/xtra/tzdate?tz=Asia/Tokyo" pattern="^.*<\!--tzdate:date-->(.*?)<\!--/tzdate:date-->.*"}%
...which croaks due to the suboptimal error handling in =TWiki::Net::getUrl. So I'm tempted to re-prioritize to "Normal" because the doc is currently in a very bad place (I often consult TWikiVariables, but never needed IncludeTopicsAndWebPages).

And since I fell over this topic, let me add my 2 cent:

I'd go for a radical approach: Create one separate topic for each "variable" with a derived name, e.g. TWikiVariableINCLUDE, and convert the list in TWikiVariables to a search over that namespace. The current scheme has the drawback that the user has to know whether %FOO{...}% is part of the TWiki core or of a plugin - and if, of which plugin. I have been looking for %TABLE{...}% in TWikiVariables quite often. If the plugin could create TWikiVariableTABLE, then there wouldn't be a difference between variables provided by the core and variables provided by a plugin - if they are available in an installation, then TWikiVariables can pick them up.

  • I second that - good idea. Eases both finding the stuff and maintenance -- AJA
  • I third that. -- MC

There are many complex "variables" like %SEARCH{...}% deserve a page of their own (see e.g. FormattedSearch). Many others can be grouped (like %SECTION{...}% and %ENDSECTION%), but this could be easily done if each of TWikiVariableSECTION and TWikiVariableENDSECTION would consist of just one line, e.g. %INCLUDE{TWikiVariablesLabels}%.

-- TWiki:Main.HaraldJoerg

Making core variables and plugin variables searchable is a good idea. This needs more design, I do not want to rush that into Dakar. An implication of creating a topic for every variables would blow up the number of topics substantially. There are other ways to offer the query capabilities.

-- PTh

I moved followup of INCLUDE error to Item1017

-- PTh

Harald, good idea.

CC

Ok, discussion of the idea shouldn't be in a bug item. I've started TWiki:Codev.CleanUpTWikiVariables as a feature request for Edinburgh.

-- TWiki:Main.HaraldJoerg

IncludeTopicsAndWebPages is restored and cleaned up, TWikiVariables as well. TWikiCategoryTable and IconSets are gone.

-- PTh

ItemTemplate
Summary Clean up TWikiVariables
ReportedBy MartinCleaver
AppliesTo Engine
Component

Priority Low
CurrentState Closed
WaitingFor

Checkins 7556 7591
Edit | Attach | Watch | Print version | History: r15 < r14 < r13 < r12 < r11 | Backlinks | Raw View |  Raw edit | More topic actions
Topic revision: r15 - 2005-11-24 - PeterThoeny
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback