Overview
The overall documentation within this website is based on a book hierarchy that is typical of a standard tree structure. As we first get rolling with the site, the first priority is to get content into the site and put it somewhere that seems reasonable. To the extent you can edit and clean up some of the content as you insert it, that will be welcome.
We will go through an editing phase to arrange the content in an optimal organization so that we can drive towards some excellent administration guides and supporting documentation to tie tightly with FreePBX.
FreePBX terms
You will note the FreePBX field at the top of the documentation. This is a category field, also known as terms in Drupal. This field should be populated sparingly and intelligently as I will explain next. It is currently free-form, kind of. As you start to type, the ajax powered field will pull existing terms and give you a pull down list. It is best to try and use existing terms. However, as we build up the site, new terms are needed. We will eventually lock this down to a set of terms.
These terms are used to auto generate the Related Content field that you will notice as you navigate through some of the pages. It is not important right now as to where we put that related content (at the bottom, inline somehow, etc.). The concept is that we will have the ability to provide links to related content. The easiest way to describe what we are trying to do is by a couple of examples.
Assume you are creating the Ring Groups page. You may (or may not) want to add Follow Me and/or Queues to that page to have content tagged with those show up in the related content. Another example may be creating the IVR page. One might consider tagging it with Announcements and System Recordings and Destinations.
In the above example, the help system will become very powerful. For example, a How To is written up about Ring Strategies or Tips & Tricks with the IVR, as examples. By simply tagging those articles with the appropriate tags, they will automatically be pulled into the related content.
So ... the ability is very powerful but if it gets used too much (to many related tags) then you end up with long lists of related content that become less useful. So careful thought should be put in. (Don't worry though, they can always be edited).
WYSIWIG Editor when Importing Content
The TINYMCE WYSIWIG Editor is made to work in BBCode mode and more geared towards original content creation. I have seen some issues using it when trying to paste content I am bringing over. Or it displays the content all smashed together when in WYSIWIG mode. Some of the filter settings have been changed to help deal with this but it continues to be a problem and may require more tweaking. What I have found most successful when importing from other places (like my Wordpress Articles) has been to copy the html code, and paste it into the editor screen with WYSIWIG turned off. Then make sure to choose html or filtered html for your format.
A note on formatting. If you have code blocks, you can use the BBCode [code] format or if doing html, you can use the <code> tag. Filters have been installed to format these as shaded code blocks.
Last note on TINYMCE. You can change your own default setting when going into edit mode. Mine has been changed to disabled by default. It really seems to speed up the page load time. You do this in your user configuration screen.
WYSIWIG Editor and Spell Checking
I find the following useful. Type up your content, then disable rich-text. Once you do that, the FireFox spell checker will kick and and you can go through and fix your typos...
Summary
That's it for now. Please use this place to develop guidelines and helpful information for documentation creation.