create new tag
, view all tags

CreateHomeWebVariable Archived discussions

These are the discussions on CreateHomeWebVariable, from 28 Oct 2006 to 21 May 2007

Please do not edit this topic anymore!


-- ArthurClemens - 28 Oct 2006

True, since we already have a WIKIHOMEWEB we could use it consistently, e.g. also as the root of the breadcrumb.

-- PeterThoeny - 28 Oct 2006

I've not seen WIKIHOMEWEB before and I don't find it in a search of TWiki.org. Are you proposing it as the name for this new variable? If so, i'm fine with that name. If it already exist, I'd appreciate if someone could point me to where it's documented. Thanks. I'll be glad to make the change and do the docs if there's any chance of sneaking it into 4.1.

-- LynnwoodBrown - 31 Oct 2006

Indeed, it does not exist; I was confusing it with the existing WIKILOGOURL / WEBLOGOURL variable.

Since it does not exist, let's brainstorm on the use cases and name for a bit.

Use cases, TWiki is used:

  • for many projects/services/interest groups, using different webs:
    • Entry point is typically the default Main.WebHome
    • ==> current default setup, e.g. no need to change anything
  • for one primary project/service/interest group:
    • Entry point is most likely the web's home, such as FooBarSIG.WebHome (actual use case at a large financial institution)
    • ==> The name of the web needs be set for the home icon link and the first link of the breadcrumb
  • as an Intranet replacement:
    • One topic in the Main web or an application web is declared as the Intranet home, such as Main.IntranetHome or News.IntranetHome; an index.html is generated from it by a cron job (actual use case is TWikiNewsPortal)
    • ==> The Web.TopicName needs be set for the home icon link and the first link of the breadcrumb

What is a good name for this? START*, HOME*, WIKIHOME*

What needs to be configurable? Separate out web name and topic name? Configurable Alt text? Configurable link text for breadcrumb home?

This is a small enhancement, it does not require a code change. That is, it does not fall under the feature freeze.

-- PeterThoeny - 31 Oct 2006

From the real world. Our TWiki consists webs for major departments/product groups and special functions. And then there is one web common to all of us. And I called that "Home". So anything with the word Home seems to be a very intuitive choice for the place you go per default. All the wiki-wide variables start with WIKI so the name that falls natural to me is WIKIHOMEWEB

-- KennethLavrsen - 31 Oct 2006

I was proposing it as a name for the new variable.

-- ArthurClemens - 31 Oct 2006

I saw that. And I proposed the same - just with an additional explanation why I also agreed with your proposal. So we all agree then smile

-- KennethLavrsen - 31 Oct 2006

Great! I'm going to create a bug item so we can finalize actions/approval there.

-- LynnwoodBrown - 31 Oct 2006

Besides WIKIHOMEWEB, I'd add also WIKIHOMETOPIC, WIKIHOMELABEL and WIKIHOMEALT, and modify the breadcrumb home and logo setting (in TWikiPreferences) to use them.

-- PeterThoeny - 31 Oct 2006

What is the performance impact on this? If TWiki has to read 4 additional settings from TWikiPreferences on each page read, does that cost extra execution time?

-- KennethLavrsen - 31 Oct 2006

Make them a configure setting, and create the tags to reference them in topics.

I see no reason of why they should be tags in the TWikiPreferences topic.

-- RafaelAlvarez - 02 Nov 2006

Lynnwood. Are you driving the implementation if this gets decided?

And do we agree on the spec? Ie. 4 settings in configure or 4 more TWikiVariables

-- KennethLavrsen - 08 Apr 2007

I could/would implement it if decied that TWikiVariables is an acceptable approach. I would not know how to implement it in configure.

-- LynnwoodBrown - 09 Apr 2007

OK. We have a clear proposal with TWO options.

  • Add the 4 variables in TWikiPreferences
  • Add the 4 variables in configure

Lynnwood can implement the first solution. And I am sure I can help Lynnwood with the 2nd if this is chosen instead. With current release schedule proposed this should be a TWiki 5 scope thing.

I think the right thing to do now is bring it up for release meeting.

Let us collect votes now. People can vote here if they cannot make next release meeting.

Name Decision
Configure or TWikiPreferences or None
KennethLavrsen Will decide at meeting after having heard view on performance

-- KennethLavrsen - 25 Apr 2007

This was discussed at the FreetownReleaseMeeting2007x05x07.

  • Some felt that it is important to be able to set logo link per web.
  • Question of performance impact on adding to configure vs. adding to TWikiPreferences.


  • Add settings to TWiki.TWikiPreferences, for consistency with existing related settings WIKITOOLNAME, WIKILOGOIMG, WIKILOGOURL, WIKILOGOALT, WIKIHOMEURL.
  • Instead of creating new WIKIHOMEWEB and WIKIHOMETOPIC, reuse existing WIKIHOMEURL for breadcrumb.
  • Add new WIKIHOMELABEL and WIKIHOMEALT for a nice breadcrumb.
  • WIKIHOMELABEL is set to WIKITOOLNAME by default.

-- PeterThoeny - 07 May 2007

FreetownReleaseMeeting2007x05x07: Many good proposals but we feel that Lynnwood as proposer should have a chance to give his views on the proposal topic so decision deferred.

-- KennethLavrsen - 07 May 2007

Lynnwood. I propose based on the previous meeting that you implement the feature using good old TWikiPreferences settings.

The experts told us that there is no performance impact on doing it this way and it enables people to also use the setting in WebPreferences.

-- KennethLavrsen - 21 May 2007

Topic revision: r1 - 2008-01-28 - ColasNahaboo
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2018 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.