Document Lifecycle (XWiki.org)

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.

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:

Choose the page name and the space you want to create it into and click the "**Create**" button:

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.

32

33

== By entering directly the URL of the new page ==

34

35

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:

= Create from Template =

40

41

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.

42

43

* After you have [[created the template and the template provider>>extensions:Extension.Administration Application#HTemplatesCreationandAdministration]] you can start creating pages from this template:(((

44

[[image:CreatePageFromTemplate.png||style="border: 1px solid silver;"]]

45

)))

46

47

* 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):(((

)))

= Edit =

This allows the editing of a page. See the [[page editing>>Features.PageEditing]] tutorial for more details.

= Show =

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:

== Code ==

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]].

64

65

To see the code when using the Colibri skin, you have to go to the More Actions menu, and click on the View Source.

== XML ==

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.

== Comments ==

Users with the comment right can leave comments on pages. This allows them to provide feedback without requiring edit rights.

77

78

Starting with XWiki 2.6 you can add a comment using the add menu:

On Colibri skin

== Attachments ==

A page can contain attachments. See [[Attachments>>Features.Attachments]] for more details.

== History ==

Displays the version history of the page. See [[Version Control>>Features.VersionControl]] for more details.

= Print =

There are several possible printing options (what you see may vary depending on the Skin used).

96

97

When using the Colibri Skin, you will find the Print Preview button on the top menu by hovering over More Actions:

98

99

* Print Preview: Generates a page which is formatted so that it can be easily printed using your browser's Print feature.(((

)))

= Export =

There are several possible exporting formats that XWiki supports : PDF, RTF, XAR, HTML. See the [[Export feature>>Features.Exports]] for more information.

On Colibri skin:

= Delete =

Removes a page and puts it in the trash.

A confirmation is asked before the removal is done.

To restore a deleted document or remove it from the trash (you'll need to have Admin permissions), hover over "Wiki" and then click on "Document Index". Click on the "Deleted Documents" tab then click "Restore" to the corresponding document you want to restore or "Delete" to remove it from the trash completely.

= Copy =

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" button if you hover over the "Page" menu.

127

128

After clicking on it you will be prompted to enter the location of the page you want to copy in the "Target Space" and the "Target Page" fields. Click on "Copy" and you're done!

On the Colibri skin

Choose the target space and the target page and then click on "**Copy**":

= Move/Rename =

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.

140

141

The rename will perform 2 refactorings:

142

143

* update backlinks

144

* update parent information

145

146

147

Limitations: currently backlinks located in Objects and translated content won't be refactored.

148

149

150

When using the Colibri skin, you can access the rename feature for a page by clicking on "Rename" under the "Page" menu in the top menu bar:

After clicking "Rename" you will be prompted to input the "New Space" and "New Page" names you want your document to have.

156

157

Now you can link to the page using its new name.

== Limitations ==

There are still some limitations on renaming:

162

163

* 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)

164

* 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.

165

* 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):(((

166

167

$xwiki.refreshLinks()

)))

= Share Page by Email =

172

173

You can share a page by email in XWiki. In order to do this navigate to your document, hover over the "Page" menu and click on **"Share by email"**. Fill in the required fields and then click **"Send"**.

174

175

176

You need to have your email server configured properly for this feature to work. For more information check out the [[guide to configuring the SMTP server>>AdminGuide.Configuration#HConfiguringtheSMTPserver]].

Wiki source code of Document Lifecycle

Quick Links

Navigation

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected

author	version	line-number	content
		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 reference="CreateInWYSIWYG.PNG"/}}
		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 reference="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 reference="CreatePage.png"/}}
		30
		31	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.
		32
		33	== By entering directly the URL of the new page ==
		34
		35	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:
		36
		37	{{image reference="CreateInURL.PNG"/}}
		38
		39	= Create from Template =
		40
		41	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.
		42
		43	* After you have [[created the template and the template provider>>extensions:Extension.Administration Application#HTemplatesCreationandAdministration]] you can start creating pages from this template:(((
		44	[[image:CreatePageFromTemplate.png\|\|style="border: 1px solid silver;"]]
		45	)))
		46
		47	* 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):(((
		48	{{image reference="1ipopup.png"/}}
		49	)))
		50
		51	= Edit =
		52
		53	This allows the editing of a page. See the [[page editing>>Features.PageEditing]] tutorial for more details.
		54
		55	= Show =
		56
		57	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:
		58
		59	{{toc start="2" depth="2" numbered="false" scope="local"/}}
		60
		61	== Code ==
		62
		63	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]].
		64
		65	To see the code when using the Colibri skin, you have to go to the More Actions menu, and click on the View Source.
		66
		67	{{image reference="ViewSourceColibri.png"/}}
		68	{{image reference="WikiCodeResultColibri.png"/}}
		69
		70	== XML ==
		71
		72	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.
		73
		74	== Comments ==
		75
		76	Users with the comment right can leave comments on pages. This allows them to provide feedback without requiring edit rights.
		77
		78	Starting with XWiki 2.6 you can add a comment using the add menu:
		79
		80	{{image reference="AddComment.png"/}}
		81
		82	On Colibri skin
		83	{{image reference="CommentsColibri.PNG"/}}
		84
		85	== Attachments ==
		86
		87	A page can contain attachments. See [[Attachments>>Features.Attachments]] for more details.
		88
		89	== History ==
		90
		91	Displays the version history of the page. See [[Version Control>>Features.VersionControl]] for more details.
		92
		93	= Print =
		94
		95	There are several possible printing options (what you see may vary depending on the Skin used).
		96
		97	When using the Colibri Skin, you will find the Print Preview button on the top menu by hovering over More Actions:
		98
		99	* Print Preview: Generates a page which is formatted so that it can be easily printed using your browser's Print feature.(((
		100	{{image reference="NewColibriPrintPreview.png"/}}
		101	)))
		102
		103	= Export =
		104
		105	There are several possible exporting formats that XWiki supports : PDF, RTF, XAR, HTML. See the [[Export feature>>Features.Exports]] for more information.
		106
		107	On Colibri skin:
		108	{{image reference="NewColibriExport.png"/}}
		109
		110	= Delete =
		111
		112	Removes a page and puts it in the trash.
		113
		114	{{image reference="NewDeleteColibri.png"/}}
		115
		116	A confirmation is asked before the removal is done.
		117
		118	{{image reference="DeleteConfirmColibri.png"/}}
		119
		120	To restore a deleted document or remove it from the trash (you'll need to have Admin permissions), hover over "Wiki" and then click on "Document Index". Click on the "Deleted Documents" tab then click "Restore" to the corresponding document you want to restore or "Delete" to remove it from the trash completely.
		121
		122	{{image reference="NewDeleteColibriConfirm.png"/}}
		123
		124	= Copy =
		125
		126	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" button if you hover over the "Page" menu.
		127
		128	After clicking on it you will be prompted to enter the location of the page you want to copy in the "Target Space" and the "Target Page" fields. Click on "Copy" and you're done!
		129
		130	On the Colibri skin
		131	{{image reference="NewCopyPageColibri.png"/}}
		132
		133	Choose the target space and the target page and then click on "Copy":
		134
		135	{{image reference="NewCopyPageConfirmColibri.png"/}}
		136
		137	= Move/Rename =
		138
		139	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.
		140
		141	The rename will perform 2 refactorings:
		142
		143	* update backlinks
		144	* update parent information
		145
		146	{{warning}}
		147	Limitations: currently backlinks located in Objects and translated content won't be refactored.
		148	{{/warning}}
		149
		150	When using the Colibri skin, you can access the rename feature for a page by clicking on "Rename" under the "Page" menu in the top menu bar:
		151
		152	{{image reference="NewRenameColibri.png"/}}
		153	{{image reference="NewRenameConfirmColibri.png"/}}
		154
		155	After clicking "Rename" you will be prompted to input the "New Space" and "New Page" names you want your document to have.
		156
		157	Now you can link to the page using its new name.
		158
		159	== Limitations ==
		160
		161	There are still some limitations on renaming:
		162
		163	* 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)
		164	* 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.
		165	* 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):(((
		166	{{code language="none"}}
		167	$xwiki.refreshLinks()
		168	{{/code}}
		169	)))
		170
		171	= Share Page by Email =
		172
		173	You can share a page by email in XWiki. In order to do this navigate to your document, hover over the "Page" menu and click on "Share by email". Fill in the required fields and then click "Send".
		174
		175	{{warning}}
		176	You need to have your email server configured properly for this feature to work. For more information check out the [[guide to configuring the SMTP server>>AdminGuide.Configuration#HConfiguringtheSMTPserver]].
		177	{{/warning}}
		178
		179	{{image reference="share1.png"/}}
		180
		181	{{image reference="share2.png"/}}
		182
		183	{{image reference="share3.png"/}}