Changes for page User Guide

Last modified by Ecaterina Moraru (Valica) on 2017/09/07 17:08

From version < 17.1 >

edited by Sorin Burjan
on 2010/06/14 09:15

To version < 16.3 >

edited by Sorin Burjan
on 2010/06/14 08:58

Change comment: added some image borders

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -145,15 +145,17 @@
  === Editing Area ===
--[[image:rta.png||style="border: 1px solid black;"]]
++image:rta.png
++
  The editing area is the place where you will type in your text and format your document. It is a rich text area because you can see, while editing, how the text will look like after it is saved. Before you start typing make sure the editing area is focused. One way to focus the text area is to click on it. This should make the blinking insertion caret appear. You can control the caret using the arrow keys. Besides typing, the editing area allows you to select a piece of text. This is useful when you want to format your text. If your content becomes larger than the available space in the editing area the scrollbars, vertical or horizontal, will appear. The scrollbars allow you to go up and down, as well as left and right through your text.
  === Toolbar ===
--[[image:toolbar.png||style="border: 1px solid black;"]]
++image:toolbar.png
++
  The toolbar is the place where you can find most of the editor features. It is placed right on top of the editing area. Each feature can be activated through a widget like a button or a list box. Features can be grouped and groups of features are separated from one another using a small vertical bar. The toolbar gets updated whenever you take an action on the editing area (like typing a character or clicking). As a consequence, some features could be disabled depending on where you place the insertion caret inside the rich text area.
--[[image:toolbarstate.png||style="border: 1px solid black;"]]
++image:toolbarstate.png
  A toolbar button can be in one of the four states depicted in the previous image. From left to right we have: not clicked, hovering, clicked and disabled. When a button is in the not clicked state it means the associated feature hasn't been activated on the current context. By current context we mean the place where the insertion caret or the selected text is inside the editing area. When you place the mouse pointer over a toolbar button the later enters the hovering state. In this state you can see a tooltip explaining what the associated feature does. If a toolbar button is in the clicked state then it means the associated features has been activated on the current context. By clicking the button again you can usually toggle off the effect of the feature (remove the bold style, remove the right alignment etc,). A toolbar button is disabled when you are not allowed to activate its feature in the current context.
@@ -161,14 +161,17 @@
  === Menus ===
--[[image:menu.png||style="border: 1px solid black;"]]
++image:menu.png
++
  The menu bar is the place where you can find the advanced editing features. It is placed right on top of the toolbar. By clicking on a top menu item you can see what entries it has. Most of the top menu items have two sets of sub entries: insert/creation related and edit related. For instance, there is an insert link menu and an edit link menu. When you place the caret inside a link the edit link menu is activated. When you move the caret outside the link the insert link menu becomes active.
--[[image:macroinsertmenu.png||style="border: 1px solid black;"]]
++image:macroinsertmenu.png
++
  Some of the menu items have an icon to help us easily recognize them. When a menu item is disabled it means its feature cannot be activated on the current context (the currently selected text or the text around the insertion caret).
  === Tabs ===
++
  [[image:tabs.png||style="border: 1px solid black;"]]
  The editor provides tabs to switch to source editing for advanced users. This tabs are situated right on top of the menu bar if the editor was configured to display them.
@@ -176,16 +176,20 @@
  Some of the editing features require additional information from the user. This information is taken using dialogs. Most of the dialogs are modal: the user can't edit while the dialog is opened. The editing is prevented using a glass panel so that the user can still see the text from the editing area while the dialog is opened. If the dialog covers a fragment of text the user wants to see then he can move the dialog by dragging it over the screen. In order to speed up the dragging and to allow the user to see as much as possible from the editing area, only the title bar is visible when the dialog is dragged.
--[[image:symbolpickerdragging.png||style="border: 1px solid black;"]]
++image:symbolpickerdragging.png
++
  Simple dialogs have a title bar and a body. The title bar has an icon on the left side followed by the dialog title. At the right end of the title bar there is the close button which acts like a cancel button.
--[[image:colorpicker.png||style="border: 1px solid black;"]]
++image:colorpicker.png
++
  The color picker is a special dialog that allows us to change the color of the selected text. Unlike the other dialogs, it auto hides when you click on the editing area. The current color is displayed using a bigger square, as it is depicted in the previous image (see the red square). See [[Colors>>#HColors]].
--[[image:symbolpicker.png||style="border: 1px solid black;"]]
++image:symbolpicker.png
++
  The symbol picker is a special dialog that allows us to insert a special symbol (such as accented characters, trademark, currency symbol etc.) in place of the current text selection or at the caret position. Just click on the desired symbol to insert it. See [[Inserting Symbols>>#HInsertingSymbols]].
--[[image:link2wikistep2.png||style="border: 1px solid black;"]]
++image:link2wikistep2.png
++
  Complex dialogs are used in wizards. Their body is made of three parts: the header, the content and the footer. The header usually contains the title of the wizard step and the next/previous buttons. The content of the dialog includes the input controls used to collect data from the user. The footer usually contains the buttons for canceling the wizard or finishing it at the current step.
  == Standard Features ==
@@ -308,10 +308,12 @@
  Headings can be used to organize your text. You can split the content in **sections** and **subsections** and then specify a title for each of them. You can choose the heading level to apply from the format list box which is found on the toolbar. If you want to remove the heading style just choose "Plain text" from the format list box.
--[[image:formatexample.png||style="border: 1px solid black;"]]
++image:formatexample.png
++
  ==== Fonts ====
--[[image:fontname.png||style="border: 1px solid black;"]]
++image:fontname.png
++
  Fonts determine how the letters of your text look like. "Times New Roman" and "Arial" are among the most used fonts. To use a different font you have to select one from the font list box found on the toolbar.
  (% style="border: 1px solid rgb(221, 221, 221); width: 500px;" %)
@@ -327,7 +327,8 @@
  ==== Text Size ====
--[[image:fontsize.png||style="border: 1px solid black;"]]
++image:fontsize.png
++
  To change your font size pick one from the font size list box found on the toolbar.
  (% style="border: 1px solid rgb(221, 221, 221); width: 500px;" %)
@@ -345,7 +345,8 @@
  The other option to make your text look different is changing the text color or its background color. If you want to change your **text color** press the [[image:forecolor.gif||style="vertical-align: middle;"]] toolbar button and pick a color from the palette by clicking on it.
--[[image:colorpicker.png||style="border: 1px solid black;"]]
++image:colorpicker.png
++
  The current color is displayed using a //bigger// square, as you can see in the previous image.
  (% style="border: 1px solid rgb(221, 221, 221); width: 500px;" %)
@@ -376,35 +376,34 @@
  You can create two kinds of lists: **numbered** (also called **ordered** because the order of the list items is important) and **bulleted** (also called **unordered** because the order of the list items is not important). The only difference between these two types of lists is the symbol (a number or a bullet) preceding the list items; they behave the same. To start a list you have to place the caret on the line that you would like to become the first list item in your new list and click the toolbar button for the type of list you wish to create: [[image:ul.gif||style="vertical-align: middle;"]] for a bulleted list or [[image:ol.gif||style="vertical-align: middle;"]] for a numbered list.
++image:listcreatestep1.png
--[[image:listcreatestep1.png||style="border: 1px solid black;"]]
++image:listcreatestep2.png
--[[image:listcreatestep2.png||style="border: 1px solid black;"]]
--
  You can also quickly create a list from a couple of lines by selecting those lines and pressing the toolbar button for the type of list you wish to create.
++image:listcreatestep3.png
--[[image:listcreatestep3.png||style="border: 1px solid black;"]]
++image:listcreatestep4.png
--[[image:listcreatestep4.png||style="border: 1px solid black;"]]
  Once you have a list you can add more list items by using the **Enter** key. Pressing Enter in the middle of a list item splits that list item in two. Pressing Enter at the end of a list item creates a new empty list item.
++image:listcreatestep5.png
--[[image:listcreatestep5.png||style="border: 1px solid black;"]]
++image:listcreatestep6.png
--[[image:listcreatestep6.png||style="border: 1px solid black;"]]
  You can create **sublists** by **indenting** list items. To do this click the [[image:indent.gif||style="vertical-align: middle;"]] button from the toolbar. Note that you can indent just one level because a sublist must always have a parent list. You can indent multiple list items at once though, by selecting them first. The **outdent** feature, [[image:outdent.gif||style="vertical-align: middle;"]], is the opposite of indent. Unlike indent, you can outdent a list item multiple levels. Outdenting a top level list item transforms it in plain text.
++image:listcreatestep7.png
--[[image:listcreatestep7.png||style="border: 1px solid black;"]]
++image:listcreatestep8.png
--[[image:listcreatestep8.png||style="border: 1px solid black;"]]
  You can **mix** bulleted lists with numbered lists.
++image:listcreatestep9.png
--[[image:listcreatestep9.png||style="border: 1px solid black;"]]
++image:listcreatestep10.png
--[[image:listcreatestep10.png||style="border: 1px solid black;"]]
  After you created the list, press the toolbar button for the associated list type to go back to plain text.
  === Creating and Editing Links ===
@@ -421,8 +421,8 @@
  To create a link to a wiki page choose "Wiki page" from the "Link" menu.
++image:link2wikistep1.png
--[[image:link2wikistep1.png||style="border: 1px solid black;"]]
  First you have to select the wiki page you wish to link to. You can use the tree to browse the exiting wiki pages. If you want to link to a page that doesn't exist yet then select "New page..." from the tree. This doesn't create a new page but just a link to a missing wiki page.
  Advanced users can use the text box below the tree to quickly search for wiki pages. You have use this syntax: **WikiName:SpaceName.PageName**. The wiki name and the space name can be omitted. The text box will offer you suggestions based on the wiki pages that match your input.
@@ -429,7 +429,8 @@
  After you select the target wiki page (either by using the tree or the text box) click the "Select" button to proceed to the next step.
--[[image:link2wikistep2.png||style="border: 1px solid black;"]]
++image:link2wikistep2.png
++
  Now you can edit the link parameters:
  * the link label
@@ -438,20 +438,22 @@
  Click "Create link" when you're done. You will comeback to this dialog when editing a link.
++image:link2wikistep3.png
--[[image:link2wikistep3.png||style="border: 1px solid black;"]]
  Your link should be visible inside the editing area at this point. Try to hover the mouse cursor over the link or to edit the link label in place.
--[[image:link2wikistep4.png||style="border: 1px solid black;"]]
++image:link2wikistep4.png
++
  ==== Link to attachment ====
  To create a link to an attachment choose "Attached file" from the "Link" menu.
--[[image:link2attachmentstep1.png||style="border: 1px solid black;"]]
++image:link2attachmentstep1.png
++
  First you have to select the attachment you wish to link to. You can choose from the files attached to the edited page. In our example we have three images attached to the current page. If you want to attach a new file then select "Upload new file" and click "Select". In our example we wanted to create a link to an attachment from a different wiki page than the one edited. For this we clicked on the "All pages" tab. If your attachment is on the current page then just click "Select" and skip the next step.
++image:link2attachmentstep2.png
--[[image:link2attachmentstep2.png||style="border: 1px solid black;"]]
  Use the tree to browse the wiki pages in search for the right attachment to link to. As you can see, each page has an "Attachments" child node that holds the attached files. Notice the "Upload file..." entry which you can use to attach a new file to the corresponding page.
  Advanced users can use the text box below the tree to quickly search for attached files. You have use this syntax: **WikiName:[email protected]**. The wiki name, the space name and the page name can be omitted. The text box will offer you suggestions based on the attachment file names that match your input.
@@ -458,9 +458,8 @@
  After you select the attachment (either by using the tree or the text box) click the "Select" button to proceed to the next step.
--image:
++image:link2attachmentstep3.png
--[[image:link2attachmentstep3.png||style="border: 1px solid black;"]]
  Now you can edit the link parameters:
  * the link label
@@ -469,10 +469,12 @@
  This are the same parameters as for a link to a wiki page. Click "Create link" when you're done. You will comeback to this dialog when editing a link.
--[[image:link2attachmentstep4.png||style="border: 1px solid black;"]]
++image:link2attachmentstep4.png
++
  Your link should be visible inside the editing area at this point. You can view or download the attachment by following this link in view mode.
--[[image:link2attachmentstep5.png||style="border: 1px solid black;"]]
++image:link2attachmentstep5.png
++
  ==== Link to web page ====
  To create a link to a web page is very easy. You have to choose "Web page" from the "Link" menu and then fill in the link parameters:
@@ -484,12 +484,14 @@
  Click "Create link" when you're done.
--[[image:link2webpage.png||style="border: 1px solid black;"]]
++image:link2webpage.png
++
  ==== Link to email ====
  Creating a link to an email address is much line creating a link to a web page. The only difference is that you have to specify an email address instead of a web page address.
--[[image:link2email.png||style="border: 1px solid black;"]]
++image:link2email.png
++
  ==== Image link ====
  You can use an image as the label of a link. To do this you have to select the image and then follow the steps for the type of link you wish to create. Note that you won't be able to edit the link label during the link creation process. If you want to change the label of an image link after it was created then edit the image.
@@ -502,7 +502,8 @@
 . press the [[image:charmap.gif||style="vertical-align: middle;"]] button on the toolbar
 . click on the symbol you wish to insert
--[[image:symbolpicker.png||style="border: 1px solid black;"]]
++image:symbolpicker.png
++
  The symbol picker automatically closes after you choose a symbol. The caret is placed after the inserted symbol so you can open the symbol picker again if you wish to insert more symbols. Inserted symbols are like any other characters you type so you can use the Delete or Backspace keys to remove them and of course you can apply [[Text Formatting>>#HTextFormatting]].
  (% style="border: 1px solid rgb(221, 221, 221); width: 500px;" %)
@@ -518,8 +518,8 @@
  To insert an image place the caret where you want the image to be inserted and choose "Insert image" from the "Image" menu. Make sure you don't have an image selected before opening the "Image" menu because otherwise you'll see the edit image menu entries and no "Insert image" entry.
++image:imagestep1.png
--[[image:imagestep1.png||style="border: 1px solid black;"]]
  You have three ways to specify which image to insert:
  * Choose from the images already attached to the edited page. In our example there are two images already attached to the edited page: the Ubuntu logo and the Firefox logo.
@@ -528,12 +528,12 @@
  Whatever option you choose you have to click on the "Select" button to move to the next step.
++image:imagestep2.png
--[[image:imagestep2.png||style="border: 1px solid black;"]]
  In our example we choose to upload a new image. Browse through your local files and pick the image you want then click on the "Upload" button to attach the image to the edited page.
++image:imagestep3.png
--[[image:imagestep3.png||style="border: 1px solid black;"]]
  In the final step, before the image is inserted, you can edit the image properties. Here's what you can specify:
  * the image **width** and **height** on the page (i.e. how much space does the image take on the page)
@@ -545,13 +545,14 @@
  Click on the "Insert image" button when you're done. Note that you don't have to set all the image properties now: you can edit the image later.
--[[image:imagestep4.png||style="border: 1px solid black;"]]
++image:imagestep4.png
++
  You should see the image in the editing area. To select it simply click on it. Notice the resize handlers that appear around the image when it is selected. You can resize the image inside the editing area by dragging them. If you open the "Image" menu when an image is selected you can see the "Edit image" menu entry.
++image:imagestep5.png
--[[image:imagestep5.png||style="border: 1px solid black;"]]
++image:imagestep6.png
--[[image:imagestep6.png||style="border: 1px solid black;"]]
  To delete an image you can select it and press the **Delete** key or choose "Remove image" from the "Image" menu.
  === Creating and Editing Tables ===
@@ -558,30 +558,32 @@
  To create an empty table place the caret where you would like the new table to be inserted and choose "Insert table" from the "Table" menu. Currently you cannot insert a table inside another table so, before opening the "Table" menu, make sure you don't have the caret inside a table cell.
++image:tablestep1.png
--[[image:tablestep1.png||style="border: 1px solid black;"]]
  In the opened dialog you can specify the number of rows and columns the new table should have and if you want a table header or not. You can leave the default number of rows and columns if you don't know how many you'll need because you can add rows and columns later. You can't add a table header later though so you must decide now if you need one or not. When you're done, click the "Insert" button.
++image:tablestep2.png
--[[image:tablestep2.png||style="border: 1px solid black;"]]
  You should see now the table in your editing area. Fill in the table cells. You can navigate from cell to cell using the **arrow keys**. See [[Writing>>#HWriting]] to find out how you can use the **Tab** key to navigate through table cells. See also [[Keyboard Shortcuts>>#HKeyboardShortcuts]] if you can't move the caret before or after the table.
++image:tablestep3.png
--[[image:tablestep3.png||style="border: 1px solid black;"]]
  If you need a new column you can insert one before or after an existing column. Just place the caret in one of the cells from the reference column and choose the appropriate option from the "Table" menu. In our example we choose to insert a new column after the "Index" column (i.e. the "Index" column was the reference column in our case). You can also delete columns in the same manner: place the caret in one of the cells from the column to be deleted and choose "Delete column" from the "Table" menu.
++image:tablestep4.png
  Notice how in the previous image the "Insert row before" option is disabled. This happened because we placed the caret in the table header and table rows are not allowed before the table header.
--[[image:tablestep5.png||style="border: 1px solid black;"]]
++image:tablestep5.png
++
  Inserting a new row is much like inserting a new column. First you choose a reference row by placing the caret in one of its cells and then you choose the appropriate option from the "Table" menu. In our example we opted for inserting a new row before the the first one (i.e. the first row was the reference row in our case). For this we picked "Insert row before" from the "Table" menu. You can delete table rows in the same manner: place the caret in one of the cells from the row to be deleted and choose "Delete row" from the "Table" menu.
++image:tablestep6.png
--[[image:tablestep6.png||style="border: 1px solid black;"]]
  As you can see the new table row is empty and ready to be filled.
++image:tablestep7.png
--[[image:tablestep7.png||style="border: 1px solid black;"]]
  To delete a table place the caret in any of its cells and choose "Delete table" from the "Table" menu.
  === Inserting and Editing Macros ===
@@ -590,50 +590,52 @@
  Start by writing a few sections in the editing area then create an empty line where you want the table of contents to be inserted. In our example, we pressed Enter after "Space" in order to create the empty line. You can insert the table of contents in other places if you want. Leave the caret on the empty line and choose "Insert Macro..." from the "Macro" menu.
++image:macroinsertstep1.png
--[[image:macroinsertstep1.png||style="border: 1px solid black;"]]
  You should see a dialog with all the available macros. Each macro has a short description that will give you a hint about what the macro does. Look for the ToC macro. You can browse the list of macros using the keyboard: Up/Down selects the previous/next item in the list, Home/End selects the first/last item in the list. Click "Select" once you have the ToC macro highlighted.
++image:macroinsertstep2.png
--[[image:macroinsertstep2.png||style="border: 1px solid black;"]]
  Parameters control the behavior and the output of a macro. Some parameters are mandatory. You can distinguish them from the rest by their color: green. The ToC macro has only optional parameters. One special macro parameter is the macro content. The ToC macro doesn't require any content but other macros like Info use the content as the main source for their output. You can say that the ToC macro uses the entire page as its content, so you don't have to specify the content.
  Change the ToC parameters if you wish but note that you can come back to this step later by editing the inserted ToC macro. We kept the default values in our example. Click "Apply" when you're done.
++image:macroinsertstep3.png
--[[image:macroinsertstep3.png||style="border: 1px solid black;"]]
  At this point you should see the ToC macro inserted in your document.
++image:macroinsertstep4.png
--[[image:macroinsertstep4.png||style="border: 1px solid black;"]]
  Next, we add more sections to the document and choose "Refresh" from the "Macro" menu in order to update the table of contents.
++image:macroinsertstep5.png
--[[image:macroinsertstep5.png||style="border: 1px solid black;"]]
  The table of contents should be updated now.
++image:macroinsertstep6.png
--[[image:macroinsertstep6.png||style="border: 1px solid black;"]]
  If you think the table of contents takes a lot of space you can collapse it. In fact you can collapse any macro. First select the macro by clicking on it and then click again to toggle between collapsed and expanded states. You can also use the "Macro" menu to collapse or expand all the inserted macros. Collapsed macros display only their name and an icon.
--[[image:macroinsertstep7.png||style="border: 1px solid black;"]]
++image:macroinsertstep7.png
  === Importing Office Content ===
  The editor allows you to import content from office applications like **OpenOffice Writer** or **Microsoft Word**. If you want to insert just a fragment from an office document you can copy it from the office application you use and then click the [[image:importer.gif||style="vertical-align: middle;"]] button from the editor toolbar.
--[[image:officeimporterstep1.png||style="border: 1px solid black;"]]
++image:officeimporterstep1.png
++
  **Paste** what you've copied from the office application in the text area that you can see on the opened dialog. Notice the "//Filter styles//" check box in bottom left corner of the dialog. If you want the pasted text to look as much as possible as in your office application then leave the check box unchecked. Otherwise, if you care only about the content and not the text styles then check "Filter styles". This will result in a much cleaner document but the result may look different than in your office application. Click the "Import" button in the end.
--[[image:officeimporterstep2.png||style="border: 1px solid black;"]]
++image:officeimporterstep2.png
++
  You should see the office content in the editing area. It was inserted at the caret position or in place of the selected text. You can edit the imported content if you want.
++image:officeimporterstep3.png
--[[image:officeimporterstep3.png||style="border: 1px solid black;"]]
  In case you need to **import** an office document and not just a fragment you can use the "//File//" tab on the Office Importer dialog. **NOTE**: this feature requires special setup in order to work. Ask your system administrator to enable it.
++image:officeimporterstep4.png
--[[image:officeimporterstep4.png||style="border: 1px solid black;"]]
  See also the [[Office Importer Application>>http://code.xwiki.org/xwiki/bin/view/Applications/OfficeImporterApplication]].
  === Undo and Redo ===

Changes for page User Guide

Summary

Details

Quick Links

My Recent Modifications

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected