Writing Guidelines

General Writing Guidelines

Please refer to the following guide for extensive hints on documentation an tutorial writing styles. Most of them are common sense writing tips, so you can consider them also for blog articles: 

Article Headings

To create a heading, just enter and select your text, and use the "Formats" menu in the editor to apply the desired heading type:

editor format menu

Use headings format for titles:

  • H2 for main article sections (like the title above)
  • H3 for sub-sections (like below)

Sections and sub-sections title will be automatically formatted and numbered when published, and will be linked in the TOC menu on the right site

This is an example sub-section (h3)

Use paragraph titles to separate different important topics within the same section or sub-section. These won't be numbered or listed in the side toc menu.

This is an example pargraph title (Title h4)

 

 Formats and Styles

 

Examples of other format types you can select:

 

BlocQuotes
Use this format format to stress some concept or for a quote

 Definition Term
Definition Description. Use the formats "Definition Terms" and "Definition Description" for lists of item to define and describe. 

 

Check this video about definition terms and description format use

Preformatted

The pre element should be used for text that has typographic formatting
that affects the meaning of the content,
such as in poems, ASCII art, transcripts, and, of course, computer code.
Note that this format doesn't allow automatic text wrapping, and will display an horizontal scrollbar for longer lines

 

Alert boxes

You can create an alert box with the text editor, by formatting any text as "DIV" and the assigning the desired style from the editor drop-down menus: 

Alert message
Use alert messages to provide positive tips to the reader
 

Alert notice
Use alert notice to give some information, or higlight some key points  of the current article

Alert Warning
Use alert warning to stress urgent actions, or behaviours to be avoided 

Alert Error
Error alert might be used for items that might lead to very relevant errors or system crashes

Within boxes you can still style the text and use shift+enter for line breaks

 

Images

 Use this icon to enter the icon manager and insert an image in inour article:

editor image insert

To insert an image:

editor image editor steps

  1. Select the desired image by clicking on its name
  2. Make sure the image path appears in the URL field
  3. Click insert

 

To Upload an image use the "UPLOAD" Icon (4)

 

Insert a popup image

To insert a popup version of your image just click to select it, and then click on "link " icon:

editor link insert

From the link insert panel,

  1. Click on this icon to open the image manager panel and select the image to be shown in popup (see paragraph before)
  2. Click on the "Popup" link, and select "JCE media box popups"

 

editor link popup steps

 

 Add Image Captions

To add an image caption:

  1. Select the image and open the Image Manager "Advanced" panel
  2. Enter your caption text to in the "Title field"

Note: you can add also popup captions from the link manager > popup tab

editor image editor advancedThis is an image caption text!

 

 

 

 

 

 

 

This site uses cookies.

Some of the cookies we use are essential for parts of the site to operate and have already been set. We also use Google Analytics scripts, which all use cookies.
You may delete or block all cookies from this site in your browser options.