Item5385: Update docs how to include and exclude topics

pencil
Priority: Normal
Current State: Closed
Released In:
Target Release: n/a
Applies To: Extension
Component: PublishPlugin
Branches: master
Reported By: TWiki:Main.ArthurClemens
Waiting For: TWiki:Main.CrawfordCurrie
Last Change By: CrawfordCurrie
Read end of topic first.

I have a hard time to tell PublishPlugin to exclude a set of topics, notably all topics that start with Web except for WebHome. Actually I don't want to exclude any topic: I just don't want the contrib to assume that I want to export all topics by default. I only want to publish topics that have a certain form.

Current behaviour:
  • the contrib will export all topics of a web when INCLUSIONS and EXCLUSIONS are both set to empty
  • unless I set EXCLUSIONS (or exclusions form field) to *, in that case it will exclude all topics

Bug:
  • form param exclusions does not work as documented. When I write:
<input type="hidden" name="exclusions" value='%SEARCH{"Web" scope="topic" web="Corporate" topic="Web*" excludetopic="WebHome" nonoise="on" format="$topic" separator=","}%' />

... it does publish topics that have Web in the name.

I think the biggest bug is that all topics are published by default.

Desired behaviour:
  • The contrib will not publish any topic unless I say so
  • I can explicitly set the topics to publish as a list of topic names. For instance: INCLUSIONS=Contact,Search,WebHome,Dictionary
  • If INCLUSIONS is set with a wildcard or fed with a large result set, I can set a list of topics to exclude.

-- TWiki:Main/ArthurClemens - 22 Feb 2008

Working through the code revealed that there is a secret parameter called configtopic. Totally undocumented but essential for having any predictable behaviour. If I remove that param from the form the contrib just publishes the list of topics that are fed to param inclusions.

I am leaving this bug entry because the documentation needs to get fixed:
  • configtopic - what does it do, where do I set it and when do I leave it out
  • Specifying lists of topics: inclusions and exclusions can be fed a list of topics, for example using a SEARCH. Very useful but undocumented.
  • Skins: I found out by plug and pray: you can add any list of skins like mycompany,public,pattern (can't pass a cover however)

-- TWiki:Main.ArthurClemens - 23 Feb 2008

Closed in NextWiki

ItemTemplate edit

Summary Update docs how to include and exclude topics
ReportedBy TWiki:Main.ArthurClemens
Codebase
SVN Range TWiki-5.0.0, Wed, 23 Jan 2008, build 16283
AppliesTo Extension
Component PublishPlugin
Priority Normal
CurrentState Closed
WaitingFor TWiki:Main.CrawfordCurrie
Checkins PublishPlugin:184e501571c1
TargetRelease n/a
ReleasedIn
CheckinsOnBranches master
masterCheckins PublishPlugin:184e501571c1
Topic revision: r9 - 21 Apr 2017, CrawfordCurrie - This page was cached on 24 Nov 2017 - 05:07.

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License