Wiki source code of DocumentLifecycle
Version 21.5 by Silvia Macovei on 2009/10/08
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
21.2 | 1 | (% class="floatinginfobox" %) |
| 2 | (((**Contents** | ||
| |
21.1 | 3 | |
| |
21.2 | 4 | {{toc start=2 depth=6 numbered=false scope=page /}}))) |
 |
1.1 | 5 | |
| |
21.1 | 6 | = Document Lifecycle = |
| |
17.1 | 7 | |
| |
16.1 | 8 | XWiki offers to perform several actions on a document (a.k.a a page). |
| 9 | |||
| |
21.1 | 10 | == Create == |
| |
1.39 | 11 | |
| 12 | There are two ways to create new pages: | ||
| |
21.3 | 13 | * You can 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 (symbolized by a question mark). |
| 14 | * 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 resolve the error. This will take you to a page with a message to create the missing page. **This is the recommended approach** as it'll allow you to create a navigation while you create new pages. | ||
| 15 | {{velocity filter="none"}} | ||
| |
1.39 | 16 | #set ($userGuideHomeDoc = $xwiki.getDocument("UserGuide.WebHome")) |
| |
21.3 | 17 | {{html}} |
| |
21.2 | 18 | |
| |
21.3 | 19 | You can watch a <a href="$userGuideHomeDoc.getAttachmentURL("linksedition_wysiwyg.swf")" target="_blank">screencast that shows how to create links in the WYSIWYG editor</a>. |
| 20 | {{/html}} | ||
| 21 | {{/velocity}} | ||
| |
1.39 | 22 | |
| |
21.1 | 23 | == Edit == |
| |
1.2 | 24 | |
| |
21.1 | 25 | This allows the edition of a page. See the [[page edition>>Features.PageEditing]] tutorial for more details. |
| |
1.2 | 26 | |
| |
21.1 | 27 | == Show == |
| |
1.3 | 28 | |
| |
1.38 | 29 | 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: |
| |
1.3 | 30 | |
| |
21.3 | 31 | {{toc start=3 depth=6 numbered=false scope=page /}} |
 |
1.35 | 32 | |
| |
21.1 | 33 | === Code === |
| |
1.3 | 34 | |
| |
21.3 | 35 | You can view the content of a page without having to edit it (and thus you don't have to be logged in, nor to have edit rights). You do this by moving the mouse over the Show button and selecting Code. This option is shown only for users in [[Advanced Mode>>Features.PageEditing#HAdvancedMode]], but you can access it in [[Simple Mode>>Features.PageEditing#HSimpleMode]] too by clicking directly on the Show button. For instance: |
| 36 | |image:code.jpg |image:coderesult.jpg | ||
| |
1.38 | 37 | |
| |
21.1 | 38 | === XML === |
| |
1.3 | 39 | |
| |
21.3 | 40 | 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 by XWiki for performing imports/exports of pages and whole wikis. |
| |
1.5 | 41 | |
| |
21.1 | 42 | === Comments === |
| |
1.33 | 43 | |
| |
1.38 | 44 | Any reader can leave comments on any page. This doesn't require edit rights. For instance: |
| |
21.5 | 45 | image:comments.PNG |
| |
1.33 | 46 | |
| |
21.1 | 47 | === Attachments === |
| |
1.5 | 48 | |
| |
21.1 | 49 | A page can contain attachments. See [[Attachments>>Features.Attachments]] for more details. |
| |
1.27 | 50 | |
| |
21.1 | 51 | === History === |
| |
1.27 | 52 | |
| |
21.1 | 53 | Displays the version history of the page. See [[Version Control>>Features.VersionControl]] for more details. |
| |
1.25 | 54 | |
| |
21.1 | 55 | === Attributes === |
| |
1.33 | 56 | |
| 57 | Displays a page's properties. | ||
| |
21.1 | 58 | {{warning}}The Attributes view is a work in progress{{/warning}} |
| |
1.33 | 59 | |
| |
21.1 | 60 | == Print == |
| |
1.25 | 61 | |
| |
20.1 | 62 | There are several possible printing options (what you see may vary depending on the Skin used): |
| 63 | * Print: Calls you're browser's Print feature to print the current page | ||
| 64 | * Print Preview: Generates a page which is formatted so that it can be easily printed using your browser's Print feature. | ||
| |
21.1 | 65 | * PDF, RTF, XAR, HTML exports: See the [[Export feature>>Features.Exports]] for more information. |
| |
21.3 | 66 | image:Features.Exports@export.png |
| |
1.38 | 67 | |
| |
21.1 | 68 | == Delete == |
| |
1.2 | 69 | |
| |
1.38 | 70 | Removes a page. A confirmation is asked before the removal is done. This option is non reversible so be very careful when you use it. |
| |
21.1 | 71 | image:delete.jpg |
| |
1.15 | 72 | |
| |
21.1 | 73 | == Copy == |
| |
1.33 | 74 | |
| |
21.1 | 75 | It is possible to create a copy of an existing page. To do so, you need to do a [[search>>code:Applications.SearchApplication]] 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. |
| |
21.3 | 76 | |
| |
1.38 | 77 | 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! |
| |
21.1 | 78 | image:XWikiCopy.png |
| |
1.33 | 79 | |
| |
21.1 | 80 | == Move/Rename == |
| |
1.33 | 81 | |
| |
21.3 | 82 | {{info}}The Rename feature is available only for versions 1.0 Beta 6 and following of XWiki{{/info}} |
| |
21.1 | 83 | 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. |
| |
21.3 | 84 | |
| |
19.2 | 85 | You can access the rename feature for a page by clicking on "Rename" in the top menu bar. For example with XWiki Enterprise 1.2, that option is in the "Action" menu: |
| |
21.1 | 86 | image:TopBarRename.png |
| |
19.3 | 87 | |
| |
1.38 | 88 | Once this is done, you will be prompted to input the new Space and Page name you want your document to take: |
| |
21.5 | 89 | image:RenameInput.PNG |
| |
19.3 | 90 | |
| |
1.38 | 91 | Now you can link to the page using its new name. |
| |
21.3 | 92 | |
| |
21.1 | 93 | As of XWiki 1.0 Beta 6 there are some known limitations: |
| |
1.38 | 94 | |
| |
19.4 | 95 | * 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) |
| |
21.1 | 96 | * 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. |
| |
19.4 | 97 | * 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): |
| |
1.31 | 98 | |
| |
21.1 | 99 | {{code}}$xwiki.refreshLinks(){{/code}} |
| 100 | |||
| 101 | |||
| |
21.3 | 102 |
