RE: simplified docbook plugin (Was: Forrest run works but forrest doesn't)
> -Original Message- > From: Ross Gardler [mailto:[EMAIL PROTECTED] > Sent: Wednesday, August 03, 2005 3:06 PM > To: user@forrest.apache.org > Subject: Re: simplified docbook plugin (Was: Forrest run > works but forrest doesn't) > > Phillip Evans wrote: > > > > Thanks for your time on this. I have done as you outlined. After > > running forrest site in testSDocbook directory I again got > the message > > in the > > console: > > > > BROKEN: > > C:\apachefriends\xampp\htdocs\apache-forrest-0.7\plugins\plugins.xml > > > > > > However all the plugins appeared to be retrieved and > configured as you > > describe. > > Yes the plugin download mechanism doesn't use a local copy of > the file (neither does the docs build anymore, thanks to your > report above). > > > I checked the distribution zip file for forrest and found that > > \apache-forrest-0.7\plugins\plugins.xml was present, so > copied it to > > where it should have been in my installation. I re-ran forrest site > > without problems. > > How can it have been present in the distribution but not in > your installation? Is it safe for me to assume that this is a > problem local to you rather than in the distribution. Yes, safe to assume that. I have no explanation for it not being there in the installation, but a local problem, yes. > > I then ran forrest run in: > > > FORREST_HOME/build/plugins/org.apache.forrest.plugin.input.simplifiedD > > ocbook without problems, and could view sdocbook.html and .pdf > > > > I then tried adding one of my own sdocbook documents, and again had > > the problem of no content. I checked out input.xmap, and > found that it > > had a sourcetype of sdocbook-v1.0, whereas my documents are all > > sdocbook-v1.1 > > > > I assigned sdocbook-v1.0 to a couple of my documents, and > they worked fine. > > > > I suppose it is possible to modify input.xmap so that will accept > > sdocbook-v1.1 as well? > > > > Where should that be done? > > I've updated the plugin for version 4.1.2.5 of the plugin but > there isn't a released 1.1 version that I can see ( > http://www.oasis-open.org/docbook/xml/simple/ ). What is the > public identifier you are using? I've been using a version from docbook.org which although it says it is available at Oasis, actually isn't. It looks like I've mixed up the public identifier in the following. http://docbook.org/xml/simple/1.1/sdocbook.dtd";> Perhaps I should revert to v1.0 for my documents? > > Once I know what we need to add I'll update the plugin. If > you want to do this yourself (and supply a patch please) then > take a look at input.xmap The supported DTD's are listed at > the top of the file and you will need to add a matcher later > in the file, it is pretty much a cut and past job. > Phil
Re: simplified docbook plugin (Was: Forrest run works but forrest doesn't)
Phillip Evans wrote: It would really help if you make your replies inline as I am doing here. If someone This keeps the context of our discussion so that I can remember exactly what we are doing. I write many mails every day and I have a short memory ;-) It also helps make the archives much more readable, that is if a new user has the same problem as you and comes to this mail in the archives they will see a dialog that describes how to diagnose their problem rather than a summary that you discovered the solution. Thanks for your time on this. I have done as you outlined. After running forrest site in testSDocbook directory I again got the message in the console: BROKEN: C:\apachefriends\xampp\htdocs\apache-forrest-0.7\plugins\plugins.xml > However all the plugins appeared to be retrieved and configured as you describe. Yes the plugin download mechanism doesn't use a local copy of the file (neither does the docs build anymore, thanks to your report above). I checked the distribution zip file for forrest and found that \apache-forrest-0.7\plugins\plugins.xml was present, so copied it to where it should have been in my installation. I re-ran forrest site without problems. How can it have been present in the distribution but not in your installation? Is it safe for me to assume that this is a problem local to you rather than in the distribution. I then ran forrest run in: FORREST_HOME/build/plugins/org.apache.forrest.plugin.input.simplifiedDocbook without problems, and could view sdocbook.html and .pdf I then tried adding one of my own sdocbook documents, and again had the problem of no content. I checked out input.xmap, and found that it had a sourcetype of sdocbook-v1.0, whereas my documents are all sdocbook-v1.1 I assigned sdocbook-v1.0 to a couple of my documents, and they worked fine. I suppose it is possible to modify input.xmap so that will accept sdocbook-v1.1 as well? Where should that be done? I've updated the plugin for version 4.1.2.5 of the plugin but there isn't a released 1.1 version that I can see ( http://www.oasis-open.org/docbook/xml/simple/ ). What is the public identifier you are using? Once I know what we need to add I'll update the plugin. If you want to do this yourself (and supply a patch please) then take a look at input.xmap The supported DTD's are listed at the top of the file and you will need to add a matcher later in the file, it is pretty much a cut and past job. Might I suggest that on the initial plugins page on forrest.apache.org that a indication be placed above the download section that this is normally done automatically by forrest, rather than having to follow a link to a second page to find this out. I've added a two sentence description on how to install plugins to the page as you suggest, it will appear on the site next time we update. Still, I have learned heaps more than I would have if it had all gone smoothly, as it obviously does if done right. Next time, read the instructions, Phillip, read the instructions. :-)) Ross
RE: simplified docbook plugin (Was: Forrest run works but forrest doesn't)
Ross, Thanks for your time on this. I have done as you outlined. After running forrest site in testSDocbook directory I again got the message in the console: BROKEN: C:\apachefriends\xampp\htdocs\apache-forrest-0.7\plugins\plugins.xml However all the plugins appeared to be retrieved and configured as you describe. I checked the distribution zip file for forrest and found that \apache-forrest-0.7\plugins\plugins.xml was present, so copied it to where it should have been in my installation. I re-ran forrest site without problems. I then ran forrest run in: FORREST_HOME/build/plugins/org.apache.forrest.plugin.input.simplifiedDocbook without problems, and could view sdocbook.html and .pdf I then tried adding one of my own sdocbook documents, and again had the problem of no content. I checked out input.xmap, and found that it had a sourcetype of sdocbook-v1.0, whereas my documents are all sdocbook-v1.1 I assigned sdocbook-v1.0 to a couple of my documents, and they worked fine. I suppose it is possible to modify input.xmap so that will accept sdocbook-v1.1 as well? Where should that be done? It may have been that downloading the plugins manually meant that they were not installed correctly. Might I suggest that on the initial plugins page on forrest.apache.org that a indication be placed above the download section that this is normally done automatically by forrest, rather than having to follow a link to a second page to find this out. Still, I have learned heaps more than I would have if it had all gone smoothly, as it obviously does if done right. Next time, read the instructions, Phillip, read the instructions. Now to try out the testSDocbook site with some of my documents. Thanks again, Ross. I am using forrest-0.7 -Original Message- From: Ross Gardler [mailto:[EMAIL PROTECTED] Sent: Wednesday, August 03, 2005 2:53 AM To: user@forrest.apache.org Subject: Re: simplified docbook plugin (Was: Forrest run works but forrest doesn't) Phillip Evans wrote: > OK, here is the process I followed and the issues that I have found > while getting forrest to work with sdocbook. Once we have verified that this works (or debugged why it doesn't work) we'll get your sdocbook files working in the new sample site we did. Ross
Re: simplified docbook plugin (Was: Forrest run works but forrest doesn't)
Phillip Evans wrote: OK, here is the process I followed and the issues that I have found while getting forrest to work with sdocbook. I edited forrest.properties to include the sdocbook plugin and the Open Office plugin. I put a (validated) sdocbook file and an Open Office document into 'sample' directory of a freshly seeded site. (I also added some sdocbook files to a 'manuals' subdirectory of 'sample') I edited site.xml to give LH Navigation to these documents. I ran 'forrest' to build a static site. The build was unsuccessful due to some broken links. I downloaded plugin.xml from forrest.apache.org into the plugins directory as the build said that file was missing. (It took me a while to figure that out) I then got a successful build. What build? the build of forrest or the build of your site? I've never heard this one before. There should be no need to download it manually, Forrest retrieves it when necessary. What version of Forrest are you using? The Open Office document converted OK,(except for images) but the sdocbook page had only the header and LH Navigation, no content. The build listing shows all plugins being available and mounts them. Following the documentation from "V5.2. How do I use DocBook as the xml documentation format?" as best as I was able with my limited knowledge, I made the following changes to sitemap.xmap in src/documentation/ : ... After which everything worked. I had presumed that just declaring the sdocbook plugin would do the trick. I needed to move sdocbook2document.xsl because of the This is mixing two issues. That FAQ is about setting up separate handling of docbook files. It has nothing to do with the sdocbook plugin. You are correct in assuming that you just installing the sdocbook plugin should work for you. I'd like to get to the bottom of why it didn't work in your case, maybe you uncovered a bug: You do not seem to have changed any core Forrest files so lets start again: rm -RF FORREST_HOME/build/plugins (this will remove all currently installed plugins) rm the plugins.xml file you downloaded manually. cd PROJECT_HOME mkdir testSDocbook cd testSDocbook forrest seed add org.apache.forrest.plugin.input.simplifiedDocbook to the project.required.plugins property of forrest.properties file forrest site When forrest runs it should retrieve the sdocbook plugin from the forrest site. If you get any errors such as the missing plugins.xml file please post the relevant output from you the console in which you ran the above command. If you get no errors do this: cd FORREST_HOME/build/plugins/org.apache.plugin.input.simplifiedDocbook forrest run http://localhost:/samples/sdocbook.html This will load a page generated from a simplified docbook file in the plugin docs. I just did this with my Forrest install, this works just fine. However, I am using SVN head so it would be great if you could test it with whatever version of Forrest you are using. Once we have verified that this works (or debugged why it doesn't work) we'll get your sdocbook files working in the new sample site we did. Ross
RE: simplified docbook plugin (Was: Forrest run works but forrest doesn't)
OK, here is the process I followed and the issues that I have found while getting forrest to work with sdocbook. I edited forrest.properties to include the sdocbook plugin and the Open Office plugin. I put a (validated) sdocbook file and an Open Office document into 'sample' directory of a freshly seeded site. (I also added some sdocbook files to a 'manuals' subdirectory of 'sample') I edited site.xml to give LH Navigation to these documents. I ran 'forrest' to build a static site. The build was unsuccessful due to some broken links. I downloaded plugin.xml from forrest.apache.org into the plugins directory as the build said that file was missing. (It took me a while to figure that out) I then got a successful build. The Open Office document converted OK,(except for images) but the sdocbook page had only the header and LH Navigation, no content. The build listing shows all plugins being available and mounts them. Following the documentation from "V5.2. How do I use DocBook as the xml documentation format?" as best as I was able with my limited knowledge, I made the following changes to sitemap.xmap in src/documentation/ : I added the following -- -- After this existing section: -- -- I added this: -- -- And I added this section: -- -- After which everything worked. I had presumed that just declaring the sdocbook plugin would do the trick. I needed to move sdocbook2document.xsl because of the mailto:[EMAIL PROTECTED] Sent: Tuesday, August 02, 2005 8:22 PM To: user@forrest.apache.org Subject: simplified docbook plugin (Was: Forrest run works but forrest doesn't) > > It would skin blank pages until I moved that file. > Is this due to a configuration error on my part? Sorry i don't understand what you mean. Have you declared the simplifiedDocbook plugin in your forrest.properties file? David > Anyway, thank you for your assistance > > Phil >
