- What's New
- How to edit the docbook files
- How to use Oxygen on ROOT docbook tree
- How to open files
- How to edit files
- How to syntax check and fix errors
- How to generate preview of single file
- How to generate complete pdf
- How to generate complete html or in chapters
- How to use vi/emacs on ROOT docbook tree
Oxygen offers several modes to edit a document "Text", "Grid" and "Author" (see the button at the bottom of the editor window). You can use the one you want, but after some time you will very likely find out that the "Text" mode is the more appropriate to edit docbook documents.Oxygen Web Site.
ALittleC++.xml Histograms.xml ROOTandQt.xml AddingaClass.xml InputOutput.xml Threads.xml CINT.xml InstallandBuild.xml Trees.xml CollectionClasses.xml Introduction.xml TutorialsandTests.xml Cover.xml LinearAlgebra.xml Users-Guide.xpr ExampleAnalysis.xml MathLibraries.xml WritingGUI.xml FittingHistograms.xml Networking.xml makeepub.sh FoldersTasks.xml ObjectOwnership.xml makehtml.sh Geometry.xml PROOF.xml makehtmlchunk.sh GettingStarted.xml PhysicsVectors.xml makepdf.sh Graphics.xml Preface.xml pictures Graphs.xml PythonRuby.xml HTMLDoc.xml ROOTUsersGuide.xml
The *.sh files are scripts to build the various formats of the ROOT User's Guide, (from the xml files). The pictures directory contains all the pictures in .png format. Users-Guide.xpr is the master file for the Users' Guide.
Double click on the chapter you want to edit ad it will appear in the central part of the Oxygen window. Then you can choose and the bottom with editing mode you want to use: "Text", "Grid" or "Author".
In "Text" mode you edit directly the xml file as you would in a normal text editor. The "Grid" mode gives a hierarchical view of the document. The "Author" mode is more "WYSIWYG". From now on lets assume we work in "Text" mode.DocBook: The Definitive Guide.
But the simplest/best way to learn the syntax is surely to look at the ROOT User's Guide. Oxygen is a great help also to learn. Once you start typing a tag it automatically proposes you the valid ones and write the closing tag at the same time.
The tag attributes appear in the top right subwindow. A green square at the top right of the edited file tells that the file syntax is correct. As soon as a mistake appears, this square becomes red and a red mark on the slider on right locates it in the file.
For instance, if you type a piece of text outside any tags (this is a common mistake), you immediately see the red lights flashing !
Three of them are related to the ROOT User's Guide. They allow to generate HTML or PDF versions of the chapter you are currently editing. To do that, just choose the transformation you want to perform and press the little red arrow top left.
- "ROOT Docbook HTML" generates the HTML version in one single file.
- "ROOT Docbook HTML - Chunk" generates the HTML version in several separated files (chunks).
- "ROOT Docbook PDF" generates the PDF version in one single files.
$ cd $ROOTSYS/docbook/users-guide $ ./makepdf.sh
$ cd $ROOTSYS/docbook/users-guide $ ./makehtml.sh
Complete html in chapters:
$ cd $ROOTSYS/docbook/users-guide $ ./makehtmlchunk.sh
cd $ROOTSYS/docbook/users-guide scp ROOTUsersGuide.pdf firstname.lastname@example.org:doc/ scp pictures/* email@example.com:doc/pictures/ scp chunks/* firstname.lastname@example.org:doc/ROOTUsersGuideHTML/