Bug 482784
| Summary: | RFE: Support refentry | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Product: | [Community] Publican | Reporter: | Don Domingo <ddomingo> | ||||||
| Component: | publican | Assignee: | Ruediger Landmann <rlandman+disabled> | ||||||
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Joshua Wulf <jwulf> | ||||||
| Severity: | medium | Docs Contact: | |||||||
| Priority: | low | ||||||||
| Version: | 2.0 | CC: | bforte, jfearn, jsmith.fedora, lcarlon, mmcallis, publican-list, rlandman | ||||||
| Target Milestone: | --- | Keywords: | Documentation | ||||||
| Target Release: | --- | ||||||||
| Hardware: | All | ||||||||
| OS: | Linux | ||||||||
| Whiteboard: | |||||||||
| Fixed In Version: | 1.0 | Doc Type: | Bug Fix | ||||||
| Doc Text: | Story Points: | --- | |||||||
| Clone Of: | Environment: | ||||||||
| Last Closed: | 2009-11-26 04:59:08 UTC | Type: | --- | ||||||
| Regression: | --- | Mount Type: | --- | ||||||
| Documentation: | --- | CRM: | |||||||
| Verified Versions: | Category: | --- | |||||||
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |||||||
| Cloudforms Team: | --- | Target Upstream Version: | |||||||
| Embargoed: | |||||||||
| Attachments: |
|
||||||||
|
Description
Don Domingo
2009-01-28 03:55:58 UTC
In the case of the "single refentry per page" problem, can't you simply add <xsl:param name="refentry.pagebreak">0</xsl:param> to the XSL customization layer? That should do the trick. None of these tags are actually supported tags ATM; these tags are using default settings and we need to look in to what is supportable use in the long term. On my initial inspection of the XML it looks to me that using better tag selection may help. The section titled "A typical reference page for a function:" at http://www.docbook.org/tdg/en/html/refentry.html has a much better structure for function specification that what is currently being used. I tested the XML from the above link and although it was not perfect, it was considerable better laid out that the current approach. I also recommend switching from refsect1 to refsection. Using refsect1 forces it to be marked up as a level 1 section, this will prevent depth based styling. Created attachment 330307 [details]
how old structure is displayed
Created attachment 330308 [details]
looking good
This new image represents how switching to the XML structure I mentioned above looks when using ANSI styled function definitions. The default function definition style is K&R, which is ugly and makes babies cry. I checked in an edited Tapset_Reference_Guide.xml containing three examples of the structure as noted above by jfearn. The first example uses printf, the second two are edits of two extant entries (cpu and euid). NB: the 'looking good' screenshot above is consequent to a publican change that, as of this typing, hasn't gone public. Don can you test this with the latest version of publican that you are using? - Mike This should be fixed in the BETA. Seems to be fixed in 0.44, but not in 1.0. I tested this with [1], as in the original report. I had to comment out the following line in Tapset_Reference_Guide.xml to get it to build: <xi:include href="refentry-example.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> However, without that line, the book built fine in 0.44 and gave me the output illustrated in the "looking good" attachment here. In 1.0, I get this error multiple times: runtime error: file /usr/share/Publican/xsl/xhtml-common.xsl line 967 element attribute xsl:attribute: Cannot add attributes to an element if children have been already added to the element. and the book doesn't build. https://svn.devel.redhat.com/repos/ecs/Red_Hat_Enterprise_Linux/5.3/Tapset_Reference_Guide/ Working of the latest upstream test version the following change set works as expected; so I can't duplicate the error :( Note I moved the offending xi:include below the para's to bypass the error. $ svn diff -x -u Index: en-US/Tapset_Reference_Guide.ent =================================================================== --- en-US/Tapset_Reference_Guide.ent (revision 21821) +++ en-US/Tapset_Reference_Guide.ent (working copy) @@ -2,4 +2,6 @@ <!ENTITY BOOKID "Tapset_Reference_Guide"> <!ENTITY YEAR "2008"> <!ENTITY RHEL "Red Hat Enterprise Linux 5"> -<!ENTITY APH "'"> \ No newline at end of file +<!ENTITY APH "'"> +<!ENTITY HOLDER "Red Hat, Inc"> + Index: en-US/Tapset_Reference_Guide.xml =================================================================== --- en-US/Tapset_Reference_Guide.xml (revision 21821) +++ en-US/Tapset_Reference_Guide.xml (working copy) @@ -28,10 +28,6 @@ <section id="format"> <title>Tapset Name Format</title> -<para>In this guide, tapset definitions appear in the following format:</para> - -<xi:include href="refentry-example.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <para> The <replaceable>return</replaceable> field specifies what data type the tapset extracts and returns from the kernel during a probe (and thus, @@ -48,6 +44,10 @@ exit functions, and print functions. </para> +<para>In this guide, tapset definitions appear in the following format:</para> + +<xi:include href="refentry-example.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <!-- <varlistentry> <term></term> Fixed in 1.0 OK -- whatever the problem is with my build, it's not with Publican. I copied one of the Refentries into a fresh book and tested it there within a section and within a chapter and it worked fine, giving the same output illustrated in the "looking good" attachment. publican-1.2-0.fc12 has been submitted as an update for Fedora 12. http://admin.fedoraproject.org/updates/publican-1.2-0.fc12 publican-1.2-0.fc12 has been pushed to the Fedora 12 stable repository. If problems still persist, please make note of it in this bug report. publican-1.2-0.fc11 has been pushed to the Fedora 11 stable repository. If problems still persist, please make note of it in this bug report. |