Startpage >> PmWiki >> EditVariables

Edit Variables

PmWiki.EditVariables History

Hide minor edits - Show changes to output

August 31, 2011, at 11:59 AM by Blahma -
Changed lines 1-77 from:
I was so confused about what to buy, but this makes it undertsadnable.
to:
(:Summary:variables used when editing pages:)
To set many of the variables below specify them in @@config.php@@.

:$EnableGUIButtons:When set to '1', turns on the graphical buttons in the "Edit Page" form.
-> # turn on graphical edit buttons
-> $EnableGUIButtons = 1;

:$EnablePostAuthorRequired:When set to '1', posting of pages requires the author to provide an author name. Otherwise, authors can post without a name.
-> # require authors to provide a name
-> $EnablePostAuthorRequired = 1;

:$EnableDrafts:When set to '1', enables the "Save draft" button and built-in handling of "draft" versions of pages, where:
## initial "Save draft" of an existing page ("PageName") saves changes to a new name ("PageName-Draft")
## subsequent attempts to edit PageName causes PageName-Draft to be edited
## subsequent selections of "Save draft" cause PageName-Draft to be saved
## pressing "Publish" causes PageName-Draft to be posted to PageName, and deleted.
-> # turn on draft edits
-> $EnableDrafts = 1;

->A related variable, $EnablePublishAttr, adds a new "publish" authorization level to distinguish editing of drafts from publishing them.

:$DraftSuffix:The suffix to use for draft versions of pages (default "-Draft").

:$DiffKeepDays:The $DiffKeepDays variable sets the minimum length of time that a page's revision history is kept. By default it is set to 3650 days, or a little less than ten years. You can change this value in a customization file to be something smaller, e.g.:
-> $DiffKeepDays = 30; # keep revisions at least 30 days
: :Note that a specific page revision isn't removed from the page until the first edit after the time specified by $DiffKeepDays has elapsed. Thus, it's still possible for some pages to have revisions older than $DiffKeepDays -- such revisions will be removed the next time those pages are edited.

:$DiffKeepNum:This variable contains the minimum number of changes to be kept in the page history, even if some of them are older than the limit defined by $DiffKeepDays. It prevents lost history of pages that are older, but have few changes.
-> $DiffKeepNum = 50; # keep at least 50 revisions (default is 20)

:$DeleteKeyPattern:The pattern used to determine if a page should be deleted. The default is to remove pages that contain only the single word "delete" (and optional spaces).
-> # change delete word to "remove"
-> $DeleteKeyPattern = "^\\s*remove\\s*$";
-> # delete any page with no visible text, i.e., empty
-> $DeleteKeyPattern = "^\\s*$";

:$EditTemplatesFmt:Name of the page (or an array of names) to be used as the default text for any newly created pages.
-> [@# Use 'Main.NewPageTemplate' as default text of all new pages
$EditTemplatesFmt = 'Main.NewPageTemplate';
# Use 'Template' in the current group for new pages
$EditTemplatesFmt = '$Group.Template';
# Use 'Template' in the current group if it exists, otherwise
# use 'Main.NewPageTemplate'
$EditTemplatesFmt = array('$Group.Template', 'Main.NewPageTemplate');@]
-> See [[Cookbook:EditTemplates]] for more information.

:$AutoCreate:Used in conjunction with the AutoCreateTargets edit function, this array records any sets of pages which should be created automatically if they don't exist. The syntax is
-> [@$AutoCreate[REGEXP] = PAGE_PARAMETERS;@]
-> where @@REGEXP@@ is a regular expression which will identify the pages to be autocreated, and @@PAGE_PARAMETERS@@ is an array of attributes for the page to be created. For example,
-> [@$AutoCreate['/^Category\\./'] = array('ctime' => $Now);@]
-> will create a blank page with a current creation time for any missing Category page.

:$DefaultPageTextFmt:The text that should be displayed when browsing non-existent pages. As default PmWiki uses the contents of Site.PageNotFound
-> [@$DefaultPageTextFmt = '(:include $[{$SiteGroup}.PageNotFound]:)';@]

:$EditFunctions: This array contains the sequence of functions that are called when a page is edited. It can be customized to provide additional functions to be called as part of the editing process. The standard setting is:
-> [@$EditFunctions = array('EditTemplate', 'RestorePage', 'ReplaceOnSave',
'SaveAttributes', 'PostPage', 'PostRecentChanges', 'AutoCreateTargets', 'PreviewPage'); @]

:$ROEPatterns: With this array you can add a pattern as ''key'' and set a text ''value'' which replace it on every edit request, using preg_replace function. Specifically it is replaced when the page is loaded into the editform, whenever a preview is done, and when the page is saved (from PmWiki 2.2.0beta45). See Cookbook:ROEPatterns for examples.

:$ROSPatterns: With this array you can add patterns as ''key'' and set a text ''value'' which will replace it when the edited page is posted (as signaled by $EnablePost). It is not replaced when the page is loaded into the editform nor when a preview is done, but it is replaced only when the page is saved. See Cookbook:ROSPatterns for examples.

:$IsPagePosted: Set to a true value if the page is actually saved (e.g., this is used to tell the RecentChanges handlers if they need to update).

:$PageEditFmt: By default, this is the HTML to be displayed for an edit form.

:$PageEditForm: Specifies the edit form for ?action=edit. Defaults to '$SiteGroup.EditForm'.

:$HandleEditFmt: Like $HandleBrowseFmt, this specifies the entire output format for ?action=edit for a page.

:$EditRedirectFmt: The page to which an author is sent after pressing "Save" or "Cancel" from an edit form. Defaults to "$FullName", which sends the author to the page just edited, but can be changed to specify another page.
-> [@# redirect to Main.HomePage
$EditRedirectFmt = 'Main.HomePage';
# redirect to HomePage of current group
$EditRedirectFmt = '{$Group}.HomePage';
@]
August 26, 2011, at 07:50 PM by Espn - uStNxfmBqbz
Changed line 1 from:
Hey, you're the goto eprxet. Thanks for hanging out here.
to:
I was so confused about what to buy, but this makes it undertsadnable.
August 26, 2011, at 07:25 PM by Kamryn - DYDSxmtHTeB
Changed line 1 from:
Was totlaly stuck until I read this, now back up and running.
to:
Hey, you're the goto eprxet. Thanks for hanging out here.
August 26, 2011, at 06:59 PM by Rocky - HsulgvWNOt
Changed line 1 from:
A mliilon thanks for posting this information.
to:
Was totlaly stuck until I read this, now back up and running.
August 26, 2011, at 05:54 PM by Ally - XvotZfHdOPGUVvkdQ
Changed line 1 from:
Full of salient points. Don't stop beileivng or writing!
to:
A mliilon thanks for posting this information.
August 26, 2011, at 05:23 PM by Janae - eiVfgyBIGJS
Changed line 1 from:
E98TtX , [url=http://lfrfeheeiepp.com/]lfrfeheeiepp[/url], [link=http://kybfcakbypvl.com/]kybfcakbypvl[/link], http://fjalfifqluxr.com/
to:
Full of salient points. Don't stop beileivng or writing!
August 26, 2011, at 05:18 PM by fcuskra - nhgONJRBCD
Changed line 1 from:
Cheers pal. I do appreciate the witring.
to:
E98TtX , [url=http://lfrfeheeiepp.com/]lfrfeheeiepp[/url], [link=http://kybfcakbypvl.com/]kybfcakbypvl[/link], http://fjalfifqluxr.com/
August 26, 2011, at 05:12 PM by Madge - zwFpQMwA
Changed line 1 from:
I have been so beiwldreed in the past but now it all makes sense!
to:
Cheers pal. I do appreciate the witring.
August 26, 2011, at 09:41 AM by Nelle - zqgKxiSUZwF
Changed line 1 from:
Calling all cars, calilng all cars, we're ready to make a deal.
to:
I have been so beiwldreed in the past but now it all makes sense!
August 26, 2011, at 07:12 AM by Verle - mYalSBacOJlNhLJ
Changed line 1 from:
The forum is a brighter place thakns to your posts. Thanks!
to:
Calling all cars, calilng all cars, we're ready to make a deal.
August 26, 2011, at 05:35 AM by Sanne - xgbZrWZBjWbNWR
Changed line 1 from:
Yeah, that's the tikect, sir or ma'am
to:
The forum is a brighter place thakns to your posts. Thanks!
August 25, 2011, at 07:08 PM by Dina - SDUAxJFmpkAKbCHfWf
Changed line 1 from:
I have been so bewildreed in the past but now it all makes sense!
to:
Yeah, that's the tikect, sir or ma'am
August 25, 2011, at 05:56 PM by Bobbe - jubylLSU
Changed line 1 from:
tv5Cuz <a href="http://jzkuecmhyxim.com/">jzkuecmhyxim</a>
to:
I have been so bewildreed in the past but now it all makes sense!
August 25, 2011, at 03:36 PM by dcluyoppaha - txAwPKHc
Changed line 1 from:
I rellay wish there were more articles like this on the web.
to:
tv5Cuz <a href="http://jzkuecmhyxim.com/">jzkuecmhyxim</a>
August 25, 2011, at 01:57 PM by Blondie - RsCamPHPhRssTTpGKb
Changed line 1 from:
Oh yeah, falbuuos stuff there you!
to:
I rellay wish there were more articles like this on the web.
August 25, 2011, at 01:08 PM by Keesha - CaVPDtqVZeWPGfTnnaC
Changed line 1 from:
Glad I've finllay found something I agree with!
to:
Oh yeah, falbuuos stuff there you!
July 19, 2011, at 06:56 PM by Datherine - xHHPtBYuNuqziQag
Changed line 1 from:
Good point. I hadn't thhougt about it quite that way. :)
to:
Glad I've finllay found something I agree with!
July 19, 2011, at 06:12 PM by Kelenna - pAtWuytgbcNyWESaS
Changed line 1 from:
I'm shocked that I found this info so esilay.
to:
Good point. I hadn't thhougt about it quite that way. :)
July 19, 2011, at 06:01 PM by Robinson - ApNFEhjol
Changed line 1 from:
So excited I found this aritlce as it made things much quicker!
to:
I'm shocked that I found this info so esilay.
July 18, 2011, at 09:18 AM by Mellie - wrsDGrxWlsVYq
Changed line 1 from:
Hey, that post leaves me feeling foloish. Kudos to you!
to:
So excited I found this aritlce as it made things much quicker!
July 18, 2011, at 08:29 AM by Bobs - ITFCyutjpelvyu
Changed line 1 from:
Heck yeah this is exlcaty what I needed.
to:
Hey, that post leaves me feeling foloish. Kudos to you!
July 18, 2011, at 03:02 AM by Wanita - EKAUDDfdqZvIUBSmz
Changed line 1 from:
Now I know who the brainy one is, I’ll keep lokinog for your posts.
to:
Heck yeah this is exlcaty what I needed.
July 08, 2011, at 06:04 PM by Jaclyn - GhhzOTvAEIkTCAdw
Changed line 1 from:
w0DPTy , [url=http://bvprqqizpqne.com/]bvprqqizpqne[/url], [link=http://fesqibxqefbn.com/]fesqibxqefbn[/link], http://gukgsjkttxod.com/
to:
Now I know who the brainy one is, I’ll keep lokinog for your posts.
July 07, 2011, at 03:21 PM by wcdqaxiqnx - nENylRoAZiGJGNpmi
Changed line 1 from:
1p1QmL <a href="http://kyiojulmnvfi.com/">kyiojulmnvfi</a>
to:
w0DPTy , [url=http://bvprqqizpqne.com/]bvprqqizpqne[/url], [link=http://fesqibxqefbn.com/]fesqibxqefbn[/link], http://gukgsjkttxod.com/
July 07, 2011, at 09:39 AM by tuowbbf - mQzhFhEhmnQiuEDo
Changed line 1 from:
I can't believe I've been going for years withuot knowing that.
to:
1p1QmL <a href="http://kyiojulmnvfi.com/">kyiojulmnvfi</a>
July 06, 2011, at 05:51 PM by Chacidy - DOhWWDClU
Changed lines 1-77 from:
(:Summary:variables used when editing pages:)
To set many of the variables below specify them in @@config.php@@.

:$EnableGUIButtons:When set to '1', turns on the graphical buttons in the "Edit Page" form.
-> # turn on graphical edit buttons
-> $EnableGUIButtons = 1;

:$EnablePostAuthorRequired:When set to '1', posting of pages requires the author to provide an author name. Otherwise, authors can post without a name.
-> # require authors to provide a name
-> $EnablePostAuthorRequired = 1;

:$EnableDrafts:When set to '1', enables the "Save draft" button and built-in handling of "draft" versions of pages, where:
## initial "Save draft" of an existing page ("PageName") saves changes to a new name ("PageName-Draft")
## subsequent attempts to edit PageName causes PageName-Draft to be edited
## subsequent selections of "Save draft" cause PageName-Draft to be saved
## pressing "Publish" causes PageName-Draft to be posted to PageName, and deleted.
-> # turn on draft edits
-> $EnableDrafts = 1;

->A related variable, $EnablePublishAttr, adds a new "publish" authorization level to distinguish editing of drafts from publishing them.

:$DraftSuffix:The suffix to use for draft versions of pages (default "-Draft").

:$DiffKeepDays:The $DiffKeepDays variable sets the minimum length of time that a page's revision history is kept. By default it is set to 3650 days, or a little less than ten years. You can change this value in a customization file to be something smaller, e.g.:
-> $DiffKeepDays = 30; # keep revisions at least 30 days
: :Note that a specific page revision isn't removed from the page until the first edit after the time specified by $DiffKeepDays has elapsed. Thus, it's still possible for some pages to have revisions older than $DiffKeepDays -- such revisions will be removed the next time those pages are edited.

:$DiffKeepNum:This variable contains the minimum number of changes to be kept in the page history, even if some of them are older than the limit defined by $DiffKeepDays. It prevents lost history of pages that are older, but have few changes.
-> $DiffKeepNum = 50; # keep at least 50 revisions (default is 20)

:$DeleteKeyPattern:The pattern used to determine if a page should be deleted. The default is to remove pages that contain only the single word "delete" (and optional spaces).
-> # change delete word to "remove"
-> $DeleteKeyPattern = "^\\s*remove\\s*$";
-> # delete any page with no visible text, i.e., empty
-> $DeleteKeyPattern = "^\\s*$";

:$EditTemplatesFmt:Name of the page (or an array of names) to be used as the default text for any newly created pages.
-> [@# Use 'Main.NewPageTemplate' as default text of all new pages
$EditTemplatesFmt = 'Main.NewPageTemplate';
# Use 'Template' in the current group for new pages
$EditTemplatesFmt = '$Group.Template';
# Use 'Template' in the current group if it exists, otherwise
# use 'Main.NewPageTemplate'
$EditTemplatesFmt = array('$Group.Template', 'Main.NewPageTemplate');@]
-> See [[Cookbook:EditTemplates]] for more information.

:$AutoCreate:Used in conjunction with the AutoCreateTargets edit function, this array records any sets of pages which should be created automatically if they don't exist. The syntax is
-> [@$AutoCreate[REGEXP] = PAGE_PARAMETERS;@]
-> where @@REGEXP@@ is a regular expression which will identify the pages to be autocreated, and @@PAGE_PARAMETERS@@ is an array of attributes for the page to be created. For example,
-> [@$AutoCreate['/^Category\\./'] = array('ctime' => $Now);@]
-> will create a blank page with a current creation time for any missing Category page.

:$DefaultPageTextFmt:The text that should be displayed when browsing non-existent pages. As default PmWiki uses the contents of Site.PageNotFound
-> [@$DefaultPageTextFmt = '(:include $[{$SiteGroup}.PageNotFound]:)';@]

:$EditFunctions: This array contains the sequence of functions that are called when a page is edited. It can be customized to provide additional functions to be called as part of the editing process. The standard setting is:
-> [@$EditFunctions = array('EditTemplate', 'RestorePage', 'ReplaceOnSave',
'SaveAttributes', 'PostPage', 'PostRecentChanges', 'AutoCreateTargets', 'PreviewPage'); @]

:$ROEPatterns: With this array you can add a pattern as ''key'' and set a text ''value'' which replace it on every edit request, using preg_replace function. Specifically it is replaced when the page is loaded into the editform, whenever a preview is done, and when the page is saved (from PmWiki 2.2.0beta45). See Cookbook:ROEPatterns for examples.

:$ROSPatterns: With this array you can add patterns as ''key'' and set a text ''value'' which will replace it when the edited page is posted (as signaled by $EnablePost). It is not replaced when the page is loaded into the editform nor when a preview is done, but it is replaced only when the page is saved. See Cookbook:ROSPatterns for examples.

:$IsPagePosted: Set to a true value if the page is actually saved (e.g., this is used to tell the RecentChanges handlers if they need to update).

:$PageEditFmt: By default, this is the HTML to be displayed for an edit form.

:$PageEditForm: Specifies the edit form for ?action=edit. Defaults to '$SiteGroup.EditForm'.

:$HandleEditFmt: Like $HandleBrowseFmt, this specifies the entire output format for ?action=edit for a page.

:$EditRedirectFmt: The page to which an author is sent after pressing "Save" or "Cancel" from an edit form. Defaults to "$FullName", which sends the author to the page just edited, but can be changed to specify another page.
-> [@# redirect to Main.HomePage
$EditRedirectFmt = 'Main.HomePage';
# redirect to HomePage of current group
$EditRedirectFmt = '{$Group}.HomePage';
@]
to:
I can't believe I've been going for years withuot knowing that.
Lasta ŝanĝo August 31, 2011, at 11:59 AM