Wiki source code of Document Lifecycle

Version 107.1 by Raluca Moisa on 2010/12/16

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 XWiki offers to perform several actions on a document (a.k.a a page).
6
7 = Create =
8
9 There are three ways to create new pages.
10
11 == By adding a wanted link ==
12
13 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 create the page.
14
15 [[image:CreateInWYSIWYG.PNG||style="border: 1px solid black;"]]
16
17 This will take you to a page with a message to create the missing page (as presented above).**This is the recommended approach** as it'll allow you to create a navigation while you create new pages.
18
19 == By using the Add page menu action ==
20
21 Starting with the [[Colibri skin>>extensions:Extension.Colibri Skin]] you can create a new page straight from the menu at the top of the page.
22
23 Starting with XWiki Enterprise 2.6 there's an Add menu:
24
25 [[image:AddPage.png]]
26
27 Choose the page name and the space you want to create it into and click the "**Create**" button:
28
29 [[image:CreatePage.png||height="202" width="650"]]
30
31 For versions prior to XWiki Enterprise 2.6, there was no Add menu but instead the Add action was in the menu for the space:
32
33 [[image:CreateMenu.PNG||style="border: 1px solid black;"]]
34 If you hover over the "Main" menu and click on "Create Page" the following will appear:
35
36 [[image:CreateInMenu.PNG||style="border: 1px solid black;"]]
37 Make sure you type the Space name in the first field, then add the Page name in the second field. Click the "Create" button and you will be able to edit your newly created page right away.
38
39 == By entering directly the URL of the new page ==
40
41 You can also **enter the new page name directly in the URL of your browser**. For example http://locahost:8080/xwiki/bin/view/SpaceName/PageName. If the space (##SpaceName## here) or page (##PageName## 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:
42
43 [[image:CreateInURL.PNG||style="border: 1px solid black;"]]
44
45 = Create from Template =
46
47 Starting with XWiki Enterprise 2.4 users and applications can provide documents that can be used as template when creating new pages. The new document content (content, objects and other metadata) will be replicated from the template.
48
49 * After you have [[created the template and the template provider>>extensions:Extension.Administration Application]] you can go then start creating pages from this template:(((
50 [[image:CreatePageFromTemplate.png||height="293" width="650"]]
51 )))
52
53 * This example shows that "Wanted Links" also offers the choice to create the new document from the available template ("My Template" template in the image below):(((
54 [[image:1ipopup.jpg||height="211" style="border: 1px solid black;" width="650"]]
55
56 = Edit =
57
58 This allows the editing of a page. See the [[page editing>>Features.PageEditing]] tutorial for more details.
59
60 = Show =
61
62 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:
63
64 {{toc start="2" depth="2" numbered="false" scope="local"/}}
65
66 == Code ==
67
68 You can view the content of a page without having to edit it (and thus you don't need edit rights). This option is shown only for users in [[Advanced Mode>>Features.PageEditing#HAdvancedMode]].
69
70 To see the code when using the Colibri skin, you have to go to the More Actions menu, and click on the View Source.
71
72 [[image:ViewSourceColibri.png||height="184" width="650"]]
73 [[image:WikiCodeResultColibri.png||style="border: 1px solid black;"]]
74
75 When using the Toucan skin, you do this by moving the mouse over the View Source button under View menu.
76
77 [[image:WikiCode.PNG||style="border: 1px solid black;"]]
78 [[image:WikiCodeResult.PNG||style="border: 1px solid black;"]]
79
80 == XML ==
81
82 XWiki allows exposing a page in XML. This is not ordinarily useful, but it can prove useful for example if you want to write a tool that automatically parses 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 internally by XWiki for performing imports/exports of pages and whole wikis.
83
84 == Comments ==
85
86 Users with the comment right can leave comments on pages. This allows them to provide feedback without requiring edit rights.
87
88 Starting with XWiki 2.6 you can add a comment using the add menu:
89
90 [[image:AddComment.png||height="196" width="650"]]
91
92 On Colibri skin
93 [[image:CommentsColibri.PNG||style="border: 1px solid black;"]]
94
95 On Toucan skin
96 [[image:CommentsToucan.PNG||style="border: 1px solid black;"]]
97
98 == Attachments ==
99
100 A page can contain attachments. See [[Attachments>>Features.Attachments]] for more details.
101
102 == History ==
103
104 Displays the version history of the page. See [[Version Control>>Features.VersionControl]] for more details.
105
106 = Print =
107
108 There are several possible printing options (what you see may vary depending on the Skin used).
109
110 When using the Colibri Skin, you will find the Print Preview button on the top menu by hovering over More Actions:
111
112 * Print Preview: Generates a page which is formatted so that it can be easily printed using your browser's Print feature.(((
113 [[image:NewColibriPrintPreview.png||height="150" width="650"]]
114 )))
115
116 Under the Toucan skin the following options are found in the Print menu at the top:
117
118 * Print: Calls you're browser's Print feature to print the current page
119 * Print Preview: Generates a page which is formatted so that it can be easily printed using your browser's Print feature.(((
120 [[image:PrintToucan.PNG||style="border: 1px solid black;"]]
121 )))
122
123 = Export =
124
125 There are several possible exporting formats that XWiki supports : PDF, RTF, XAR, HTML exports: See the [[Export feature>>Features.Exports]] for more information.
126
127 On Colibri skin:
128 [[image:NewColibriExport.png||height="153" width="650"]]
129
130 On Toucan skin:
131 [[image:PrintToucan.PNG||style="border: 1px solid black;"]]
132
133 = Delete =
134
135 Removes a page. A confirmation is asked before the removal is done.
136 To restore a deleted document, go to Quick Links panel on the right side and click Document Index. Click on the Deleted Documents tab then click restore to the corresponding document you want to restore.
137
138 On Colibri skin:
139 [[image:NewDeleteColibri.png||height="170" width="650"]]
140 [[image:DeleteConfirmColibri.png||style="border: 1px solid black;" width="648"]]
141 [[image:NewDeleteColibriConfirm.png||height="256" width="650"]]
142
143
144
145 On Toucan skin:
146 [[image:DeleteToucan.PNG||style="border: 1px solid black;"]]
147 [[image:DeleteConfirmToucan.png||style="border: 1px solid black;"]]
148 [[image:RestoreDocumentToucan.png||style="border: 1px solid black;"]]
149
150 = Copy =
151
152 {{warning}}
153 This feature currently requires for an user to have Programming Rights in order to function. See [[XSCOLIBRI-209>>http://jira.xwiki.org/jira/browse/XSCOLIBRI-209]] and [[XWiki-508>>http://jira.xwiki.org/jira/browse/XWIKI-5081]]
154 {{/warning}}
155
156 It is possible to create a copy of an existing page. To do so, you need to do a [[search>>extensions:Extension.Search Application]] 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.
157
158 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!
159
160 On Colibri skin
161 [[image:NewCopyPageColibri.png||height="198" width="650"]]
162
163 Choose the language and the target page then click the "**Copy**" button:
164
165 [[image:NewCopyPageConfirmColibri.png||height="218" width="650"]]
166
167 On Toucan skin
168 [[image:NewCopyPageToucan.png||height="162" width="650"]]
169
170 = Move/Rename =
171
172 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 to another, as well as keep them evolving with your wiki.
173
174 The rename will perform 2 refactorings:
175
176 * update backlinks
177 * update parent information
178
179 {{warning}}
180 Limitations: currently backlinks located in Objects and translated content won't be refactored.
181 {{/warning}}
182
183 In colibri, you can access the rename feature for a page by clicking on Rename under the More Actions in the top menu bar:
184
185 [[image:NewRenameColibri.png||height="180" width="650"]]
186 [[image:NewRenameConfirmColibri.png||height="275" width="650"]]
187
188
189 When using the Toucan skin, the Rename function can be found under the Action menu in the top menu bar:
190
191 [[image:TopBarRenameToucan.PNG||style="border: 1px solid black;"]]
192 [[image:RenameInputToucan.PNG||style="border: 1px solid black;"]]
193
194 Once this is done, you will be prompted to input the new Space and Page name you want your document to take:
195
196 Now you can link to the page using its new name.
197
198 == Limitations ==
199
200 There are still some limitations on renaming:
201
202 * 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)
203 * backlinks in objects attached to pages are not currently renamed. You can track issue [[XWIKI-981>>http://jira.xwiki.org/jira/browse/XWIKI-981]] to follow the progress.
204 * 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):(((
205 {{code language="none"}}
206 $xwiki.refreshLinks()
207 {{/code}}
208 )))
209
210 = Share Page by Mail =
211
212 [[image:share1.png||style="border: 1px solid rgb(0, 0, 0);"]]
213
214 [[image:share2.png||style="border: 1px solid rgb(0, 0, 0);"]]
215
216 [[image:share3.png||style="border: 1px solid rgb(0, 0, 0);"]]
217 )))

Get Connected