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 non-existent page. Simply click on the link to create the page as a child of the current page.
14
15 {{image reference="CreateInWYSIWYG.PNG"/}}
16
17 This will take you directly to the edit mode for the missing page. **This is the recommended approach** as it'll allow you to create a hierarchy while you create new pages.
18
19 Users and applications can provide pages that can be used as [[templates>>extensions:Extension.Administration Application#HTemplates]] when creating new pages. The new page content (content, objects and other meta data) will be replicated from the template. When clicking on a "wanted link", if there are available templates, you will be asked to select one:
20
21 {{image reference="templateSelectorForWantedLink.png"/}}
22
23 Then you will be taken to the Inline Form edit mode corresponding to the selected page template.
24
25 == By using the Add Page action ==
26
27 You can create a new child page for the current page by using the plus icon located to the right of the page title.
28
29 {{image reference="AddPage.png"/}}
30
31 This will open the Create Page wizard where you can specify the title of the new page.
32
33 By default, the new page will be created as a child of the current page. If you don't want that, then you can change the location of the target page using the page picker (by selecting an existing parent).
34
35 Note: When creating a new page from the wiki's homepage (i.e. clicking the plus icon from the wiki's homepage), there is an exception to the above behavior. In this case, the default is to create a top level page instead of a child of the current page (homepage). If your intention was really to create a child of the homepage (which is not usually the case for homepages), then you can use the page picker and select the homepage as parent of the new page.
36
37 You can also select a [[template>>extensions:Extension.Administration Application#HTemplatesCreationandAdministration]] for the new page.
38
39 Once you're done click the "Create" button and you will be able to edit your newly created page right away.
40
41 This is what you'll see if you're a [[simple user>>platform:Features.PageEditing#HSimpleandAdvancededitingmodes]]:
42 {{image reference="CreatePageSimple.png"/}}
43
44 And if you're an [[advanced user>>platform:Features.PageEditing#HSimpleandAdvancededitingmodes]] you'll be able to control whether the page created will be a Terminal page (i.e. a page that cannot have children, see also [[Terminology>>platform:Features.ContentOrganization.WebHome#HTerminology]]) or not:
45
46 {{image reference="CreatePageAdvanced.png"/}}
47
48 == By entering directly the URL of the new page ==
49
50 You can also **enter the new page name (and its path) directly in the URL of your browser**. For example ##http:~/~/localhost:8080/xwiki/bin/view/Movies/Thriller/Rear Window##. If the target page doesn'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:
51
52 {{image reference="CreateInURL.PNG"/}}
53
54 == Limitations ==
55
56 Starting with {{code}}XWiki 11.4RC1{{/code}} you might see a warning such as the following when creating a document:
57
58 {{image reference="page-fullname-toolong.png"/}}
59
60 This means that the complete path of the document (the name of the document and the names of its ancestors) is too long, and you have either to rename the document, or to try creating it at antoher place.
61
62 = Edit =
63
64 This allows the editing of a page. See the [[page editing>>platform:Features.PageEditing]] tutorial for more details.
65
66 = Delete =
67
68 Removes a page and puts it in the trash.
69
70 {{image reference="DeletePageFlamingo.png"/}}
71
72 A confirmation is asked before the removal is done. Here, you can decide either or not to delete the children along with the current page.
73
74 {{image reference="DeleteConfirmFlamingo.png"/}}
75
76 {{version since="12.8RC1"}}
77
78 Advanced user can be allowed to choose whether they want to delete the page permanently, or send it to the recycle bin.
79
80 In this case, the following options are presented on the page delete screen.
81
82 [[image:skip_recycle_bin_screen_cropped.png||queryString="height=300" alt="skip_recycle_bin_screen.png"]]
83 {{/version}}
84
85 Note: When deleting a non-terminal page and the only child of that page is the 'WebPreferences' terminal page, the 'Affect children' checkbox will be checked by default. Normally, it would be unchecked, but in this case we`ve noticed that it`s very easy to forget about that page (since it's hidden and automatically created when going into 'Page Administration') and your deleted page might still show up in some places because of that leftover. You can still uncheck it if you know what you are doing.
86
87 Then, you have to wait during the deletion of the page:
88
89 {{image reference="Deleting.png"/}}
90
91 And finally, you have the success message:
92
93 {{image reference="DeleteFlamingoConfirm.png"/}}
94
95 Note that if someone else is currently performing an action on the page you want to delete, you might see the following information box:
96
97 [[image:job-waiting-infobox.png]]
98
99 The deletion will automatically resume when the other job is finished or cancelled. You should't quit the page, since some questions can be asked during the deletion.
100
101 == Pages that belong to extensions ==
102
103 Before the success message, you might see the following screen:
104
105 {{gallery}}
106 image:DeleteExtensionPage.png
107 {{/gallery}}
108
109 It happens when you try to delete a page that belong to an extension. This page could be one of the children of the current page. If you continue the delete action, the extension will not work anymore.
110
111 Moreover, it is not recommended to delete pages that belong to extensions manually. You should use the [[Extension Manager>>extensions:Extension.Extension Manager Application]] instead.
112
113 This screen makes you able to select precisely which pages to remove and which ones to preserve. You can also abort the action by clicking on the "Cancel" button.
114
115 == Pages that contains an used XClass ==
116
117 Starting with {{info}}10.10RC1{{/info}}, you might also see one of the following screen:
118
119 {{gallery}}
120 image:delete_simpleuser_xclass.png
121 image:delete_advanceduser_xclass.png
122 {{/gallery}}
123
124 It happens when you try to delete a page that contains an XClass which is used somewhere. This page could be one of the children of the current page. If you continue the delete action, some other pages will not work anymore. That is why the action is completely forbidden for simple users. Advanced users are allowed to chose precisely the pages to remove and those to preserve. They can also abort the action by clicking on the "Cancel" button.
125
126 = Restore =
127
128 To restore a deleted page or remove it from the trash (you'll need to have Admin permissions), check the documentation for the [[Index Application>>extensions:Extension.Index Application]].
129
130 = Copy =
131
132 If you want to create a copy of an existing page then you have to navigate to that page (access that page in view mode) and then select the Copy entry from the page menu (that is located to the right of the page title).
133
134 {{image reference="CopyPageFlamingo.png"/}}
135
136 This will take you to the Copy Page Wizard where you can specify the title of the copy and its new location.
137
138 {{image reference="CopyPageConfirmFlamingo.png"/}}
139
140 If the page is translated in multiple languages then you can select which translation to copy, or you can copy all the translations. If the page has child pages then you can choose to copy them as well (this way you can replicate a hierarchy of pages).
141
142 {{image reference="copyStatus.png"/}}
143
144 Once you click the Copy button you are taken to the Copy Status page where you can see the options that you have selected and the progress of the copy operation. The copy is performed asynchronously. The progress bar is replaced with the operation status at the end in order to let you know if the operation succeeded or failed. You can use the breadcrumbs to navigate to the new page or the old one.
145
146 Starting with 11.1RC1, you might see the following box information instead of the progress bar if another job is currently performed against the pages you selected:
147
148 [[image:job-waiting-infobox.png]]
149
150 = Move/Rename =
151
152 If you want to rename or move an existing page then you have to navigate to that page (access that page in view mode) and then select the Rename entry from the page menu (that is located to the right of the page title).
153
154 {{image reference="RenameFlamingo.png"/}}
155
156 This will take you to the Rename Page Wizard where you can specify the new page title (if you want to rename) and/or the new page location (if you want to move the page to a different location).
157
158 This is what you'll see if you're a [[simple user>>platform:Features.PageEditing#HSimpleandAdvancededitingmodes]] (**Note**: you can only see the options to Move / Rename or Delete if you have the Delete Rights or if you are making the changes on a page you've created):
159 {{image reference="RenameConfirmFlamingoSimple.png"/}}
160
161 And if you're an [[advanced user>>platform:Features.PageEditing#HSimpleandAdvancededitingmodes]] you'll be able to also control:
162
163 * whether to update the back-links to the renamed page
164 * whether the new page will be a Terminal page (i.e. a page that cannot have children, see also [[Terminology>>platform:Features.ContentOrganization.WebHome#HTerminology]]) or not
165
166 {{image reference="RenameConfirmFlamingoAdvanced.png"/}}
167
168 If the page has child pages then you can choose to move them to the new location as well. This way the hierarchy under the renamed page is going to be preserved. Otherwise, if you choose to preserve the current path of the child pages (keep the children in place) then they will become "orphans": they will still be accessible with the same URLs (bookmarks are not broken) but they will have a missing parent (which you can fix by creating the parent page later).
169
170 By default (unless advanced users uncheck the box), all internal references in the wiki to the renamed page (and child pages) will be updated to point to the new location of the page (this includes links in content, values of wiki macro parameters, etc.), with the exception of the [[limitations detailed below>>#HLimitations-1]]. The pages or objects containing these references will be updated to point to the new reference and these modifications will be visible in the history of the impacted page with a comment of type "Renamed back-links.".
171
172 In case there are external links (e.g. bookmarks) to the renamed page (or its child pages) they will be broken after the rename unless you choose to create an automatic redirect from the old location to the new one. Note: if a link was made to another wiki page as an external link (by copy-pasting the address bar in the browser) instead of using the wiki syntax to point to the page reference or the Wysiwyg Link menu, this reference is considered an external one and thus not updated automatically.
173
174 Once you click the Rename button you are taken to the Rename Status page where you can see the options that you have selected and the progress of the rename operation. The rename, like the copy, is performed asynchronously. The progress bar is replaced with the operation status at the end in order to let you know if the operation succeeded or failed. You can use the breadcrumbs to navigate to the new page or the old one.
175
176 {{image reference="renameProgress.png"/}}
177
178 Starting with 11.1RC1, you might see the following box information instead of the progress bar if another job is currently performed against the pages you selected:
179
180 [[image:job-waiting-infobox.png]]
181
182 == Pages that belong to extensions ==
183
184 Before the success message, you might see the following screen:
185
186 {{gallery}}
187 image:renameextension.png
188 {{/gallery}}
189
190 It happens when you try to rename a page that belong to an extension. This page could be one of the children of the current page. If you continue the rename action, the extension might not work anymore.
191
192 This screen makes you able to select precisely which pages to rename and which ones to preserve. You can also abort the action by clicking on the "Cancel" button.
193
194 == Pages that contains an used XClass ==
195
196 Starting with {{info}}10.10RC1{{/info}}, you might also see one of the following screen:
197
198 {{gallery}}
199 image:rename_simpleuser_xclass.png
200 image:rename_advanceduser_xclass.png
201 {{/gallery}}
202
203 It happens when you try to rename or move a page that contains an XClass which is used somewhere. This page could be one of the children of the current page. If you continue the renaming/moving action, some other pages will not work anymore. That is why the action is completely forbidden for simple users. Advanced users are allowed to chose precisely the pages to move and those to preserve. They can also abort the action by clicking on the "Cancel" button.
204
205 == Limitations ==
206
207 There are still some limitations on renaming a page, related to the update of the references pointing to that page to point to the new location of the page:
208
209 * 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)
210 * [[Image references are not properly updated after a rename>>https://jira.xwiki.org/browse/XWIKI-18634]]
211 * 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):(((
212 {{code language="none"}}
213 $xwiki.refreshLinks()
214 {{/code}}
215 )))
216 * backlinks from macros whose content is not of type wiki syntax are not renamed:
217 ** this includes all scripting macros: velocity, groovy, html (with wiki syntax activated), etc.
218 ** it can also impact macros that do accept wiki syntax as content but do not declare it as such (because they were built based on an older version of the API).
219 ** the macros whose content is of type wiki syntax content and for which renaming references will work are the ones that can be edited inline in the Wysiwyg editor (technically described [[here for java macros>>rendering:Main.ExtendingMacro#HSpecifythetypeofthemacrocontent]] and [[here for wiki macros>>xwiki:Documentation.DevGuide.Tutorials.WritingMacros.WikiMacroTutorial.WebHome#HDefinition]]).
220 * {{version before="13.4RC1"}}none of the backlinks located in macros are renamed - even those in wiki syntax macros.{{/version}}
221 * {{version before="11.2RC1"}}[[backlinks located in XObjects and translated content are not renamed>>https://jira.xwiki.org/browse/XWIKI-981]].{{/version}}
222
223 ----
224
225 Additional page information and operations are available from the wiki page menu, described below.
226
227 = Show =
228
229 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:
230
231 {{toc start="2" depth="2" numbered="false" scope="local"/}}
232
233 == Code ==
234
235 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>>platform:Features.PageEditing#HAdvancedMode]].
236
237 To see the code when using the Flamingo skin, you have to go to the More Actions menu, in Viewers menu sub-section, and click on Source.
238
239 {{image reference="ViewSourceFlamingo.png"/}}
240
241 {{image reference="WikiCodeResultFlamingo.png"/}}
242
243 == Comments ==
244
245 Users with the ##comment## right can leave comments on pages. This allows them to provide feedback without requiring edit rights.
246
247 The comments area is located in the first tab at the bottom of the page.
248 {{image reference="CreateCommentTab.png"/}}
249
250 {{version since="12.6.2,12.7"}}
251 The comment form is not displayed by default, a comment button allows you to display the comment form if needed.
252
253 {{gallery}}
254 image:no_comment.png
255 image:two_comments.png
256 image:comment.gif
257 {{/gallery}}
258 {{/version}}
259
260 You can also click the {{image reference="PageActionsMenuButton.png"/}} button and click on "Comments" in the "Viewers" section.
261 {{image reference="AddComment.png"/}}
262
263 On the Flamingo skin, this is the current look of the comments. To add a comment, simply enter the text then click on "Add comment".
264 {{image reference="CommentsFlamingo.png"/}}
265
266 Note: Guest users, if they have the ##comment## right, can also post comments, but they will be asked to fill in their name and possibly to fill out a CAPTCHA (if the feature is enabled) before being able to post a new comment.
267
268 To reply to a comment, click the "Reply" icon.
269 {{image reference="CommentsReplyButton.png"/}}
270
271 In addition to plain text you may also use [[XWiki syntax>>XWiki.XWikiSyntax]] in the content.
272 {{image reference="CommentsAddReply.png"/}}
273
274 To preview your comment click on the "Preview" button after you have entered the content.
275 {{image reference="CommentsAddReplyPreview.png"/}}
276
277 Should you want to go back and edit your comment further, click "Back". To discard the comment altogether click "Cancel". If you are ready to submit your comment click on "Add Comment".
278 {{image reference="CommentsAddReplyView.png"/}}
279
280 The author of the comment or an admin can delete a comment.
281 {{image reference="deleteModal.png"/}}
282
283 You may change the comment you made at a later time by clicking the "Edit" pen icon.
284 {{image reference="CommentsEdit.png"/}}
285
286 By pressing the permalink button, you can get a direct link to that comment which you can share with others.
287 {{image reference="permalinkModal.png"/}}
288
289 == Attachments ==
290
291 A page can contain attachments. See [[Attachments>>platform:Features.Attachments]] for more details.
292
293 == History ==
294
295 Displays the version history of the page. See [[Version Control>>platform:Features.VersionControl]] for more details.
296
297 == Information ==
298
299 Displays information about the current page:
300
301 * {{version since="12.3RC1"}}Page locale (language), if the current page is a translation.{{/version}}
302 * {{version since="12.3RC1"}}Original page locale (language).{{/version}}
303 * {{version since="12.3RC1"}}Existing and missing page translations, if multilingual is on.{{/version}}
304 * {{version since="12.3RC1"}}Page syntax.{{/version}}
305 ** {{version since="12.6.3,12.9RC1"}}When changing the syntax, XWiki will propose to convert the page content and meta data to the new syntax if it knows how to perform the conversion. This is not different from what happens in edit mode when [[changing the syntax>>Documentation.UserGuide.Features.PageEditing||anchor="HConvertingbetweenSyntaxes"]].{{/version}}
306 * {{version since="12.3RC1"}}Whether the page is hidden or not.{{/version}}
307 * Included pages
308 * Backlinks (the list of pages having links leading to the current page)
309 * {{version since="11.1RC1"}}Page reference. This can be used as the value of a macro parameter that expects a page reference (e.g. [[Include Macro's>>extensions:Extension.Include Macro]] ##reference## parameter) or when calling script APIs. The reference displayed by default is relative to the current wiki, but you can use the button on the left to get a global (absolute) reference. Use the button on the right to copy the page reference to the clipboard.{{/version}}
310
311 {{image reference="pageInformation.png"/}}
312
313 Some of the page information can be edited in-place, from view mode, provided you have the edit right.
314
315 == Children ==
316
317 You can show all children pages of the current page by selecting the "Viewers >> Children" menu option as shown on the following screenshot:
318
319 {{image reference="ShowChildren.png" width="650px"/}}
320
321 = Print =
322
323 There are several possible printing options (what you see may vary depending on the Skin used).
324
325 When using the Flamingo Skin, you will find the Print Preview by clicking on More Actions:
326
327 * Print Preview: Generates a page which is formatted so that it can be easily printed using your browser's Print feature.(((
328 {{image reference="PrintFlamingo.png"/}}
329 )))
330
331 = Export =
332
333 There are several possible exporting formats that XWiki supports: PDF, RTF, XAR, HTML. See the [[Export feature>>platform:Features.Exports]] for more information.
334
335 On the Flamingo skin:
336
337 {{gallery}}
338 image:Documentation.UserGuide.Features.Exports@ExportFlamingo.png
339 image:Documentation.UserGuide.Features.Exports@ExportFlamingoPDF.png
340 image:Documentation.UserGuide.Features.Exports@ExportFlamingoXAR.png
341 {{/gallery}}

Get Connected