r3 - 01 May 2006 - 16:04:58 - SamHaslerYou are here: TWiki >  Codev Web > TWikiRoot > LibDir > TWikiDir > UiDir > EditDotPm
Tags:
, create new tag

Module name TWiki::UI::Edit.pm EditDotPm
Location TWIKIROOT/lib/TWiki/UI/Edit.pm
Summary Implements functionality for edit
Primary Author Main.
CVS history SVN:lib/TWiki/UI/Edit.pm
CVS alpha SVNget:lib/TWiki/UI/Edit.pm
Contributing authors (see CVS History)
Is Class Yes
First Release CrawfordCurrie
File Hierarchy
  TWIKIROOT
  lib
  TWiki
  UI
  Edit.pm

Purpose

To implement functionality needed by the EditCgiScript

Used by

One of:

  • This script is part of the following CgiScriptWorkflow? : EditPreviewViewWorkflow
  • This cgi script is invoked by the user when the user edits pages

TWiki Modules used

This CGI script depends on the following TWiki modules for functionality:

External Modules used

This CGI script also depends on the following external modules

Note: Below documentation is extracted from the currently installed <module name here> Perl module by the PerlDocPlugin

package TWiki::UI::Edit

Edit command handler

StaticMethod edit( $session )

Edit command handler. This method is designed to be invoked via the TWiki::UI::run method. Most parameters are in the CGI query:

cmd Undocumented save command, passed on to save script
onlywikiname if defined, requires a wiki name for the topic name if this is a new topic
onlynewtopic if defined, and the topic exists, then moans
formtemplate name of the form for the topic; will replace existing form
templatetopic name of the topic to copy if creating a new topic
skin skin(s) to use
topicparent what to put in the topic prent meta data
text text that will replace the old topic text if a formtemplate is defined (what the heck is this for?)
contenttype optional parameter that defines the application type to write into the CGI header. Defaults to text/html.
action Optional. If supplied, use the edit${action} template instead of the standard edit template. An empty value means edit both form and text, "form" means edit form only, "text" means edit text only

Please see CodevDocumentationProject and CodevDocumentationProjectDev for comments on the format of these pages.

Implementation Notes

-- PeterThoeny - 03 Oct 2004

Edit | WYSIWYG | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r3 < r2 < r1 | More topic actions
 
Powered by TWiki
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback SourceForge.net Logo