Wiki source code of Page Editing
Version 91.1 by Sorin Burjan on 2010/09/20
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | In XWiki all pages are editable (provided you are logged in and/or have the edit rights). To edit a page, all you 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). | ||
| 6 | |||
| 7 | For instance if you're using the [[Toucan skin>>code:Skins.ToucanSkin]] you should see what is on the image below: | ||
| 8 | |||
| 9 | |||
| 10 | [[image:EditSimpleMode.png||style="border:1px solid black;"]] | ||
| 11 | |||
| 12 | If you're using the [[Colibri skin>>code:Skins.ToucanSkin]] with the new Action Menus introduced in [[XWiki 2.5 Milestone 1>>xwiki:Main.ReleaseNotesXWikiEnterprise25M1]] you should see the following: | ||
| 13 | |||
| 14 | [[image:EditSimpleModeColibri.png||style="border:1px solid black;"]] | ||
| 15 | |||
| 16 | For XWiki Enterprise version 2.4 the menu will look like in the image below: | ||
| 17 | [[image:EditSimpleModeColibri24.png||style="border:1px solid black;"]] | ||
| 18 | |||
| 19 | |||
| 20 | = Simple and Advanced editing modes = | ||
| 21 | |||
| 22 | Since XWiki is an [[application wiki>>Main.SecondGenerationWiki]], not all users will need to use the same features. This is why XWiki comes with a Simple and an Advanced editing mode. Users can easily choose which editing 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 editing modes they may not be familiar with. By default new users are given the Simple editing mode but they can switch to the Advanced mode as described below. | ||
| 23 | |||
| 24 | == Simple Mode == | ||
| 25 | |||
| 26 | 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 (i.e. pages using the ###includeForm()## macro). The two editing modes available in Simple mode are: | ||
| 27 | |||
| 28 | * [[Wiki Editing Mode>>Features.PageEditing#HWikieditingmode]] | ||
| 29 | * [[WYSIWYG Editing Mode>>Features.PageEditing#HWYSIWYGeditingmode]] | ||
| 30 | |||
| 31 | == Advanced Mode == | ||
| 32 | |||
| 33 | Experienced XWiki users will want to use all the editing 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 on any page will display the full editing 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. | ||
| 34 | |||
| 35 | [[image:AdvancedEditMode.png||style="border:1px solid black;"]] | ||
| 36 | Once you have switched to advanced mode, the "Edit" menu will look like this on mouse over: | ||
| 37 | |||
| 38 | This will give you access to the following additional editing modes (for XWiki Enterprise 2.4): | ||
| 39 | [[image:EditAdvancedMode24.png||style="border:1px solid black;"]] | ||
| 40 | |||
| 41 | |||
| 42 | * [[Form Editing Mode>>Features.PageEditing#HFormeditingmode28akainlinemode29]] | ||
| 43 | * [[Object Editing Mode>>Features.PageEditing#HObjectseditingmode]] | ||
| 44 | * [[Class Editing Mode>>Features.PageEditing#HClasseseditingmode]] | ||
| 45 | * [[Access Rights Editing Mode>>Features.PageEditing#HPageAccessRightseditingmode]] | ||
| 46 | |||
| 47 | = Common edit actions = | ||
| 48 | |||
| 49 | All edit modes have some or all of the elements in the following image : | ||
| 50 | |||
| 51 | [[image:EditActions.png||style="border:1px solid black;"]] | ||
| 52 | |||
| 53 | 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. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | |||
| 57 | 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. | ||
| 58 | |||
| 59 | The **comment** field allows entering a short description of the changes made to the document in the version that is being saved. It is displayed in the history page and it is meant to increase comprehensibility of the content's evolution. | ||
| 60 | |||
| 61 | The **Cancel** button causes the changes to be discarded and forwards to the document view mode. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | |||
| 65 | The **Save & Continue** button submits the current changes and returns to the current edit mode. | ||
| 66 | |||
| 67 | The **Save & View** button submits the current changes and returns to the document view mode. | ||
| 68 | |||
| 69 | = Wiki editing mode = | ||
| 70 | |||
| 71 | 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. | ||
| 72 | |||
| 73 | This is how the wiki edit mode looks like with the Colibri skin: | ||
| 74 | |||
| 75 | [[image:WikiEditing.png||style="border:1px solid black;"]] | ||
| 76 | |||
| 77 | == Choosing a Syntax == | ||
| 78 | |||
| 79 | 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 Colibri Skin: | ||
| 80 | |||
| 81 | [[image:Syntax2.png||style="border:1px solid black;"]] | ||
| 82 | |||
| 83 | {{velocity}} | ||
| 84 | {{html wiki="true"}} | ||
| 85 | #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]].") | ||
| 86 | {{/html}} | ||
| 87 | {{/velocity}} | ||
| 88 | |||
| 89 | = WYSIWYG editing mode = | ||
| 90 | |||
| 91 | 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. | ||
| 92 | |||
| 93 | [[image:wysiwyg.png||style="border:1px solid black;"]] | ||
| 94 | |||
| 95 | {{velocity}} | ||
| 96 | {{html wiki="true"}} | ||
| 97 | #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]].") | ||
| 98 | {{/html}} | ||
| 99 | {{/velocity}} | ||
| 100 | |||
| 101 | Read the [[documentation for using the new WYSIWYG editor>>WysiwygEditor]] for more details. | ||
| 102 | |||
| 103 | = Form editing mode (aka inline mode) = | ||
| 104 | |||
| 105 | 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 and the form view is automatically displayed. | ||
| 106 | |||
| 107 | Technically the inline mode is triggered automatically differently whether the page is written in XWiki Syntax 1.0 or 2.0, using the following algorithm: | ||
| 108 | |||
| 109 | * XWiki Syntax 1.0: If the page contains a call to ###includeForm()## | ||
| 110 | * XWiki Syntax 2.0: If the page is including another page which itself contains an object of the type ##XWiki.SheetClass## | ||
| 111 | |||
| 112 | Note that 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. | ||
| 113 | |||
| 114 | = Objects editing mode = | ||
| 115 | |||
| 116 | 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. | ||
| 117 | [[image:ObjectEditor.png||style="border:1px solid black;"]] | ||
| 118 | |||
| 119 | = Classes editing mode = | ||
| 120 | |||
| 121 | 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 find out more about programming with Objects/Classes. | ||
| 122 | [[image:ClassEditor.png||style="border:1px solid black;"]] | ||
| 123 | |||
| 124 | = Page Access Rights editing mode = | ||
| 125 | |||
| 126 | 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. | ||
| 127 | |||
| 128 | = Full Screen Mode = | ||
| 129 | |||
| 130 | 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 edit 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. | ||
| 131 | |||
| 132 | //The button you need to click to go in full-screen mode// | ||
| 133 | [[image:FullScreenButton.png||style="border:1px solid black;"]] | ||
| 134 | |||
| 135 | //Editing while in full-screen mode// | ||
| 136 | [[image:FullScreen.png||style="border:1px solid black;"]] |
