Difference between revisions of "Editing Help"

From IAP-Wiki
Jump to navigation Jump to search
en>Randyrls
en>Randyrls
Line 3: Line 3:
 
[[WikiText Details|WikiText]] is a markup language using text symbols and special characters to format text into document objects such as Headings, Lists, Links, and other formatting.&nbsp; It is UGLY, but some things are easier to do in the WikiText mode. Wiki's originator stated intention was to see how minimalistic formatting instructions could be and still be functional.&nbsp; The formatting has been extended a bit since first developed.&nbsp; <br>  
 
[[WikiText Details|WikiText]] is a markup language using text symbols and special characters to format text into document objects such as Headings, Lists, Links, and other formatting.&nbsp; It is UGLY, but some things are easier to do in the WikiText mode. Wiki's originator stated intention was to see how minimalistic formatting instructions could be and still be functional.&nbsp; The formatting has been extended a bit since first developed.&nbsp; <br>  
  
Editing pages in WYSIWYG mode is easy to do and intuitive.&nbsp; DIVE&nbsp;RIGHT&nbsp;IN&nbsp;AND&nbsp;GET&nbsp;YOUR&nbsp;FEET&nbsp;WET!&nbsp; Remember that even if you save your changes, there is a complete history of the page you are editing and it can be recovered.&nbsp; This Page only covers the WYSIWYG&nbsp;editor.&nbsp; For help information on the Wiki software, see the Help section.<br>  
+
Editing pages in WYSIWYG mode is easy to do and intuitive.&nbsp; DIVE&nbsp;RIGHT&nbsp;IN&nbsp;AND&nbsp;GET&nbsp;YOUR&nbsp;FEET&nbsp;WET!&nbsp; Remember that even if you save your changes, there is a complete history of the page you are editing and it can be recovered.&nbsp; This Page only covers the WYSIWYG&nbsp;editor.&nbsp; For help information on the Wiki software, see the [[Help:Contents|Help section]].<br>  
  
 
'''IMPORTANT&nbsp;TIP:&nbsp; When doing any serious editing, click on&nbsp;[[Image:Wiki FCKeditor Icon Fullscreen.jpg]] to enter FullScreen mode.&nbsp; Do not click on the navigation bar at left because you will loose your work!'''<br>  
 
'''IMPORTANT&nbsp;TIP:&nbsp; When doing any serious editing, click on&nbsp;[[Image:Wiki FCKeditor Icon Fullscreen.jpg]] to enter FullScreen mode.&nbsp; Do not click on the navigation bar at left because you will loose your work!'''<br>  

Revision as of 13:20, 19 June 2009

WYSIWYG Editing in IAP-Wiki

WikiText is a markup language using text symbols and special characters to format text into document objects such as Headings, Lists, Links, and other formatting.  It is UGLY, but some things are easier to do in the WikiText mode. Wiki's originator stated intention was to see how minimalistic formatting instructions could be and still be functional.  The formatting has been extended a bit since first developed. 

Editing pages in WYSIWYG mode is easy to do and intuitive.  DIVE RIGHT IN AND GET YOUR FEET WET!  Remember that even if you save your changes, there is a complete history of the page you are editing and it can be recovered.  This Page only covers the WYSIWYG editor.  For help information on the Wiki software, see the Help section.

IMPORTANT TIP:  When doing any serious editing, click on File:Wiki FCKeditor Icon Fullscreen.jpg to enter FullScreen mode.  Do not click on the navigation bar at left because you will loose your work!

DO NOT press the TAB key when in full screen mode.  If you do, press Shift-TAB to get back to your edit screen.

Browser Specific Information details known issues for different browsers.  Contributions to this page welcome!


Editing Operation

This page only covers the actual usage of the WYSIWYG editor.  The Wiki Help pages describe the ways to structure the Wiki. To start editing a page, click on the "edit" tab at the top of the page, or on the "[edit]" tab on the Section heading lines.  When you edit a Section, only that Section appears on the screen. 

Shortcut Keys are

Command Keystroke Comments
Edit Alt-Shift-E
Begin editing the page on the screen.   You must be logged in to edit pages.  A few pages are protected and cannot be edited.
Preview Alt-Shift-P

Preview the changes you have made.  The normal edit area appears below the Preview.

WARNING!  Previewing a page does not save your changes.  Make sure you save the page after previewing it!

Save Alt-Shift-S Saves and closes the Edit Session. If you are editing a page save it at regular intervals and do not leave the page for any reason without saving it!  There is no "Are You Sure?" warning in the Wiki.  There is no "Save" button on the editor Toolbar.
Quit N/A There is no "Exit without Saving".  You can click on "Cancel" at the bottom of the screen, or use the "Back" button on your browser to abandon the Editing.
Undo Ctrl-Z Undo last edit or operation.  Save cannot be undone.



Common Tasks

To edit any page, click on the "edit" tab at the top of the screen (shortcut Alt-Shift-E) to start editing.  If there isn't an edit tab, you are not allowed to edit the page.


Create New Page

Page creation is easy!  In the "Search Box", type the Name of the Page you want to create and click on the "Go" button.  A screen appears that contains the text 'There is no page titled "XXXXXXX". You can create this page.' Click on the "create this page" .  Enter some text, and click on the "Save Page" button at the bottom.  It is just that easy!  If a link on a page appears in red it is a link to a page that doesn't exist.  Click on it and you will again see the page above.


Before you create a new page, take a look at the Section "Page Text matches".  This will show you a list of pages that contain ths same text or partial text as you are about to create.  Maybe what you want to create should be there instead of a separate page.


Edit Text

Editing text with the WYSIWYG editor is very easy and anyone who has used a word processor or email program should be able to do this.


Formatting Text

The Format Icon File:Wiki FCKeditor Icon Format.jpg is used to control the text size of text on a page and set Sections and sub-headings. Click on the down-arrow at the end of the icon to change the format at the cursor position.  High light a string of text, then use the down-arrow to set the text format.


  1. Normal:  The normal size text for the body text of a page.
  2. Heading 1 and 2:  Section headings in bold  and decreasing font sizes.  These Headings also appear on pages as Sections.  You can link to a section.  See Advanced Editing for a discussion on Sections names.   It isn't possible to set specific font type or size.  Sorry.
  3. Heading 3 thru 6:  Headings in bold but decreasing font sizes.  These ARE NOT Section Names.
  4. Formatted:  A fixed width font used to delineate Quotes and attributions in the body of a page.  Sometimes used for code fragments on computer pages. Used to provide examples of operations.


Manipulating Text or (Cut, Copy and Paste)

The Cut Copy and Paste Icons File:Wiki FCKeditor Icon Cut Copy Paste.jpgon the Icon bar operate pretty much the way you would expect.  You can also use standard Windows shortcut keys (Control-X; Control-C; Control-V) to do these operations.  Of course these functions work with the standard windows Clipboard, so you can paste information from a document on your computer directly into a page.


Create a Link

The Link Icon File:Wiki FCKeditor Icon Link.jpg is used to create a link to a page or modify an existing link.  Highlight some text on your page that will be the link, and click on the icon.  A box appears and you start typing the Page name you want in the "Link" field.  Below you will see a list of pages that match what you are typing.  To create a link to a page that doesn't exist, just type the entire page name you want and click "OK".  Save your existing page, and click on the link that will take you to the "Create New Page" screen as shown in the Create New Page section above. 


Save a Page

You should preview your changes to see what they look like before saving a page.  Click on the "Show Preview" button or press shortcut key "Alt-Shift-P" to see the preview.  REMEMBER YOU HAVE NOT SAVED YOUR WORK YET!  You should check that links you have created are valid (Blue) and text is formatted correctly and images appear properly.  Then click on the "Save Page" button or press shortcut key "Alt-Shift-S" to save the page.


Upload File

You can upload a File to the IAP-Wiki with the left side navigation section "toolbox", "Upload File" link.  Please use meaningful names!  "IMAGE_3417.jpg" isn't but "Baron_Olive_wood.jpg" is better.  Enter the file name on your computer that you wish to upload and if needed, pick a different name for the file on the IAP-Wiki.  Any spaces in the file name will be converted to underscores in the file name on the WIki.  Enter a description into the "Summary" field and click "Upload File".  You will see a successful upload screen as well as information on the files located in the IAP-Wiki.  The "Edit this file using an external application" is not functional at this time.


Using Images on Pages

You can display images and photos in your pages.  You first need to upload a file to the IAP-Wiki as above. To include a file on a page, position the cursor where you want the image to appear.  Begin typing the filename in the "Image File Name" and a list of matching file names will appear in the "Search Results" box below.  Select the file name you want and enter a "Caption".  You can set the alignment of the image, and it's size, then click "OK".  You can edit an image to change it's alignment and size by right clicking on the image and selecting "Image Properties".  Text on the page normally wraps around any images that are on the page.  You can add carriage returns to position text above and below the image. 


Icon ToolBar

File:Wiki FCKeditor Icon bar.jpg

On the formatting bar above are the editing tools you will need to Type Text, Format, Link to Pages, and Insert Images. If you allow the mouse to hover over an icon, you will see a quick text definition of what the icon does.  An icon that isn't appropriate to the current operation will be "grayed-out".  Most are self explanatory, but see below for detailed descriptions.  The Icon bar does not have a "Save" button!

Top Line by Group

  1. "Wikitext" switches editor mode between WYSIWYG and WikiText mode.
  2. The next group of three icons are "Cut", "Copy", and "Paste".  Used to manipulate blocks of text.
  3. Printer icon prints a copy of the displayed page.
  4. Arrow left and right is "Undo" and "Redo".  Reverses the last change, and reapplies it.
  5. Binocular group is "Find", "Replace", and "Spell Check".  The Spell Check has issues, but is better than nothing,
  6. Square group is "Select All" and "Remove Format".  "Remove Format" doesn't do anything at present.
  7. Insert Group icons insert "Special Character", "Table", "Image", and "Horizontal Line".
  8. The last group on the Top Line Inserts a "Page Template", "Special Tag", "Insert a Formula", "Insert Signature", and "Insert / Edit Category".
    1. Only use a signature on the "Talk" pages.
    2. "Insert / Edit Categories" is used to create new categories and assign pages to existing categories.


Bottom Line by Group and Item

  1. Format controls the text size and makes it bold for some items.  You can't easily change the Font or set Font Size.  Sorry.
  2. Format controls make text "Bold", "Italic", "Underline", or "Strikout".
  3. "Superscript" or "Subscript" are the next two icons. These are useful for attributions and references.
  4. "Numbered List of Items", and "Bulleted List" are most used;  "Block Quote" inserts an indented block of text intended as a Quotation.
  5. "Outdent" and "Indent" are used in Item Lists to add indentation to slow outline levels.
  6. File:Wiki FCKeditor Icon Link.jpg "Insert/Edit Link" creates a link to another Page, Section, Anchor, or Web Site page or modify an existing link.
  7. "Remove Link" is self explanatory. The remove link looks too similar to the Insert Link beside it.
  8. File:Wiki FCKeditor Icon Anchor.jpg "Anchor" creates a target for a link to connect to.See Advanced Editing below for additional details.
  9. "Text Color" and "Text Background" change the text color and background respectively.  Use sparingly.
  10. File:Wiki FCKeditor Icon Fullscreen.jpg "Full Screen" changes the editor to Fullscreen mode and removes the navigation bar at the left.



Advanced Editing

There are places in the wiki where only lower case is permitted.  This restriction is imposed by the Wiki software.  In these situations, case will be ignored.


Categories

Pages can be assigned to Categories and may be part of more than one category.  A Category may have sub-categories.  A Category Page is a special page that contains a list of all the pages that belong to the Category and any sub-categories.  Categories should be inserted at the bottom of the page.  Categories cannot be renamed or moved.  Sorry.

To access the Categories of a page, click on the File:Wiki FCKeditor Icon Category.jpg icon on the editor icon bar.  A dialog box will appear.   The page belongs to the categories in the top box.

  1. To add a page to a Category, type the category you want in the "Search category".  If the category exists, double click on the name in the lower box to add the page to this category.  The Category will appear in the upper box. 
    1. If the category doesn't exist, you can create a new category.  Type the Cateory name you want and click on the "Add new" button.  This will create the Category, and add the page to the Category.  All categories should have a Category Page.  You should create a Category Page when you create a new Category.  All the pages in the category are on the Category Page.
  2. You can remove a Page from a Category by double clicking on the Category Name in the upper box.
  3. You can create a link to a Category Page using the same instructions as the "Create a Link" section above, but you must do some things manually.  
    1. The format of a Link to a Category Page is [[:category:CategoryName|Displayed Text]]
      1. The ":category" means this is a link to a Category Page, not a normal page.  The leading colon is NOT a typo and must appear there.
      2. The "CategoryName" is the Category Page name and it must be exactly correct.
      3. The text after the Vertical bar "|" is the text that will appear on the display screen.
      4. Example:  [[:category:Wood_Species|Wood Species]]  produces a link to the Category Page Wood Species
      5. Notice the differences in the text?


Inclusion / Transclusion

A page can be included on another page by "transclusion".  This is often done to display the same boiler plate text on every page displayed.  Position the cursor where you want the included page text to appear on the page.  click on the File:Wiki FCKeditor Icon Template.gif icon in the Editor icon bar.  Manually type the page name to be included.  It takes the form of This must be done manually.  Inclusions cannot be nested.


Redirect

Redirect syntax is '#redirect[[NewPageName]]'    Use a redirect to create a searchable entry that leads to another page.  See the Quick Start Guide for an example.  A REDIRECT must lead to a valid page.  Multiple REDIRECTS may lead to the same page, but nested or chained REDIRECTS are not allowed.


Anchors and Links

An Anchor is the target of links.  By default, Page Names and Sections Headings are Anchors and you do not have to explicitly create them.  You can create an Anchor with the File:Wiki FCKeditor Icon Anchor.jpg Icon in the FCKeditor Icon bar.  You can link to a Section Heading by creating a link to the page name, add a pound sign (#), then the Section Name.  Remember to replace any spaces with underscores.   Example of a link to a section.  This links to this section of this page.  You must type this, page matching look-up only works with page names

Editing_Help#Anchors_and_Links 


Tables

Tables will display information in rows and columns.  The File:Wiki FCKeditor Icon Table.jpg Icon will create a new table or allow you to edit the properties of an existing table.  When editing a table, click on a table cell to edit the contents.  The TAB key does not work in edit mode.  You can use the left mouse button (context menu) to add or delete rows and columns.


Magic Words

Magic Words are commands to the Wiki Engine to control how to display the page.  Magic Words begin and end with TWO UNDERSCORES and a USUALLY ALL UPPERCASE.  The most common ones are listed below.


Magic Word Location on Page Effect
__NOTOC__ Anywhere on page Disable the display of the Table of Contents section links at the top of the page. This magic word is valid anywhere on the page, but please put it at top of the page. 
__TOC__ Anywhere on page Forces the Table of Contents to appear at this point on the page.  There can be only ONE TOC Magic Word on a page.