Wiki source code of DocumentLifecycle

Version 1.41 by Vincent Massol on 2007/10/19

Show last authors
1 1 Document Lifecycle
2
3 XWiki offers to perform several actions on a document (a.k.a a page):
4
5 *Contents*
6 #toc("" "2" "")
7
8 1.1 Create
9
10 There are two ways to create new pages:
11 * You can enter the new page name directly in the URL of your browser. For example http:\/\/locahost:8080/xwiki/bin/view/SpaceName/NoPage. If the space (<tt>SpaceName</tt> here) or page (<tt>NoPage</tt> here) don't exist then you'll get an empty page with a message saying that the page doesn't exist and there'll be a link to create it (symbolized by a question mark).
12 * You can edit an existing page and create a link to your new page (either in Wiki mode or in WYSIWYG mode). The resulting link will show up with a question mark next to it showing it as a nonexistent page. Simply click on the link to resolve the error, which will take you to a page with a message to create the missing page. *This is the recommended approach* as it'll allow you creating a navigation at the same time as you create new pages.
13
14 #set ($userGuideHomeDoc = $xwiki.getDocument("UserGuide.WebHome"))
15 You can watch a <a href="$userGuideHomeDoc.getAttachmentURL("linksedition_wysiwyg.swf")" target="_blank">screencast showing how to create links in the WYSIWYG editor</a>.
16
17 1.1 Edit
18
19 This allows the edition of a page. See the [page edition>UserGuide.PageEditing] tutorial for more details.
20
21 1.1 Show
22
23 Whenever you click on a link to a page XWiki automatically shows the page in view mode. This is the default mode. XWiki also supports displaying the page in other formats that may be more adapted to specific circumstances:
24
25 #toc("3" "" "")
26
27 1.1.1 Code
28
29 You can view the content of a page without having to edit it (and thus without having to be logged in nor to have edit rights). You do this by moving the mouse over the Show button and then by selecting Code. This option is shown only for users in [Advanced Mode>UserGuide.PageEditing#HAdvancedMode], but you can access it in [simple mode>UserGuide.PageEditing#HSimpleMode] too by clicking directly on the "show" button. For instance:
30
31 <table><tr>
32 <td>{image:code.jpg}</td>
33 <td>{image:coderesult.jpg}</td>
34 </tr></table>
35
36 1.1.1 XML
37
38 XWiki allows exposing a page in XML. This not ordinarily useful but it can be for example if you want to write a tool that automatically parse the content of a page. As the XML format is well-defined for all pages this is much easier than doing screen-scrapping for example. In addition this XML format is used by XWiki for performing imports/exports of pages and whole wikis.
39
40 1.1.1 Comments
41
42 Any reader can leave comments on any page. This doesn't require edit rights. For instance:
43
44 {image:comments.jpg}
45
46 1.1.1 Attachments
47
48 A page can contain attachments. See [Attachments>UserGuide.Attachments] for more details.
49
50 1.1.1 History
51
52 Displays the version history of the page. See [Version Control>UserGuide.VersionControl] for more details.
53 1.1.1 Attributes
54
55 Displays a page's properties.
56
57 #warning("The Attributes view is a work in progress")
58
59 1.1 Print
60
61 <table>
62 <tr>
63 <td>
64 There are 2 possible printing options:
65 * Print PDF: This exports the current page in PDF format so that it can then be easily printed or sent to someone.
66 * Print Preview: This generates a page which is formatted so that it can be easily printed using your browser's print feature.
67 </td>
68 <td>{image:print.jpg}</td>
69 </tr>
70 </table>
71
72
73 1.1 Delete
74
75 Removes a page. A confirmation is asked before the removal is done. This option is non reversible so be very careful when you use it.
76
77 {image:delete.jpg}
78
79 1.1 Copy
80
81 It is possible to create a copy of an existing page. To do so, you need to do a [search>UserGuide.Search] with Admin Rights using the title of the page you want to copy. You will then see a "copy" next to the page you want to copy.
82
83 After clicking on it you will be prompted to enter the location of the page you want to copy (that is, "where should the page be copied?"). Click on "copy" and you're done!
84
85 {image:XWikiCopy.png}
86
87 1.1 Rename
88
89 #info("The Rename feature is available only for version 1.0 Beta 6 and following of XWiki")
90
91 A rename feature is available in XWiki. Its effect is to change the page name (that is, you get http://\<server\>/xwiki/bin/View/NewSpace/NewPageName instead of http://\<server\>/xwiki/bin/View/OldSpace/OldPageName) and all the backlinks linking to it. This means that you can easily move a page from one space from another as well as keep them evolving with your wiki.
92
93 You can access the rename feature for a page by clicking on "Rename" (on the top bar in view mode):
94
95 {image:TopBarRename.png}
96
97 Once this is done, you will be prompted to input the new Space and Page name you want your document to take:
98
99 {image:RenameInput.png}
100
101 Now you can link to the page using its new name.
102
103 As of XWiki 1.0 Beta 6 there are some known limitations:
104 ** backlinks have to be turned on (they are turned on by default but if you have turned them off, rename will not rename backlinks and you'll have to turn them on again to benefit from this feature)
105 ** backlinks in objects attached to pages are not currently renamed
106 ** backlinks are saved when a page is saved thus it may happen with a clean XWiki database that backlinks are not saved. In this special case, you can call the following in a page to refresh all links (you'll need to be admin to do this):
107 {code}
108 $xwiki.refreshLinks()
109 {code}

Get Connected