Wiki source code of PageEditing
Version 28.1 by Silvia Macovei on 2009/08/19
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{velocity filter="none"}} | ||
| 2 | {{html clean="false" wiki="true"}} | ||
| 3 | #startfloatingbox() | ||
| 4 | **Contents** | ||
| 5 | |||
| 6 | {{toc start="2" depth="3" numbered=""/}} | ||
| 7 | #endfloatingbox() | ||
| 8 | |||
| 9 | |||
| 10 | = Page Editing = | ||
| 11 | |||
| 12 | |||
| 13 | |||
| 14 | In XWiki all pages are editable (provided you are logged in and/or have the edit rights). To edit a page, all you have have to do is to click the "Edit" button which is usually located at the top left of the page you're viewing (please note however that the location of the "Edit" button varies depending on the skin your wiki is using). For instance using the [[Toucan skin>>code:Skins.ToucanSkin]] you should see what is on the image below. | ||
| 15 | |||
| 16 | image:EditionSimpleMode.PNG | ||
| 17 | |||
| 18 | |||
| 19 | == Simple and Advanced edition modes == | ||
| 20 | |||
| 21 | |||
| 22 | |||
| 23 | Since XWiki is an [[application wiki>>Main.SecondGenerationWiki]], all users will not need to use the same features. This is why XWiki comes with a simple and an advanced edition mode. Users can easily choose which edition mode they prefer on their profile (available at the top right of the page when you are logged in). This way, standard users do not have to choose between edition modes they may not be familiar with. By default new users are given the Simple edition mode but they can switch to the Advanced mode as described below. | ||
| 24 | |||
| 25 | |||
| 26 | === Simple Mode === | ||
| 27 | |||
| 28 | |||
| 29 | |||
| 30 | After clicking on the "Edit" button in simple mode, XWiki will automatically edit the page in the basic mode (WYSIWYG or Wiki) for standard pages and in Form mode for pages which include Forms (ie pages using the #includeForm() macro). The two edition modes available in simple mode are: | ||
| 31 | |||
| 32 | * [[Wiki Edition Mode>>Features.PageEditing#HWikieditingmode]] | ||
| 33 | * [[WYSIWYG Edition Mode>>Features.PageEditing#HWYSIWYGeditingmode]] | ||
| 34 | |||
| 35 | === Advanced Mode === | ||
| 36 | |||
| 37 | |||
| 38 | |||
| 39 | Experienced XWiki users will want to use all the edition choices (particularly those who want to use XWiki programming features). They can choose to switch to advanced mode on their user profile page (see image below). Following this, clicking on the "Edit" button will display the full edition menu, letting the user choose which mode he wants to use ("Wiki", "Inline form", "Objects"...). Under the "Show" tab, the "Wiki code" option is displayed too. | ||
| 40 | |||
| 41 | image:AdvancedMode.PNG | ||
| 42 | |||
| 43 | Once you have switched to advanced mode, the "Edit" menu will look like this when the mouse is over: | ||
| 44 | |||
| 45 | image:EditAdvancedMode.PNG | ||
| 46 | |||
| 47 | This will give you access to the following edition modes: | ||
| 48 | |||
| 49 | |||
| 50 | * [[Form Edition Mode>>Features.PageEditing#HFormeditingmode28akainlinemode29]] | ||
| 51 | * [[Object Edition Mode>>Features.PageEditing#HObjectseditingmode]] | ||
| 52 | * [[Class Edition Mode>>Features.PageEditing#HClasseseditingmode]] | ||
| 53 | * [[Access Rights Edition Mode>>Features.PageEditing#HPageAccessRightseditingmode]] | ||
| 54 | |||
| 55 | == Common edit actions == | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | All edit modes have some or all of the elements in the following image: | ||
| 60 | |||
| 61 | image:EditActions.PNG | ||
| 62 | |||
| 63 | The **minor edit** checkbox is meant to mark the fact that superficial changes were made to the document. Such changes may include, but are not restricted to: spelling error corrections, text rearrangements, formatting. It is the editor's responsibility to distinguish between major and minor changes. | ||
| 64 | |||
| 65 | Reminder: A wiki document's version is composed of two numbers. Saving a major change will increase the first component and reset the second to "1", while a minor edit will just increase the second component. | ||
| 66 | |||
| 67 | By default, minor edits do not appear in the "What's New" page and in the document history. The option "Show minor edits" will list all the versions, including minor ones. | ||
| 68 | |||
| 69 | The **comment** field allows entering a short description of the changes made to the document in the version being saved. It is displayed in the history page and it is meant to increase comprehensibility of the content's evolution. | ||
| 70 | |||
| 71 | The **Cancel** button causes the changes to be discarded and forwards to the document view mode. | ||
| 72 | |||
| 73 | The **Preview** button shows the document as it would look with the current changes saved, but does not actually change the document. From the preview mode, the user will be able to cancel the changes, return to edit mode or save the changes. This button is not available in all edit modes. | ||
| 74 | |||
| 75 | The **Save & Continue** button submits the current changes and returns to the current edit mode. | ||
| 76 | |||
| 77 | The **Save & View** button submits the current changes and returns to the document view mode. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | == Wiki editing mode == | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | This is a mode you should be familiar with if you're already a wiki user. In this mode you can enter text using a simple [[Wiki Syntax>>Main.XWikiSyntax]]. Note that the syntax documentation help is displayed in a menu on the right when you edit a page in this mode. | ||
| 86 | |||
| 87 | This is what the wiki edition mode looks like with the Toucan skin: | ||
| 88 | |||
| 89 | image:WikiEdition.PNG | ||
| 90 | |||
| 91 | In Wiki and WYSIWYG mode, the user can maximize the edit area to occupy as much as possible of the full window. For this, there is a green arrow button on the top-right corner of the editor, which launches the fullscreen editing mode. The user is able to save, preview or continue working without closing the fullscreen window. | ||
| 92 | In order to close the window and restore the original dimensions of the editor the user can press the green arrow button on the top-right corner of the editor. | ||
| 93 | |||
| 94 | |||
| 95 | === Choosing a Syntax === | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | Starting with XWiki Enterprise 1.7 you now have the option to choose what syntax you want to use for writing the content of the page (see the [[XWiki Syntax Guide>>platform:Main.XWikiSyntax]] for more details). To choose one of the [[configured syntaxes>>platform:AdminGuide.Configuration#HConfiguringWikiSyntaxes]] go in wiki edit mode and in the Information Panel select the syntax to use. For example using the Toucan Skin: | ||
| 100 | |||
| 101 | image:Syntax.PNG | ||
| 102 | |||
| 103 | #info("If you choose the XWiki Syntax 2.0 and switch to the WYSIWYG editor you'll notice that you'll be using the [new WYSIWYG editor>WysiwygEditor].") | ||
| 104 | |||
| 105 | |||
| 106 | == WYSIWYG editing mode == | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | This mode is ideal for first time users or people who do not want to use the Wiki Syntax. It's a mode similar to the one used by your favorite word processor in which you see how what you type is rendered. There's a toolbar available to add special effects to your text, add images, insert links, add macros, etc. | ||
| 111 | |||
| 112 | image:wysiwyg.png | ||
| 113 | |||
| 114 | #info("Starting with XWiki Enterprise 1.7 we now have 2 WYSIWYG editors and we are phasing out the old editor (based on TinyMCE) that you'll be automatically using if your documents are written in XWiki Syntax 1.0. If your [document is using the XWiki Syntax 2.0>#HChoosingasyntax] or if your wiki is [configured to use the XWiki Syntax 2.0 by default>platform:AdminGuide.Configuration#HConfiguringWikiSyntaxesanddefaultSyntax] then you'll be using automatically the [new WYSIWYG editor (based on GWT)>WysiwygEditor].") | ||
| 115 | |||
| 116 | Read the [[documentation for using the new WYSIWYG editor>>WysiwygEditor]] for more details. | ||
| 117 | |||
| 118 | {{/html}} | ||
| 119 | {{/velocity}} | ||
| 120 | |||
| 121 | == Form editing mode (aka inline mode) == | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | Inline mode, or Form mode, is a special feature of XWiki, that allows administrators to define patterns of structured information (like a blog entry, or a standard tax form). Pages containing such structured information can be edited and re-edited as simple HTML Forms, which have (almost) the same structure as the displayed page. Thus, when clicking the edit button, it seems that the page content can be edited in-place, or inline. | ||
| 126 | |||
| 127 | You can only use this edit mode for pages having such structured content. | ||
| 128 | |||
| 129 | Technically this mode is used to edit pages that use the #includeForm() macro to display Forms objects attached to the page. It is beyond the scope of this simple guide to explain the programming technique supporting this feature. Please check the [[Developer's Guide>>DevGuide.WebHome]] to find out more about programming with Objects/Classes and Forms. | ||
| 130 | |||
| 131 | |||
| 132 | == Objects editing mode == | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | In XWiki it's possible to attach Objects to pages. Objects are simple sets of properties with values that add additional information about a page. For example a security right can be added to a page to control its rights, a blog object is attached to a page representing a blog entry, etc. Again it's beyond this simple guide to explain this programming technique. Please check the [[Developer's Guide>>DevGuide.WebHome]] to know more about programming with Objects/Classes. | ||
| 137 | |||
| 138 | |||
| 139 | == Classes editing mode == | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | We've seen that some pages can have Objects attached to them. Some pages can also be Object definitions, a.k.a Classes. The Classes editing mode calls the class editor on the current page, allowing to edit the Classes attached to the document. Again it's beyond this simple guide to explain this programming technique. Please check the [[Developer's Guide>>DevGuide.WebHome]] to know more about programming with Objects/Classes. | ||
| 144 | |||
| 145 | |||
| 146 | == Page Access Rights editing mode == | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | This mode allows you to control the access rights for the page you're viewing (you need to have the correct access rights to modify a page's rights of course!). See the [[Rights Management>>Features.RightsManagement]] topic for more information. | ||
| 151 | |||
| 152 | |||
| 153 | == Full Screen Mode == | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | From version 1.1 onwards, a full-screen mode is available in XWiki. When editing a page either in Wiki or WYSIWYG mode, clicking on the green button at the top right of the edition box will send the editor in full-screen mode. You can then edit your page as usual and click on the green button to return to the usual interface when you are finished. | ||
| 158 | |||
| 159 | //The button you need to click to go in full-screen mode// | ||
| 160 | image:FullScreenButton.PNG | ||
| 161 | |||
| 162 | //Edition while in full-screen mode// | ||
| 163 | image:FullScreen.PNG |
