Wiki source code of Document Lifecycle
Version 80.2 by Raluca Moisa on 2010/12/15
Show last authors
| 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 four ways to create new pages: | ||
| 10 | |||
| 11 | * 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.((( | ||
| 12 | [[image:CreateInWYSIWYG.PNG||style="border: 1px solid black;"]] | ||
| 13 | |||
| 14 | 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. | ||
| 15 | ))) | ||
| 16 | * 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.((( | ||
| 17 | [[image:CreateMenu.PNG||style="border: 1px solid black;"]] | ||
| 18 | If you hover over the "Main" menu and click on "Create Page" the following will appear: | ||
| 19 | |||
| 20 | [[image:CreateInMenu.PNG||style="border: 1px solid black;"]] | ||
| 21 | 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. | ||
| 22 | ))) | ||
| 23 | * Starting with [[XWiki 2.6>>http://www.xwiki.org/xwiki/bin/view/Main/Download]] you can create a new page using the add menu:((( | ||
| 24 | [[image:AddPage.png||height="183" style="border: 1px solid black;" width="650"]] | ||
| 25 | )))Choose the page name and the space you want to create it into and click the "**Create**" button: | ||
| 26 | |||
| 27 | [[image:CreatePage.png||height="202" width="650"]] | ||
| 28 | |||
| 29 | * 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 :((( | ||
| 30 | [[image:CreateInURL.PNG||style="border: 1px solid black;"]] | ||
| 31 | ))) | ||
| 32 | |||
| 33 | Starting with XWiki Enterprise 2.4 M2 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. | ||
| 34 | |||
| 35 | * After you have [[created the template and the template provider>>extensions:Extension.Administration Application]] you can go then start creating pages from this template:((( | ||
| 36 | [[image:1gcreatedocument.jpg||style="border: 1px solid black;"]] | ||
| 37 | ))) | ||
| 38 | |||
| 39 | * 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):((( | ||
| 40 | [[image:1ipopup.jpg||style="border: 1px solid black;"]] | ||
| 41 | |||
| 42 | = Edit = | ||
| 43 | |||
| 44 | This allows the editing of a page. See the [[page editing>>Features.PageEditing]] tutorial for more details. | ||
| 45 | |||
| 46 | = Show = | ||
| 47 | |||
| 48 | 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: | ||
| 49 | |||
| 50 | {{toc start="2" depth="2" numbered="false" scope="page"/}} | ||
| 51 | |||
| 52 | == Code == | ||
| 53 | |||
| 54 | 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]]. | ||
| 55 | |||
| 56 | To see the code when using the Colibri skin, you have to go to the More Actions menu, and click on the View Source. | ||
| 57 | |||
| 58 | [[image:WikiCodeColibri.png||style="border: 1px solid black;"]] | ||
| 59 | [[image:WikiCodeResultColibri.png||style="border: 1px solid black;"]] | ||
| 60 | |||
| 61 | When using the Toucan skin, you do this by moving the mouse over the View Source button under View menu. | ||
| 62 | |||
| 63 | [[image:WikiCode.PNG||style="border: 1px solid black;"]] | ||
| 64 | [[image:WikiCodeResult.PNG||style="border: 1px solid black;"]] | ||
| 65 | |||
| 66 | == XML == | ||
| 67 | |||
| 68 | 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. | ||
| 69 | |||
| 70 | == Comments == | ||
| 71 | |||
| 72 | Users with the comment right can leave comments on pages. This allows them to provide feedback without requiring edit rights. | ||
| 73 | |||
| 74 | On Colibri skin | ||
| 75 | [[image:CommentsColibri.PNG||style="border: 1px solid black;"]] | ||
| 76 | |||
| 77 | On Toucan skin | ||
| 78 | [[image:CommentsToucan.PNG||style="border: 1px solid black;"]] | ||
| 79 | |||
| 80 | Starting with XWiki 2.6 you can add a comment using the add menu: | ||
| 81 | |||
| 82 | |||
| 83 | == Attachments == | ||
| 84 | |||
| 85 | A page can contain attachments. See [[Attachments>>Features.Attachments]] for more details. | ||
| 86 | |||
| 87 | == History == | ||
| 88 | |||
| 89 | Displays the version history of the page. See [[Version Control>>Features.VersionControl]] for more details. | ||
| 90 | |||
| 91 | == Attributes == | ||
| 92 | |||
| 93 | Displays a page's properties. | ||
| 94 | |||
| 95 | {{warning}} | ||
| 96 | The Attributes view is a work in progress | ||
| 97 | {{/warning}} | ||
| 98 | |||
| 99 | = Print = | ||
| 100 | |||
| 101 | There are several possible printing options (what you see may vary depending on the Skin used). | ||
| 102 | |||
| 103 | When using the Colibri Skin, you will find the Print Preview button on the top menu by hovering over More Actions: | ||
| 104 | |||
| 105 | * Print Preview: Generates a page which is formatted so that it can be easily printed using your browser's Print feature.((( | ||
| 106 | [[image:PrintColibri.PNG||style="border: 1px solid black;"]] | ||
| 107 | ))) | ||
| 108 | |||
| 109 | Under the Toucan skin the following options are found in the Print menu at the top: | ||
| 110 | |||
| 111 | * Print: Calls you're browser's Print feature to print the current page | ||
| 112 | * Print Preview: Generates a page which is formatted so that it can be easily printed using your browser's Print feature.((( | ||
| 113 | [[image:PrintToucan.PNG||style="border: 1px solid black;"]] | ||
| 114 | ))) | ||
| 115 | |||
| 116 | = Export = | ||
| 117 | |||
| 118 | There are several possible exporting formats that XWiki supports : PDF, RTF, XAR, HTML exports: See the [[Export feature>>Features.Exports]] for more information. | ||
| 119 | |||
| 120 | On Colibri skin: | ||
| 121 | [[image:ExportColibri.PNG||style="border: 1px solid black;"]] | ||
| 122 | |||
| 123 | On Toucan skin: | ||
| 124 | [[image:PrintToucan.PNG||style="border: 1px solid black;"]] | ||
| 125 | |||
| 126 | = Delete = | ||
| 127 | |||
| 128 | Removes a page. A confirmation is asked before the removal is done. | ||
| 129 | To restore a deleted document, go to Quick Links panel on the right side and click Document Index. Click on the Deleted Documents tab then click restore to the corresponding document you want to restore. | ||
| 130 | |||
| 131 | On Colibri skin: | ||
| 132 | [[image:DeleteColibri.PNG||style="border: 1px solid black;"]] | ||
| 133 | [[image:DeleteConfirmColibri.png||style="border: 1px solid black;"]] | ||
| 134 | [[image:RestoreDocumentColibri.png||style="border: 1px solid black;"]] | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | On Toucan skin: | ||
| 139 | [[image:DeleteToucan.PNG||style="border: 1px solid black;"]] | ||
| 140 | [[image:DeleteConfirmToucan.png||style="border: 1px solid black;"]] | ||
| 141 | [[image:RestoreDocumentToucan.png||style="border: 1px solid black;"]] | ||
| 142 | |||
| 143 | = Copy = | ||
| 144 | |||
| 145 | {{warning}} | ||
| 146 | This feature currently requires for an user to have Programming Rights in order to function. See [[XSCOLIBRI-209>>http://jira.xwiki.org/jira/browse/XSCOLIBRI-209]] and [[XWiki-508>>http://jira.xwiki.org/jira/browse/XWIKI-5081]] | ||
| 147 | {{/warning}} | ||
| 148 | |||
| 149 | 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" next to the page you want to copy. | ||
| 150 | |||
| 151 | 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! | ||
| 152 | |||
| 153 | On Colibri skin | ||
| 154 | [[image:XWikiCopy.png||style="border: 1px solid black;"]] | ||
| 155 | |||
| 156 | On Toucan skin | ||
| 157 | [[image:XWikiCopyToucan.png||style="border: 1px solid black;"]] | ||
| 158 | |||
| 159 | = Move/Rename = | ||
| 160 | |||
| 161 | 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. | ||
| 162 | The rename will perform 2 refactoring: | ||
| 163 | - update backlinks | ||
| 164 | - update parent information | ||
| 165 | |||
| 166 | In colibri, you can access the rename feature for a page by clicking on Rename under the More Actions in the top menu bar: | ||
| 167 | |||
| 168 | [[image:RenameColibri.PNG||style="border: 1px solid black;"]] | ||
| 169 | [[image:RenameInputColibri.PNG||style="border: 1px solid black;"]] | ||
| 170 | |||
| 171 | |||
| 172 | When using the Toucan skin, the Rename function can be found under the Action menu in the top menu bar: | ||
| 173 | |||
| 174 | [[image:TopBarRenameToucan.PNG||style="border: 1px solid black;"]] | ||
| 175 | [[image:RenameInputToucan.PNG||style="border: 1px solid black;"]] | ||
| 176 | |||
| 177 | Once this is done, you will be prompted to input the new Space and Page name you want your document to take: | ||
| 178 | |||
| 179 | Now you can link to the page using its new name. | ||
| 180 | |||
| 181 | == Limitations == | ||
| 182 | |||
| 183 | There are still some limitations on renaming: | ||
| 184 | |||
| 185 | * 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) | ||
| 186 | * 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. | ||
| 187 | * 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):((( | ||
| 188 | {{code language="none"}} | ||
| 189 | $xwiki.refreshLinks() | ||
| 190 | {{/code}} | ||
| 191 | ))) | ||
| 192 | |||
| 193 | = Share Page by Mail = | ||
| 194 | |||
| 195 | [[image:share1.png||style="border: 1px solid rgb(0, 0, 0);"]] | ||
| 196 | |||
| 197 | [[image:share2.png||style="border: 1px solid rgb(0, 0, 0);"]] | ||
| 198 | |||
| 199 | [[image:share3.png||style="border: 1px solid rgb(0, 0, 0);"]] | ||
| 200 | ))) |
