MoreFuncContrib

This contrib contains basic functionality needed by many plugins that is not included in Dakar's TWiki::Func. Some or all of these will probably be merged into the TWiki::Func at some point.

Webs, Topics, and Attachments

readTopicMeta($web, $topic, $rev) -> $metadata

Returns the metadata for a topic.

getTopicPreferenceValue($web, $topic, $prefName) -> $pref

Returns the value of a topic's preference.

getChildWebs($web) -> $listOfWebs

Returns a list of a web's child webs

Plugin-specific file handling

readWorkFile($pluginName, $fileName) -> $data

Returns the contents of a file in a particular plugin's work area

saveWorkFile($pluginName, $fileName, $data)

Saves $data to a file in a plugin's work area

deleteWorkFile($pluginName, $fileName)

Delete a file in a plugin's work area

General Utilities

buildMimeHash($session) -> $hash

Return a mapping of extention to mime type

suffixToMimeType ( $session, $theFilename ) -> $mimetype

Returns the mime type of a file based on its suffix

Installation Instructions

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

  File:	Description:
  data/TWiki/MoreFuncContrib.txt	Plugin doc page
  lib/TWiki/Contrib/MoreFuncContrib.pm	Plugin Perl module

• Run MoreFuncContrib_installer.pl to automatically check and install other modules that this module depends on. You can also do this step manually. Dependencies: None

Contrib Info

Related Topics: TWikiFuncDotPm

-- TWiki:Main.MeredithLesly - 2012-05-26