Summary Plugin

Syntax Rules

%SUMMARY{prefix="Blog*" excludetopic="BlogTemplate" author="NelsonFerraz" startdate="20050801" enddate="20050901" limit="20" offset="0" reverse="on" format="   * [[$topic][$title]] ($day/$mon/$yea)\n$text"}%

%SUMMARY{prefix="Blog*" excludetopic="BlogTemplate" author="" startdate="20050801" enddate="20050901" limit="" offset="" reverse="on" format="   * [[$topic][$title]] ($day/$mon/$yea)\n$text"}%

Topic filenames should be in the "prefix_author_date" format, for instance: "Blog_NelsonFerraz_20050801123000".

• '$title' is extracted from the first /---+ (.+)/
• '$text' is extracted from the first paragraph after $title /([^\n]+)/

Plugin Settings

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

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Este plugin não faz nada, mas pode ser usado como modelo para seus próprios plugins.

• Your own setting, i.e.:
  • Set EXAMPLE = got it!

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

Plugin Installation Instructions

• Just unzip the file and put the files in the correct directories.

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins, DefaultPlugin

-- TWiki:Main.AndreaSterbini - 27 Feb 2001
-- TWiki:Main.PeterThoeny - 21 Mar 2004
to top