Contextual aid and tips for putting texts on-line

One key aspect of using co-ment® is making texts available on-line. As a user, you have a choice between writing the text on-line or uploading it from a file on your computer. In both cases you must choose a target format for the text: either a structured wiki-type format such as the pandoc version of markdown we use in co-ment, or simply HTML.

We have now put in place a contextual aid to help you making the proper decisions at these steps. By bringing your pointer on the question mark icon after the corresponding dropdown menus, you will obtain information on the meaning of each choice. Here is a summary of all possible situations:

  • For writing a text on-line and revising it based on comments, choose Create a text and then markdown format.
  • For submitting a web page to comments, choose Create a text, then HTML format and paste the contents of the Web page in the editor.
  • When starting with a text processing document with complex formatting (images, tables) and having no plan to revise it within co-ment: choose Upload a text and then HTML format.
  • When starting with a text processing document with no complex formatting or planning to revise it within co-ment: choose Upload a text and then markdown format. Note that if the text has complex formatting, some format editing in markdown may be necessary.

When you are editing a markdown text, the graphical editor will provide you with the essential formating functionality. See the detailed presentation of markdown syntax, and its pandoc flavor. Finally here are some important tips regarding [pandoc] markdown formatting:

  • To force line returns, put two trailing spaces at the end of a line
  • To create endnotes use the
    ^[text of endnote]
    syntax.
  • Share