close   
namespace:
close   
Fri Sep 3 06:15:01 EDT 2010
DokuWikiFCK
Total Downloads:   7598
Unique IP's from which downloads originated:   1973
fckgLite
Total Downloads:   11769
Unique IP's from which downloads originated:   2891
close   
All questions, bug fixes, and feature requests should go through the mailing list. To subscribe to the list, do one of the following:

1. Send an email to fckglite-request@freelists.org with 'subscribe' in the Subject field
2. Visit the fckgLite page at http://www.freelists.org/list/fckglite
3. Or click the subscribe link below

Subscribe
close   
 

Syntax compatibility

To view the compatibility of fckgLite with Dokuwiki, see the wiki:syntax page. It represents all of the syntax that Dokuwiki supports. For comparison purposes, to see what Dokuwiki does not support, see the original syntax page which comes as default with Dokuwiki. You will find that as of the current distribution, fckgLite does not support the <nowiki> tag or the Dokuwiki quotation markup.

Toolbar

The fckgLite toolbar is a subset of the DokuWikiFCK toolbar. To look up a toolbar icon, go to the DokuWikiFCK toolbar page. To edit the tool bar see the faq.

Image alignment

Images and the text which surrounds them can be aligned using the “Image properties” dialogue which appears when you click on the image toolbar icon.

You can also bring up this dialogue by right-clicking on the image, if it has already been inserted into your text.

There are five options in the drop-down 'Align' menu. The left, middle, and right alignments will position the image horizontally. Images will automatically left-align. With left alignment, you can create a horizontal row of images.

And you can position text to the right side of your images. The text will wrap around the image and return to the left-hand margin when the image is no longer at its left. Right alignment will do the same with the text, but to the right of the screen.

This an an example of right-alignment. All text and images align to the left of this image until the bottom of the image is cleared.

With baseline alignment, you can create a column of images that will align against the left-hand margin:

When you select baseline, the text and/or images will move to the first free line after the base-lined image.

For instructions on using the image file browser, go to the filebrowser page.

Nested Ordered Lists

fckgLite has a facility for nesting numbered lists. This is its tool bar icon:

How To:

First start your numbered list. When you want to nest a second list, place your cursor at the end of the current list item and click the nesting icon:

  1. list item
  2. current list item[cursor here]
    1. nesting
    2. nesting[cursor]
      1. another level
      2. another item
  3. back to top

When starting a nested list, the editor will insert an extra line after the new item number. Adjust the line-spacing and move your cursor to the start of the nested list. Begin typing. When you are finished with the nested list, hit the Enter key twice to get you back to the previous level. Again you may get an extra line between the nested list and the new item of the previous list. Simply delete it.

It can sometime become confusing to the parser if you include bold letters in these nested lists and then remove them.

Nested Unordered Lists

As of versions beginning Apr 24, there is a nested unordered list facility. It is handled the same as the nested ordered list. Its icon is:

Plugins and the Plugin Tool

Beginning with version 0.03 most plugin syntax is handled by the editor, and nothing special has to be done. For most plugins, the plugin syntax has to be 'escaped', otherwise the FCKeditor will permanently embed the output of the plugin into the page after the page has been saved. There is a configuration setting in the Dokuwiki Configuration Manager which enables you to specifiy a list of “Immutable” plugins;these will not be escaped and their output and not the plugin syntax will appear on the page after the first save.

The icon for the plugin tool is the electric plug:

The plugin tool comes with three options.

  1. If you have difficulty with a particular plugin, the plugin tool has an option that may be able to handle plugin syntax that is not recognized by the editor. In this option, you highlight the plugin syntax in the editor, type the name of the plugin in the text box and click OK. This 'escapes' the syntax so that the editor will not embed the output permanently in the page. To remove a plugin created in this way, highlight the plugin text, click on the icon and check the removecheckbox. The text will be left but the underlying plugin tags will have been removed.
  2. A plugin editor. If you enter a plugin into the FCKeditor and then want to change something in its syntax or in its content, you must highlight the text of the plugin and make your edits in the plugin editor. This editor handles the escapes correctly and reconstructs the original plugin syntax together with the new additons. This editor is not for use with plugins created by option 1.
  3. Stet Plugin. With this option you create a Stet plugin. Stet is a proof-reader's mark meaning “let it stand”, keep the text as is. This plugin enables the user to isolate text that contains either HTML sensitive characters or Dokuwiki markup characters. The text to which stet has been applied will appear “as is”. However, angle brackets will be escaped with space characters. See html conflicts below.

It is sometimes necessary to clear out your cache to get some plugins to work. For a demonstration page, see plugins.

Multi-line plugins

There are some plugins, like the bureaucracy plugin in which the plugin syntax carries over across line boundaries. This is not the same as plugins which enclose more than one line of text inside the plugin markup, like the color plugin or the note plugin, which act as containers for text. If you are using a multi-line plugin, you will very likely need to preserve the lines in tact, that is each line will need to end with a new line (which you get when you hit the Enter or Return key). To preserve the integrity of your lines, and to assure that each line ends with a new-line, you can use the MULTI_PLUGIN markup, which looks like this:

~~MULTI_PLUGIN_OPEN~~
<your-multi-line-plugin>
line 1
line 2
line 3
</your-multi-line-plugin>
~~MULTI_PLUGIN_CLOSE~~

The easiest and least error prone way to include the plugin text is to first type it into a text editor and then to copy it from the text editor and paste it into the fckgLite editing window. This will give you the precise line spacing that is required. You cannot have spaces at the beginning of lines, since they will be treated as standard markup for DokuWiki code blocks.


Paragraph to Line-Break Tool

The FckEditor formats text in paragraphs. As you type the text will come to the end of your editing window and wrap around to the next line. Everything within the paragraph will be single-spaced. If you type a series of short lines, they will each be placed in a separate paragraph and the effect will be that they are double-spaced. To get single-spacing for these lines, select them with your mouse and click on the paragraph-to-line-break tool:

In some browsers, only the first two lines, and sometimes none, will appear to be single spaced. This is because the screen has not updated. In fact the paragraphs have been removed, and you can manually close up the line-spacing. You can also use this tool by selecting your text and right-clicking and selecting ”<P> to <BR>” from the context menu.

Creating and Editing Tables

Tables are created and edited using the FCKeditor's table tool, in the toolbar, and the context menu which is accessed by right-clicking in the cell, column, or row which you want to change or extend. The table tool enables you to set the initial number of rows and columns and to create a row or column of table headers. With the context menu you can add and delete rows, columns, and cells, or activate the cell properties dialog, from which you can create table headers for individual cells, rowspans, and colspans. You can also horizontally align the text of individual cells: left (default), center, right.

Note: fckgLite does not support the FCKeditor's caption or summary features, which are present in versions of fckgLite prior to March 23 2010.

Footnote Editor

You can create footnotes using the native Dokuwiki syntax for footnotes, directly in the text you are editing:

This is a text with ((footnote))

Or you can use the footnote editor, which is accessed from the toolbar using the icon with the number 1 on it. This will hide the footnotes, so that your text will be free of the footnote text; the notes will be added to the document when the document is saved and will appear as end notes. Native Dokuwiki footnotes and footnotes created with the footnote editor can both be used in the same document. They will be combined when the document is saved.

To create a note: click on the footnote icon; enter your note in the text area provided; when finished, click OK. Each note created with the footnote editor will get a unique identifier that will appear as a superscript where the footnote number would normally appear:

This text has a note created by the footnote editor.fckgL1

If you want to edit the footnote, click on the footnote icon in the toolbar and enter the id in the space provided; click the “Load Note in Editor” button and the note will appear in the text area provided, where you can edit the note; when finished, click OK.

Note: The footnote editor does not work in Safari and Chrome.You must use the standard Dokuwiki parentheses syntax.

Geshi Code Blocks and Downloadable Snippets

You can create syntax highlighted Geshi code blocks and downoadable code snippets using the Geshi toolbar item:

To create the code block you must select the language frm the drop-down list of language names, If you are creating a snippet, you must also enter a filename in the file name text block. You can create an empty code block and then enter the text to be highlighted. Or, you can first enter you text into the editor, select it with your mouse, and then click on the Geshi tool.

The highlighting does not occur until after you've saved your document. After an initial save the highlighting will appear in both the browser and the editor. Similarly, if you edit an already highlighted block, the new text will not be highlighted until after it is saved.

For examples of using the code facility see the faq.

Smileys

You can create smileys that come with the FCKeditor and smileys that are native to the Dokuwki editor, using the smiley toolbar item. For tips on using and editing smileys, see the faq.

Editing Issues

HTML Conflicts

Versions prior to 0.02

The page contents of web pages are formatted using HTML . Angle brackets are an essential tool of the HTML markup language. Unless they are 'disguised', the editor will not be able to differentiate your angle brackets from those of the HTML . There are two ways to disguise these brackets: one is to put the opening bracket or both brackets in italics: <angle brackets>. Another is to leave spaces around the content inside the brackets: <angles >

Here is the HTMLfor creating bold text:

<b>DokuWikiFCK</b>

Without placing the angle brackets in italics, we would get this:

DokuWikiFCK

See above the Stet plugin .

Version 0.02 and Later

Starting with version 0.02.09-Dec_13-11_07, the escaping of HTML brackets is handled by the editor. See the Changelog for December 2009 (11 Dec) for a detailed explanation.

Here is html code using current versions of fckgLite:

<b>This is bold but not bold</b>

It is not necessary to escape the above code; fckgLite does it for you. You cannot use the <html> tag or the <body> tag without manually escaping them. So, here, in this sentence, I have escaped both <html> and <body> by italicizing the opening angle bracket of each.

See also the :faq page on HTML .

Removing Links

  1. Place your cursor on the link. The “Remove Link” tool, will no long be grayed out. Click on it and it will romve the link.
  2. Right-click on the link and select “Remove Link” from the pop-up context menu.

Creating Email Links

Use the link tool and select the email option from “Link Type” menu. If you type in an address such as jsmith@abc.org you will get this:

jsmith@abc.org

If you first type in some text, you can select it with your mouse, open the link editor and then enter the email address. For instance, if you type in “write to jsmith at our organization” and highlight “organization”, you can then type in the email address in the email address field, and you will get this:

write to our organization.

Deleting Images

After a page has been saved, DokuWiki places image inside a link, so that when you click on the image you are directed to a new page with the image and the details about the image. In order to delete an image you must first delete the link. To remove the link, place your cursor on the image and follow the procedure for removing links described above. Then you can delete your image.

Normalizing

Under the “Format” menu, the first item is “Normal”. Use this item to remove the Header markup from Headers which have underlining. You can also use it to remove The formatting from Non-parsed blocks.

Backed into a corner, use the Back-space Key

Sometimes the FCKeditor seems to back you into a corner. For instance, you may have deleted a heading created by the Format menu without Normalizing. The text for the heading may be gone but the editor sometimes leaves behind hidden header markup. Consequently, your text will be indented, as though the header were still there. Use the Back-space key to back out of it.

Lines created with the horizontal line tool are also difficult to get rid of. Hit them with the Back-space key. Other places you might get hung up are non-parsed blocks or tables that you can't get out of. Again, the Back-space key will usually work. But in these cases, saving your document and re-loading may help to back you out of a corner.

Using Dokuwiki Markup

A great number of the Dokuwiki markup characters will be recognized by fckgLite. For instance, you can type the following and you will get a link: [[ start|start]]. Or { {:dokuwiki-128.png} } and you will get an image.

Both of the preceding have been 'escaped' by setting the markup characters in monospace, selected from the “Style” menu. This prevents them from being active as they would be if not escaped. Where the markup consists of two characters, as in the case of the brackets above, it is only necessary to escape one bracket of each bracket-pair. But if you escape both, then they have to be escaped individually. For instance, one and two em dashes can be created with hyphens, as follows: -- gives you –, and --- gives you —. Each bracket has been individually escaped, so that they all are the same size in the final output. But if you group the hyphens and mark them as monospace in one unit, then the escaping will not work.

Warning!!

If you want to switch from the fckgLite editor to the native Dokuwiki editor: Click “DW Edit”, then when you get to the Dokuwiki editor, click “Cancel” and then re-open your file. It is not safe to switch directly from the fckgLite editor to the Dokuwiki Editor and then to edit and Save. You will end up with data duplication on your page.

Future versions of fckgLite will have an “Exit” button on this screen instead of a “Save” to circumvent this problem.

Note: The Exit button has now been implemented as of Apr 24 2010.

I have had a report that data has been lost when switching to “FCK Preview”. I believe this has been resolved but if it happens to you and you are using one of the dailies, please write to the mailing list.

Note: The “FCK Preview” screen has been eliminated from version 4 of fckgLite and from later versions of fckgLite 3.