parent nodes: SignalPageNodes | SignalUserTags | WikidPadReferences | WpInsertions

Wp Attributes

Contents:
Wp Attributes
General
Syntax
User defined attributes
Global attribute properties
Autocompletion
Global attributes
Editor
Page linking
Page formatting
Page Signalling
Spell checking
Scripting
Plugins

Back

General

Wiki pages support "attributes" [1]. Attributes are used for two purposes: Top
[1] The page has partly been assembled using page inserts; it's complete contents can only be seen in preview.

Syntax

The general format for an attribute is: Multiple attributes for one page with the same key, but with different values can be combined into one multivalue attribute, separating the different values with semicolons; like: Attribute values can be enclosed in quotation characters to allow them to contain reserved characters, e.g. Attribute keys can be composed keys with a hierarchical structure; i.e they can exist of multiple words, separated by a period "."; like: Certain system attributes have global representations, that set default values for the entire wiki that they are in. Their key is then prefixed with "global."; like:

User defined attributes

Users can define their own attributes - key: value pairs - in order to create their own additional indexes for their pages in the views tree. For description and examples see: Page signalling: user tags.

Global attribute properties

Attributes support global properties, that influence the representation of pages in the page tree. To set the properties, a variant on the attribute specification is used, like: Would set the node in the main tree of every page that has the attribute: assigned, to use the icon "people", font style bold and font color "coral".
For more comprehensive description and examples see: Page signalling: user tags and todo tags.

Autocompletion

The editor supports autocompletion for attributes. Type part of the attribute, press Ctrl-Space and a list with existing attribute specifications will come up. Autocompletion for attributes works exactly like autocompletion for links; see there for details and examples. In fact, depending on how much of the attribute text is typed, a list of both attributes ánd links will come up [1].

Top
[1] Currently there is a bug in WikidPad, that prevents autocompletion for attributes with a period "." in the typed part of the key. This will be solved in an upcomming version op.

Global attributes

This section lists the system attributes, that have global representations. They set wiki wide defaults for those attributes.

Editor

[global.font: font name]
Sets the default editor font face for a wiki; default = none ???.

[global.wrap: wrap value]
Sets the default wrap value for a wiki; default = none but mostly a default of 70 is set in the WikiSettings page at creation of a wiki.

Top

Page linking

[global.camelCaseWordsEnabled: true / false]
Sets the default camelcase mode to true or false; default = true.
[global.auto_link: off / relax]
Sets the default recognition mode of non-camelcase wiki words in normal text; default = Off.

Top

Page formatting

[global.template: page name]
Sets a default template for every new page in wiki; can be overruled by a local template attribute; default = none.

[global.template_head: auto / manual]
Sets the default title generation for templated pages to auto of manual; default = auto.
[global.html.bgcolor: hex color number]

Sets the default background color for pages in preview and export; default = none.

[global.html.textcolor: hex color number]

Sets the default foreground (text) color for pages in preview and export; default = none.

[global.html.linkcolor: hex color number]

Sets the default link color for pages in preview and export; default = none.

[global.html.alinkcolor: hex color number]

Sets the default active link color for pages in preview and export; default = none.

[global.html.vlinkcolor: hex color number]

Sets the default visited link color for pages in preview and export; default = none.

[global.html.bgimage: image url]

Sets the default background image for pages in preview and export; default = none.

[global.paragraph_mode: true / false]

Sets the default paragraph mode to on or off; default = off.
[global.view_pane: off / editor / preview]
Sets the default for mode in whitch a page should be opened; default = Off.

Top

Page Signalling

[global.child_sort_order: sort type]
Sets the default child sort order for the page tree; default = ascending.

Top

Spell checking

[global.language: language code]
Sets the default language code for spell checking; default = none

Top

Scripting

[global.import_scripts: page name]
Sets a default page to be used as the script library for the whole wiki; can be overruled by the local "import_scripts" attribute. The scripts in the specified page will automatically be available on every page of the wiki.

Top

Plugins

[global.graph.relation.exclude: attribute keys to exclude]
Sets the default for attribute keys that should be excluded from relation graphs; default = None.
Example: [global.graph.relation.exclude: alias; template] excludes "alias" and "template" from the graph.

[global.graph.relation.include: attribute keys to include]
Sets the default for attribute keys that should be included in relation graphs; default = All.
If global.graph.relation.exclude is also set, then global.graph.relation.include is ignored.
Example: [global.graph.relation.include: intro; help] includes only "intro" and "help" in the graph.

Top
previous: Back
parents:  SignalPageNodes, SignalUserTags, WikidPadReferences, WpInsertions
attributes: [tree_position: 4]
[help.status: done]


inserts
GlobalAttributesEditor
GlobalAttributesWikiWords
GlobalAttributesBracketedLinks
GlobalAttributesTemplates
GlobalAttributesPageView
GlobalAttributesPageMisc
GlobalAttributesPageNodes
GlobalAttributesSpellChecking
GlobalAttributesScripting
GlobalAttributesStructureGraphs