data/TWiki/TWikiUIManageDotPm.txt,v
changeset 0 414e01d06fd5
equal deleted inserted replaced
-1:000000000000 0:414e01d06fd5
       
     1 head	1.4;
       
     2 access;
       
     3 symbols;
       
     4 locks; strict;
       
     5 comment	@# @;
       
     6 
       
     7 
       
     8 1.4
       
     9 date	2008.01.22.03.21.31;	author TWikiContributor;	state Exp;
       
    10 branches;
       
    11 next	1.3;
       
    12 
       
    13 1.3
       
    14 date	2007.01.16.04.11.56;	author TWikiContributor;	state Exp;
       
    15 branches;
       
    16 next	1.2;
       
    17 
       
    18 1.2
       
    19 date	2006.04.01.05.55.43;	author TWikiContributor;	state Exp;
       
    20 branches;
       
    21 next	1.1;
       
    22 
       
    23 1.1
       
    24 date	2006.02.01.12.01.25;	author TWikiContributor;	state Exp;
       
    25 branches;
       
    26 next	;
       
    27 
       
    28 
       
    29 desc
       
    30 @new-topic
       
    31 @
       
    32 
       
    33 
       
    34 1.4
       
    35 log
       
    36 @buildrelease
       
    37 @
       
    38 text
       
    39 @---+ Package =TWiki::UI::Manage=
       
    40 
       
    41 UI functions for web, topic and user management
       
    42 
       
    43 
       
    44 %TOC%
       
    45 
       
    46 ---++ StaticMethod *manage* <tt>($session)</tt>
       
    47 
       
    48 =manage= command handler.
       
    49 This method is designed to be
       
    50 invoked via the =UI::run= method.
       
    51 
       
    52 
       
    53 
       
    54 ---++ StaticMethod *rename* <tt>($session)</tt>
       
    55 
       
    56 =rename= command handler.
       
    57 This method is designed to be
       
    58 invoked via the =UI::run= method.
       
    59 Rename the given topic. Details of the new topic name are passed in CGI
       
    60 parameters:
       
    61 
       
    62 | =skin= | skin(s) to use |
       
    63 | =newweb= | new web name |
       
    64 | =newtopic= | new topic name |
       
    65 | =breaklock= | |
       
    66 | =attachment= | |
       
    67 | =confirm= | if defined, requires a second level of confirmation |
       
    68 | =currentwebonly= | if defined, searches current web only for links to this topic |
       
    69 | =nonwikiword= | if defined, a non-wikiword is acceptable for the new topic name |
       
    70 
       
    71 
       
    72 
       
    73 ---++ StaticMethod *move* <tt>($session,$oldWeb,$oldTopic,$newWeb,$newTopic,$attachment,\@@refs)</tt>
       
    74 
       
    75 Move the given topic, or an attachment in the topic, correcting refs to the topic in the topic itself, and
       
    76 in the list of topics (specified as web.topic pairs) in the \@@refs array.
       
    77 
       
    78    * =$session= - reference to session object
       
    79    * =$oldWeb= - name of old web - must be untained
       
    80    * =$oldTopic= - name of old topic - must be untained
       
    81    * =$newWeb= - name of new web - must be untained
       
    82    * =$newTopic= - name of new topic - must be untained
       
    83    * =$attachment= - name of the attachment to move (from oldtopic to newtopic) (undef to move the topic) - must be untaineted
       
    84    * =\@@refs= - array of webg.topics that must have refs to this topic converted
       
    85 Will throw TWiki::OopsException or TWiki::AccessControlException on an error.
       
    86 
       
    87 
       
    88 
       
    89 ---++ StaticMethod *getReferringTopics* <tt>($session,$web,$topic,$allWebs) -> \%matches</tt>
       
    90 
       
    91    * =$session= - the session
       
    92    * =$web= - web to search for
       
    93    * =$topic= - topic to search for
       
    94    * =$allWebs= - 0 to search $web only. 1 to search all webs _except_ $web.
       
    95 Returns a hash that maps the web.topic name to a summary of the lines that matched. Will _not_ return $web.$topic in the list
       
    96 
       
    97 
       
    98 @
       
    99 
       
   100 
       
   101 1.3
       
   102 log
       
   103 @buildrelease
       
   104 @
       
   105 text
       
   106 @d12 1
       
   107 a12 1
       
   108 invoked via the =TWiki::UI::run= method.
       
   109 d20 1
       
   110 a20 1
       
   111 invoked via the =TWiki::UI::run= method.
       
   112 @
       
   113 
       
   114 
       
   115 1.2
       
   116 log
       
   117 @buildrelease
       
   118 @
       
   119 text
       
   120 @d9 1
       
   121 d17 1
       
   122 d52 1
       
   123 @
       
   124 
       
   125 
       
   126 1.1
       
   127 log
       
   128 @buildrelease
       
   129 @
       
   130 text
       
   131 @a32 2
       
   132 !!!rename!!!
       
   133 
       
   134 @