DocGenerator API: sentences

To add a sentence, you can either use^[1]

There are equivalent methods using a ParagraphElement parent, for example: DocGeneratorAPI.addSentence(ParagraphElementParent, String)

:

• DocGeneratorAPI.addSentence(XMLArticle, String) adds a regular sentence
• DocGeneratorAPI.addSentence(XMLArticle, String, int) adds a regular sentence, and sets its font type
• DocGeneratorAPI.addSentence(XMLArticle, String, SentenceStyle) adds a regular sentence, and sets its style

For example:

  DocGeneratorAPI api = new DocGeneratorAPI();
  api.createModel();
  api.setOutputDirectory(<the wiki directory>);

  // create an article
  XMLArticle article = api.createArticle("the first article");
      
  // add a sentence
  api.addSentence(article, "the regular sentence");      

Combining sentences

Of course, you can combine sentences, new lines, and break. For example, the following code will create this content:

This is a bold text in red
and some text on a new line.

      DocGeneratorAPI api = new DocGeneratorAPI();
      api.createModel();
      api.setOutputDirectory(<the wiki directory>);

      // create an article
      XMLArticle article = api.createArticle("the first article");
      
      // add the text on the first line
      api.addSentence(article, "This is a ");
      
      SentenceStyle style = SentenceStyle.createTypeStyle(FontType.BOLD);
      api.addSentence(article, "bold", style);
      
      api.addSentence(article, " text in ");
      
      style = SentenceStyle.createColorStyle("red");
      XMLTextStyle textStyle = api.addTextStyle(article, style);  
      api.addSentence(textStyle, "red");
      
      api.addBreak(article);
      // add the text on the second line
      api.addSentence(article, "and some text on a new line.");      

Converting new lines and tabulations

If you want to add new lines or tabulations in the middle of a sentence, you must add a break because new lines in the html source does not produce line break or tabulations. However several methods automatically convert new lines in the text to line breaks or tabulations.

For example:

• DocGeneratorAPI.addMultilineSentence(XMLArticle, String) adds a sentence, and will create line breaks if necessary
• DocGeneratorAPI.addMultilineSentence(XMLArticle, String, SentenceStyle) adds a regular sentence, and sets its style. It will create line breaks if necessary

All these methods will correctly handle new lines and tabulations ( \n and \t).

For example:

   DocGeneratorAPI api = new DocGeneratorAPI();
   api.createModel();
   api.setOutputDirectory(<the wiki directory>);

   // create an article
   XMLArticle article = api.createArticle("the first article");
      
   // add some text on two lines
   api.addMultilineSentence(article, "This is a text on the first line\nand on the second line");
   // add some tabulated text
   api.addMultilineSentence(article, "\tThis is a text after a tab");