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 action ==

20

21

You can create a new child page for the current page by using the plus icon located to the right of the page title.

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). Once you're done click the "Create" button and you will be able to edit your newly created page right away.

Prior to XWiki 7.2M3 the Add Page action was located in the top level menu.

30

31

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

32

33

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:

= Create from Template =

38

39

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.

40

41

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

42

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

43

)))

44

45

* This example shows that "Wanted Links" also offers the choice to create the new document from the available template:(((

)))

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

62

63

To see the code when using the Flamingo skin, you have to go to the More Actions menu, and click on 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.

On the Flamingo 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).

93

94

When using the Flamingo Skin, you will find the Print Preview by clicking on More Actions:

95

96

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

103

104

On the Flamingo skin:

= Delete =

Removes a page and puts it in the trash.

A confirmation is asked before the removal is done.

= Restore =

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

= 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 click on the "Page" menu.

128

129

After clicking "Copy" 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 Flamingo skin

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

139

140

The rename will perform 2 refactorings:

141

142

* update backlinks

143

* update parent information

144

145

146

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

147

148

149

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:

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

168

169

)))

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 action ==
		20
		21	You can create a new child page for the current page by using the plus icon located to the right of the page title.
		22
		23	{{image reference="AddPage.png"/}}
		24
		25	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). Once you're done click the "Create" button and you will be able to edit your newly created page right away.
		26
		27	{{image reference="CreatePage.png"/}}
		28
		29	Prior to XWiki 7.2M3 the Add Page action was located in the top level menu.
		30
		31	== By entering directly the URL of the new page ==
		32
		33	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:
		34
		35	{{image reference="CreateInURL.PNG"/}}
		36
		37	= Create from Template =
		38
		39	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.
		40
		41	* After you have [[created the template and the template provider>>extensions:Extension.Administration Application#HTemplatesCreationandAdministration]] you can start creating pages from this template:(((
		42	[[image:CreatePageFromTemplate.png\|\|style="border: 1px solid silver;"]]
		43	)))
		44
		45	* This example shows that "Wanted Links" also offers the choice to create the new document from the available template:(((
		46	{{image reference="1ipopup.png"/}}
		47	)))
		48
		49	= Edit =
		50
		51	This allows the editing of a page. See the [[page editing>>Features.PageEditing]] tutorial for more details.
		52
		53	= Show =
		54
		55	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:
		56
		57	{{toc start="2" depth="2" numbered="false" scope="local"/}}
		58
		59	== Code ==
		60
		61	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]].
		62
		63	To see the code when using the Flamingo skin, you have to go to the More Actions menu, and click on View Source.
		64
		65	{{image reference="ViewSourceFlamingo.png"/}}
		66
		67	{{image reference="WikiCodeResultFlamingo.png"/}}
		68
		69	== XML ==
		70
		71	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.
		72
		73	== Comments ==
		74
		75	Users with the comment right can leave comments on pages. This allows them to provide feedback without requiring edit rights.
		76
		77	{{image reference="AddComment.png"/}}
		78
		79	On the Flamingo skin
		80	{{image reference="CommentsFlamingo.png"/}}
		81
		82	== Attachments ==
		83
		84	A page can contain attachments. See [[Attachments>>Features.Attachments]] for more details.
		85
		86	== History ==
		87
		88	Displays the version history of the page. See [[Version Control>>Features.VersionControl]] for more details.
		89
		90	= Print =
		91
		92	There are several possible printing options (what you see may vary depending on the Skin used).
		93
		94	When using the Flamingo Skin, you will find the Print Preview by clicking on More Actions:
		95
		96	* Print Preview: Generates a page which is formatted so that it can be easily printed using your browser's Print feature.(((
		97	{{image reference="ViewSourceFlamingo.png"/}}
		98	)))
		99
		100	= Export =
		101
		102	There are several possible exporting formats that XWiki supports: PDF, RTF, XAR, HTML. See the [[Export feature>>Features.Exports]] for more information.
		103
		104	On the Flamingo skin:
		105	{{image reference="ExportFlamingo.png"/}}
		106
		107	{{image reference="ExportFlamingoPDF.png"/}}
		108
		109	= Delete =
		110
		111	Removes a page and puts it in the trash.
		112
		113	{{image reference="DeletePageFlamingo.png"/}}
		114
		115	A confirmation is asked before the removal is done.
		116
		117	{{image reference="DeleteConfirmFlamingo.png"/}}
		118
		119	{{image reference="DeleteFlamingoConfirm.png"/}}
		120
		121	= Restore =
		122
		123	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]].
		124
		125	= Copy =
		126
		127	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 click on the "Page" menu.
		128
		129	After clicking "Copy" 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!
		130
		131	On the Flamingo skin
		132	{{image reference="CopyPageFlamingo.png"/}}
		133
		134	{{image reference="CopyPageConfirmFlamingo.png"/}}
		135
		136	= Move/Rename =
		137
		138	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.
		139
		140	The rename will perform 2 refactorings:
		141
		142	* update backlinks
		143	* update parent information
		144
		145	{{warning}}
		146	Limitations: currently backlinks located in Objects and translated content won't be refactored.
		147	{{/warning}}
		148
		149	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:
		150
		151	{{image reference="RenameFlamingo.png"/}}
		152
		153	{{image reference="RenameConfirmFlamingo.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	)))