All - After mark's last note about committing to my sandbox I thought it was time to put together some information on how to use and edit Publican documents.
First and most important. all the XML documents are now fully XML compliant with some exceptions in the rexxref document. What that means is that all documents have to fully conform to the DocBook XML standard without exception. Each document now has a proper XML DTD header and has been modified where necessary to conform to the DocBook DTD. In reality, that should have little impact on you. If you have been committing changes to ooRexx documents then you can almost continue your work without much impact or change. The real change will come when you want to compile the documents. Ypu will need to install the Publican software on your system. To do that please consult the Publican User's Guide for instructions. It is available at http://jfearn.fedorapeople.org/en-US/Publican/2.7/html/Users_Guide/ There is a Makefile for each document. Please make sure that your current directory is the same as the location of the Makefile. Befor compiling you first document you MUST compile and install the brand. To do this 1. CD to the publican oorexx subdirectory. 2. make brand 3. make install The Makefile is currently only for *nix systems. I have not created one for Windows yet. To compile a document 1. CD to the publican document directory containing the Makefile 2. make pdf 3. make html The compiled documents will be off the current directory in tmp/en-US/pdf and tmp/en-US/html respectively. Also note, Publican expects documents to be contained in a special directory tree layout. Please do not move file around in the directory tree as things will begin to go really bad if you do. Here are some additional notes in no particular order. 1. In compiling the existing documents I have noticed that the error message sometimes are not accurate in reporting the offending line number in the document. Sometimes they point much further down in the document where a tag closes a section of code that actually contains the error. You should only run into this if commit large blocks of code and it contains errors. 2. Before we go full production I am going to replace the <link> tags in all the documents and replace it with the <xref> tag. The <link> tag is causing a warning message for every instance of the tag. So do not use this tag in the future. Use the <xref> tag instead. 3. In case you are wondering about the en-US directories in each document tree there is a reason for it existing. Publican can be used on XML documents in multiple languages. Each language's document gets its own directory. Currently we only support United States English. So do NOT remove the en-US directory. Publican will not work without it. 4. The Publican XML parsing is VERY strict. If the document violates the DTD in any way the compile process will halt. Publican parses ALL the XML documents in the en-US directory whether they are used in the document or not. So be careful about putting temporary XML files in the en-US directory as they will be parsed and an error in them will cause the compile to stop. 4. Unfortunately, Publican can not process pdf images. I had to fall back to using the png version where necessary. Both jpg an png files (and a lot more) are acceptable. That is all I can think of at the moment. If you have other questions please do not hesitate to ask. David Ashley ------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/ _______________________________________________ Oorexx-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/oorexx-devel
