FX Documentation installs a Pages database to create a new documentation section in your community. The database is designed to mime IPS Community Guides section. But this installation is even more. It includes custom database, custom database fields, database and page templates, custom CSS and JS. It creates automatically TOC (Table of Contents) from subheadings in your content and it wraps the images nicely with alt Tag displayed as image caption. You can use the database for documentations, guides, books and even more.
The database and page can be customized as usual with drag'n'drop blocks, and WYSIWYG editor. Use ready-made widgets that pull in all kinds of data from throughout your community to put it on the documentation page.
TOC is tables of contents. It is useful if you have a long page with some subsections. You can create TOC manually. With FX Documentation TOC is built automatically from your headings. You can see this block right under the page title to the right on desktop or below on mobile.
How do I add subheadings?
There are two ways to add subheadings to your content. You can install an editor plugin Format to get the button into your editor. Or you allow HTML source editing to add headings into the source like this:
<h2>Subheading</h2> The best way is however to use an editor plugin as you can precisely define of who and where can use headings within your community. This plugin is not bind on FX Documentation, the button can be used throughout the whole IPS suite.
Installing Format plugin
Navigate to Customization -> Editor -> Toolbars in the AdminCP. Click the Add Button, and from the next screen select the CKEditor Plugin tab.
Note: The plugin version you install needs to be compatible with the CKEditor version used in your current version of the IPS Community Suite. IPS displays your current version on this form so that you can cross-check the compatibility with the CKEditor website.
Next, download the plugin on your local disc https://ckeditor.com/cke4/addon/format. Return to AdminCP, choose plugin zip file you downloaded, and then submit the form.
If everything installed successfully, you will see the new button shown on the Buttons Not On Editor toolbar at the bottom of the editor management screen. You can now drag it to your active toolbars at the position you like. To manage permissions and areas for the button double click on it. For further customization of your editor, read IPS documentation.
Some SEO and accessibility tips
You should not use H1 Heading more than one time on your page. The record title is already formatted as H1. You should start with H2 within your content and use a tree structure. E. g. do not use H4 if you do not have H3. TOC can only be displayed correctly if you have a correct logical heading structure.
FX Documentation helps to improve SEO and accessibility while adding images to the content.
Whenever you add an image to the content, you should always fill out an ALT attribute of the image that is displayed if the image cannot be loaded. This attribute is also used by search engines to index images and by disabled people.
After adding an image into your content double-click on it. Fill out the field Image Title and save. The image title will be automatically displayed below the image. See the example below.
This functionality is provided by custom JS script installed with FX Documentation. You cannot see the image title while editing the record. It will be only shown while viewing the record.