Re: [docbook-apps] Show off what you've done with Docbook
Hi, Have any of you PDF + HTML output with Docbook? If anyone has such a project and will be willing to show it off, send some URLs! The MySQL documentation is created and maintained in DocBook XML. The entry point to the docs is here: http://dev.mysql.com/doc/ As you can see, we build a lot of formats from DocBook, including Unix man pages which are created from the same source as the rest of the formats (most documentation teams maintain man pages separately). Last time we cared to do a detailed analysis of our stuff was in 2009; here's a summary: http://dev.mysql.com/doc/index-about.html It's only become more in every respect, more products to cover, more books, more pages, more complexity. We get the "why don't you use X instead, it's so much better" question every once in a while, but DocBook has been working remarkably well for us for more than a decade, and it scales, so we have no plans to move away from it anytime soon. Reasons to consider DocBook in the first place included Norm's (http://docbook.org/tdg/en/html/docbook.html) and Bob's (http://www.sagehill.net/docbookxsl/) great books, by the way. :-) Cheers, Stefan -- Oracle <http://www.oracle.com> Stefan Hinz, MySQL Documentation Manager Oracle MySQL <http://dev.mysql.com/doc> Berlin, Germany, +49-30-82702940 - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] Problem with http://www.sagehill.net
Hi Frank, I’m getting a ”Permanently moved” message when trying to access http://www.sagehill.net Is this site gone? Maybe a temporary failure? I can access it fine, including http://www.sagehill.net/docbookxsl/index.html. I get a 404 for http://www.sagehill.net/personal/ElectricRabbit.htm, but I can live with that. :-) Cheers, Stefan -- Oracle http://www.oracle.com Stefan Hinz | MySQL Documentation Manager | +49-30-82702940 Oracle MySQL http://dev.mysql.com/doc Berlin, Germany - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] Problem with http://www.sagehill.net
Hej Frank, Greetings from Sweden, sunshine and 30 degrees! Beat that if you can... That's easy! Over Pentecost, Berlin had 36, today the maximum is a mere 34. :-) Cheers, Stefan -- Oracle http://www.oracle.com Stefan Hinz | MySQL Documentation Manager | +49-30-82702940 Oracle MySQL http://dev.mysql.com/doc Berlin, Germany - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
[docbook-apps] WebHelp Changes Required For XHTML Validity
Hi guys, While customizing WebHelp to our needs, we found a couple of namespace and validity errors in the XHTML. They should be easy to fix for future versions. Here they are: 1) Namespace errors Every heading on a page causes two XML namespace error. There seems to be a problem with the titlepage templates. There is an empty titlepage div with an empty xmlns="" attribute. div xmlns="" class="titlepage" The xmlns attribute as added to many different HTML elements, e.g: h2 xmlns="http://www.w3.org/1999/xhtml" class="title" style="clear: both" Horizontal rule elements are not properly closed: hr FIX: The XHTML namespace declaration is missing on a couple of the docbook stylesheets. The following needs to be added to the xsl:stylesheet element in the webhelp.xsl and titlepage.templates.xsl files: xmlns="http://www.w3.org/1999/xhtml" 2) WebHelp Search Form The search form for the WebHelp Sidebar is not valid XHTML for the following reasons: The action attribute is a required attribute on the form element. For instance, the form element should have something like: action="" The type attribute on the input element has a value of "search", but the permitted values for this attribute are "text password checkbox radio submit reset file hidden image button ". The value of "search" for this attribute is new in HTML 5. The value for this attribute should be changed to 'text'. The placeholder attribute on the input element is an invalid attribute. The placeholder attribute is a new attribute in HTML 5. This attribute should be removed from the form. -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jrgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] GSoC Project Idea: integrated LaTeX output support for the stylesheets
Hi Jirka, The chunked HTML output of the MySQL Reference Manual (see e.g. http://dev.mysql.com/doc/refman/5.6/en/index.html) took about 12 hours to build, as opposed to the single-file output which takes just about 3 hours. The remaining 9 hours were entirely spent on chunking the HTML with XSLT (aka the DocBook XSL standard way of doing this). Last year, we created a chunker.py Python script that chunks the single-file HTML (which is now the only HTML variant we're building with XSLT), and it brought down the chunking portion of build time to 3 seconds (no joke!). If chunking takes 4x longer then single page HTML then there is either some problem with XSLT procesor you have used and how it's configured or there is some fundamental flaw in stylesheets which should be discovered by using profiler. Which XSLT procesor you have used? Plain old xsltproc. -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] GSoC Project Idea: integrated LaTeX output support for the stylesheets
Hi Jirka, Which XSLT procesor you have used? Plain old xsltproc. That's not surprising. On larger documents Saxon usually scales much better. First, I would give it try using Saxon (using Sun/Oracle JVM, not gjc :-). Thanks for the hint! I'll give Saxon a try if I can convince my team to not shy away from Java. :-) -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] GSoC Project Idea: integrated LaTeX output support for the stylesheets
Here's a little anecdote from building-huge-docs land: I'm also not concerned about Python as a dependency. It is widely available, and seems to me to be a better tool to translate XML to LaTeX than XSLT. However I'd be happy to learn otherwise.:-) The chunked HTML output of the MySQL Reference Manual (see e.g. http://dev.mysql.com/doc/refman/5.6/en/index.html) took about 12 hours to build, as opposed to the single-file output which takes just about 3 hours. The remaining 9 hours were entirely spent on chunking the HTML with XSLT (aka the DocBook XSL standard way of doing this). Last year, we created a chunker.py Python script that chunks the single-file HTML (which is now the only HTML variant we're building with XSLT), and it brought down the chunking portion of build time to 3 seconds (no joke!). That's just to second Stefan's non-concern about introducing a Python dependency. I'm all for sticking to XSLT as the standard for processing DocBook to other formats, but since Python can provide a performance improvement of factor 10,000 we should probably take it into consideration for other processing things, too. -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] WebHelp bug?
Hi Bob, Thanks for the quick advice, and sorry for a belated reply. I'll investigate what's going on/wrong in our WebHelp customization, and will let the list know what it is once I find out. Cheers, Stefan On 26.02.2013 17:03, Bob Stayton wrote: Hi, Usually that error message comes when trying to process the given element in mode=title.markup or mode=object.title.markup, which triggers using the gentext templates. In this case, an imagedata element is likely being processed in that mode (the imageobject error is an artifact of the stylesheet trying to fall back to the title of the failing element).So look for instances of that mode in the webhelp stylesheet that is not in the other stylesheets. The title.markup mode can also be used when resolving cross references. Does your document contain an xref to an imagedata element? Bob Stayton Sagehill Enterprises b...@sagehill.net -- From: Stefan Hinz stefan.h...@oracle.com Sent: Tuesday, February 26, 2013 3:31 AM To: docbook-apps@lists.oasis-open.org Subject: Re: [docbook-apps] WebHelp bug? Hi David, Thanks for looking into this! Test case attached. I should probably mention I'm using the 1.78.0 XSL style sheets, with a mildly modified webhelp/template/ folder (just a couple of images replaced with branded versions, such as logo and favicon). Here again is the error I'm getting when trying to build WebHelp: No template for /book/chapter/mediaobject/imageobject/imagedata (or any of its leaves) exists in the context named title in the en localization. No template for /book/chapter/mediaobject/imageobject (or any of its leaves) exists in the context named title in the en localization. XPath error : Invalid type xmlXPathCompiledEval: 1 objects left on the stack. Building the following formats works fine, though: - HTML (one file) - HTML (chunked per chapter) - HTML (chunked per section)* - XHTML (one file) - XHTML (chunked per chapter) - XHTML (chunked per section)* - EPUB - FO - PDF * Per-section chunking doesn't make sense for the little test case, but it works flawlessly, anyway. Cheers, Stefan On 25.02.2013 17:02, David Cramer wrote: On 02/25/2013 05:14 AM, Stefan Hinz wrote: Note that the construct that makes WebHelp fail is perfectly legal according to the DocBook DTD. We don't get any errors when building other formats (XHTML, FO, etc.). Since this is specific to WebHelp, I wonder if we've simply hit a bug. Let me know, and I'll file a bug report on SF.net. It's very odd that this would affect only webhelp and not other outputs. Have you tried with just chunked html and htmlhelp? There's nothing in the webhelp directly related to those constructs. Could you post a small test case that causes the problem? I just added that construct to a test document and couldn't get it to fail (using xsltproc or saxon). David - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] WebHelp bug?
Hi David, Thanks for looking into this! Test case attached. I should probably mention I'm using the 1.78.0 XSL style sheets, with a mildly modified webhelp/template/ folder (just a couple of images replaced with branded versions, such as logo and favicon). Here again is the error I'm getting when trying to build WebHelp: No template for /book/chapter/mediaobject/imageobject/imagedata (or any of its leaves) exists in the context named title in the en localization. No template for /book/chapter/mediaobject/imageobject (or any of its leaves) exists in the context named title in the en localization. XPath error : Invalid type xmlXPathCompiledEval: 1 objects left on the stack. Building the following formats works fine, though: - HTML (one file) - HTML (chunked per chapter) - HTML (chunked per section)* - XHTML (one file) - XHTML (chunked per chapter) - XHTML (chunked per section)* - EPUB - FO - PDF * Per-section chunking doesn't make sense for the little test case, but it works flawlessly, anyway. Cheers, Stefan On 25.02.2013 17:02, David Cramer wrote: On 02/25/2013 05:14 AM, Stefan Hinz wrote: Note that the construct that makes WebHelp fail is perfectly legal according to the DocBook DTD. We don't get any errors when building other formats (XHTML, FO, etc.). Since this is specific to WebHelp, I wonder if we've simply hit a bug. Let me know, and I'll file a bug report on SF.net. It's very odd that this would affect only webhelp and not other outputs. Have you tried with just chunked html and htmlhelp? There's nothing in the webhelp directly related to those constructs. Could you post a small test case that causes the problem? I just added that construct to a test document and couldn't get it to fail (using xsltproc or saxon). David - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher attachment: _test.png?xml version=1.0 encoding=utf-8 standalone=no? !DOCTYPE book PUBLIC -//OASIS//DTD DocBook XML V4.5//EN http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd; book id=test chapter id=test-chapter titleThis is just a Test/title para This is a test for a specific construct in the Client/Server Protocol chapter that breaks WebHelp builds. /para mediaobject imageobject imagedata fileref=_test.png/ /imageobject textobject programlisting# This is a just test listing/programlisting /textobject /mediaobject /chapter /book - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
[docbook-apps] WebHelp bug?
Building one of our books in WebHelp format gives a fatal error: No template for /book/chapter/mediaobject/imageobject/imagedata (or any of its leaves) exists in the context named title in the en localization. XPath error : Invalid type xmlXPathCompiledEval: 1 objects left on the stack. A took some investigation to boil down the issue to this: A construct like this makes WebHelp builds fail: mediaobject imageobjectimagedata .../.../imageobject textobjectprogramlisting.../programlisting/textobject /mediaobject The failure doesn't occur when the construct is changed to either of these: a) Replacing programlisting with phrase: mediaobject imageobjectimagedata .../.../imageobject textobjectphrase.../phrase/textobject /mediaobject b) Removing the imageobject: mediaobject textobjectprogramlisting.../programlisting/textobject /mediaobject Note that the construct that makes WebHelp fail is perfectly legal according to the DocBook DTD. We don't get any errors when building other formats (XHTML, FO, etc.). Since this is specific to WebHelp, I wonder if we've simply hit a bug. Let me know, and I'll file a bug report on SF.net. -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] ???TITLE???
Hi Bob, Update on my previous reply: I've tried building with the 1.78.0 stylesheets. Indeed, this gets rid of the ???TITLE??? ugliness, but it still adds the section numbers to the link title, rather than using just the text provided with link. Here's a sample from building with 1.77.1 and then 1.78.0: ~/svn/mysqldoc/refman-5.0 grep explain-output-columns manual.xhtml.1771 a class=link href=#explain-output-columns title=8.2.2. ???TITLE??? Output Columnscode class=literalEXPLAIN/code /p/li/ul/divh4a id=explain-output-columns/a ~/svn/mysqldoc/refman-5.0 grep explain-output-columns manual.xhtml.1780 a class=link href=#explain-output-columns title=8.2.2. EXPLAIN Output Columnscode class=literalEXPLAIN/code /p/li/ul/divh4a id=explain-output-columns/a The corresponding DocBook source is: link linkend=explain-output-columnsliteralEXPLAIN/literal Output Columns/link And the link target is: bridgehead id=explain-output-columns literalEXPLAIN/literal Output Columns /bridgehead Is this another bug, or is it expected behavior? Cheers, Stefan On 15.01.2013 19:22, Bob Stayton wrote: That's a bug that was fixed in version 1.78.0. If you don't want to upgrade, you can add this template to your customization layer: xsl:template match=bridgehead mode=title.markup xsl:apply-templates/ /xsl:template In 1.77.1 and earlier, that template used mode=title.markup for the children when it should not. Bob Stayton Sagehill Enterprises b...@sagehill.net -- From: Stefan Hinz stefan.h...@oracle.com Sent: Tuesday, January 15, 2013 9:29 AM To: DocBook Apps docbook-apps@lists.oasis-open.org Subject: [docbook-apps] ???TITLE??? No, this is not a spam email. :-) While running some XHTML build tests today, I noticed a couple of warnings like these: Request for title of element with no title: literal Request for title of element with no title: link After debugging, to begin with the conclusion, we found these are annoying but harmless. But I'd like to get rid of them, anyway, if possible. :-) The ???TITLE??? things in the output come from constructs that attempt to link to a bridgehead. For example, in one of our files: para The join type. For descriptions of the different types, see link linkend=explain-join-typesliteralEXPLAIN/literal Join Types/link. /para That links to: bridgehead id=explain-join-types literalEXPLAIN/literal Join Types /bridgehead The link becomes this in the output HTML: p The join type. For descriptions of the different types, see a class=link href=#explain-join-types title=8.2.2. ???TITLE??? Join Typescode class=literalEXPLAIN/code Join Types/a. /p So the ???TITLE??? becomes part of the title that is displayed if you hover the mouse over the link, but is not otherwise visible. (That's why it's harmless.) Each of the ???TITLE??? instances corresponds to the presence of a literalsomething/literal in the link content. No idea why the stylesheets don't just use the text of the literal in the title attribute value. Does anyone have an idea what might be going wrong? Cheers, Stefan - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] ???TITLE???
Hi Bob, Again, thanks much for confirming my suspicion and for fixing the bug! Is there a workaround for the 1.78.0 style sheets? Cheers, Stefan On 16.01.2013 20:01, Bob Stayton wrote: Hi Stefan, Yes, this was a bug. There was some confusion in the stylesheet about whether bridgeheads are numbered. Part of the confusion came from DocBook: The Definitive Guide, which said a bridgehead is handled like a section title. However, I just consulted with the DocBook Technical Committee in our monthly meeting, and we agreed that bridgeheads should not normally be part of the section hierarchy and should not be numbered. I fixed the stylesheet in SVN and it should appear in the next snapshot and 1.78.1 release. Thanks for the report. Bob Stayton Sagehill Enterprises b...@sagehill.net -- From: Stefan Hinz stefan.h...@oracle.com Sent: Wednesday, January 16, 2013 7:08 AM To: docbook-apps@lists.oasis-open.org Subject: Re: [docbook-apps] ???TITLE??? Hi Bob, Update on my previous reply: I've tried building with the 1.78.0 stylesheets. Indeed, this gets rid of the ???TITLE??? ugliness, but it still adds the section numbers to the link title, rather than using just the text provided with link. Here's a sample from building with 1.77.1 and then 1.78.0: ~/svn/mysqldoc/refman-5.0 grep explain-output-columns manual.xhtml.1771 a class=link href=#explain-output-columns title=8.2.2. ???TITLE??? Output Columnscode class=literalEXPLAIN/code /p/li/ul/divh4a id=explain-output-columns/a ~/svn/mysqldoc/refman-5.0 grep explain-output-columns manual.xhtml.1780 a class=link href=#explain-output-columns title=8.2.2. EXPLAIN Output Columnscode class=literalEXPLAIN/code /p/li/ul/divh4a id=explain-output-columns/a The corresponding DocBook source is: link linkend=explain-output-columnsliteralEXPLAIN/literal Output Columns/link And the link target is: bridgehead id=explain-output-columns literalEXPLAIN/literal Output Columns /bridgehead Is this another bug, or is it expected behavior? Cheers, Stefan On 15.01.2013 19:22, Bob Stayton wrote: That's a bug that was fixed in version 1.78.0. If you don't want to upgrade, you can add this template to your customization layer: xsl:template match=bridgehead mode=title.markup xsl:apply-templates/ /xsl:template In 1.77.1 and earlier, that template used mode=title.markup for the children when it should not. Bob Stayton Sagehill Enterprises b...@sagehill.net -- From: Stefan Hinz stefan.h...@oracle.com Sent: Tuesday, January 15, 2013 9:29 AM To: DocBook Apps docbook-apps@lists.oasis-open.org Subject: [docbook-apps] ???TITLE??? No, this is not a spam email. :-) While running some XHTML build tests today, I noticed a couple of warnings like these: Request for title of element with no title: literal Request for title of element with no title: link After debugging, to begin with the conclusion, we found these are annoying but harmless. But I'd like to get rid of them, anyway, if possible. :-) The ???TITLE??? things in the output come from constructs that attempt to link to a bridgehead. For example, in one of our files: para The join type. For descriptions of the different types, see link linkend=explain-join-typesliteralEXPLAIN/literal Join Types/link. /para That links to: bridgehead id=explain-join-types literalEXPLAIN/literal Join Types /bridgehead The link becomes this in the output HTML: p The join type. For descriptions of the different types, see a class=link href=#explain-join-types title=8.2.2. ???TITLE??? Join Typescode class=literalEXPLAIN/code Join Types/a. /p So the ???TITLE??? becomes part of the title that is displayed if you hover the mouse over the link, but is not otherwise visible. (That's why it's harmless.) Each of the ???TITLE??? instances corresponds to the presence of a literalsomething/literal in the link content. No idea why the stylesheets don't just use the text of the literal in the title attribute value. Does anyone have an idea what might be going wrong? Cheers, Stefan - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543
Re: [docbook-apps] ???TITLE???
Cool. And yet another thank you so much, Bob! Cheers, Stefan On 16.01.2013 22:41, Bob Stayton wrote: Yes, you should be able to add this: xsl:template match=d:bridgehead mode=is.autonumber xsl:text0/xsl:text /xsl:template xsl:template name=label.this.section xsl:param name=section select=./ xsl:variable name=level xsl:call-template name=section.level/ /xsl:variable xsl:choose xsl:when test=$section/self::d:bridgehead0/xsl:when xsl:when test=$level lt;= $section.autolabel.max.depth xsl:value-of select=$section.autolabel/ /xsl:when xsl:otherwise0/xsl:otherwise /xsl:choose /xsl:template I think that should do it. Bob Stayton Sagehill Enterprises b...@sagehill.net -- From: Stefan Hinz stefan.h...@oracle.com Sent: Wednesday, January 16, 2013 1:09 PM To: Bob Stayton b...@sagehill.net Cc: docbook-apps@lists.oasis-open.org Subject: Re: [docbook-apps] ???TITLE??? Hi Bob, Again, thanks much for confirming my suspicion and for fixing the bug! Is there a workaround for the 1.78.0 style sheets? Cheers, Stefan On 16.01.2013 20:01, Bob Stayton wrote: Hi Stefan, Yes, this was a bug. There was some confusion in the stylesheet about whether bridgeheads are numbered. Part of the confusion came from DocBook: The Definitive Guide, which said a bridgehead is handled like a section title. However, I just consulted with the DocBook Technical Committee in our monthly meeting, and we agreed that bridgeheads should not normally be part of the section hierarchy and should not be numbered. I fixed the stylesheet in SVN and it should appear in the next snapshot and 1.78.1 release. Thanks for the report. Bob Stayton Sagehill Enterprises b...@sagehill.net -- From: Stefan Hinz stefan.h...@oracle.com Sent: Wednesday, January 16, 2013 7:08 AM To: docbook-apps@lists.oasis-open.org Subject: Re: [docbook-apps] ???TITLE??? Hi Bob, Update on my previous reply: I've tried building with the 1.78.0 stylesheets. Indeed, this gets rid of the ???TITLE??? ugliness, but it still adds the section numbers to the link title, rather than using just the text provided with link. Here's a sample from building with 1.77.1 and then 1.78.0: ~/svn/mysqldoc/refman-5.0 grep explain-output-columns manual.xhtml.1771 a class=link href=#explain-output-columns title=8.2.2. ???TITLE??? Output Columnscode class=literalEXPLAIN/code /p/li/ul/divh4a id=explain-output-columns/a ~/svn/mysqldoc/refman-5.0 grep explain-output-columns manual.xhtml.1780 a class=link href=#explain-output-columns title=8.2.2. EXPLAIN Output Columnscode class=literalEXPLAIN/code /p/li/ul/divh4a id=explain-output-columns/a The corresponding DocBook source is: link linkend=explain-output-columnsliteralEXPLAIN/literal Output Columns/link And the link target is: bridgehead id=explain-output-columns literalEXPLAIN/literal Output Columns /bridgehead Is this another bug, or is it expected behavior? Cheers, Stefan On 15.01.2013 19:22, Bob Stayton wrote: That's a bug that was fixed in version 1.78.0. If you don't want to upgrade, you can add this template to your customization layer: xsl:template match=bridgehead mode=title.markup xsl:apply-templates/ /xsl:template In 1.77.1 and earlier, that template used mode=title.markup for the children when it should not. Bob Stayton Sagehill Enterprises b...@sagehill.net -- From: Stefan Hinz stefan.h...@oracle.com Sent: Tuesday, January 15, 2013 9:29 AM To: DocBook Apps docbook-apps@lists.oasis-open.org Subject: [docbook-apps] ???TITLE??? No, this is not a spam email. :-) While running some XHTML build tests today, I noticed a couple of warnings like these: Request for title of element with no title: literal Request for title of element with no title: link After debugging, to begin with the conclusion, we found these are annoying but harmless. But I'd like to get rid of them, anyway, if possible. :-) The ???TITLE??? things in the output come from constructs that attempt to link to a bridgehead. For example, in one of our files: para The join type. For descriptions of the different types, see link linkend=explain-join-typesliteralEXPLAIN/literal Join Types/link. /para That links to: bridgehead id=explain-join-types literalEXPLAIN/literal Join Types /bridgehead The link becomes this in the output HTML: p The join type. For descriptions of the different types, see a class=link href=#explain-join-types title=8.2.2. ???TITLE??? Join Typescode class=literalEXPLAIN/code Join Types/a. /p So the ???TITLE??? becomes part of the title that is displayed if you hover the mouse over the link, but is not otherwise visible. (That's why it's harmless.) Each of the ???TITLE??? instances corresponds to the presence of a literalsomething/literal in the link content. No idea why the stylesheets don't just
[docbook-apps] ???TITLE???
No, this is not a spam email. :-) While running some XHTML build tests today, I noticed a couple of warnings like these: Request for title of element with no title: literal Request for title of element with no title: link After debugging, to begin with the conclusion, we found these are annoying but harmless. But I'd like to get rid of them, anyway, if possible. :-) The ???TITLE??? things in the output come from constructs that attempt to link to a bridgehead. For example, in one of our files: para The join type. For descriptions of the different types, see link linkend=explain-join-typesliteralEXPLAIN/literal Join Types/link. /para That links to: bridgehead id=explain-join-types literalEXPLAIN/literal Join Types /bridgehead The link becomes this in the output HTML: p The join type. For descriptions of the different types, see a class=link href=#explain-join-types title=8.2.2. ???TITLE??? Join Typescode class=literalEXPLAIN/code Join Types/a. /p So the ???TITLE??? becomes part of the title that is displayed if you hover the mouse over the link, but is not otherwise visible. (That's why it's harmless.) Each of the ???TITLE??? instances corresponds to the presence of a literalsomething/literal in the link content. No idea why the stylesheets don't just use the text of the literal in the title attribute value. Does anyone have an idea what might be going wrong? Cheers, Stefan - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] ???TITLE???
Hi Bob, As always, I'm impressed with your analysis. In fact, we're still using 1.77.1, but will switch to 1.78.x in the foreseeable future. Thanks much, also for providing a workaround! Cheers, Stefan On 15.01.2013 19:22, Bob Stayton wrote: That's a bug that was fixed in version 1.78.0. If you don't want to upgrade, you can add this template to your customization layer: xsl:template match=bridgehead mode=title.markup xsl:apply-templates/ /xsl:template In 1.77.1 and earlier, that template used mode=title.markup for the children when it should not. Bob Stayton Sagehill Enterprises b...@sagehill.net -- From: Stefan Hinz stefan.h...@oracle.com Sent: Tuesday, January 15, 2013 9:29 AM To: DocBook Apps docbook-apps@lists.oasis-open.org Subject: [docbook-apps] ???TITLE??? No, this is not a spam email. :-) While running some XHTML build tests today, I noticed a couple of warnings like these: Request for title of element with no title: literal Request for title of element with no title: link After debugging, to begin with the conclusion, we found these are annoying but harmless. But I'd like to get rid of them, anyway, if possible. :-) The ???TITLE??? things in the output come from constructs that attempt to link to a bridgehead. For example, in one of our files: para The join type. For descriptions of the different types, see link linkend=explain-join-typesliteralEXPLAIN/literal Join Types/link. /para That links to: bridgehead id=explain-join-types literalEXPLAIN/literal Join Types /bridgehead The link becomes this in the output HTML: p The join type. For descriptions of the different types, see a class=link href=#explain-join-types title=8.2.2. ???TITLE??? Join Typescode class=literalEXPLAIN/code Join Types/a. /p So the ???TITLE??? becomes part of the title that is displayed if you hover the mouse over the link, but is not otherwise visible. (That's why it's harmless.) Each of the ???TITLE??? instances corresponds to the presence of a literalsomething/literal in the link content. No idea why the stylesheets don't just use the text of the literal in the title attribute value. Does anyone have an idea what might be going wrong? Cheers, Stefan - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] How do you manage your catalogs ?
Hi Richard, I'm not sure it would work for us. We produce software and write our own documentation. And there aren't many of us. What my colleagues are used to is ediiting in Word and producing PDF straight from it using a third-party pseudo-printer (BullZip) (*). Some have started producing CHM instead, based on hand-edited HTML (ie edited in FrontPage or Expression Web). We've been told that neither format is suitable for every one of our customers so I'd like to find a way of generating multiple formats - hence trying DocBook. So from this starting point I think we need a system where everyone can generate any output themselves. The easiest thing to do would be an editor as XMLMind's XXE (as Stefan Seefeld pointed out), or Oxygen XML Editor which my department is using. Creating common formats like HTML, XHTML, PDF, and EPUB is pre-configured in Oxygen, so it's just a matter of a few clicks to produce those formats. At the moment some of the software and documents are produced by a manual build by an individual developer, and others are produced by an automated build. That's actually how we are doing things in my department. We've set up a make-based system that works the exact same way on the central build server and when run locally; for example (for a document named book.xml): * 'make book.valid': runs xmllint and other tools to validate book.xml * 'make book.html' * 'make book.pdf' * 'make book.epub' * etc. The idea is to have an easy-to-remember set of commands that work both locally and centrally, and a system that can be set up fairly quickly. More information can be found here: http://dev.mysql.com/doc/mysqldoc-guide/en/index.html (and the complete tool set is here: http://downloads.mysql.com/docs/mysqldoc-toolset.tar.gz). HTH. -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] Cannot find (possible) markup error
Hallo Michael, Since no one has replied so far, let me make a wild guess. Could it be you're using xrefs that point to elements that have no title? For example, something like this: paraDetails can be found under xref linkend=details/./para para id=detailsHere are more details./para That would be valid, so xmllint wouldn't complain, but xref/ wouldn't find a title at the link target to create a label from. Maybe that's where the warnings come from. See http://www.sagehill.net/docbookxsl/CrossRefs.html for information on xref and friends. Cheers, Stefan On 29.11.2012 10:03, Michael Wiedmann wrote: Given a legacy DocBook 4.3 file, quite large (approx. 640 KB, composed out of several XML files using XInclude). This source file validates w/o any errors/warnings using xmllint. Trying to generate XHTML with the DocBook XSL stylesheets V1.77.1 (*no* customization used, using xsltproc) shows some messages like: Request for title of element with no title: literal (see common/titles.xsl title.markup) I looked all over the file, checking every literal element but could not find any markup error (as well as xmllint!). Any hints how to further track down the (possible) markup errors? Michael - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
[docbook-apps] Zero-width space as line-wrapping workaround?
Does anyone have experience using #8203; -- the Unicode zero-width space character (see http://www.fileformat.info/info/unicode/char/200b/index.htm)? If it works as advertised, it would be helpful for the hyphenation of some of our really_really_super_and_extra_long_option_names, particularly when they're within table cells. For example, this would make sure the table width won't explode when there's a cell like this: entry optionreally_really#8203;_super_and_extra#8203;_long_option_name/option /entry I presume the idea is to have a character that has no visible effect within a keyword, but allows it to be split across lines anyway. Personally, I don't like invisible things like this that could get in the way of grepping through the source. Any other pros and cons? Maybe other/better ways to work around the problem? Cheers, Stefan - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] Zero-width space as line-wrapping workaround?
Hi Thomas, Thanks for advising, and for the hyphenate-url.xsl template! Minor question below. On Mon, 26 Nov 2012 15:09:24 +0100 Stefan Hinz stefan.h...@oracle.com wrote: Does anyone have experience using #8203; -- the Unicode zero-width space character (see http://www.fileformat.info/info/unicode/char/200b/index.htm)? Yes. :) [...] I presume the idea is to have a character that has no visible effect within a keyword, but allows it to be split across lines anyway. Personally, I don't like invisible things like this that could get in the way of grepping through the source. Any other pros and cons? Maybe other/better ways to work around the problem? I had the same concerns with grepping through the sources. For URLs, the solution is very easy. Use the following two parameters: * $ulink.hyphenate Set it to the ZERO WIDTH SPACE character (#x200B; or #8203;). By default, it is empty. * $ulink.hyphenate.chars Defines which characters are considered to contain the ZWS after that character. By default, it's /, but you could extend it with other characters like _, -, , ... These two parameters are used in the hyphenate-url template. This template goes through the string and checks each character, if it's in the set of $ulink.hyphenate.chars. You could use this template as a base for your option template. Any experience with performance impacts? I'm asking because we have quite a few options that would get parsed: ~/svn/mysqldoc grep -R option | wc -l 65219 You can find an example of my modification of hyphenate-url in the daps repository. I needed a finer control which characters should contain the ZWS before or after that character. You can find the code here: https://svn.code.sf.net/p/daps/svn/trunk/daps/suse/xslt/fo/hyphenate-url.xsl Hope this helps. :) Sure, thanks again! -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] Zero-width space as line-wrapping workaround?
Hi Jirka, Any experience with performance impacts? I'm asking because we have quite a few options that would get parsed: I wouldn't be worried. Long time ago DocBook XSL stylesheets contained code which did replacements in each text node in order to go around some PassiveTeX bug. I was worried about performance impact but my testing shown that performance impact is between unmeasurable and 5%. Sounds negligible. Thanks for sharing your experience! -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
[docbook-apps] [ANNC] MySQL tech writer wanted
If you're a tech writer located in Europe or North America, a native English speaker, and looking for a (new) job, check out my blog under https://blogs.oracle.com/mysqlf/ where you can find the details for our recent job opening. If you don't, but happen to know someone who might fit the bill, please refer them to my blog! Thanks in advance! -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
[docbook-apps] Alternatives to bridgeheads
We're currently using bridgehead a lot to emulate section, mostly where we don't want sections to be split out into separate HTML pages (and where we can't prevent that simply via the chunking level). bridgehead has a number of drawbacks, though, one of them being that it's not a container element. I guess we're looking for something that satisfies these requirements: * Produces a separate (not inline) title, unlike formalpara * Takes a title, so that it can be xref'ed without having to supply the link text, unlike bridgehead * Acts as a wrapper around the associated content, unlike bridgehead, and unlike formalpara (which wraps only a limited set of elements, not including lists for example) * Does not produce a standalone section (unlike section which might or might not depending on nesting depth) I don't know of anything like that. Does it exist? Does simplesect do all that? Cheers, Stefan - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] Alternatives to bridgeheads
Hi Bob, Yes, simplesect does all those things. You can control whether or not they appear in the table of contents with the 'simplesect.in.toc' parameter. Perfect. Thanks much! Cheers, Stefan -- From: Stefan Hinz stefan.h...@oracle.com Sent: Thursday, October 18, 2012 3:06 AM To: DocBook Apps docbook-apps@lists.oasis-open.org Subject: [docbook-apps] Alternatives to bridgeheads We're currently using bridgehead a lot to emulate section, mostly where we don't want sections to be split out into separate HTML pages (and where we can't prevent that simply via the chunking level). bridgehead has a number of drawbacks, though, one of them being that it's not a container element. I guess we're looking for something that satisfies these requirements: * Produces a separate (not inline) title, unlike formalpara * Takes a title, so that it can be xref'ed without having to supply the link text, unlike bridgehead * Acts as a wrapper around the associated content, unlike bridgehead, and unlike formalpara (which wraps only a limited set of elements, not including lists for example) * Does not produce a standalone section (unlike section which might or might not depending on nesting depth) I don't know of anything like that. Does it exist? Does simplesect do all that? Cheers, Stefan - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] computeroutput vs screen vs xmllint
Bonjour Mathieu, We are internally using different docbook editors (vi, emacs, serna and xmlmind). To some extent, we would like to preserve a nice and clear history of revision of our XML files in SVN (subversion). For this we use a script based on xmllint --format to reformat to a unique presentation. This has work quite well until today. Could someone please let me know if the following situation is an issue with either XML or docbook itself: ?xml version=1.0 encoding=UTF-8? !DOCTYPE article PUBLIC -//OASIS//DTD DocBook XML V4.5//EN http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd; article section titleIntroduction/title paraBefore/para screencomputeroutputa.txt b.txt /computeroutput /screen paraAfter/para /section /article while xmllint --format prefers: ?xml version=1.0 encoding=UTF-8? !DOCTYPE article PUBLIC -//OASIS//DTD DocBook XML V4.5//EN http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd; article section titleIntroduction/title paraBefore/para screen computeroutputa.txt b.txt /computeroutput /screen paraAfter/para /section /article The latter is wrong. Stuff within verbatim containers such as screen or programlisting shouldn't be re-formatted at all, but rather preserved as is. I'd suggest using Paul DuBois' XML Formatter which does what it's supposed to do. It's included in many Linux distros already, but if it's not in yours (or if you're not using Linux) you can find it here: http://www.kitebird.com/software/xmlformat/ This leads to differences in the fo output with extra spaces. So how does one handles such corner cases ? By formatting (or not formatting) properly. :-) -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] computeroutput vs screen vs xmllint
Bonjour Mathieu, On Tue, Sep 11, 2012 at 10:01 AM, Stefan Hinz stefan.h...@oracle.com wrote: We are internally using different docbook editors (vi, emacs, serna and xmlmind). To some extent, we would like to preserve a nice and clear history of revision of our XML files in SVN (subversion). For this we use a script based on xmllint --format to reformat to a unique presentation. This has work quite well until today. Could someone please let me know if the following situation is an issue with either XML or docbook itself: ?xml version=1.0 encoding=UTF-8? !DOCTYPE article PUBLIC -//OASIS//DTD DocBook XML V4.5//EN http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd; article section titleIntroduction/title paraBefore/para screencomputeroutputa.txt b.txt /computeroutput /screen paraAfter/para /section /article while xmllint --format prefers: ?xml version=1.0 encoding=UTF-8? !DOCTYPE article PUBLIC -//OASIS//DTD DocBook XML V4.5//EN http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd; article section titleIntroduction/title paraBefore/para screen computeroutputa.txt b.txt /computeroutput /screen paraAfter/para /section /article The latter is wrong. Stuff within verbatim containers such as screen or programlisting shouldn't be re-formatted at all, but rather preserved as is. I'd suggest using Paul DuBois' XML Formatter which does what it's supposed to do. It's included in many Linux distros already, but if it's not in yours (or if you're not using Linux) you can find it here: http://www.kitebird.com/software/xmlformat/ $ wget http://www.kitebird.com/software/xmlformat/xmlformat-1.04.tar.gz $ tar xvfz xmlformat-1.04.tar.gz $ cd xmlformat-1.04 $ cp xmlformat.pl /usr/local/bin/xmlformat $ xmlformat input.xml new.xml $ cat new.xml ?xml version=1.0 encoding=UTF-8? !DOCTYPE article PUBLIC -//OASIS//DTD DocBook XML V4.5//EN http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd; article section titleIntroduction/title paraBefore/para screen computeroutputa.txt b.txt /computeroutput /screen paraAfter/para /section /article This is *exactly* what I am trying to avoid. xmllint and xmlformat seems to produce the exact same output. Is it working as supposed on your machine ? Which version are you using ? Darn, sorry for that. :-( I guess xmlformat-1.04 still doesn't include the setting it includes in our setup here: atlas~/svn/mysqldoc-toolset/tools grep screen xmlformat.conf programlisting literallayout synopsis screen In other words, add screen to the respective line of xmlformat.conf, and things should work properly. -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] SEVERE: Image not found
Hi Bob, and Glenn, Thanks much for the pointers! I'll have a look at our customization layer to see what's going wrong. Should be fairly easy to find out, now that I have a clue where to look. :-) Glenn: Sorry for the confusion around FOP. As I said in a subsequent mail, it finally dawned on me that the problem was related to XSL and has nothing to do with FOP. Cheers, Stefan On 25.08.2012 08:22, Bob Stayton wrote: Hi Stefan, If you do not want the images next to note (and the other admonition elements warning, caution, important and tip), then you can set the stylesheet parameter named 'admon.graphics' to zero. That is the default setting in the stylesheet, so someone has reset it to 1 for your process. Also, the path to the icon graphics is set by the stylesheet parameter 'admon.graphics.path', which by default is 'images/'. There is no common in the default path, another indication that some customization has been done. If you can locate the customization stylesheet where those parameters are being set, then you can either turn off the graphics or reset the admon.graphics.path param. That path should be either a full path or a path relative to the .fo file being generated (or the .xml file if you are letting FOP apply the stylesheet). For more information, see: http://www.sagehill.net/docbookxsl/PrintIcons.html#PrintAdmonGraphics Bob Stayton Sagehill Enterprises b...@sagehill.net - Original Message - From: Stefan Hinz stefan.h...@oracle.com To: DocBook Apps docbook-apps@lists.oasis-open.org Sent: Friday, August 24, 2012 6:23 AM Subject: [docbook-apps] SEVERE: Image not found Hi guys, I asked about a FOP problem on the fop-users list, but it turned out to be not a FOP problem, but rather an issue with the DocBook style sheets, thus bringing it up on this list. The issue: When creating PDF, I get lots of warnings like this: SEVERE: Image not found. URI: ../common/images/note.svg. ... This is not severe at all (the PDF builds fine, no issues in the layout, etc.), but the warnings clutter up the output, which makes it hard to identify real issues like overflow problems. So I created FO to see where note.svg would show up. Here's a relevant snippet: fo:blockfo:external-graphic width=auto height=auto content-width=36pt src=url(../common/images/note.svg)//fo:block/fo:list-item-labelfo:list-item-body start-indent=body-start()fo:block space-before.minimum=0em space-before.optimum=0em space-before.maximum=0em font-family=Helvetica,Verdana,Arial,Sans Serif font-size=10pt font-weight=bold margin-left=0.25in margin-right=0.25in border-left=5pt solid black padding-left=0.1in hyphenate=false keep-with-next.within-column=alwaysNote/fo:blockfo:block space-before.minimum=0em space-before.optimum=0em space-before.maximum=0em margin-left=0.25in margin-right=0.25in border-left=5px solid black padding-left=0.1info:block space-before.optimum=1em space-before.minimum=0.8em space-before.maximum=1.2em The logic of the previous example also applies for a relation such as this one: In DocBook, this would be: note para The logic of the previous example also applies for a relation such as this one: So, quite apparently, note.svg is inserted for a DocBook note. (I've confirmed for other instances of note.svg in the FO file.) But when searching the DocBook XSL style sheets (local copy) for note.svg, all I get is this: 2005-01-05 Jirka Kosek ko...@users.sourceforge.net * caution.svg, important.svg, note.svg, tip.svg, warning.svg: New file. No clue as to how the file gets inserted into the FO. :-( Searching e.g. the 1.77.1 DocBook XSL style sheets for note.svg gives me this: docbook-xsl-1.77.1/images/colorsvg/note.svg docbook-xsl-1.77.1/images/note.svg Still no clue why (and how) note.svg is referenced in the FO, but at least it's an existing file, although FOP seems to expect it in a different location (../common/images), thus the error. This looks like a bug in the DocBook XSL style sheets to me, but maybe it's not. In any case, how could I work around this issue, so that the warnings won't show up any more? (I could probably copy note.svg and friends to a ../common/images/ folder for each of our docs, but I'd rather avoid that.) Thanks in advance for any pointers! Cheers, Stefan For example, use fop -xml test.xml -xsl test.xsl -foout test.fo.xml On Wed, Aug 15, 2012 at 7:19 AM, Stefan Hinz stefan.h...@oracle.com mailto:stefan.h...@oracle.com wrote: I've googled for the annoying messages FOP 1.0 spits out, and found quite a few complaints, but no resolution. So here are my questions to you: When converting DocBook XML to PDF, using xsltproc and the DocBook XSL style sheets version 1.77.1 (it's not specific to that version, just saying), I get a gazillion warnings like this: SEVERE: Image not found. URI: ../common/images/note.svg. ... They're
[docbook-apps] SEVERE: Image not found
Hi guys, I asked about a FOP problem on the fop-users list, but it turned out to be not a FOP problem, but rather an issue with the DocBook style sheets, thus bringing it up on this list. The issue: When creating PDF, I get lots of warnings like this: SEVERE: Image not found. URI: ../common/images/note.svg. ... This is not severe at all (the PDF builds fine, no issues in the layout, etc.), but the warnings clutter up the output, which makes it hard to identify real issues like overflow problems. So I created FO to see where note.svg would show up. Here's a relevant snippet: fo:blockfo:external-graphic width=auto height=auto content-width=36pt src=url(../common/images/note.svg)//fo:block/fo:list-item-labelfo:list-item-body start-indent=body-start()fo:block space-before.minimum=0em space-before.optimum=0em space-before.maximum=0em font-family=Helvetica,Verdana,Arial,Sans Serif font-size=10pt font-weight=bold margin-left=0.25in margin-right=0.25in border-left=5pt solid black padding-left=0.1in hyphenate=false keep-with-next.within-column=alwaysNote/fo:blockfo:block space-before.minimum=0em space-before.optimum=0em space-before.maximum=0em margin-left=0.25in margin-right=0.25in border-left=5px solid black padding-left=0.1info:block space-before.optimum=1em space-before.minimum=0.8em space-before.maximum=1.2em The logic of the previous example also applies for a relation such as this one: In DocBook, this would be: note para The logic of the previous example also applies for a relation such as this one: So, quite apparently, note.svg is inserted for a DocBook note. (I've confirmed for other instances of note.svg in the FO file.) But when searching the DocBook XSL style sheets (local copy) for note.svg, all I get is this: 2005-01-05 Jirka Kosek ko...@users.sourceforge.net * caution.svg, important.svg, note.svg, tip.svg, warning.svg: New file. No clue as to how the file gets inserted into the FO. :-( Searching e.g. the 1.77.1 DocBook XSL style sheets for note.svg gives me this: docbook-xsl-1.77.1/images/colorsvg/note.svg docbook-xsl-1.77.1/images/note.svg Still no clue why (and how) note.svg is referenced in the FO, but at least it's an existing file, although FOP seems to expect it in a different location (../common/images), thus the error. This looks like a bug in the DocBook XSL style sheets to me, but maybe it's not. In any case, how could I work around this issue, so that the warnings won't show up any more? (I could probably copy note.svg and friends to a ../common/images/ folder for each of our docs, but I'd rather avoid that.) Thanks in advance for any pointers! Cheers, Stefan For example, use fop -xml test.xml -xsl test.xsl -foout test.fo.xml On Wed, Aug 15, 2012 at 7:19 AM, Stefan Hinz stefan.h...@oracle.com mailto:stefan.h...@oracle.com wrote: I've googled for the annoying messages FOP 1.0 spits out, and found quite a few complaints, but no resolution. So here are my questions to you: When converting DocBook XML to PDF, using xsltproc and the DocBook XSL style sheets version 1.77.1 (it's not specific to that version, just saying), I get a gazillion warnings like this: SEVERE: Image not found. URI: ../common/images/note.svg. ... They're just warnings, but they clutter up the output so that it's hard to spot real problems such as overflow issues. (1) Any idea what causes those warnings? We're not using SVG images at all, just PNG files. Particularly, we're not using files in ../common/images (there's no such directory for any of our books). (2) Assuming it's some FOP-internal thing (a bug?) that cannot be fixed on our end, is there a workaround to stop FOP from issuing those warnings? (3) How would I find out the exact FOP version I'm using? (I'm thinking maybe it's a bug that would be fixed by upgrading to a newer version.) When running fop --version it just reports 1.0. Thanks much for any pointers! -- Cheers, Stefan Hinz stefan.h...@oracle.com mailto:stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940 tel:%2B49-30-82702940, Fax: +49-30-82702941 tel:%2B49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher --__--__- To unsubscribe, e-mail: fop-users-unsubscribe@__xmlgraphics.apache.org mailto:fop-users
Re: [docbook-apps] What is Xml ?
Hi Richard, Please can someone direct me to an authoritative explanation of what constitutes a valid XML file ? Let me try with expert knowledge freshly gained from Wikipedia (http://en.wikipedia.org/wiki/XML#Well-formedness_and_error-handling). For your below document, this means: * The ?xml? prolog is optional. * There's no single root element that contains all the other elements. Therefore, the XML isn't well-formed, and thus not valid. HTH. Cheers, Stefan I've been provided with some XML files which are a bit like this : ?xml? category id=information section id=general element id=fileinfo / /section /category category id=device section id=Status element id=1 / element id=2 / /section /category They are described as XML, together with a note that ... file can be created using any XML editor providing the format and tags required are used, though I get various errors from emacs+nxml-mode, XmlMind and Serna. I think that they are not well-formed, on account of having two root nodes. I'm also a bit surprised by the lack of the usual version, encoding and standalone attributes in the xml PI, though I suspect they are actually optional. And I've just found that it starts with (hex) ef bb bf, before the ? - is that a byte-order mark ? Or just another non-standardness ? I will need to pass this back to the originators so that they can either : 1. Change their software to produce/use real XML. or: 2. Change their documentation to refer to XML-like or similar. In the meantime I'll need to do some sort of processing to get it into a form that I can process. Appreciatively, Richard. Blue line *Richard Kerry* BNCS Engineer T: +44 (0)20 82259063 M: +44 (0)7812 325518 Room EBX 301, BBC Television Centre, Wood Lane, London, W12 7RJ richard.ke...@atos.net mailto:richard.ke...@atos.net uk.atos.net http://uk.atos.net/en-uk/ Atos logo This e-mail and the documents attached are confidential and intended solely for the addressee; it may also be privileged. If you receive this e-mail in error, please notify the sender immediately and destroy it. As its integrity cannot be secured on the Internet, the Atos group liability cannot be triggered for the message content. Although the sender endeavours to maintain a computer virus-free network, the sender does not warrant that this transmission is virus-free and will not be liable for any damages resulting from any virus transmitted. -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
[docbook-apps] 1.77.0 bug with index building?
We're building customized XHTML output for OTN (Oracle Technology Network), for many books. Using the 1.76.1 style sheets, all works fine, but switching to the 1.77.0 style sheets gives an error like this: XML_CATALOG_FILES=../../../mysqldoc-toolset//catalog.xml ../../../mysqldoc-toolset/xsl.d/docbook-xsl-1.77.0/catalog.xml xsltproc --xinclude --novalid \ --stringparam l10n.gentext.default.language en \ --stringparam html.stylesheet mysql-html.css \ --stringparam generate.toc book toc,title \ --param chunk.section.depth 1 \ --output user.xhtml-otn-tmp/ \ ../../../mysqldoc-toolset/xsl.d/mysql-xhtml-otn.xsl \ user-prepped.xml ../../../mysqldoc-toolset/tools/add-index-navlinks.pl user.xhtml-otn-tmp/*.html Cannot find top of index 0, file user.xhtml-otn-tmp/ix01.html make: *** [user.xhtml-otn] Fehler 25 (German for error 25) This is reproducible for all our books. It might not be a bug in the 1.77.0 style sheets, but rather something in our customization layer that must be adapted to work with the new style sheets. However, I'm at a loss how to start debugging this. Any pointers appreciated, and of course I can provide our customized xhtml-otn style sheet if necessary to track down the problem. -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] 1.77.0 bug with index building?
Hallo Thomas, Good catch, thanks a lot! In fact, the cannot find top string comes from one of our Perl (!) scripts that analyzes index terms to create an index navigation bar for long indexes, like the one you can see on http://dev.mysql.com/doc/refman/5.5/en/ix01.html. Not sure why the script works flawlessly with the 1.76.1 style sheets but dies with the 1.77.0 ones, but this should be fairly easy to find out. If our findings yield anything of general interest, I'll post it to this list. Of course, I'll also do so in case this still turns out to be a 1.77.0 bug. Again, thanks much for your reply, and schönes Wochenende! Cheers, Stefan On 01.06.2012 13:25, Thomas Schraitle wrote: Hi Stefan, On Fri, 01 Jun 2012 11:28:12 +0200 Stefan Hinzstefan.h...@oracle.com wrote: We're building customized XHTML output for OTN (Oracle Technology Network), for many books. Using the 1.76.1 style sheets, all works fine, but switching to the 1.77.0 style sheets gives an error like this: XML_CATALOG_FILES=../../../mysqldoc-toolset//catalog.xml ../../../mysqldoc-toolset/xsl.d/docbook-xsl-1.77.0/catalog.xml xsltproc --xinclude --novalid \ --stringparam l10n.gentext.default.language en \ --stringparam html.stylesheet mysql-html.css \ --stringparam generate.toc book toc,title \ --param chunk.section.depth 1 \ --output user.xhtml-otn-tmp/ \ ../../../mysqldoc-toolset/xsl.d/mysql-xhtml-otn.xsl \ user-prepped.xml ../../../mysqldoc-toolset/tools/add-index-navlinks.pl user.xhtml-otn-tmp/*.html Cannot find top of index 0, file user.xhtml-otn-tmp/ix01.html make: *** [user.xhtml-otn] Fehler 25 (German for error 25) I've searched for the string Cannot find top in the stylesheets and couldn't find it. I even grepped the complete SVN repository with the same result. So I guess it might be somewhere in your Makefiles or Perl scripts. To debug it further, grep/search for this string in your build mechanics. Maybe you can locate it there. Another option could be to try remake[1] instead of make. It's an improved error reporting, tracing, and a debugger for make. Frank, my colleague, uses it to debug his Makefiles. The output is a bit... challenging to read, but it could give you some important hints. Hope this helps. :) - [1] http://bashdb.sourceforge.net/remake/ -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
[docbook-apps] Highlighting new contents
We're in the process of rewriting documentation for a software product. We'll be copying over existing docs from the previous product version, but many of the contents will be written from scratch. To make it easy for internal reviewers (mostly the devs) to distinguish new from old, we'd like to highlight the new stuff, for example as text in red. Target format is just XHTML, and new stuff would just be block-level elements (sections, paras mostly). I was thinking of adding a role attribute to the block level elements that contain new stuff, and then processing it so that it comes out as red text or in some other distinguishable way: section role=new, para role=new, etc. But I was wondering if there's a better way of doing this, for example with a new.../new wrapper that I happened to miss in the list of available tags on http://docbook.org/tdg/en/html/docbook.html. :-) -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] Highlighting new contents
Thanks, Thomas! (And thanks Paul and David!) I knew I was missing something. Now guess what a Google search for highlighting changes in DocBook brought up? D'uh. We're after a one-time markup, by the way, so revisionflag is exactly what I was looking for. Thanks much for the quick feedback. Cheers, Stefan On 27.04.2012 12:58, Thomas Schraitle wrote: Hi Stefan, On Fri, 27 Apr 2012 12:24:20 +0200 Stefan Hinzstefan.h...@oracle.com wrote: [... highlight changes ...] I was thinking of adding a role attribute to the block level elements that contain new stuff, and then processing it so that it comes out as red text or in some other distinguishable way: section role=new,para role=new, etc. But I was wondering if there's a better way of doing this, for example with anew.../new wrapper that I happened to miss in the list of available tags on http://docbook.org/tdg/en/html/docbook.html. :-) Don't fiddle with role, there is the revisionflag[1] attribute exactly for this purpose. :) It can hold several values (added, deleted, changed, off) which you can use to highlight your changes. How to use it is described in Bob's chapter Highlighting changes[2]. It would be certainly more convenient to add the attribute automatically. Norman wrote the diffmk utility for this task which expects an old and a new version. It creates a DocBook file which just contains elements with revisionflag attributes and their respective values. I tried it, but it didn't work for me. Maybe things have changed now. To display your changes in your XHTML, use the changebars.xsl customization. It detects the revisionflags and creates aspan tag and a class attribute. So you can style it with CSS. Details are described in Bob's book. Have fun! :-) [1] http://www.docbook.org/tdg/en/html/ref-elements.html#common.attributes [2] http://sagehill.net/docbookxsl/Changebars.html -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] Learning DocBook and related technologies
Hi David, I added links for a few things I know about, but please add other stuff (especially good free web tutorials): http://wiki.docbook.org/LearningDocBook After registering and logging in to Moin Moin Wiki, I can't edit the page because it's listed as an immutable page. Can you change the settings, please? I was going to add the DocCookBook (http://doccookbook.sourceforge.net/html/en/index.html) under Web Tutorials. -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
[docbook-apps] Re: Task list of WebHelp for GSoC 2012
ensive use of xinclude. Imagine you
xinclude some file from some random place on your system
and the DocBook content includes a fileref with a
relative path to an image. The build system has to copy
the image into the webhelp output dir AND adjust the
path to the image to it's new home. Ideally this should
be robust enough to handle whatever weird and random
thing a writer might do. I've implemented a solution for
this that could be adapted.
Enhanced
configurability, together with improved readability of
the code (webhelp.xsl).
These issues are somewhat interwoven; being able to
make WebHelp more configurable is hard when the code is
hard to parse.
Moving
the params and gentext strings into the normal place in
the xsls. Seems a docbook developer already started
doing this.
We'll
provide some specific instructions for this stuff on
what needs to be done.
EASY
Tasks
Remove
the "content" folder in WebHelp output (and thus in the
template). - Easy
This
is fairly easy work. Further, this could be a sub-task
under (parameterize list of files to exclude from
indexing.)
This
could be implemented after (2).
Make
it possible to include the document title in the html
page's headtitle without also having the
document title appear in the search results summary.
Adding
this task here is arguable. Would this be configurable?
If not, would everyone regard this an improvement?
Make
sure we give an informative message if they come to the
page using NoScript or with cookies disabled.
NoScript
is all over the place these days, so the informative
message could even be "please configure NoScript to
allow _javascript_ for this page".
Low
Priority
Add
autocompletion to the search box (This was suggested
by one of the students and is an interesting idea).
This
could of lower priority. Shall we keep this to the
end? `
If
someone dies to implement this, why not, but otherwise
it's a "nice to have" item to the largest possible
extent. :-)
Make
the toc width adjustable (is
this even possible?)
It's
possible, generally. But should look whether this can be
integrated into webhelp design. low prioriy!
Fix
some bugs:
Sidebar
does not remain collapsed when clicking next/previous
Improve
performance in IE 8/9 (remove need for "treat as IE 7
directive")
Adjust
titlepage templates so abstract is not shown by default.
=
--
~~~***'***~~~
Kasun Gajasinghe
Software Engineer; WSO2 Inc.; http://wso2.com,
linked-in: http://lk.linkedin.com/in/gajasinghe
blog: http://blog.kasunbg.org
twitter: http://twitter.com/kasunbg
--
Cheers,
Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager
Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc
ORACLE Deutschland B.V. Co. KG
Registered Office: Riesstr. 25, 80992 Muenchen, Germany
Commercial R
[docbook-apps] Re: Task list of WebHelp for GSoC 2012
Hi Kasun, Did you meant the typewith.me http://typewith.me etherpad we maintained? Seems it's down currently for upgrades. http://www.downforeveryoneorjustme.com/http://typewith.me Ah, OK. I thought David had moved it to another place from Typewith.me. Thanks! BTW, a blog post I wrote covering Moratuwa Google Summer of Code session made to Google Open Source Blog. :)) There's tiny mention of DocBook too. It looks kinda like a contribution from DocBook! Congratulations! Got a URL for me to look at? Cheers, Stefan On Thu, Apr 5, 2012 at 5:30 PM, Stefan Hinz stefan.h...@oracle.com mailto:stefan.h...@oracle.com wrote: Hi Kasun, David, What happened to the online version of our below list? I'm just about to help Visitha get his application finalized, and wanted to have a look at that list on the web. I'm sure I bookmarked it, but all I can find are http://docbook.xmlpress.net/tiki-index.php?page=Ideas2012#Webhelp (just the executive summary) and http://docbook.xmlpress.net/tiki-index.php?page=WebHelpIdeas (a mostly unordered list). Any ideas where the ordered list below can be found? Cheers, Stefan On 30.03.2012 04:18, Kasun Gajasinghe wrote: Hi all, The mentors for webhelp has come up with the following priority feature list to be expected from the possible students for webhelp [1]. If you are eligible to participate, and like to contribute to DocBook, and WebHelp, then join with us. The list provided might look overwhelming at first. For a new user, it always will be. :-) But by the time, it'll be OK. Unless otherwise specified, almost all the tasks expected are moderate. I would classify only one to have a bit of more research involved. The possible students can of course discuss about these and come to an agreement on what needs to be implemented which will match with our objectives, and students current skills plus skills that s/he like to develop. During the proposal period, only keep your focus on first 5 tasks here and (6) a. Please don't hesitate to ask questions you may have regarding the provided tasks, and DocBook in general. There's still time to discuss and submit a proposal. The proposal deadline is April 6th, 19:00 UTC. [1] http://docbook.xmlpress.net/tiki-index.php?page=Ideas2012#Webhelp = 1. *Provide an example Makefile as an alternative to the ant script* 1. Removal of the dependency on Ant. Make WebHelp build with make, so that people using make and xsltproc can build WebHelp. 2. This would be a good starter task for the student to get a feel for how thing work. 3. There might be a sample Makefile to get the implementor of this going, or to give the student some ideas. 2. *Parameterize list of files to exclude from indexing. *Currently it's hard coded that we don't index index.html and ix01.html (the legal notice and index topics). It should be smarter and automatically not index the index file even if it's not named ix01.html. Add to the indexer the ability to specify a list of files or file patterns not to index. Currently it does not index index.html or ix01.html, which is generally appropriate, but it should be up to the user to decide. 3. *Search functionality improvements* 1. Add other search options: 1. Add an option to create webhelp as a webapp using Lucene as the search engine. 2. Strip quotes from search queries (if a user searches for foo bar with quotes, strip the quotes). Currently a quoted search shows no results. 1. That would be a relatively easy and quick fix, and would add a lot of benefit. 4. *Improve image copying functionality to deal with xincluded content.* - This could be blocker for some projects, and it doesn't WYSIWYG IDE friendly. Current image copying feature is very primitive. * This will be a bit of a mindbender for the student, but a good exercise. We'll provide a good demo doc that shows what is needed. * Why issue are we trying to address here? This is more of an issue if you make extensive use of xinclude. Imagine you xinclude some file from some random place on your system and the DocBook content includes a fileref with a relative path to an image. The build system has to copy the image into the webhelp output dir AND adjust the path to the image to it's new home. Ideally this should be robust enough to handle whatever weird and random thing a writer might do. I've implemented a solution for this that could be adapted. 5. *Enhanced configurability, together with improved readability of the code* (webhelp.xsl). These issues are somewhat interwoven; being able to make WebHelp more
Re: [docbook-apps] Re: Task list of WebHelp for GSoC 2012
Hi David, Did you meant the typewith.mehttp://typewith.me etherpad we maintained? Seems it's down currently for upgrades. http://www.downforeveryoneorjustme.com/http://typewith.me Ah, OK. I thought David had moved it to another place from Typewith.me. Thanks! We can replace the xmlpress page with Kasun's updated version...or maybe move our content to the DocBook MoinMoin wiki... Either (or both) is fine by me. Typewith.me seems a little fragile -- already when I added comments a week ago it tended to time out every once in a while. BTW, a blog post I wrote covering Moratuwa Google Summer of Code session made to Google Open Source Blog. :)) There's tiny mention of DocBook too. It looks kinda like a contribution from DocBook! Congratulations! Got a URL for me to look at? Yes, congratulations, it's a great post! I found it here: http://google-opensource.blogspot.com/2012/04/moratuwa-sri-lanka-google-summer-of.html Thanks for the link! We also explained about the value of having connections all around the world and the spiritual happiness open source projects bring in general. Well said, and unfortunately too often forgotten while we're focusing on just the tech. -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] WebHelp display issue
Hi David,
On the other hand, I still think that adding all that color
information is a glitch. As the name implies, positioning.css is
about wheredivs and other things should be positioned, rather
than how they should look like.
Ok, submit a patched version of it that excludes the things that don't
belong. I'll give it a shot. On the one hand we want it to be
configurable, on the other we want it to look ok out of the box. We
could add another css for skinning, but that would be another http
request.
That would basically be the 1.76.1 version with the min-width fix.
Please find it attached.
I've thought about this over the weekend, and I'm wondering if the
approach I'm taking is the right thing to do. Basically, I've copied
over the webhelp/templates directory to a safe location. Of course,
that copy will eventually go out of sync with the templates folder
included in the XSL style sheets, unless I sync over changes manually.
I've done the fork for the following reasons:
* The images folder contains a set of images that we (and probably many
others) will want to replace with their own, customized, images.
* The jquery folder contains a certain theme, theme-redmond. Again, we
will want to customize that by either using a different theme from the
jQuery UI gallery, or by rolling our own from
http://jqueryui.com/themeroller/.
* We will want to use a different favicon.
* Regarding files in content/search, we're considering using the search
improvements made by Peter Desjardins, the most important one being the
ability to search for search strings in quotes, expanding the one-word
search that exists by default.
Granted, the last item could be done as a contribution to the XSL style
sheets, rather than as a customization, if Peter or I can find the time
to extract the changes he made, and provide a patch. But for the rest of
the items (images, jQuery theme, favicon), I see no viable way of
accomplishing customization other than by forking the templates
folder, or by polluting the original style sheets with customized
stuff. Both options don't seem to be optimal.
There's a third option, which would be to make many more things
customizable in the webhelp style sheets. Configuration options would
include:
* Using a different images folder (with the exact same file names), for
example /custom/path/webhelp/ui-images/.
* Using a different jquery/theme-redmond folder, for example
/custom/path/webhelp/theme-darkside.
* Using a different favicon.ico file (with the same name), for example
/custom/path/webhelp/favicon.ico.
Not sure how viable this would be, though. What do you think?
--
Cheers,
Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager
Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc
ORACLE Deutschland B.V. Co. KG
Registered Office: Riesstr. 25, 80992 Muenchen, Germany
Commercial Register: Local Court Of Munich, HRA 95603
Managing Director: Jürgen Kunz
General Partner: ORACLE Deutschland Verwaltung B.V.
Hertogswetering 163/167, 3543 AS Utrecht, Niederlande
Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697
Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher
body { font: 12px Verdana, Geneva, sans-serif; }
p, ul, ol, li { font: 10pt Verdana, Geneva, sans-serif; }
h1 { font: bold 15pt Arial, Helvetica, geneva; }
h2 { font: bold 14pt Arial, Helvetica, geneva; }
#header {
background: white url(../images/header-bg.gif) repeat-x;
position: fixed;
width: 100%;
height: 95px;
top: 0;
right: 0;
bottom: auto;
left: 0;
border-bottom: 2px solid #cc;
z-index: 2000;
}
#leftnavigation {
/* background-color:#91e7b3;*/
overflow: auto;
position: fixed;
height: auto;
top: 90px;
bottom: 0;
left: 0;
width: 280px;
z-index: 1500;
border-right:2px solid #CC;
}
#content {
position: relative;
top: 90px; /* left: 240px;*/
right: auto; /* bottom: 20px; */
margin: 0px 0px 0px 280px;
width: auto;
height: inherit;
padding-left: 5px;
padding-right: 30px;
color: #00;
/*border-left: 2px solid #cc; overflow :scroll;*/
z-index: 1000;
max-width: 70em;
min-width:200px;
}
#navheader {
position: fixed;
top: 65px;
right:4px;
}
#content h1, #content h2 { color: #cc; }
.navfooter { bottom: 2%; }
.highlight { background-color: #c5d3c3; }
.highlightButton{ font-size: 0; }
/* Show Hide TOC tree */
.pointLeft {
background: url(../images/showHideTreeIcons.png) 0 0 no-repeat;
height: 28px;
width: 15px;
display: block;
font-size: 0;
cursor: pointer;
}
.pointRight {
background: url(../images/showHideTreeIcons.png) -15px 0 no-repeat;
height: 28px;
display: block;
font-size: 0;
cursor: pointer;
}
/* Search results Styling */
.searchExpression {
color: #0050A0;
background-color: #EBEFF8;
font-size: 12pt;
}
.searchresult li
Re: [docbook-apps] WebHelp display issue
Hi David,
Follow-up on my mail of Feb 15 (no reply yet). I was looking at
http://snapshots.thingbag.net/xsl/webhelp/template/common/css/ today
since I noticed changes, and -- whoops -- positioning.css is gone! Can
someone put it back, please? :-)
Also, see my comments below, including the attached diff file.
Cheers,
Stefan
Also, I noticed that positioning.css has grown significantly since
the last time I pulled the snapshots (about 12 days ago). The size
has tripled, and from looking at (my) svn diff this is due to the
fact that many, many lines have been added that set colors (for tr,
th, div, span, and many other elements). These look like
inadvertent changes to me, because they would effectively
hard-code colors in the layout.
I don't recall any recent commits, but some of those rules are related
to showing colors for changebars (e.g. if you use the revisionflag
attribute or a tool like DeltaXML to produce diffs).
In its current state, positioning.css is unusable for me, because it
adds background colors in various places that can't be overridden by
jQuery theme settings. The most visible issue is a teal background color
in the top div. The previous (12 day old) version of positioning.css was
good. I'm attaching an svn diff between the two versions so you can see
what I mean.
Cheers,
Stefan
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
iQEcBAEBAgAGBQJPOrSrAAoJEMHeSXG7afUhUWoH/3cHvKgMQiTbzmlbHfXYlpB+
ZZhFAJpaP/QHDmpXNXdiwSOcFqq8MFONdbGcpWnQuIJw8FLnsIsirN1Z9kEHqV6O
vVOCO6JJHOpJdkv43H91rXwVScWGynITwKqCirf8QFmDodKXIsNz3tMin1hzWBSq
CY+GCdc3DhhWwVxlXzTjRaAyP2BgBePWWVAHZrUpLVunz0vQFeR1co3dK6ddizBb
NHffnQ1v6/+bocWbYbFWJjIRTyaa6KpLc7hAbmK3AOuaRAyITjgKv1btILTehZKx
oWYu2iD7xgc8Ci7rWMl0qKs2mwJNPTYYflrT+cqbpA0+UWbZHMDR/CVPV8vnxcc=
=TwIw
-END PGP SIGNATURE-
--
Cheers,
Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager
Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc
ORACLE Deutschland B.V. Co. KG
Registered Office: Riesstr. 25, 80992 Muenchen, Germany
Commercial Register: Local Court Of Munich, HRA 95603
Managing Director: Jürgen Kunz
General Partner: ORACLE Deutschland Verwaltung B.V.
Hertogswetering 163/167, 3543 AS Utrecht, Niederlande
Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697
Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher
Index: positioning.css
===
--- positioning.css (Revision 1046)
+++ positioning.css (Arbeitskopie)
@@ -1,34 +1,107 @@
+tr th .added { color: #E6E6FA; }
+tr th .changed {color: #99ff99; }
+div.added tr, div.added{ background-color: #E6E6FA; }
+div.deleted tr, div.deleted { text-decoration: line-through;
+ background-color: #FF7F7F; }
+div.changed tr, div.changed { background-color: #99ff99; }
+div.off { }
+
+span.added { background-color: #E6E6FA; }
+span.deleted { text-decoration: line-through;
+ background-color: #FF7F7F; }
+span.changed { background-color: #99ff99; }
+span.off { }
+
+
body { font: 12px Verdana, Geneva, sans-serif; }
p, ul, ol, li { font: 10pt Verdana, Geneva, sans-serif; }
-h1 { font: bold 15pt Arial, Helvetica, geneva; }
-h2 { font: bold 14pt Arial, Helvetica, geneva; }
+h1 { font: 15pt Arial, Helvetica, geneva;
+ color: black!important!;
+}
+h2 { font: normal 12pt Arial, Helvetica, geneva; }
#header {
-background: white url(../images/header-bg.gif) repeat-x;
+background: url(../images/header-bg.png) scroll top left repeat-x #4d8c83;
position: fixed;
width: 100%;
-height: 95px;
+height: 99px;
top: 0;
right: 0;
bottom: auto;
left: 0;
-border-bottom: 2px solid #cc;
+border-bottom: 1px solid #bbc4c5;
z-index: 2000;
}
+#header h1 {
+margin-left: 310px;
+position: fixed;
+top: 10px;
+left: -15px;
+color: #404040 !important;
+}
+
+/*
+#header h1 {
+ margin-top: 2px;
+}
+*/
+
+p.breadcrumbs {
+margin-top: 30px;
+margin-left: 310px;
+}
+
+#header img {
+float: left;
+margin-left: 20px;
+margin-top: 12px;
+}
+
+#header p.breadcrumbs a {
+color: #bbb;
+}
+
#leftnavigation {
-/* background-color:#91e7b3;*/
overflow: auto;
position: fixed;
height: auto;
-top: 90px;
+top: 95px;
bottom: 0;
left: 0;
width: 280px;
z-index: 1500;
+border-right:2px solid #bbc4c5;
+padding: 0px;
+background-color: #ededed!important;
+}
+
+#treeDiv {
+overflow: auto;
+position: fixed;
+height: auto;
+top: 136px;
+bottom: 0;
+left: 0;
+width: 243px;
+z-index: 1500;
border-right:2px solid #CC;
+background-color: #f0f0f0!important;
}
+#searchDiv {
+overflow: auto;
+position: fixed;
+height: auto;
+top: 138px;
+bottom: 0;
+left: 0;
+width: 243px;
+z
Re: [docbook-apps] WebHelp display issue
Hi David, Sorry for the delay in replying. I was busy with a deadline. Sounds all too familiar. You have my sympathies. That's weird that apache isn't showing positioning.css in the directory listing. If you go directly to the file, it's there: http://snapshots.docbook.org/xsl/webhelp/template/common/css/positioning.css Confirmed, it's there. Apache still doesn't show it, but now I know. :-) To answer you're original question: Would it help if we provide a param to point to the css of your choice instead of positioning.css? Yes, that would be helpful. On the other hand, I still think that adding all that color information is a glitch. As the name implies, positioning.css is about where divs and other things should be positioned, rather than how they should look like. Cheers, Stefan On 02/17/2012 07:40 AM, Stefan Hinz wrote: Hi David, Follow-up on my mail of Feb 15 (no reply yet). I was looking at http://snapshots.thingbag.net/xsl/webhelp/template/common/css/ today since I noticed changes, and -- whoops -- positioning.css is gone! Can someone put it back, please? :-) Also, see my comments below, including the attached diff file. Cheers, Stefan Also, I noticed that positioning.css has grown significantly since the last time I pulled the snapshots (about 12 days ago). The size has tripled, and from looking at (my) svn diff this is due to the fact that many, many lines have been added that set colors (for tr, th, div, span, and many other elements). These look like inadvertent changes to me, because they would effectively hard-code colors in the layout. I don't recall any recent commits, but some of those rules are related to showing colors for changebars (e.g. if you use the revisionflag attribute or a tool like DeltaXML to produce diffs). In its current state, positioning.css is unusable for me, because it adds background colors in various places that can't be overridden by jQuery theme settings. The most visible issue is a teal background color in the top div. The previous (12 day old) version of positioning.css was good. I'm attaching an svn diff between the two versions so you can see what I mean. Cheers, Stefan -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.11 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iQEcBAEBAgAGBQJPOrSrAAoJEMHeSXG7afUhUWoH/3cHvKgMQiTbzmlbHfXYlpB+ ZZhFAJpaP/QHDmpXNXdiwSOcFqq8MFONdbGcpWnQuIJw8FLnsIsirN1Z9kEHqV6O vVOCO6JJHOpJdkv43H91rXwVScWGynITwKqCirf8QFmDodKXIsNz3tMin1hzWBSq CY+GCdc3DhhWwVxlXzTjRaAyP2BgBePWWVAHZrUpLVunz0vQFeR1co3dK6ddizBb NHffnQ1v6/+bocWbYbFWJjIRTyaa6KpLc7hAbmK3AOuaRAyITjgKv1btILTehZKx oWYu2iD7xgc8Ci7rWMl0qKs2mwJNPTYYflrT+cqbpA0+UWbZHMDR/CVPV8vnxcc= =TwIw -END PGP SIGNATURE- -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.11 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iQEbBAEBAgAGBQJPPmAgAAoJEMHeSXG7afUhopYH+Mm9KE3KATp83qx/MX0MYFg8 RW+OadioQ3oVe/odsfR2E7LX5WvV538Ay/f9AufUylQeUNmXsRmxHAFF/Fx9Y3/G oXOHFW8/oFKTn+6WF/zcPWWqK1ZiZn+grUsQHZszFU08boTC7Rbz/UX5XG73Ai49 SVHhwY4ckxtfYtuGV3jJtZ0E5Pf4CbFYoaZ581ajcBFbrPWjUSb65hJcoRzR7ar0 EkdRUqwbqreqcgQH80pY4sYdKYXG0b31DIzHEtnaEPWTSRMaxXQHj1WCV4iQ0YFL ewJijd3ZIRa97+1SJ2YAu7EHoCOu6IhTNN91qySifmTkkslBCjArnigrvdCEHg== =4lJd -END PGP SIGNATURE- -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
[docbook-apps] WebHelp display issue
Hi guys, WebHelp fan Stefan again. :-) Someone in our group noticed that WebHelp format displays weirdly when the browser window isn't wide enough to fit the contents horizontally. When moving the horizontal scroll bar, the right pane (div) moves under the left pane (the one with the TOC). In the WebHelp builds I've done the right pane's content becomes visible in the left pane. Apparently, the left div is transparent due to some jQuery settings I've changed. In default builds, the right pane's content is obscured when moving under the left pane, as can be seen here (make sure to size your browser window narrow enough for the horizontal scroll bar to appear): http://docbook.sourceforge.net/release/xsl/current/webhelp/docs/content/ch01.html When hiding the TOC tree (click the arrow symbol), and with a browser window that's so narrow that it still displays a horizontal scroll bar, the contents disappear on the left side when scrolling. This issue has been confirmed for a whole bunch of web browsers: Windows: - Google Chrome 16 - Firefox 6.0.1 - IE 9 Ubuntu/openSuse: - Firefox 9.0 - Firefox 6.0.2 - Google Chrome 16 - Chromium 18 (openSuse's Chrome) Looks like a bug to me. Any pointers how to fix this? -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
[docbook-apps] WebHelp display issue
Hi guys, Update (sorry for the extra mail): While the rendering issue has been confirmed on Windows and Linux, someone on Mac OS X just reported that he's _not_ seeing the issue. He's using Firefox 4.0. Cheers, Stefan --- Original mail follows --- WebHelp fan Stefan again. :-) Someone in our group noticed that WebHelp format displays weirdly when the browser window isn't wide enough to fit the contents horizontally. When moving the horizontal scroll bar, the right pane (div) moves under the left pane (the one with the TOC). In the WebHelp builds I've done the right pane's content becomes visible in the left pane. Apparently, the left div is transparent due to some jQuery settings I've changed. In default builds, the right pane's content is obscured when moving under the left pane, as can be seen here (make sure to size your browser window narrow enough for the horizontal scroll bar to appear): http://docbook.sourceforge.net/release/xsl/current/webhelp/docs/content/ch01.html When hiding the TOC tree (click the arrow symbol), and with a browser window that's so narrow that it still displays a horizontal scroll bar, the contents disappear on the left side when scrolling. This issue has been confirmed for a whole bunch of web browsers: Windows: - Google Chrome 16 - Firefox 6.0.1 - IE 9 Ubuntu/openSuse: - Firefox 9.0 - Firefox 6.0.2 - Google Chrome 16 - Chromium 18 (openSuse's Chrome) Looks like a bug to me. Any pointers how to fix this? -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] WebHelp display issue
Hi David,
From your reply, it seems I didn't get my point across. Excuse me
for (a) top-posting and (b) sending a screen shot to the list, but
I think a picture says more than a thousand words in this case.
I don't think the following is expected behavior (this is from
http://docbook.sourceforge.net/release/xsl/current/webhelp/docs/content/ch01.html,
I've just committed the following change to webhelp's css. I think it
will take care of the issue. We should see the result on the snapshot
machine soon:
http://snapshots.docbook.org/xsl/webhelp/docs/content/ch01.html
Thanks! I've pulled the changes, and built with the new CSS file. The
horizontal scroll bar goes away for many of my pages, but when they're
wide (wide graphics, program listings, etc.), it reappears (of course),
and the effect with contents sliding under the left pane comes back. So
I'm afraid adjusting the minimum width didn't fix the issue.
Also, I noticed that positioning.css has grown significantly since the
last time I pulled the snapshots (about 12 days ago). The size has
tripled, and from looking at (my) svn diff this is due to the fact that
many, many lines have been added that set colors (for tr, th, div, span,
and many other elements). These look like inadvertent changes to me,
because they would effectively hard-code colors in the layout.
Cheers,
Stefan
Index: positioning.css
===
- --- positioning.css (revision 9198)
+++ positioning.css (working copy)
@@ -114,7 +114,7 @@
color: #00;
/*border-left: 2px solid #cc; overflow :scroll;*/
z-index: 1000;
- -min-width:800px;
+min-width:200px;
}
#navheader {
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
iQEcBAEBAgAGBQJPOoM9AAoJEMHeSXG7afUhAT4H+wRbSbOAdtyA9S6gDSlaCTjp
kEGffS+fgqBP/KpQEtX+1oOTDi6XHYcgHmuWAQ4hZuj5HX2ShPwXsOolTC1iZJUK
DxnmOXmea0S2FFbzvYv3dS35w+VpwD30Zb0dBXaogQFJ6uQw0rsSP2E9idkeu528
0cARbKXQuBthfo5GyzbX7oRWphlG1w6acmJsxWbOLmqHmT8VGIhE7yQ+Mmx90M8f
rSd/bzmPRA6/jxvYogBV5rD2paGyGTMpnE0ZO2uv/hcbGNcEBmLfOHoMabD8/y+m
lPhgBMF9Cp/qmNDPrsnklKn/RZkjeKmC7NUyG0LAtjzjj+RuaWhbfO3pjKEJfHM=
=euQn
-END PGP SIGNATURE-
--
Cheers,
Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager
Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc
ORACLE Deutschland B.V. Co. KG
Registered Office: Riesstr. 25, 80992 Muenchen, Germany
Commercial Register: Local Court Of Munich, HRA 95603
Managing Director: Jürgen Kunz
General Partner: ORACLE Deutschland Verwaltung B.V.
Hertogswetering 163/167, 3543 AS Utrecht, Niederlande
Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697
Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher
-
To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org
For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
[docbook-apps] Linux tech writer wanted
Anyone here interested in joining our documentation group as a tech writer with a focus on writing docs for the Oracle Linux product? If so, have a look at my blog under http://blogs.oracle.com/mysqlf/. The latest post has links to the official, detailed job description. For questions, you can also contact me off-list. -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] WebHelp search indexes
Hi Barton, There's no reason you can't call ant from your Makefile. Best of both worlds. I know, but Ant would still require configurations to be made in the build.xml and build.properties files. In other words, I couldn't configure Ant to read options from a Makefile, or could I? -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] WebHelp search indexes
Hi David, There's no reason you can't call ant from your Makefile. Best of both worlds. I know, but Ant would still require configurations to be made in the build.xml and build.properties files. In other words, I couldn't configure Ant to read options from a Makefile, or could I? Indeed you can set values to properties from the command line; You can also set properties on the command line. This can be done with the -Dproperty=value option, where property is the name of the property, and value is the value for that property. If you specify a property that is also set in the build file (see the property task), the value specified on the command line will override the value specified in the build file. https://ant.apache.org/manual/running.html I suspect it will save you some effort if you can just use the ant script and invoke it from Make. Wow, good to know! Thanks much; I'll try this out. Cheers, Stefan Btw., you can also keep one copy of the main ant script on your system and import it into small/mostly empty ant files for each doc or set of docs. David -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.11 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iQEcBAEBAgAGBQJPL9wKAAoJEMHeSXG7afUhkI4H/0yBoptLcip439ysRhIcEYf3 lULBnnQWPxGM897kM4IPPf/L7CySfF80CVeFWbheHYqbpN4DN5qPhBbJBl/am06z 9IoMRn1/LaEQ4dt3dSETGYfscxOE/oAsBlxNYvKPwazRUqJnEFhCTvnHMMoJSzNK SnqyPEiqM4GoFFOfmXJ1sjROSYY6T5h3+HOckyo/eNqS4ybUGnBN35UBRteTv79y AhtsfXj72gn6Z0uXHyw3Ih3fKEkafQ4aGDGVJ5LqAh17lwkWDfbaz69zdwMZwTxo R1u2utvtC5lq1YKuz6N+VBRkzhFyy1UYX0OKVqi5aKgBEwq+i9TzYAoVlFdNlkk= =w4YY -END PGP SIGNATURE- -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] WebHelp search indexes
Hi Kasun, Thanks again for the info! I'm using the snapshot XSL style sheets for building our internal docs now, so far with no issues. Still need to make the WebHelp search working, either the way you suggested it, or by calling Ant from the Makefile (as David proposed). Once I have a make-based setup working, I'll let this forum know, and will attach the configuration so others can benefit. Cheers, Stefan On 03.02.2012 16:15, Kasun Gajasinghe wrote: On Fri, Feb 3, 2012 at 7:48 PM, Stefan Hinz stefan.h...@oracle.com mailto:stefan.h...@oracle.com wrote: Hi Kasun, Thanks for a swift reply, and providing a truckload full of information! I'll look at this in more detail next week, but I have a couple of general questions first, so excuse me for top-posting. First of all, the reason I was asking here in the first place is because I'd really like to avoid using Ant in our infrastructure. Nothing against Ant, but our stuff is completely make-based, so any ant would look like an alien in our environment. :-) And no, we're not afraid to use Java -- we're using FOP (0.25 and 1.0) a lot. So here are my questions: (1) Do you think I could use the WebHelp snapshot on http://snapshots.thingbag.net/__xsl/ http://snapshots.thingbag.net/xsl/ as a drop-in replacement for the current 1.76.1 WebHelp XSL? From looking at the files there this seems to be the case. I'm just asking in case you're aware of that some of the stuff has conceptually changed to an extent that is guaranteed to break whatever I've set up using 1.76.1 WebHelp. I think this depends on how far you are going customize webhelp. But there wasn't any major conceptual changes like you asked. It still use JQuery, has the same structure of the html files, no changes on how users invoke the indexer, and the indexed contents etc. So, I think you should be fine. One thing though. The snapshot building was setup quite recently, so, I can not vouch that the snapshot builds are correctly built just yet. Others can clarify on this I believe. (2) I'm not sure what you mean exactly when you're saying snapshot, bridged webhelp, and latest version. Isn't the snapshot the latest version one can get, unless you'd built directly from the svn repo? Sorry for the use of confusing words. By bridged I meant a mix of 1.76.1 and the latest snapshot. Yes, snapshot is the latest one can get. That's it for now. :-) I'll try the procedure you've given below, and will keep this forum updated on the progress. Cheers, Stefan On Fri, Feb 3, 2012 at 4:09 PM, Stefan Hinz stefan.h...@oracle.com mailto:stefan.h...@oracle.com mailto:stefan.h...@oracle.com mailto:stefan.h...@oracle.com__ wrote: At the MySQL Docs team, we build targets using make and xsltproc. There's no documentation how to do that for creating WebHelp output, though -- all the docs I've seen just explain how to build output with Ant. Anyway, I've got this working with xsltproc and our build infrastructure now, except for one thing: The search functionality works, but it doesn't find anything. I compared the output created by Ant (using the Oxygen Editor), and the one created by xsltproc, and found that the latter doesn't create any index files in the content/search/ directory. Those files are named index-1.js, index-2.js, and index-3.js. If they're created, that is. :-) The WebHelp documentation on this is very sparse, and again Ant-specific. It says: To build the indexer, you must have installed the JDK version 1.5 or higher and set the ANT_HOME environment variable. Run ant build-indexer to recompile nw-cms.jar Based on this, I assume you are using 1.76.1 of the stylesheets not a snapshot? Either way, since you are a user, recompiling of the indexer is not needed. AFAIR, 1.76.1 didn't have support for building webhelp via make. So, if needed you could have just copy the Makefile from a snapshot to your webhelp directory, and tweak as necessary. Invoke the indexer is currently done by 'ant index' command. The make command also calls ANT inside the script. In the builds.xml configuration file for Ant, I see quite a few lines relating to the indexer, but I don't know how to rewrite that for make. I suppose you are not eager to install ANT, eh? :) Unfortunately, you can not run 1.76.1 without ANT. The indexer there is specific to ANT, because it uses ANT task definition (taskdef). The good news is that the current snapshot does
[docbook-apps] WebHelp search indexes
At the MySQL Docs team, we build targets using make and xsltproc. There's no documentation how to do that for creating WebHelp output, though -- all the docs I've seen just explain how to build output with Ant. Anyway, I've got this working with xsltproc and our build infrastructure now, except for one thing: The search functionality works, but it doesn't find anything. I compared the output created by Ant (using the Oxygen Editor), and the one created by xsltproc, and found that the latter doesn't create any index files in the content/search/ directory. Those files are named index-1.js, index-2.js, and index-3.js. If they're created, that is. :-) The WebHelp documentation on this is very sparse, and again Ant-specific. It says: To build the indexer, you must have installed the JDK version 1.5 or higher and set the ANT_HOME environment variable. Run ant build-indexer to recompile nw-cms.jar In the builds.xml configuration file for Ant, I see quite a few lines relating to the indexer, but I don't know how to rewrite that for make. Any pointers how to run the indexer from our make-based environment? -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] WebHelp search indexes
Hi Kasun,
Thanks for a swift reply, and providing a truckload full of information!
I'll look at this in more detail next week, but I have a couple of
general questions first, so excuse me for top-posting.
First of all, the reason I was asking here in the first place is because
I'd really like to avoid using Ant in our infrastructure. Nothing
against Ant, but our stuff is completely make-based, so any ant would
look like an alien in our environment. :-) And no, we're not afraid to
use Java -- we're using FOP (0.25 and 1.0) a lot.
So here are my questions:
(1) Do you think I could use the WebHelp snapshot on
http://snapshots.thingbag.net/xsl/ as a drop-in replacement for the
current 1.76.1 WebHelp XSL? From looking at the files there this seems
to be the case. I'm just asking in case you're aware of that some of the
stuff has conceptually changed to an extent that is guaranteed to break
whatever I've set up using 1.76.1 WebHelp.
(2) I'm not sure what you mean exactly when you're saying snapshot,
bridged webhelp, and latest version. Isn't the snapshot the latest
version one can get, unless you'd built directly from the svn repo?
That's it for now. :-) I'll try the procedure you've given below, and
will keep this forum updated on the progress.
Cheers,
Stefan
On Fri, Feb 3, 2012 at 4:09 PM, Stefan Hinz stefan.h...@oracle.com
mailto:stefan.h...@oracle.com wrote:
At the MySQL Docs team, we build targets using make and xsltproc.
There's no documentation how to do that for creating WebHelp output,
though -- all the docs I've seen just explain how to build output
with Ant.
Anyway, I've got this working with xsltproc and our build
infrastructure now, except for one thing: The search functionality
works, but it doesn't find anything. I compared the output created
by Ant (using the Oxygen Editor), and the one created by xsltproc,
and found that the latter doesn't create any index files in the
content/search/ directory. Those files are named index-1.js,
index-2.js, and index-3.js. If they're created, that is. :-)
The WebHelp documentation on this is very sparse, and again
Ant-specific. It says:
To build the indexer, you must have installed the JDK version 1.5 or
higher and set the ANT_HOME environment variable. Run ant
build-indexer to recompile nw-cms.jar
Based on this, I assume you are using 1.76.1 of the stylesheets not a
snapshot? Either way, since you are a user, recompiling of the indexer
is not needed.
AFAIR, 1.76.1 didn't have support for building webhelp via make. So, if
needed you could have just copy the Makefile from a snapshot to your
webhelp directory, and tweak as necessary. Invoke the indexer is
currently done by 'ant index' command. The make command also calls ANT
inside the script.
In the builds.xml configuration file for Ant, I see quite a few
lines relating to the indexer, but I don't know how to rewrite that
for make.
I suppose you are not eager to install ANT, eh? :)
Unfortunately, you can not run 1.76.1 without ANT. The indexer there is
specific to ANT, because it uses ANT task definition (taskdef). The good
news is that the current snapshot does not depend on ANT. So, if needed
you could just read the ANT script and convert it to make. But you need
to have Java installed (with JAVA_HOME properly set.)
So, what you can do is just use the indexer from snapshot inside 1.76.1.
Are you interested in trying this bridged webhelp? Or use the latest
version?
Former also shouldn't be a big deal. I can help you out there if needed.
Possible steps that comes into my mind is,
1. Replace webhelpindexer.jar in docbook-xsl-1.76.1/extensions/, and
copy tagsoup-1.2.1.jar to the same directory.
2. Then read the 'index' target in the ant build.xml. This one is pretty
easier to understand, not like the previous.
3. Adapt it to 'make'.
Apart from the file copying, the java task looks like the following
without all the clutter. [1] You can do the same via make by invoking
java with the relevant parameters and the classpath set.
ie. java -DhtmlDir=docs/content -DindexerLanguage=xx
-DfillTheRest=true -classpath
path/to/lucene/1.jar:2.jar:/path/to/tagsoup/jar
I probably have missed something here because I haven't tried this.
[1]
java classname=com.nexwave.nquindexer.IndexerMain fork=true
sysproperty key=htmlDir value=${output-dir}/content/
sysproperty key=indexerLanguage value=${webhelp.indexer.language}/
sysproperty key=htmlExtension value=${html.extension}/
sysproperty key=doStem value=${enable.stemming}/
sysproperty key=tocFile value=${toc.file}/
!--TagSoup SAX Parser for parsing even the bad html contents. see
http://sourceforge.net/tracker/?func=detailaid=3401185group_id=21935atid=373750--
http://sourceforge.net/tracker/?func=detailaid=3401185group_id=21935atid=373750--
sysproperty key=org.xml.sax.driver
value=org.ccil.cowan.tagsoup.Parser/
sysproperty key=javax.xml.parsers.SAXParserFactory
Re: [docbook-apps] webhelp.xsl customizations
Hi David, It is possible to checkout the source for the DocBook distribution from svn [1], but you would then have to build it [2], so typically working with the snapshot builds is much easier if you need features that haven't made it into a release yet. Thanks for the info! I'll set things up to pull the snapshot tarball then. -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] Oxygen XML Editor: Docbook XML to HTML using CSS
Hi Daniel,
currently we are
having some problems
customizing the respective XSL stylesheet for transforming our
documents
into Html ( and if it works also XHTML, webhelp etc.).
The problems seems to be that
Oxygen
in a way is blocking our CSS stylesheet, since it is obviously
recognized
by the XSL stylesheet:
xsl:template
name="user.head.content"
style
type="text/css"
css;
/style
/xsl:template
The code staed above is working
out
pretty fine, but still the result we we see is not what we
configured.
As a consequence, the ouput is
not what
it should be.
Instead applying what was specified:
body_text{
font-family: Ariel;
Are you sure about "Ariel"? I guess you'd want to use "Arial"
instead.
font-size: 10pt;
line-height: 100%;
text-align: left;
padding-bottom: 12pt;
}
This says nothing about the font color used, does it?
the result is body_texttest/body_text
. It is red instead of
black.
I would guess that, since no color is specified for body_text,
the font color is inherited from an element higher in the document
tree (div?).
Hope this helps you get started with the debugging, because,
frankly, I don't fully understand what the problem is.
Cheers,
Stefan
Can anyone give me a hint what
the problem
is? Have I configured Oxygen incorrectly or is it the XSL
Stylesheet.
Thanks!
Daniel Keyes
===
Disclaimer
The information contained in this e - mail and any attachments
( together the "message") is intended for the addressee only
and may
contain confidential and/or privileged information. If you have
received
the message by mistake please delete it and notify the sender
and do
not copy or distribute it or disclose its contents to anyone.
FINARIS Financial Software Partner GmbH
Smmerringstr. 23, 60322 Frankfurt/Main, Germany
Registered at Frankfurt/Main, HRB 52873
Managing Directors:
Dipl. Inf. Hermann Friebel, Dipl. Ing. Kai Bchle, Dipl. Inf.
Werner Mrkl
=======
--
Cheers,
Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager
Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc
ORACLE Deutschland B.V. Co. KG
Registered Office: Riesstr. 25, 80992 Muenchen, Germany
Commercial Register: Local Court Of Munich, HRA 95603
Managing Director: Jrgen Kunz
General Partner: ORACLE Deutschland Verwaltung B.V.
Hertogswetering 163/167, 3543 AS Utrecht, Niederlande
Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697
Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher
-
To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org
For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] webhelp.xsl customizations
Hi David,
Excuse me for being dense, but are you saying you've put that
empty template in the SVN version of the XSL style sheets? If so,
will that change be in the next release of the DocBook style
sheets?
Yes, the xsls in svn but not yet part of a release are available for
evaluation as part of the snapshot builds. For now, you can use this
url to download the snapshots:
http://snapshots.thingbag.net/
Eventually http://snapshots.docbook.org will take you there.
Great, thanks! Admittedly, we've been slow to update to the latest
DocBook XSL style sheet versions here at MySQL docs. We're getting
better about this, though, and I've just proposed that we pull in the
svn snapshots into our infrastructure, which would make it a lot easier
to run tests in our environment.
Also, I wonder how user.webhelp.head.content is supposed to work.
You're saying it's called at the end of user.head.content, so I
would assume it becomes part of that template. But if that's
correct, it would just *add* stuff to the user.head.content
template, rather than replacing what's there. This wouldn't make
much sense. Apparently, I'm missing something.
Yes, the idea is that these empty templates hooks that allow you to
add stuff. In this case it adds whatever you want to user.head.content
at the end in the same way that user.head.content adds stuff to
system.head.content in the base xsls. For example, you might want to
add your ownscript elements to support additional custom
functionality or your own css.
Got it. So your additions are actually for adding more customized HTML
header stuff. Although I don't have an immediate need for that at the
moment, it's probably a good idea to have it at hand in case it's needed.
Thanks for taking into consideration the proposed parametrizations, and
for pointing out webhelp.indexer.language=zz to turn off the stemmer
(although I'll give it a try!).
Cheers,
Stefan
To modify stuff within user.head.content without overriding it, I have
to parameterize it for you.
You asked for things that we should be able to
configure/customize. Here's a list:
(1)style type=text/css: I'd suggest to put that in a CSS file.
The template already links 3 CSS files, so adding another one
shouldn't be an issue.
Yeah, that had occurred to me too.
(2)link rel=stylesheet type=text/css
href=../common/jquery/theme-redmond/jquery-ui-1.8.2.custom.css/:
As said before, this is probably high on anyone's list of things to
be customized.
(3)script type=text/javascript
src=../common/jquery/jquery-1.4.2.min.js andscript
type=text/javascript
src=../common/jquery/jquery-ui-1.8.2.custom.min.js: This should
be configurable because it contains version numbers. Hard-coding
makes it harder to upgrade jQuery JavaScript.
Ok, that's easy enough to parameterize those two.
(4)script type=text/javascript
src={concat('search/stemmers/',$webhelp.indexer.language,'_stemmer.js')}:
While the integrated jQuery search works great for simple searches, I
hear that the stemmer-based search isn't really useful ATM, so
that would be a candidate for stuff to turn off.
So the stemmer has been improved recently to fix some bugs, so check
it out again. To disable stemming, just set the indexer language to an
unsupported langauge, e.g.:
webhelp.indexer.language=zz
David
That's about it for the moment. :-)
Thanks, and have a great weekend!
Cheers,
Stefan
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
iQEcBAEBAgAGBQJPI+nrAAoJEMHeSXG7afUhGCkH/0+YYcsC2fpwd/KHeG6tBXTD
JGt4s1qQjQFRTUwz9tDF6R5rtVDW1h06jWwxwxRCBe2wdHbD5d+8nLVXD7rm3seJ
yuuCgiaSyNKcG0XvpRLmeSUNXw5P6uLImIZwUohBq6CnRdOQMO6vDXKmkVIPBLlp
mMxmzXbDhy2KSKdsu/jUFcLAI9l3SBveTyslVoa6Nh2Wg9u6J3nBo76lnm4JipgF
oT9uO6FAuwHPwD+mJGuQoA/lwFKpnYKMZnBT6+nWSUwHOQF0caeR9j6ph0y7RhwI
KzbPiGvrI5qutEB5KYcUVy9dQNSjwtW8Lktg9XuulQXCUy4f7AHZEFK6ZzDef1E=
=CJKM
-END PGP SIGNATURE-
--
Cheers,
Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager
Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc
ORACLE Deutschland B.V. Co. KG
Registered Office: Riesstr. 25, 80992 Muenchen, Germany
Commercial Register: Local Court Of Munich, HRA 95603
Managing Director: Jürgen Kunz
General Partner: ORACLE Deutschland Verwaltung B.V.
Hertogswetering 163/167, 3543 AS Utrecht, Niederlande
Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697
Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher
-
To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org
For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] webhelp.xsl customizations
Hi Kasun, (1)style type=text/css: I'd suggest to put that in a CSS file. The template already links 3 CSS files, so adding another one shouldn't be an issue. Two points. First, all the css styles in the later in thestyle section of webhelp.xsl are there to over-ride some styles in defined in jquery-ui-1.8.2.custom.css. The point is, the said jquery css file is 'untouched' meaning you can upgrade it easily without hassle. (All these over-ride css starts with .ui* which makes it easier to identify.) Yep, good point. Second, if you think there's a better to do the said over-riding, please consider moving these into the positioning.css file. That's a better option rather than adding another http request. The naming of the file may not be exact on its purpose, but that's where all the docbook webhelp related styles reside. Sounds like a plan, although I guess David Cramer should make those changes, since he's maintaining the style sheets (?). Glad to hear that you are interested in docbook webhelp Stefan. BTW, the best place to send contributions is to use the DocBook tracker for patches at sourceforge. [1] [1] http://sourceforge.net/tracker/?group_id=21935atid=373749 Bookmarked, thanks! I'll upload patches there as soon as I feel qualified doing so. :-) -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] webhelp.xsl customizations
Hi Kasun, Thanks for clarifying! Plans are to contribute at some point, but not *right now*, because this is the first time I'm having a look at the style sheets. A tad more experience can't hurt, I think. :-) Cheers, Stefan On 30.01.2012 12:03, Kasun Gajasinghe wrote: On Mon, Jan 30, 2012 at 4:22 PM, Stefan Hinz stefan.h...@oracle.com mailto:stefan.h...@oracle.com wrote: Hi Kasun, (1)style type=text/css: I'd suggest to put that in a CSS file. The template already links 3 CSS files, so adding another one shouldn't be an issue. Two points. First, all the css styles in the later in thestyle section of webhelp.xsl are there to over-ride some styles in defined in jquery-ui-1.8.2.custom.css. The point is, the said jquery css file is 'untouched' meaning you can upgrade it easily without hassle. (All these over-ride css starts with .ui* which makes it easier to identify.) Yep, good point. Second, if you think there's a better to do the said over-riding, please consider moving these into the positioning.css file. That's a better option rather than adding another http request. The naming of the file may not be exact on its purpose, but that's where all the docbook webhelp related styles reside. Sounds like a plan, although I guess David Cramer should make those changes, since he's maintaining the style sheets (?). Both David and I are maintaining the webhelp stylesheets currently. This was written under the assumption that you were willing to submit patch because I kind of felt that you were interested! :-) Glad to hear that you are interested in docbook webhelp Stefan. BTW, the best place to send contributions is to use the DocBook tracker for patches at sourceforge. [1] [1] http://sourceforge.net/__tracker/?group_id=21935atid=__373749 http://sourceforge.net/tracker/?group_id=21935atid=373749 Bookmarked, thanks! I'll upload patches there as soon as I feel qualified doing so. :-) -- Cheers, Stefan Hinz stefan.h...@oracle.com mailto:stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940 tel:%2B49-30-82702940, Fax: +49-30-82702941 tel:%2B49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher --__--__- To unsubscribe, e-mail: docbook-apps-unsubscribe@__lists.oasis-open.org mailto:docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-help@lists.oasis-__open.org mailto:docbook-apps-h...@lists.oasis-open.org -- ~~~***'***~~~ Kasun Gajasinghe, University of Moratuwa, Sri Lanka. Blog: http://kasunbg.blogspot.com Twitter: http://twitter.com/kasunbg -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] webhelp.xsl customizations
Hi Denis,
I didn't realize the jquery css file was intended for overrides, either.
So my solution was to add a link to my custom CSS style sheet at the end
of the user.head.content template, after all the stock css and js files.
That way, my CSS rules take precedence.
Implicit CSS precedence, fair enough. :-) You could also use explicit
precedence, i.e. setting things !important that shouldn't be overridden.
In that case, the sequence in which CSS files are included wouldn't matter.
Cheers,
Stefan
On 01/28/2012 10:35 AM, Kasun Gajasinghe wrote:
(1)style type=text/css: I'd suggest to put that in a CSS file.
The template already links 3 CSS files, so adding another one
shouldn't be an issue.
Two points.
First, all the css styles in the latter part of thestyle section of
webhelp.xsl are there to over-ride some styles in defined in
jquery-ui-1.8.2.custom.css. The point is, the said jquery css file is
'untouched' meaning you can upgrade it easily without hassle. (All
these over-ride css starts with .ui* which makes it easier to
identify.)
Second, if you think there's a better to do the said over-riding,
please consider moving these into the positioning.css file. That's a
better option rather than adding another http request. The naming of
the file may not be exact on its purpose, but that's where all the
docbook webhelp related styles reside.
Glad to hear that you are interested in docbook webhelp Stefan. BTW,
the best place to send contributions is to use the DocBook tracker for
patches at sourceforge. [1]
[1] http://sourceforge.net/tracker/?group_id=21935atid=373749
Regards,
--Kasun
Yeah, that had occurred to me too.
(2)link rel=stylesheet type=text/css
href=../common/jquery/theme-redmond/jquery-ui-1.8.2.custom.css/:
As said before, this is probably high on anyone's list of things to
be customized.
(3)script type=text/javascript
src=../common/jquery/jquery-1.4.2.min.js andscript
type=text/javascript
src=../common/jquery/jquery-ui-1.8.2.custom.min.js: This should
be configurable because it contains version numbers. Hard-coding
makes it harder to upgrade jQuery JavaScript.
Ok, that's easy enough to parameterize those two.
(4)script type=text/javascript
src={concat('search/stemmers/',$webhelp.indexer.language,'_stemmer.js')}:
While the integrated jQuery search works great for simple searches, I
hear that the stemmer-based search isn't really useful ATM, so
that would be a candidate for stuff to turn off.
So the stemmer has been improved recently to fix some bugs, so check
it out again. To disable stemming, just set the indexer language to an
unsupported langauge, e.g.:
webhelp.indexer.language=zz
David
That's about it for the moment. :-)
Thanks, and have a great weekend!
Cheers,
Stefan
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
iQEcBAEBAgAGBQJPI+nrAAoJEMHeSXG7afUhGCkH/0+YYcsC2fpwd/KHeG6tBXTD
JGt4s1qQjQFRTUwz9tDF6R5rtVDW1h06jWwxwxRCBe2wdHbD5d+8nLVXD7rm3seJ
yuuCgiaSyNKcG0XvpRLmeSUNXw5P6uLImIZwUohBq6CnRdOQMO6vDXKmkVIPBLlp
mMxmzXbDhy2KSKdsu/jUFcLAI9l3SBveTyslVoa6Nh2Wg9u6J3nBo76lnm4JipgF
oT9uO6FAuwHPwD+mJGuQoA/lwFKpnYKMZnBT6+nWSUwHOQF0caeR9j6ph0y7RhwI
KzbPiGvrI5qutEB5KYcUVy9dQNSjwtW8Lktg9XuulQXCUy4f7AHZEFK6ZzDef1E=
=CJKM
-END PGP SIGNATURE-
-
To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org
For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
-
To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org
For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
--
Cheers,
Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager
Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc
ORACLE Deutschland B.V. Co. KG
Registered Office: Riesstr. 25, 80992 Muenchen, Germany
Commercial Register: Local Court Of Munich, HRA 95603
Managing Director: Jürgen Kunz
General Partner: ORACLE Deutschland Verwaltung B.V.
Hertogswetering 163/167, 3543 AS Utrecht, Niederlande
Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697
Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher
-
To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org
For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
[docbook-apps] webhelp.xsl customizations
Thanks again to everyone who pointed out WebHelp to me earlier this week, and provided great hints for adjusting it to our needs! I've had a look at webhelp.xsl from the DocBook 1.76.1 XSL style sheets. In parts, this is a regular style sheet, in the sense that you can override default values easily. For example, if I wanted to change the file name of the start page, I'd look at this line ... xsl:param name=webhelp.start.filenameindex.html/xsl:param ... and override this with e.g. in a Makefile with: --stringparam webhelp.start.filename toc.htm There's one template, though, that consists of more than 120 lines, and is thus not easily configurable: xsl:template name=user.head.content Granted, it's a template, rather than a parameter, so there's nothing like a one-line change, done in a Makefile. :-) Anyway, here's what I thought I should do -- add a customization layer with this: xsl:template name=user.head.content !-- Copy 120+ lines from webhelp.xsl, and adjust to our needs -- /xsl:template First question: Is this the right approach? Overriding 120+ lines of a DocBook style sheet almost feels like modifying the style sheet itself, which I'd never do because I guess that's considered heresy. Last question: The user.head.content template has lots of things hard-coded that I believe should be parametrized. Here's an extreme example where both a specific jQuery theme and even the version number are hard-coded: link rel=stylesheet type=text/css href=../common/jquery/theme-redmond/jquery-ui-1.8.2.custom.css/ Is there any way to parametrize *that* (i.e. within a template)? If so, that should probably be done in webhelp.xsl, rather than in the customization layer, so that not only our group would benefit. Assuming parametrization could be done, what would be the proper way to contribute such a patch? (OK, that's one more question, but it's related to the previous one. :-)) Thanks in advance for any pointers! -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] webhelp.xsl customizations
Hi David,
Excuse me for being dense, but are you saying you've put that empty
template in the SVN version of the XSL style sheets? If so, will that
change be in the next release of the DocBook style sheets?
Also, I wonder how user.webhelp.head.content is supposed to work. You're
saying it's called at the end of user.head.content, so I would assume it
becomes part of that template. But if that's correct, it would just
*add* stuff to the user.head.content template, rather than replacing
what's there. This wouldn't make much sense. Apparently, I'm missing
something.
You asked for things that we should be able to configure/customize.
Here's a list:
(1) style type=text/css: I'd suggest to put that in a CSS file. The
template already links 3 CSS files, so adding another one shouldn't be
an issue.
(2) link rel=stylesheet type=text/css
href=../common/jquery/theme-redmond/jquery-ui-1.8.2.custom.css/: As
said before, this is probably high on anyone's list of things to be
customized.
(3) script type=text/javascript
src=../common/jquery/jquery-1.4.2.min.js and script
type=text/javascript
src=../common/jquery/jquery-ui-1.8.2.custom.min.js: This should be
configurable because it contains version numbers. Hard-coding makes it
harder to upgrade jQuery JavaScript.
(4) script type=text/javascript
src={concat('search/stemmers/',$webhelp.indexer.language,'_stemmer.js')}:
While the integrated jQuery search works great for simple searches, I
hear that the stemmer-based search isn't really useful ATM, so that
would be a candidate for stuff to turn off.
That's about it for the moment. :-)
Thanks, and have a great weekend!
Cheers,
Stefan
On 27.01.2012 15:37, David Cramer wrote:
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
So the xsls in svn has an empty template called
user.webhelp.head.content that is called at the end of
user.head.content which will help when you only want to add stuff to
head. There's also a user.webhelp.content.footer and a
user.webhelp.navheader.content (thanks to Jirka for adding those):
!-- This is for the USERS. Users who want to customize webhelp
may over-ride this template to add content tohead. --
xsl:template name=user.webhelp.head.content/
!-- This is for the USERS. Users who want to customize webhelp
may over-ride this template to add content to the footer of the
content DIV.
i.e. withindiv id=content .../div --
xsl:template name=user.webhelp.content.footer/
xsl:template name=user.webhelp.navheader.content/
I'll add a note to the documentation about that feature.
It sounds like there's also a need for a $webhelp.jquery.theme.path
param so you can easily switch between themes.
Let me know if there are other things that need to be made easier to
customize. Webhelp is itself a customization layer, so it uses the
normal customization features of the DocBook xsls. It's also different
in that it includes a build script, and css, js, and image files. All
of which are candidates for customization as well.
Thanks,
David
On 01/27/2012 08:10 AM, Tim Arnold wrote:
Hi Stefan, I'll be interested to see the other replies to your
question. Your suggestion is exactly what I've done. Even for some
largish templates (and user.head.content as well) I just copy them
to my customization layer and make them do what I need them to do.
I know only enough xslt to get myself in trouble, so hopefully
we'll hear from more knowledgeable folks about the *best* way to
go.
good luck! --Tim Arnold
On Fri, Jan 27, 2012 at 5:48 AM, Stefan Hinz
stefan.h...@oracle.com wrote:
Thanks again to everyone who pointed out WebHelp to me earlier
this week, and provided great hints for adjusting it to our
needs!
I've had a look at webhelp.xsl from the DocBook 1.76.1 XSL style
sheets. In parts, this is a regular style sheet, in the sense
that you can override default values easily. For example, if I
wanted to change the file name of the start page, I'd look at
this line ...
xsl:param name=webhelp.start.filenameindex.html/xsl:param
... and override this with e.g. in a Makefile with:
--stringparam webhelp.start.filename toc.htm
There's one template, though, that consists of more than 120
lines, and is thus not easily configurable:
xsl:template name=user.head.content
Granted, it's a template, rather than a parameter, so there's
nothing like a one-line change, done in a Makefile. :-) Anyway,
here's what I thought I should do -- add a customization layer
with this:
xsl:template name=user.head.content !-- Copy 120+ lines from
webhelp.xsl, and adjust to our needs -- /xsl:template
First question: Is this the right approach? Overriding 120+ lines
of a DocBook style sheet almost feels like modifying the style
sheet itself, which I'd never do because I guess that's
considered heresy.
Last question: The user.head.content template has lots of things
hard-coded that I believe should be parametrized. Here's an
extreme example where both a specific jQuery
Re: [docbook-apps] Tripane output
Hi Barton, Thanks for the additional hints, particularly the XMLMind Web Help Compiler! While I'd like to avoid a conversion chain DocBook = XHTML = WebHelp, we might use this as a fallback in case we run into fancy problems with some of our huge docs. Cheers, Stefan On 24.01.2012 16:42, Barton Wright wrote: Hi Stefan, You are describing fairly standard Web Help format, except for the fourth pane for legalese and the placement of the navigation buttons. Perhaps you could start with one of the standard Web Help generators and customize it to add those features. The standard DocBook stylesheets can now generate Web Help output, and the latest editions of both Oxygen and XXE provide Web Help transformations, if you want to experiment. XMLmind just released a free, open source Web Help Compiler http://www.xmlmind.com/whc.shtml that converts any set of static XHTML, DocBook-generated or not, into Web Help. Example http://www.xmlmind.com/xmleditor/_distrib/doc/help/wh/index.html. Also look at Eclipse Help running online as an Infocenter. Examples are the Eclipse help system http://help.eclipse.org/indigo/index.jsp and that of my company. The advantage of the DocBook-generated Web Help, including XMLmind’s implementation, is that the URL to the current text page appears in the browser’s address bar, which allows your readers to bookmark and e-mail URLs to exact pages. (This is not usually possible in a frames-based system.) I see that this is also true of the Oracle help system you want to emulate. The example http://docbook.sourceforge.net/release/xsl/current/webhelp/docs/content/ch01.html that Jirka sent shows nav buttons in the top panel like you want. WHC moves those buttons to the top of the TOC panel. The advantages of an Eclipse Infocenter are the built-in search and separate search-in-current-topic features, plus collapsible frames, all generated for you. Infocenters have the disadvantages that the address bar does not contain the URL to the current text frame (but there is an alternate way to generate a URL that opens to an exact page or section of a page), and that there are no sequential page-by-page nav buttons. (The yellow arrows are browser-like Back and Next buttons, not in-sequence-only nav buttons.) Best of luck! *From:*Stefan Hinz [mailto:stefan.h...@oracle.com] *Sent:* Tuesday, January 24, 2012 9:23 AM *To:* DocBook Apps *Subject:* [docbook-apps] Tripane output Has anyone on this list created a tripane (X)HTML output from DocBook XML? Something like this (the live version is here http://docs.oracle.com/cd/E19351-01/821-1927/z40008479112.html): Tripane example That would be: * Book title and navigation buttons (prev/next) in top pane * TOC in left pane * Contents in right pane (chunked XHTML) * Legalese in bottom right pane Bob's fine book explains how to create similar output with frames (http://www.sagehill.net/docbookxsl/OtherOutputForms.html#Xhtml), but I need to use something more modern (divs). With the DocBook style sheets, the XHTML created via xsltproc contains lots of div containers. Those divs don't have IDs, but that's a fairly straightforward fix using a customization layer. Once they have IDs, the respective portions of the XHMTL can be displayed in the appropriate div containers. The tough thing is to display the TOC in the left div at all times. In our current XHTML output, the TOC is just on the start page. Has anyone done something similar already? Any pointers appreciated! -- Cheers, Stefan Hinzstefan.h...@oracle.com mailto:stefan.h...@oracle.com, MySQL Documentation Manager Phone:+49-30-82702940, Fax:+49-30-82702941,http://dev.mysql.com/doc ORACLE Deutschland B.V.Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] Tripane output
Hi Eric, The last time I seriously used HTML frames was in 1998; I really wouldn't want to go back there. ;-) The div-based layout used by WebHelp is the way to go. Someone pointed out to me that WebHelp is highly configurable via the jQueryUI: http://jqueryui.com/themeroller/ You can download preconfigured themes, or roll your own using a fairly intuitive web interface. Replacing the default WebHelp theme (theme-redmond) with one from jQueryUI is pretty straightforward, too. Cheers, Stefan On 24.01.2012 17:32, Eric Johnson wrote: David, The snapshot sample looks very nice. I cannot wait to see it in a new release so I can update our docs. Stefan, My company migrated from the frame solution that is documented in Bob's book to the WebHelp templates and it was a huge improvement. The templates are fairly easy to work with and can be customized to get any branding or look and feel you'd want. Cheers, Eric -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] Tripane output
David, Jirka, Peter, You guys rock! :-) Thank you so much for your pointers! So it turns out that a task I had considered mission impossible this morning is little more than a standard thing. I'll talk to Peter to see if I can borrow his adaptation of WebHelp for OTN (Oracle Technology Network). Again, thanks much. You guys have saved my day! Cheers, Stefan On 24.01.2012 16:47, David Cramer wrote: -BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 01/24/2012 09:15 AM, Jirka Kosek wrote: On 24.1.2012 15:23, Stefan Hinz wrote: Has anyone on this list created a tripane (X)HTML output from DocBook XML? Something like this (the live version is here http://docs.oracle.com/cd/E19351-01/821-1927/z40008479112.html): Try WebHelp output: http://docbook.sourceforge.net/release/xsl/current/webhelp/docs/content/ch01.html Btw., the version in svn has many improvements: http://snapshots.thingbag.net/xsl/webhelp/docs/content/index.html David -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.11 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iQEcBAEBAgAGBQJPHtKXAAoJEMHeSXG7afUhYOEH/2S28anDOFJ35DrUsrrhNYjJ A2bmxF4qQM6zzj93m7ddsbHGIxkkoW7kM/v04v+B3URCobidpgVt1yUY/bd1XrYh DQ/wEWYLin950HMPbGaBTryTf6hB3UgwPsDdYVo+idngLLVp+yaQQsGw0oUJUXUz dm5Kd9Yb84mLj9QJxsxgK3tsPUCrj1HU7YPaDuWcHASnrkJ5LB+HzyLLvr242U5N IdgA+xUa7o3DHI/g15J71rdLEjRgnY8CqjNPHTx26qwUVULsAr6a9uiXTybVqK85 iR+Q7vdP2t+Zp7eVE73pUT6vFwwr5y2jRx/3MIKeKeJI4+hJj3JHIhYVzpiJYrE= =+HHA -END PGP SIGNATURE- -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] Customizing and creating a stylesheet for docbook using the XML Mind or Oxygen XML Editor
Hi Daniel, You might want to look at the MySQL documentation system, described on this page: http://dev.mysql.com/doc/index-about.html The MySQL Guide to Documentation linked from that page provides an overview of how we set up and handle DocBook things. There are also links for downloading the tool set and the mysqldoc repository which you can use to look at and learn from how to set up your own books. The tool set requires a Unix-like system; in theory, it will run on Windows as well, but in practice all our writers use either Linux, Mac OS X, or a Linux virtual machine on Windows. Even if you end up using a different system (say, Ant-based) it's probably worth looking at the Guide to Documentation. We've been using DocBook for all MySQL documentation since 2004, and we have a lot of content to handle. Most of our writers use Oxygen XML Editor, some use vi or Emacs. Oxygen has validation and transformation built in, but it's not trivial to automate things, and this one of the reasons why we use our own set of tools. The tool set is based on a few select open source components (make, XML tools, Perl, FOP) which makes it easy to run the tools on any (non-Windows) computer. Cheers, Stefan On 17.01.2012 09:43, daniel.ke...@finaris.de wrote: Hello, currently my company is thinking about transferring its user documentation into XML and docbook. Since we are an IT company, XML and programming in general is not a problem. But: We cannot find and adjust the stylesheet needed to create our custom documentation. We are currently setting up a prototype for our documentation, following the instructions from Walsh´s DocBook 5: The definitive Guide and working with the XML Mind Editor and a trial version of OXYGEN Editor. Basically, we are satisfied with the results and trust in docbooks function (since having lots of trouble with Word), but the lacking transparency http://shop.oreilly.com/product/9780596805012.do?sortby=publicationDatemakes it really hard to come up with a sample documentation/ prototype .Each file we open has at least one reference to a website we cannot open and dozens of files that don´t exist or are really hard to find. We checked the regular docbook.zip from the docbook homepage, but also all files of the respective editors. (Is there something as a default Docbook editor that you would propose?) Can anyone give me some advice, a link or even a how-to for adjusting the docbook stylesheet? Personally, I would love to use docbook for our user documentation, simply for the additional features it has compared to other text processing program, but only if I can adjust the appearance. Especially regarding corporate identity this is absolutely necessary. Thanks and with best regards, D. Keyes === Disclaimer The information contained in this e - mail and any attachments ( together the message) is intended for the addressee only and may contain confidential and/or privileged information. If you have received the message by mistake please delete it and notify the sender and do not copy or distribute it or disclose its contents to anyone. FINARIS Financial Software Partner GmbH Sömmerringstr. 23, 60322 Frankfurt/Main, Germany Registered at Frankfurt/Main, HRB 52873 Managing Directors: Dipl. Inf. Hermann Friebel, Dipl. Ing. Kai Bächle, Dipl. Inf. Werner Märkl === -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 Managing Director: Jürgen Kunz General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
Re: [docbook-apps] Setting up a DocBook system
Hi Richard, Have a look at the MySQL guide to documentation, http://dev.mysql.com/doc/mysqldoc-guide/en/index.html. The toolset directory containing all the XSL and make machinery are available for download as well. We've been using DocBook XML since 2004; http://dev.mysql.com/doc/index-about.html explains how we're handling the authoring, processing, and publication processes. Cheers, Stefan Am 18.11.2011 18:24, schrieb Kerry, Richard: Team, I am setting up a Docbook system. When I did so for the first time for some tests a couple of years ago I didn't worry too much about whether everything was done using the best tools, or in the best way. This time I want to be a bit more certain I'm doing things the best way and not missing anything. I want to produce a susyem that colleagues can use and foresee resistence if it is more difficult than it needs to be. I've started out by looking at Bob Stayton's book on-line. But, I think it is a bit out of date. Can anyone direct me to any more up-to-date Getting Started guides ? Or Bob, is there any chance that you might update your on-line book, in particular the version numbers referenced for Saxon and Fop ? And the class names to use (The section on Saxon still refers to version 6 and the ICL version of the class-name). Appreciatively, Richard. Blue line *Richard Kerry * BNCS Engineer T: +44 (0)20 82259063 M: +44 (0)7812 325518 Room 457 Drama Building, BBC Television Centre, Wood Lane, London, W12 7RJ richard.ke...@atos.net mailto:richard.ke...@atos.net uk.atos.net http://uk.atos.net/en-uk/ Atos logo This e-mail and the documents attached are confidential and intended solely for the addressee; it may also be privileged. If you receive this e-mail in error, please notify the sender immediately and destroy it. As its integrity cannot be secured on the Internet, the Atos group liability cannot be triggered for the message content. Although the sender endeavours to maintain a computer virus-free network, the sender does not warrant that this transmission is virus-free and will not be liable for any damages resulting from any virus transmitted. -- Cheers, Stefan Hinz stefan.h...@oracle.com, MySQL Documentation Manager Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc ORACLE Deutschland B.V. Co. KG Registered Office: Riesstr. 25, 80992 Muenchen, Germany Commercial Register: Local Court Of Munich, HRA 95603 General Partner: ORACLE Deutschland Verwaltung B.V. Hertogswetering 163/167, 3543 AS Utrecht, Niederlande Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697 Managing Directors: Juergen Kunz, Marcel van de Molen, Alexander van der Ven - To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
