Next / Previous / Contents / Shipman's homepage

6.6. root(): Generate the root element

root(s)
s

An instance of class sox.Sox that manages the output XML stream. For links to the documentation for this class, see Section 2, “XSL-FO resources”.

This function writes the opening <root> tag of the root element of the output XSL-FO file. The function returns a token, a sox.Elt instance, that you must use later to generate the closing tag. When all the document's content has been generated, be sure to call the .end() method of this token, and then close the Sox instance by calling its .close() method. If you don't perform both these steps, there is no guarantee that the file will have been written completely to the output file.