ScriptsSummary < Codev

Tags: view all tags

For the assistance of those who may be motivated to help generate some useful testcases, here is a breakdown of all the bin scripts and the parameters they take. A good starting point would be a set of testcases that contain URLs for these scripts, with some idea of expected results when the URL is clicked in each case. I have not covered installpasswd or register because MartinCleaver knows a lot more about those than I do wink

I can't guarantee the accuracy of the parameter descriptions. I wrote most of the in-code documentation, but I didn't write the code and I suspect nobody has checked the documentation yet. There may be more information on some of these parameters in the TWiki web, I haven't cross-checked it (it was tedious enough extracting this lot!)

bin/script	parameter	value(s)	description	testcase
`attach`			prepare an `upload` query (attach again or attach new)	none
	`topic`	topic name	overrides topic in URL	none
	`skin`	skin name	set the skin	none
	`filename`	file name (no path)	file being attached	none
`changes`				none
	`topic`	topic name	ignored?	none
	`skin`	skin name	set the skin	none
`edit`			edit a topic	none
	`topic`	topic name	overrides topic in URL	none
	`skin`	skin name	set the skin	none
	`cmd`	`repRev`, `delRev`	optional CM controls
	`breaklock`	boolean	if defined, breaks any pre-existing lock before edit	none
	`onlywikiname`	boolean	if defined, requires a wiki name for the topic name if this is a new topic	none
	`onlynewtopic`	boolean	if defined, and the topic exists, then moans	none
	`formtemplate`	form topic name	name of the form for the topic; will replace existing form	none
	`templatetopic`	topic name	name of the topic to copy if creating a new topic	none
	`contenttype`	MIME type	application type e.g. text/html	none
	`apptype`	MIME type	overrides `contenttype` (deprecated)	none
	`topicparent`	(optional web .) topic name	what to put in the topic parent meta data	none
	`text`	string	text that will replace the old topic text if a formtemplate is defined (what the heck is this for?)	none
`manage`			miscellaneous management actions	none
	`action`	`createweb`, `changePassword`, `deleteUserAccount`	sub-action	none
	`newweb`	web name	`action` = `createweb` Name of new web	none
	`newtopic`	topic name	`action` = `createweb` topic in new web to redirect to when finished	none
	`baseweb`	web name	`action` = `createweb` Name of web to copy to create newweb	none
	`webbgcolor`	HTML colour	`action` = `createweb` background color for new web	none
	`sitemapwhat`	string	`action` = `createweb` value for SITEMAPWHAT	none
	`sitemapuseto`	string	`action` = `createweb` value for SITEMAPUSETO	none
	`nosearchall`	string	`action` = `createweb` value for NOSEARCHALL	none
	`TopicName`	topic name	`action` = `changePassword` overrides topic in URL	none
	`username`		`action` = `changePassword` user to change	none
	`oldpassword`	unencrypted	`action` = `changePassword` their old password	none
	`password`	unencrypted	`action` = `changePassword` new password, first try	none
	`passwordA`	unencrypted	`action` = `changePassword` new password, second try	none
	`TopicName`	topic name	`action` = `deleteUserAccount` overrides topic in URL	none
	`username`		`action` = `deleteUserAccount` dead users name	none
	`password`	unencrypted	`action` = `deleteUserAccount` dead users password	none
`oops`			display message screen	none
	`topic`	topic name	overrides topic in URL (ignored?)	none
	`skin`	skin name	set the skin	none
	`template`	template name	name of oops template file	none
	`param1`	string	arbitrary text parameter 1	none
	`param2`	string	arbitrary text parameter 2	none
	`param3`	string	arbitrary text parameter 3	none
	`param4`	string	arbitrary text parameter 4	none
`preview`			preview changes to a topic	none
	`topic`	topic name	overrides topic in URL	none
	`skin`	skinName	set the skin	none
	`submitChangeForm`			none
	`dontnotify`	boolean	if defined, suppress change notification	none
	`cmd`	`delRev`, `repRev`	optional repRev or delRev	none
	`topicparent`	(optional web.) topic name		none
	`formtemplate`	topic name	if defined, use the named template for the form	none
	`text`	string	target text for the topic	none
`rdiff`			difference a topic	none
	`topic`	topic name	overrides topic in URL	none
	`skin`	skinName	set the skin	none
	`render`	`sequential`, `sidebyside`, `raw`, `debug`	the rendering style	none
	`type`	`history`, `diff`, `last`	history diff, version to version, last version to previous	none
	`context`	number	number of lines of context	none
	`rev1`	(r?1\.)\d+	the higher revision	none
	`rev2`	(r?1\.)\d+	the lower revision	none
`rename`			rename topic or attachment	none
	`topic`	topic name	overrides topic in URL	none
	`skin`	skinName	set the skin	none
	`newweb`	web name	target web name	none
	`newtopic`	topic name	target topic name	none
	`breaklock`	boolean	break any pre-existing lock	none
	`attachment`	file name (no path)	attachmemnt to rename (if present)	none
	`confirm`	boolean	if defined, requires a second level of confirmation	none
	`currentwebonly`	boolean	if defined, searches current web only for links to this topic	none
	`nonwikiword`	boolean	if defined, a non-wikiword is acceptable for the new topic name	none
	`changerefs`	boolean	justChangeRefs will be true when some topics that had links to oldTopic still need updating, previous update being prevented by a lock. Not sure how this is used.	none
`save`			save topic	none
	`topic`	topic name	overrides topic in URL	none
	`skin`	skinName	set the skin	none
	`action`	`checkpoint`, `quietsave`, `cancel`, `preview`	type of save	none
	`cmd`	`repRev`, `delRev`	optional extended commands, not valid with all actions	none
	`text`	string	target text for the topic	none
	`templatetopic`	topic name	if defined, embed text in this template	none
	`unlock`	boolean	if defined, unlock the written topic	none
	`dontnotify`	boolean	if defined, suppress change notification	none
	`submitChangeForm`			none
	`topicparent`	(optional web.) topic name	content for parent meta-data	none
	`onlywikiname`	boolean	if true, only allow wikinames	none
	`onlynewtopic`	boolean	if true, reject save to existing topic	none
	`formtemplate`	topic name	if defined, use the named template for the form	none
`search`			parameters as for %SEARCH tag, I think	none
	`topic`	topic name	overrides topic in URL	none
	`skin`	skinName	set the skin	none
	`web`		see TWikiVariables	none
	`search`	string	see TWikiVariables	none
	`excludetopic`		see TWikiVariables	none
	`scope`	`topic`, `text`	see TWikiVariables	none
	`order`		see TWikiVariables	none
	`type`		see TWikiVariables	none
	`regex`	boolean	deprecated	none
	`limit`		see TWikiVariables	none
	`reverse`	boolean	see TWikiVariables	none
	`casesensitive`		see TWikiVariables	none
	`nosummary`	boolean	see TWikiVariables	none
	`nosearch`	boolean	see TWikiVariables	none
	`noheader`	boolean	see TWikiVariables	none
	`nototal`	boolean	see TWikiVariables	none
	`bookview`		see TWikiVariables	none
	`renameview`		see TWikiVariables	none
	`showlock`	boolean	see TWikiVariables	none
	`expandvariables`		see TWikiVariables	none
	`noempty`	boolean	see TWikiVariables	none
	`template`		see TWikiVariables	none
	`header`		see TWikiVariables	none
	`format`		see TWikiVariables	none
	`multiple`		see TWikiVariables	none
	`separator`		see TWikiVariables	none
`statistics`			update statistics page	none
	`topic`	topic name	ignored?	none
	`skin`	skin name	set the skin	none
`upload`			upload a file	none
	`topic`	topic name	overrides topic in URL	none
	`skin`	skin name	set the skin	none
	`hidefile`	boolean	if defined, don't show file in view	none
	`filecomment`	string	comment for view	none
	`createlink`	boolean	if true, create a link at end of topic (even if already there)	none
	`changeproperties`	boolean	if true, don't upload the file	none
	`filepath`	file path	full client path name	none
	`filename`	file name (no path)	attachment name	none
`view`			view a topic in browser	none
	`topic`	topic name	overrides topic in URL	none
	`skin`	skin name	set the skin	none
	`rev`	(r?1\.)\d+	revision to view	none
	`raw`	`on`, `debug`	show in textbox (interactions with skin!!)	none
	`unlock`	boolean	force unlock of topic	none
	`contenttype`	MIME type	the application type e.g. text/html	none
`viewfile`			view attachment in browser	none
	`topic`	topic name	overrides topic in URL	none
	`skin`	skin name	set the skin	none
	`filename`	file name (no path)	attachment to view	none
	`rev`	\d+	rev to see (minor revision number only)	none

-- CrawfordCurrie - 26 Nov 2004

BasicForm
TopicClassification	TWikiCommunity
TopicSummary
InterestedParties
RelatedTopics

Topic revision: r2 - 2004-11-27 - CrawfordCurrie

Account
- Log In
- Register User

Edit
Attach

Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2026 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.