Wiki source code of Document Lifecycle

Version 166.1 by Marius Dumitru Florea on 2015/09/01

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 Starting with XWiki Enterprise 2.4 users and applications can provide documents that can be used as [[templates>>extensions:Extension.Administration Application#HTemplatesCreationandAdministration]] when creating new pages. The new document 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. If you don't want the new page to be a child of the current page then you can change the location of the target page using the document picker (by selecting an existing parent). You can also select a [[template>>extensions:Extension.Administration Application#HTemplatesCreationandAdministration]] for the new page. Once you're done click the "Create" button and you will be able to edit your newly created page right away.
32
33 {{image reference="CreatePage.png"/}}
34
35 Prior to XWiki 7.2M3 the Add Page action was located in the top level menu.
36
37 == By entering directly the URL of the new page ==
38
39 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:
40
41 {{image reference="CreateInURL.PNG"/}}
42
43 = Edit =
44
45 This allows the editing of a page. See the [[page editing>>Features.PageEditing]] tutorial for more details.
46
47 = Show =
48
49 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:
50
51 {{toc start="2" depth="2" numbered="false" scope="local"/}}
52
53 == Code ==
54
55 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]].
56
57 To see the code when using the Flamingo skin, you have to go to the More Actions menu, and click on View Source.
58
59 {{image reference="ViewSourceFlamingo.png"/}}
60
61 {{image reference="WikiCodeResultFlamingo.png"/}}
62
63 == XML ==
64
65 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.
66
67 == Comments ==
68
69 Users with the comment right can leave comments on pages. This allows them to provide feedback without requiring edit rights.
70
71 {{image reference="AddComment.png"/}}
72
73 On the Flamingo skin
74 {{image reference="CommentsFlamingo.png"/}}
75
76 == Attachments ==
77
78 A page can contain attachments. See [[Attachments>>Features.Attachments]] for more details.
79
80 == History ==
81
82 Displays the version history of the page. See [[Version Control>>Features.VersionControl]] for more details.
83
84 = Print =
85
86 There are several possible printing options (what you see may vary depending on the Skin used).
87
88 When using the Flamingo Skin, you will find the Print Preview by clicking on More Actions:
89
90 * Print Preview: Generates a page which is formatted so that it can be easily printed using your browser's Print feature.(((
91 {{image reference="ViewSourceFlamingo.png"/}}
92 )))
93
94 = Export =
95
96 There are several possible exporting formats that XWiki supports: PDF, RTF, XAR, HTML. See the [[Export feature>>Features.Exports]] for more information.
97
98 On the Flamingo skin:
99 {{image reference="ExportFlamingo.png"/}}
100
101 {{image reference="ExportFlamingoPDF.png"/}}
102
103 = Delete =
104
105 Removes a page and puts it in the trash.
106
107 {{image reference="DeletePageFlamingo.png"/}}
108
109 A confirmation is asked before the removal is done.
110
111 {{image reference="DeleteConfirmFlamingo.png"/}}
112
113 {{image reference="DeleteFlamingoConfirm.png"/}}
114
115 = Restore =
116
117 To restore a deleted document or remove it from the trash (you'll need to have Admin permissions), check the documentation for the [[Index Application>>extensions:Extension.Index Application]].
118
119 = Copy =
120
121 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).
122
123 {{image reference="CopyPageFlamingo.png"/}}
124
125 This will take you to the Copy Page Wizard where you can specify the title of the copy and its new location.
126
127 {{image reference="CopyPageConfirmFlamingo.png"/}}
128
129 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).
130
131 = Move/Rename =
132
133 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.
134
135 The rename will perform 2 refactorings:
136
137 * update backlinks
138 * update parent information
139
140 {{warning}}
141 Limitations: currently backlinks located in Objects and translated content won't be refactored.
142 {{/warning}}
143
144 When using the Flamingo skin, you can access the rename feature for a page by clicking on "Rename" under the "Page" menu in the top menu bar:
145
146 {{image reference="RenameFlamingo.png"/}}
147
148 {{image reference="RenameConfirmFlamingo.png"/}}
149
150 After clicking "Rename" you will be prompted to input the "New Space" and "New Page" names you want your document to have.
151
152 Now you can link to the page using its new name.
153
154 == Limitations ==
155
156 There are still some limitations on renaming:
157
158 * 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)
159 * 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.
160 * 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):(((
161 {{code language="none"}}
162 $xwiki.refreshLinks()
163 {{/code}}
164 )))

Get Connected