Loading...
 

History: Wiki Handler

View page Collapse Into Edit Sessions

Preview of version: 23

Wiki Page Handler


Profile installer in Tikiwiki 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.

The wiki handler cannot overwrite existing pages in a wiki. This will cause a handler error.



YAML
preferences:
  enable: [ feature_wiki ]
objects:
  -
    type: wiki_page
    ref: wiki_sample_page
    data:
      name: SamplePage
      description: A sample page
      lang: en
      content: wikicontent:WikiHandlerSamplePage



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.



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, however . . .
  • Profile Can't Overwrite Page Content - currently if you try to install a profile which modifies content on a wiki page that already exists, it will produce a handler error.

List of Profiles with Wiki Handler


Help_Pages
Contact_Form
Profile_Repository_Profile
Example_Wiki_Profile

Comparing version 37 with version 38

Lines: 22-26Lines: 22-26
 content|yes|Initial 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. content|yes|Initial 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. 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. +translations| |List of page references to be attached as translations. Use this syntax: -+ ~np~[ $pageref1]~/np~ +-, or if several: -+ ~np~[ $pageref1, $pageref2]~/np~ +-
 message| |Specify the version message. Will default to modification made by profile installer. (>=4.0) 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) 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)
Lines: 69-74Lines: 69-74
 ((Help_Pages)) ((Help_Pages))
-((Contact_Form)) +((Custom_Contact_Form))
 ((Profile_Repository_Profile_3x)) ((Profile_Repository_Profile_3x))
 ((Example_Wiki_Profile)) ((Example_Wiki_Profile))

History

Advanced
Information Version
Thu 01 of Jan, 2009 23:49 GMT-0000 idealpragmatist 23
Thu 01 of Jan, 2009 23:48 GMT-0000 idealpragmatist 22
Thu 01 of Jan, 2009 23:45 GMT-0000 idealpragmatist 21
Thu 01 of Jan, 2009 23:15 GMT-0000 idealpragmatist 20
Thu 01 of Jan, 2009 21:40 GMT-0000 idealpragmatist 19
Thu 01 of Jan, 2009 21:38 GMT-0000 idealpragmatist 18
Thu 01 of Jan, 2009 21:28 GMT-0000 idealpragmatist 17
Thu 01 of Jan, 2009 20:32 GMT-0000 idealpragmatist 16
Thu 01 of Jan, 2009 20:19 GMT-0000 idealpragmatist 15
Thu 01 of Jan, 2009 20:19 GMT-0000 idealpragmatist 14
Thu 01 of Jan, 2009 20:18 GMT-0000 idealpragmatist 13
Thu 01 of Jan, 2009 20:00 GMT-0000 idealpragmatist 12
Wed 31 of Dec, 2008 21:32 GMT-0000 idealpragmatist 11
Wed 31 of Dec, 2008 21:08 GMT-0000 idealpragmatist 10
Wed 22 of Oct, 2008 06:47 GMT-0000 idealpragmatist 9
Wed 22 of Oct, 2008 06:34 GMT-0000 idealpragmatist 8
Wed 22 of Oct, 2008 06:28 GMT-0000 idealpragmatist 7
Sat 23 of Aug, 2008 15:34 GMT-0000 Marc Laporte 6
Sat 23 of Aug, 2008 15:24 GMT-0000 Marc Laporte for backlinks 5
Thu 26 of Jun, 2008 22:44 GMT-0000 System Administrator 4
Thu 26 of Jun, 2008 22:38 GMT-0000 System Administrator 3
Thu 26 of Jun, 2008 19:53 GMT-0000 System Administrator 2
  • 1
  • 2 (current)
  • »