NOTE: This is a DistributionDocument. This document is generated, please do not change it. Put questions, error notes, and suggestions concerning the documentation of this topic in the comments section below. Use the Support web for problems you are having using TWiki.

Package TWiki::Prefs::Parser

This Prefs-internal class is used to parse * Set and * Local statements from arbitrary text, and extract settings from meta objects. It is used by TopicPrefs to parse preference settings from topics.

This class does no validation or duplicate-checking on the settings; it simply returns the recognized settings in the order it sees them in.

ClassMethod new () -> topicparserobject

Construct a new parser object.

ObjectMethod parseText ($text,$prefs)

Parse settings from text and add them to the preferences in $prefs

ObjectMethod parseMeta ($metaObject,$prefs)

Traverses through all PREFERENCE attributes of the meta object, creating one setting named with $settingPrefPrefix . 'title' for each. It also creates an entry named with the field 'name', which is a cleaned-up, space-removed version of the title.

Settings are added to the $prefs passed.

Comments & Questions about this Distribution Document Topic