Help:Editing
From Electrical Installation Guide
This is a WYSIWYG (What You See is What You Get) editor. The text you enter in the editor will be converted to Wikitext (the base language for creating and editing wikis) and should appear in the final, saved version looking exactly as you created it. This editor is derived from an open source product, FCKeditor, with this version specifically designed for interface with MediaWiki, the wiki tool used by Wiki-EIG. As a derivative of an open source tool, the documentation available on the web is marginal. What do you expect from something called "FCKeditor" (no doubt created by teenagers downing lots of Red Bull)? So your Wiki-EIG administrators have created this guide to assist you.
You must be logged into your account to edit a page. To create an account, or log in click here, or use the Login/Create Account link in the left sidebar.
Contents |
The editing toolbar
Click the Edit tab at the top of a page to enter the editor. If you are not a registered author, you will be asked to register. While not required, we ask that you do so. Pictured above is the toolbar for the Wiki-EIG editor. Place your cursor over any toolbar icon to trigger a display note about the function of that icon. Some of the toolbar functions are quite familiar to anyone who has used a text editor, such as the BOLD, ITALICS and UNDERLINE functions. You may cut, copy and paste using toolbar icons or via familar keyboard shortcouts. Some of the less obvious toolbar functions are unique to this environment and are explained below.
Wikitext
This icon switches editing into the native Wikitext format, the actual text coding language behind a Wiki. If you're familiar with Wikitext, you may be comfortable editing in this mode. If you're not familiar with Wikitext,this site will give you a brief introduction; When done editing in the Wikitext mode, click this icon again to return to the WYSIWYG mode or click Save. NOTE: All Wikitext is not the same. In this case, you will get the interpretation of Wikitext as made by the FCKeditor, which may or may not be quite what you are expecting. Remember, it's called "FCKeditor"!
Insert image
Facilitates insertion of images that have already been uploaded (See Upload File). Click to open the Image Properties dialog box. Type all or part of the uploaded image name and all choices matching that entry will appear in the search window. Click on your choice and ok to insert. You may enter a caption before inserting, or set various parameters about image size and alignment (left, right, center, etc.). These may be left blank for default settings. The image will always insert to the upper left of the page, regardless of where the cursor was placed. You may click and drag the image to the desired location on the page. You may resize it by clicking and then dragging on the corners. Right click (Apple-click for fans of Mr. Jobs) to open a menu with choices of copy, cut, past or image properties. The latter will open the same dialog box that you saw when inserting the image. You can add/change parameters in this dialog.
If you are proficient with Wikitext, you may create an image link directly to images residing in Wikimedia commons. Enter the URL of the wikimedia commons image in the standard wikitext field for calling an image.
Insert/edit template
Allows insertion of Wikitext function templates (predefined wikitext). Click the manual tab and pull-down menu to access and insert pre-defined templates, which will be indicated visually in the edited text by the insertion of this icon
. For those of you familiar with Wikitext, use the edit tab to create and insert {{ }} functions or called parameters.
Insert/edit special tag
Inserts special Wikitext function tags. This is only of use if you understand Wikitext, in which case it's just a shortcut for entering these functions w/o going into Wikitext mode. Note, it inserts both the opening and closing function tag. You must enter the text you wish to appear between the tags in the Special Tag Parameters field in the dialog box.
Creating a references section
Put your cursor at the end of your article, on the left margin. Click on the insert/edit template function, choose the manual tab in the dialog box, and from the menu list choose Template:Reflist. and click OK. You should see this icon inserted
. Save the article and you should see a references section and a summary listing of all the footnote notations you have created throughout the document. Add more footnotes and the notations will show up here.
Insert/edit formula
This tool allows entry of mathematical formulas.
Format
This pull-down menu allows you to set the fomat of highlighted text or text on the line of the cursor. Heading 1 is reserved for the main title only. Second tier sections use Heading 2, and so forth on down. Heading 3 and 4 are the same, so please skip use of Heading 4.
Insert/remove numbered list
Click the Insert/Remove Numbered List Button to start a numbered list. To finish your list hit enter twice.
Insert/remove bulleted list
Click the Insert/Remove Bulleted List Button to start a bulleted list. To finish your list hit enter twice.
Blockquote
Duh.
Insert/edit link
Highlight the text in which you desire to inbed a link and click on the link icon. The Link dialog box will open. If linking to another existing Wiki-EIG page, type the title (not URL) of your new page into the Link field, and the Wiki-EIG will search for your page. Matches will appear in the Automatic Search box below. Click on your page as found by the search, and click OK. That should insert the link into your highlighted text, which will now appear blue. Exit the editor by clicking Save.
- To link to another Wiki-EIG page and direct the page to open to a specific heading on that page, do as described above and append onto the name of the page #heading name. For example, for a link to this page directed to open the page at the heading of this section, the entry in the Link field of the dialog box would look be: Help:Editing a page#Insert/edit link.
- If linking to a page outside of Wiki-EIG, you must enter or paste the actual URL into the Link field of the dialog box. Use this same process to edit any existing imbedded links, or right click on exisiting links and choose edit.
- If linking to a heading within the same page, type the name of the heading into the Link field, preceeded by a # character. For instance, to link to the heading on this page called Format, you would type #Format into the Link field.
- To create a link to a non-existing page (a page you would like to create), highlight your text and proceed as described above to open the Link dialog box. Type in the title of the new page you want to create. Remember, this will become the title of the page, so take care in choosing a name. Follow the style guide (begin with an upper case character, followed by lower case only). Click Ok. The text containing the link will now appear blue. When out of the editor mode, the text containing the link will appear red, indicating a link to a new, never opened page/article. Click this link to open your new page.
Once outside the editor, links to other Wiki-EIG pages will appear purple, links to pages outside Wiki-EIG will appear blue, and links to new, never opened pages will appear red, .
Remove link
Highlight text containing an imbedded link and click this icon to remove that link. You may also highlight a link in the text, and right-click to open a menu allowing you to remove the link.
Upload files
Click on the Upload File item in the toolbox (left sidebar). This will open an Upload file dialog box, allowing you to browse files on your computer. When you've found the file you wish to upload, click the Upload button near the bottom of the dialog box. This will bring the file onto the Wiki-EIG server, where it can be accessed by other tools, such as the Insert Image tool. Note: Allowed file types are: png, gif, jpg, jpeg. Recommended file size is <200kb.
Please edit the image page and include information about the original image source and specifically if any restrictions on usage or duplication exist.











