Fullscreen
[Show/Hide Left Column]
[Show/Hide Right Column]

Wiki Handler

Wiki Page Handler


Profile installer in Tiki would not be very useful without wiki pages, thus, a handler was created. To create a wiki page, the page content must exist in the profile repository. The page name is provided in the profile to reference to it.

YAML
preferences:
  enable: [ feature_wiki ]
objects:
  -



Wiki Object Parameters


Field nameMandatoryValue
typeyesmust be "wiki_page"
ref can link to a category or structure. see Object References.
nameyesThe name of the page to be created. Can be different from local pagename.
description The page description.
lang Page language as the two letter code (ex: fr, en, es)
contentyesInitial page content. To simplify the profile, large pages can be included from a remote location in the same profile repository. This is done by using the wikicontent: prefix, as seen in the example.
mode create, update, append, create_or_append, create_or_update (default). Handler mode that determines behavior on existing page. create will prevent installation if page already exists. update and append require the page to exist prior to profile installation.
translations List of page names (or page references) to be attached as translations.
message Specify the version message. Will default to modification made by profile installer. (>=4.0)
wysiwyg y or n. If set to y, will create/update the page in wysiwyg editor mode. Otherwise created wiki page won't load in wysiwyg mode (>=6.0)
wiki_authors_style classic, business, collaborative, lastmodif, none (>=8.0)




Details

minimally, to import a wiki page the following YAML syntax will suffice.

objects:
  -
    type: wiki_page
    data:
      name: todo
      content: wikicontent:todo


  • mind your spaces here each level of indentation is two spaces. (recommended). type and data are at the third level, name and content in the fourth.
  • Re-import is ok (>=tikiwiki3.0) you can load a profile multiple times in the same wiki. It will ask if you want to Forget the install - this will not remove data imported. When you re-install a profile anything new will be added. In wiki pages, it's possible to replace & append (see above options)

Alternatively, wikidirect: can be used instead of wikicontent:. When used, the content of the target page will not be parsed for references, which is useful when setting up data channels.

As of Tiki 6 onwards, wikiparsed: can be used to to get the parsed (HTML) output from a page, instead of the wiki mark-up. Used with tracker filter plugins and pretty tracker templates this can make tracker data available to be used in data channels.

List of Profiles with Wiki Handler


Help_Pages
Contact_Form
Profile_Repository_Profile_3x
Example_Wiki_Profile


Contributors to this page: Nelson233 points  , Marc Laporte6087 points  , jonnybradley1323 points  , axold297 points  , System Administrator and idealpragmatist347 points  .
Page last modified on Wednesday 14 of September, 2011 04:40:11 UTC by Nelson233 points .