close   


DokuwikiFCK is no longer being supported.
It has been superceded by fckgLite and ckgedit.
close   
namespace:
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
 

  

Syntax compatibility

To view the compatibility of fckgLite with Dokuwiki, see the wiki:syntax page. It represents all of the syntax that fckgLite supports. For comparison purposes, to see what it does not support, see the original syntax page which comes as default with Dokuwiki. You will find, for instance, that fckgLite does not the support Dokuwiki quotation markup. You might also consider that the contents of this page has been fully created and formatted using fckgLite.

Toolbar

Most of the the fckgLite toolbar icons are covered here; those which need little explanation can be found on 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.

For instructions on using the Link dialog, see filebrowser, and the section on editing links below.

Nested Lists

To create a nested list you hit the “Nested List” button and to return to the previous level you hit the “Nested List Return” button. This works with both ordered and unordered lists. Hitting the Return button when you are at the top levelwill also bring you back to the margin.

  • Nested List:
  • Nested List Return:

In versions prior to August 25 2013, there were separate buttons for ordered and unordered nested lists. See: Old Nested Lists Buttons

Plugins

Beginning with version 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. The escaping is done automatically by the fckgLite parser. The escapes consist of a number of features, including adding spaces between syntax features and italicizing the open angle brackets. These are removed on saving. See the page on the editing plugins.

In some plugins the syntax will contain characters which will have to be manually escaped, for instance the asterisk. In such cases you can escape these characters using the backslash:

{{ filelist >:\*\.png&style=table&sort=mtime}}

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

Editing a plugin

For a demonstration of how to edit plugin syntax after a save, see plugin_editor.

Immutable Plugins

There is a configuration setting in the Dokuwiki Configuration Manager which enables you to specify 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. This setting is not guaranteed to work with all plugins. You will only know through trial and error.

In versions of fckgLite beginning dated January 2011 and later, the plugin tool can edit plugins that use HTML-style markup, as in the color plugin: <color red/yellow>red on yellow</color>. You have the choice of editing either the enclosed text or the raw plugin markup. Again, this may not work with every plugin.

What determines whether or not an immutable plugin behaves as described above is whether it encloses its text inside an HTML SPAN or an HTML DIV. Plugins that use a SPAN will work as described and these are plugins which generally affect text style. Plugins that use the DIV work on larger blocks of text material. The color plugin, the fontsize2 plugin are compatible with the immutable plugin technique because they enclose their contents inside the SPAN; the note plugin is not, because it uses a DIV.

The Plugin Tool

The icon for the plugin tool is the electric plug:

The plugin tool comes with three options.

1. [deprecated] Escape Plugin Syntax.
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 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 can highlight the text of the plugin and make your edits in the plugin editor. This editor handles most of the escapes correctly and reconstructs the original plugin syntax together with the new additions. But you should always check to make sure that the plugin syntax has been fully restored. This editor is not for use with plugins created by option 1. The plugin editor also edits immutable plugin markup and text, as noted above at immutable_plugins.

3. [deprecated] 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.

  • Note: The stet plugin is now deprecated, use Dowkuwiki nowiki tags instead. The stet option should not be used with current versions of fckgLite.

The plugin tool will also remove the underlying HTML markup that is created when you escape a plugin using option 1 above. Just highlight the plugin and click on the toolbar item. You will be presented with a checkbox that enables you to remove the hidden markup.

Note: Beginning with version 06 of fckgLite, the options marked deprecated above will no longer be available.

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 wrap 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.

The editro, by default, double spaces at the ends of line. To single space, hold down the SHIFT key while hitting the ENTER (or RETURN) key.

Note: You can have only one multi plugin block per editing window. That is, you can have more than one to a page, as long as they are edited in separate section edits.

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.

Keyboard shortcut
For a single line it possible to achieve the same result with a keyboard shortcut: hold down the shift key while hitting the Enter/Return key. The new line will be single-spaced with respect to the preceding line, as in:

Line one
Line two

Creating and Editing Tables

Creating
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.

Editing Using Context Menu
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. See the demo page.

Colspans may be used without issue.

If you use complex tables, there is a new distribution which seems to be able to handle all kinds of complexity and has side benefits in its ability to handle features situtations that sometimes caused errors in markup. See the listings in the :dailies page. With this distribution much of what is said below no longer applies.

There is limited support for rowspans. Specifically, rowspans cannot be assigned to cells in two columns which have overlapping positions and depending upon the complexity of the table, multiple rowspans may still cause problems. Rowspans can be stacked in a single column, e.g. cells 1-2, 3-4 of column 1. Rowspans may be combined with colspans.

In some complex tables involving colspans, the gray background to some of the table header cells sometimes is lost.

If you have need for complex tables, it is recommended that you create them in the native Dokuwiki editor and embed them in your pages using the include plugin. In this connection, see the following posts in the Dokuwiki forum:

https://forum.dokuwiki.org/post/27893
https://forum.dokuwiki.org/post/23840

You can include code blocks in table cells, but they must be the only item in the cell, that is, there cannot be text before or after the code block.

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

For some of the other things you can do with tables see the plugins demo.

Complex tables distribution

There is now an upgrade to fckgLite's table handling. It is aimed at addressing requests for better parsing of complex tables, tables which use multiple col and row spans.

The new table handling algorithm must be turned on; otherwise fckgLite parses tables as in previous versions. There are three ways to turn on the new alogorithm:

  1. A new configuration option: complex_tables. This will cause the new table handlng to be implemented for all tables on all pages.
  2. A new checkbox: Enable Complex Tables. Checking this box will enable the new algorithm for the current page. This must be checked off every time the page is edited, otherwise the earlier table parsing will be in effect.
  3. The ~~COMPLEX_TABLES~~ macro. When this macro is present the tables on the page where it appears will always use the new table parser. This macro should appear at the top of your page. It is implemented as a syntax plugin, which means that the page must be saved before it can come into effect. The way to handle this is to check off the complerx tables checkbox when you first place the macro on your page. After that first use, the page will always be parsed using the table handling.
  4. In version 08 of fckgLite, if the Enable Complex Tables checkbox is checked and the ~~COMPLEX_TABLES~~ macro is not yet on the page, it will automatically be inserted by the parser, insuring that the page will be properly parsed in the future. You can always remove the macro and uncheck the checkbox.

If you do not need complex table handling, then leaving not using the upgraded table handling will have a small speed advantage in the parsing of tables.


See also configuration, option number 22.

Font Plugin Tool

The font plugin is accessed from the following toolbar icon:

Before clicking on this icon, you must first select the text you wish to format. Then the following dialog is opened:

You select a font from the drop-down menu and a size and weight. Font sizes not explicitly designated in the form are entered in the “Other Size” facility.

If you select a text which has already been formatted by the font tool, its characteristics will be displayed in the form:

You can then change any one or more of the elements. Clicking on the “Show Samples” button will open a window showing all of the available fonts in their displayed formats. There are approximately 23 available font styles based on styles common to Windows and OS X. You can add to these fonts by expanding the fonts array FCKConfig.FontNamesArray, which is found in fckeditor/fckconfig.js.

Once you have set the font specifications, you can edit the text in the fckgLite editor; however, if you want to change the font specs, you must select the text with your mouse or keyboard and re-set the font specification using the font tool dialog.

The font tool can be used in conjunction with Dokuwiki's standard typographic features: italics, underline, bold. See the example in the faq.

Selecting Text and Text Background Colors

Click on the “Show Colors” button to open a dialog which will enable you to select your colors from an extensive color chart. Or, you can enter the color names or color hex numbers directly into the text boxes in the main dialog. The left-hand box is for the text color, the right-hand box is for the background color. The “Color Options” drop down menu will give you a number of choices for reverting to earlier color selections or removing the colors entirely.

fckg_font plugin

The font facility is based on a Dokuwiki syntax plugin, fckg_font, which comes with fckgLite and has the following format:

<font size:weight/face;;text-color;;background-color>text</font>

It is this markup that is saved to the Dokuwiki file.

The size can be in points, ems or pixels, as in 12pt, 12px, 2em. The weight is either normal or bold, and the face is the font style of your choice. The face can be a comma separated sequence of fonts, as in CSS, for instance: times new roman, baskerville, serif. The colors can be recognized HTML color names, like red, blue, yellow; or they can be hex values like #0000FF. You can put this markup into the native Dokuwiki editor and it will be recognized by fckgLite. fckgLite treats this markup as a special case of immutable plugin; it cannot be edited using the plugin tool but must be edited with the font tool and its text must be edited directly in the FCKeditor editing window.

Language Support

  • There is a single language file in the plugin's language directory: fckg/fckeditor/editor/plugins/fonts/lang/en.js

Use this file as a template for your own language file and place it in this directory. Then add a reference to your language in fckeditor/fckfconfig.js. Look for the following:

FCKConfig.Plugins.Add( 'fonts', 'en') ;

Then add your language code to the language list, using the two-character ISO_639-1 language code for your language. For instance, for German you would do this:

FCKConfig.Plugins.Add( 'fonts', 'en, de') ;

See the discussion of these language files under the plugin tool in configuation. You can also add your language translations to the javascript language file for your language in fckg/fckeditor/editor/lang. See the template file.

Footnote Editor

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

((This is a footnote using the Dokuwiki syntax, which is the double parenthesis.))

This is a note1) made with the Dokuwiki footnote markup.

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, for instance this: fckgL1

This text has a note created by the footnote editor.2)

If you want to edit the footnote, click on the footnote icon in the toolbar and enter the identifier 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.

You cannot use the footnote editor to edit footnotes that have already been created and saved. The footnote eidtor is to be used only for initially creating footnotes and for editing them before a save.

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

Deleting and Editing Footnotes

Editing the footnote text

After a file has been saved, footnotes are edited in place, in the endnotes area at the bottom of the editing window.

If you are section editing, edit the section in which the note appears. The notes will appear at the bottom of the editing window and you can edit them in place. The same is true if you edit the entire page.

Deleting a footnote

Deleting is a bit trickier than editing. In both your text and in the footnote itself, select the superscripted footnote number. Apply the eraser tool to both. This removes the HTML markup that identifies the footnote. Then delete the footnote itself. You must first apply the eraser. You cannot simply cut the note from your text, either from the body of the text or from the footnote window at the bottom of the editing window.

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 box. 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.

MS Word Paste

The MS Word Paste tool is fairly flexible. It has been tested with MS Word 2000 and Open Office documents. It accepts lists, both numbered and bulleted, and tables. But it does not import images. Nor does it import footnotes; the footnote text will appear at the bottom of your page but it will not link to the footnoted place in your text. However, you can include footnotes by incorporating them into your Word or Open Office document using the standard Dokuwiki double parenethesis notatation.

Once the text is imported into the editor, you may find that you have to do some clean-up.

This tool is probably best used for snippets and not for extended documents. You will have to do your own experimentation.

Signature

In distributions beginning with March 12 2013, the context menu has a signature item. Right-click in the editor window and select Signature. This will create a dokuwiki-style signature: an email link with with user's name and date:

M. Turner 2013/03/12 10:35 —

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 .

  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.

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.

It is also possible to by-pass the link dialog and to use native Dokuwiki syntax directly in the editor:

                     <joe@abc.com>

This will give you the standard Dokuwiki format: joe@abc.com. But if you want to create a named link as in the example of “organization” above, then you should use the link tool.

Deleting Images

After a page has been saved, DokuWiki places an 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. You can also enclose these types of markup in nowiki tags, directly in the text.

<nowiki>[[start|start]]</nowiki>

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 hyphen 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.

For more detail on using the nowiki tag, see the :faq page.

User Interface

The buttons which control the editing window and its functions are fairly self-explanatory.

  1. Save will, of course, save your document.
  2. Cancel will cause the editor to exit without saving.
  3. DW Edit will save your work and exit from the editor; when you next open the editor, you will be in the native Dokuwiki editing window. You can switch back to fckgLite by clicking on the FCK editorbutton, which is added to the Dokuwiki editor's button array but you must save your document first, if you want to retain any edits made in the Dokuwiki editor.
  4. Delete will delete your page completely; a blank page is the result.
  5. Language lets you select the language for the spellchecker. This button appears only if the SCAYT spellchecker is not active.
  6. Back-up saves the current state of the editor window to memory; it also resets the Dokuwiki lock timer and, if more than 30 seconds have passed since the lock time was last set, this button will also cause Dokuwiki to save a draft to disk. There is a configuration setting in the configuration manager which will save the back up to disk in the meta directory; the meta file has the same name as the document with an .fckg extension. It will be saved in the meta directory that matches the document's namespace.
  7. Revert will restore the last saved material to the editing window, replacing whatever is currently there.

The file browser, together with the Link tool and the Image tool, give you access to the files on your Dokuwiki and enable you to load images and links into your documents. The file browser should install automatically but if you have problems, see the file browser documentation. For a tutorial on using the file browser and the link and image tools, see the media page.

1)
Dokuwiki markup note.
2)
Footnote editor note.