AttachContentPlugin

This plugin puts any text between a %STARTATTACH{"filename"}% and %ENDATTACH% into an attachment with the given filename.

The current version only refreshes the attachment when the topic is saved. Obviously this means that the attachment can get out of synch if, for example, it explicitly or implicitly refers to other topics.

This plugin is written specifically to be able to put css into topic(s) and still be able to have efficient stylesheets: i.e., without the overhead of TWiki processing. The feature can be used for many other things where you want TWiki to generate a plain text file a smart way.

Syntax Rules

Put in a %STARTATTACH{"filename"}% before the content you want in the attached textfile, and %ENDATTACH% after it, and the contents in between will be attached to the topic, for easy reference by other pages.

Examples

This example sets backgroup color using a variable. The variable is expanded when the content is rendered, and resulting text is saved to "mycolors.css".

This example will change the background to grey once the file is saved, if you are using PatternSkin - refreshing your browser cache between tries might be necessarry, typically this is done by pressing CTRL-F5.

Set color:

• Set BG = eeeeee

%STARTATTACH{"mycolors.css"}%
#patternTopBar {
	background-color:#eeeeee;
	border-color:#ccc;
}
#patternOuter {
	background-color:#eeeeee;
	border-color:#ccc;
}
#patternBottomBar {
	background-color:#eeeeee;
	border-color:#ccc;
}
html body {
	background-color:#eeeeee;
}
%ENDATTACH%

• Set USERCOLORSURL = http://gtts.ehu.es/TWiki/pub/TWiki/AttachContentPlugin/mycolors.css

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %CACHECONTENTPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Caches portions of a topic in attachments to that topic

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

• Keep paragraph <p /> tags, <nop> tags, and square bracket type links.
  • Set KEEPPARS = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

• Download the ZIP file from the Plugin web (see below)
• Unzip AttachContentPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/AttachContentPlugin.txt	Plugin topic
  data/TWiki/AttachContentPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/AttachContentPlugin.pm	Plugin Perl module

• Test if the installation was successful:

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main.KennethLavrsen - 19 Oct 2006