Hey guys! I'm happy to announce that I'm now working with Bill to setup our guide on the Mac OS Forge servers as http://guide.macports.org. In doing that I'm also testing it's automated regen, so that we can trigger it as a post-commit hook against the trunk/doc-new sources. We're experiencing some errors and warnings, however: alpha:/tmp/mpdoctest root# make guide mkdir -p guide/html cp guide/resources/docbook.css guide/html/docbook.css cp guide/resources/images/* guide/html/ xsltproc --xinclude --stringparam html.stylesheet docbook.css -- stringparam section.autolabel 1 --stringparam toc.section.depth 1 -- stringparam generate.toc "book toc" --stringparam section.label.includes.component.label 1 --stringparam profile.condition "noman" --output guide/html/guide.html \ /opt/local/share/xsl/docbook-xsl/xhtml/profile-docbook.xsl guide/ xml/guide.xml WARNING: cannot add @xml:base to node set root element. Relative paths may not work. Error: no ID for constraint linkend: development.phases. Error: no ID for constraint linkend: reference.livecheck. Error: no ID for constraint linkend: reference.keywords.global. ID recommended on section: General ID recommended on section: Dependencies ID recommended on section: Port and Non-Port Dependencies ID recommended on section: Variants ID recommended on section: Livecheck / Distcheck ID recommended on section: Installation Phase Keywords ID recommended on section: A Word about Keyword List Modifiers (-ap... ID recommended on section: Common Uses for Keyword List Modifiers ID recommended on section: A Word about Keyword Argument Modifiers ... ID recommended on section: Fetch Phase Keywords ID recommended on section: Fetch from CVS ID recommended on section: Fetch from Subversion ID recommended on section: Checksum Phase Keywords ID recommended on section: Extract Phase Keywords ID recommended on section: Patch Phase Keywords ID recommended on section: Configure Phase Keywords ID recommended on section: Configure Universal ID recommended on section: Automake and Autoconf ID recommended on section: Build Phase Keywords ID recommended on section: Destroot Phase Keywords ID recommended on section: StartupItem Attributes ID recommended on section: Executable StartupItems ID recommended on section: Script StartupItems ID recommended on section: Loading / Unloading StartupItems into la... ID recommended on section: StartupItem Internals ID recommended on refentry: PORTGROUP ID recommended on refentry: PORTHIER Anyone care to comment on them? Regards,... -jmpp
On Fri, Dec 07, 2007 at 10:12:16PM -0400, Juan Manuel Palacios wrote:
Hey guys!
I'm happy to announce that I'm now working with Bill to setup our guide on the Mac OS Forge servers as http://guide.macports.org. In doing that I'm also testing it's automated regen, so that we can trigger it as a post-commit hook against the trunk/doc-new sources.
We're experiencing some errors and warnings, however:
[snip]
Anyone care to comment on them?
Regards,...
-jmpp
Hi Juan, most of these problems are going to be fixed soon, when we have integrated the data from the old man pages. But I'm not sure how to fix one, it is caused by the xsl file and I don't know very much about xsl code: WARNING: cannot add @xml:base to node set root element. Relative paths may not work. So for now these errors can be ignored and cause no problems for our new guide. Thanks, Simon PS: Mark, have you got my mail regarding the old man pages? -- + privacy is necessary + using http://gnupg.org + public key id: 0x6115F804EFB33229
On Dec 8, 2007, at 9:41 AM, Simon Ruderich wrote:
On Fri, Dec 07, 2007 at 10:12:16PM -0400, Juan Manuel Palacios wrote:
Hey guys!
I'm happy to announce that I'm now working with Bill to setup our guide on the Mac OS Forge servers as http://guide.macports.org. In doing that I'm also testing it's automated regen, so that we can trigger it as a post-commit hook against the trunk/doc-new sources.
We're experiencing some errors and warnings, however:
[snip]
Anyone care to comment on them?
Regards,...
-jmpp
Hi Juan,
most of these problems are going to be fixed soon, when we have integrated the data from the old man pages.
Good to hear!
But I'm not sure how to fix one, it is caused by the xsl file and I don't know very much about xsl code:
WARNING: cannot add @xml:base to node set root element. Relative paths may not work.
I don't know any xsl code either, unfortunately! Can't help you there :-(
So for now these errors can be ignored and cause no problems for our new guide.
I have to be honest that I hadn't tried generating the guide locally, so I thought the errors were fatal. But it turns out they aren't so I predict we'll have the guide up on the official web server really soon now! One thing I'd like to ask, though... how about this little patch: Index: Makefile =================================================================== --- Makefile (revision 31776) +++ Makefile (working copy) @@ -45,7 +45,7 @@ mkdir -p $(GUIDE-RESULT) cp $(GUIDE)/resources/$(STYLESHEET) $(GUIDE-RESULT)/$(STYLESHEET) cp $(GUIDE)/resources/images/* $(GUIDE-RESULT)/ - xsltproc --xinclude $(STRINGPARAMS) --output $(GUIDE-RESULT)/ guide.html \ + xsltproc --xinclude $(STRINGPARAMS) --output $(GUIDE-RESULT)/ index.html \ $(GUIDE-XSL) $(GUIDE-SRC)/guide.xml man: Renaming the generated file from "guide.html" to "index.html" will allow us to load a standard guide.macports.org URL and have the guide spring up right there without having to request an explicit file (guide.macports.org/guide.html). Seems better to me like that.
Thanks, Simon
Regards,... -jmpp
On Sat, Dec 08, 2007 at 10:46:49PM -0400, Juan Manuel Palacios wrote:
[snip]
I have to be honest that I hadn't tried generating the guide locally, so I thought the errors were fatal. But it turns out they aren't so I predict we'll have the guide up on the official web server really soon now!
[snip]
Renaming the generated file from "guide.html" to "index.html" will allow us to load a standard guide.macports.org URL and have the guide spring up right there without having to request an explicit file (guide.macports.org/guide.html). Seems better to me like that.
Regards,...
-jmpp
Hi Juan, renaming the guide file to index.html is a good idea so I just committed it to SVN. I also committed [31828] which adds much data of the old portfile.7 man page (but we are not finished). This fixes some missing ids and so some warnings. It would be very nice if you or any other who is willing to help could check if we made any mistakes or knows how to fix some missing defaults (marked as ???) or other todos (marked as TODO). Thanks. Thanks for the idea and your help, Simon -- + privacy is necessary + using http://gnupg.org + public key id: 0x6115F804EFB33229
On Dec 9, 2007, at 11:26 AM, Simon Ruderich wrote:
On Sat, Dec 08, 2007 at 10:46:49PM -0400, Juan Manuel Palacios wrote:
[snip]
I have to be honest that I hadn't tried generating the guide locally, so I thought the errors were fatal. But it turns out they aren't so I predict we'll have the guide up on the official web server really soon now!
[snip]
Renaming the generated file from "guide.html" to "index.html" will allow us to load a standard guide.macports.org URL and have the guide spring up right there without having to request an explicit file (guide.macports.org/guide.html). Seems better to me like that.
Regards,...
-jmpp
Hi Juan,
renaming the guide file to index.html is a good idea so I just committed it to SVN.
Gut, thanks!
I also committed [31828] which adds much data of the old portfile.7 man page (but we are not finished). This fixes some missing ids and so some warnings.
Gut ;-)
It would be very nice if you or any other who is willing to help could check if we made any mistakes or knows how to fix some missing defaults (marked as ???) or other todos (marked as TODO). Thanks.
Most certainly! I already have a few comments that I'll put into working patches as time becomes available.
Thanks for the idea and your help, Simon
Thank *you* for the effort in revitalizing our crufty documentation! Regards,... -jmpp
On Mon, Dec 10, 2007 at 12:50:17PM -0400, Juan Manuel Palacios wrote:
It would be very nice if you or any other who is willing to help could check if we made any mistakes or knows how to fix some missing defaults (marked as ???) or other todos (marked as TODO). Thanks.
Most certainly! I already have a few comments that I'll put into working patches as time becomes available.
Thats good to hear ;-)
Thanks for the idea and your help, Simon
Thank *you* for the effort in revitalizing our crufty documentation!
I'm glad I can help.
Regards,...
-jmpp
Simon -- + privacy is necessary + using http://gnupg.org + public key id: 0x6115F804EFB33229
participants (2)
-
Juan Manuel Palacios
-
Simon Ruderich