From d9efa233d1b73fc5d40ea481976ef76df9fc21b8 Mon Sep 17 00:00:00 2001 From: Antonio Ospite Date: Mon, 16 Oct 2017 15:12:54 +0200 Subject: [PATCH 01/26] Add support for the "version" attribute in the SVG schema The "version" attribute is specified by SVG[1] and is used by some libraries like Cairo[2] in their generated SVG output. Supporting the "version" attribute in the schema allows to validate files generated by Cairo with xmllint. [1] https://www.w3.org/TR/SVG11/struct.html#SVGElementVersionAttribute [2] https://www.cairographics.org/ --- schema/svg/SVG.xsd | 1 + 1 file changed, 1 insertion(+) diff --git a/schema/svg/SVG.xsd b/schema/svg/SVG.xsd index 4cd0a3be..a298f7f4 100644 --- a/schema/svg/SVG.xsd +++ b/schema/svg/SVG.xsd @@ -1102,6 +1102,7 @@ + From 82110503d196c4baf1048aad27e1c4159dd7ee4b Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Thu, 3 Sep 2020 10:45:18 -0400 Subject: [PATCH 02/26] Changing the filename of the generated cover file to cover.xhtml --- htmlbook-xsl/epub.xsl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/htmlbook-xsl/epub.xsl b/htmlbook-xsl/epub.xsl index acec95ce..4e85ec31 100755 --- a/htmlbook-xsl/epub.xsl +++ b/htmlbook-xsl/epub.xsl @@ -161,7 +161,7 @@ - + From 01aae5dc9ad0a605e15fcbc5bee00aded753fdd1 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Fri, 11 Sep 2020 11:05:49 -0400 Subject: [PATCH 03/26] changing the file extension of the root chunk to .xhtml --- htmlbook-xsl/chunk.xsl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/htmlbook-xsl/chunk.xsl b/htmlbook-xsl/chunk.xsl index 95222d9d..64299525 100755 --- a/htmlbook-xsl/chunk.xsl +++ b/htmlbook-xsl/chunk.xsl @@ -28,7 +28,7 @@ - + From fbfd38506636a0c6ec798b490362ffd088535ee6 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Wed, 30 Sep 2020 09:06:57 -0400 Subject: [PATCH 04/26] Revert "ATLAS-209: Update toolchain to generate index file with .xhtml extension" --- htmlbook-xsl/chunk.xsl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/htmlbook-xsl/chunk.xsl b/htmlbook-xsl/chunk.xsl index 64299525..95222d9d 100755 --- a/htmlbook-xsl/chunk.xsl +++ b/htmlbook-xsl/chunk.xsl @@ -28,7 +28,7 @@ - + From 843271be379723eacf3acf2dce5a0b7b5ac01379 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Wed, 30 Sep 2020 09:09:16 -0400 Subject: [PATCH 05/26] Revert "ATLAS-206: Update toolchain to generate EPUB cover file with .xhtml extension" --- htmlbook-xsl/epub.xsl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/htmlbook-xsl/epub.xsl b/htmlbook-xsl/epub.xsl index 4e85ec31..acec95ce 100755 --- a/htmlbook-xsl/epub.xsl +++ b/htmlbook-xsl/epub.xsl @@ -161,7 +161,7 @@ - + From acdf4cb2cfdfb11f6a245dbae3d9d15ff88a59b5 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Wed, 30 Sep 2020 09:10:22 -0400 Subject: [PATCH 06/26] Revert "ATLAS-27: Update XSL to generate files with .xhtml extension" --- htmlbook-xsl/chunk.xsl | 2 +- htmlbook-xsl/xspec/fileextension.xspec | 25 ------------------------- 2 files changed, 1 insertion(+), 26 deletions(-) delete mode 100755 htmlbook-xsl/xspec/fileextension.xspec diff --git a/htmlbook-xsl/chunk.xsl b/htmlbook-xsl/chunk.xsl index 64299525..265be172 100755 --- a/htmlbook-xsl/chunk.xsl +++ b/htmlbook-xsl/chunk.xsl @@ -320,7 +320,7 @@ sect5:s - .xhtml + .html diff --git a/htmlbook-xsl/xspec/fileextension.xspec b/htmlbook-xsl/xspec/fileextension.xspec deleted file mode 100755 index 4acb7b0b..00000000 --- a/htmlbook-xsl/xspec/fileextension.xspec +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - -
- - - ch01.xhtml - - - From a62f70846f647ab705594672dbcb468d08da12b6 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Wed, 30 Sep 2020 10:27:28 -0400 Subject: [PATCH 07/26] adding file extension.xspec file back --- htmlbook-xsl/xspec/fileextension.xspec | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 htmlbook-xsl/xspec/fileextension.xspec diff --git a/htmlbook-xsl/xspec/fileextension.xspec b/htmlbook-xsl/xspec/fileextension.xspec new file mode 100644 index 00000000..6cd60fa3 --- /dev/null +++ b/htmlbook-xsl/xspec/fileextension.xspec @@ -0,0 +1,25 @@ + + + + + + + +
+ + + ch01.xhtml + + + \ No newline at end of file From c483479835cbd41c1d632cb49850a98fde484f83 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Wed, 30 Sep 2020 10:28:26 -0400 Subject: [PATCH 08/26] adding newline at end of file back --- htmlbook-xsl/xspec/fileextension.xspec | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/htmlbook-xsl/xspec/fileextension.xspec b/htmlbook-xsl/xspec/fileextension.xspec index 6cd60fa3..4acb7b0b 100644 --- a/htmlbook-xsl/xspec/fileextension.xspec +++ b/htmlbook-xsl/xspec/fileextension.xspec @@ -22,4 +22,4 @@ ch01.xhtml - \ No newline at end of file + From 55453f33712fb828288213f1dc61fc7f03c9a646 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Mon, 2 Nov 2020 10:32:51 -0500 Subject: [PATCH 09/26] Add Support for xrefs to Admonitions Adding support for cross-references to admontions (notes, tips, warnings) by 1) Giving them the pagenum class in param.xsl so that xrefs in PDFs display the page numer (as dicated by the CSS theme), and 2) adding handling in xrefgen.xsl so that a warning is display if the linked admonition has no title. This is necessary because admonitionsa are valid with and without titles. --- htmlbook-xsl/param.xsl | 3 +++ htmlbook-xsl/xrefgen.xsl | 22 ++++++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/htmlbook-xsl/param.xsl b/htmlbook-xsl/param.xsl index 0d2e369b..92694616 100755 --- a/htmlbook-xsl/param.xsl +++ b/htmlbook-xsl/param.xsl @@ -223,6 +223,9 @@ sidebar refsect1 refsect2 refentry +note +tip +warning diff --git a/htmlbook-xsl/xrefgen.xsl b/htmlbook-xsl/xrefgen.xsl index 23d4ee0e..30d17956 100755 --- a/htmlbook-xsl/xrefgen.xsl +++ b/htmlbook-xsl/xrefgen.xsl @@ -245,6 +245,28 @@ + + + + + + + “” + + + + + + + Cannot output gentext for XREF to Admonition (id: + + ) that does not contain a descendant h1 element + + + ??? + + + From 3f1ef48f5c76880ee39aefa0215774c147b422e8 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Thu, 19 Nov 2020 15:49:00 -0500 Subject: [PATCH 10/26] Add Test for Admonition XREFS This commit adds 3 new scenarios, each with 3 sub scenarios to test the new xrefs to admonitions. The 3 scenarios are as follows: * Testing whether xrefs to admonitions with titles generate with the correct text * Testing whether xrefs to admonitions without titles generate with ??? * Testign whether xrefs to admonitions generate with the pagenum class given the additions to the xref.elements.pagenum.in.class param --- htmlbook-xsl/xspec/xrefgen.xspec | 111 ++++++++++++++++++++++++++++++- 1 file changed, 110 insertions(+), 1 deletion(-) diff --git a/htmlbook-xsl/xspec/xrefgen.xspec b/htmlbook-xsl/xspec/xrefgen.xspec index 432f12b2..9f70559e 100755 --- a/htmlbook-xsl/xspec/xrefgen.xspec +++ b/htmlbook-xsl/xspec/xrefgen.xspec @@ -1657,5 +1657,114 @@ and the script from https://github.com/xspec/xspec."> oreilly.com - + + + + +
+
+

I am a note title!

+

This is a note

+
+
+

I am a tip title!

+

This is a tip

+
+
+

I am a warning title!

+

This is a warning

+
+
+ + + + + “I am a note title!” + + + + “I am a tip title!” + + + + + “I am a warning title!” + + + + + +
+
+

This is a note

+
+
+

This is a tip

+
+
+

This is a warning

+
+
+ + + + + ??? + + + + + ??? + + + + + ??? + + + + + + + note + tip + warning + +
+

XREF to Note:

+ +

XREF to Tip:

+ +

XREF to Warning:

+ +
+

I am a title!

+

This is a note

+
+ +
+

I am a title!

+

This is a tip

+
+ +
+

I am a title!

+

This is a warning

+
+
+ + + + ... + + + + ... + + + + ... + + + From 506a0543c1c6794043385970438de31a5d62fa5a Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Wed, 25 Nov 2020 10:28:45 -0500 Subject: [PATCH 11/26] Remove ticket number from comment --- htmlbook-xsl/xspec/xrefgen.xspec | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/htmlbook-xsl/xspec/xrefgen.xspec b/htmlbook-xsl/xspec/xrefgen.xspec index 9f70559e..198f42a9 100755 --- a/htmlbook-xsl/xspec/xrefgen.xspec +++ b/htmlbook-xsl/xspec/xrefgen.xspec @@ -1658,7 +1658,7 @@ and the script from https://github.com/xspec/xspec."> oreilly.com - +
From 5255fcb8357ba89f47d4bed224338fefbb9c4067 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Thu, 13 May 2021 15:36:40 -0400 Subject: [PATCH 12/26] Adding Title Attribute to element in content.opf When testing whether Amazon will ingest our epubs, we've been receiving errors that state: "Guide title is empty. Item is ignored" and "This index is empty and has been skipped". I was able to locate the source of this error in the content.opf file, which is created by opf.xsl. In content.opf, there is a element, which contains elements as children. There is a for the Cover, TOC, and Title Page. The s for the Cover and TOC each have 3 attributes: href, type, and title, while the for the Title Page only has the first two. Looking at the logic within opf.xsl, this seems to be because the Title Page is set up to be flexible if there is no Title Page within the book, and so we didn't want to hardcode a title attribute. However, given that this is preventing ingestion to Amazon as well as the fact that every O'Reilly title built in Atlas has a title page, I believe it is worth it to hardcode this attribute. --- htmlbook-xsl/opf.xsl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/htmlbook-xsl/opf.xsl b/htmlbook-xsl/opf.xsl index 32bbe3d1..80e4bb1a 100755 --- a/htmlbook-xsl/opf.xsl +++ b/htmlbook-xsl/opf.xsl @@ -454,7 +454,7 @@ - + From bccc0178cb74b56600f890e1cd31d798023dac3b Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Tue, 18 May 2021 10:50:12 -0400 Subject: [PATCH 13/26] Changing Title Page to Start of Text so that the attribute is more generic to match the logic of the XSL. --- htmlbook-xsl/opf.xsl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/htmlbook-xsl/opf.xsl b/htmlbook-xsl/opf.xsl index 80e4bb1a..853cba5f 100755 --- a/htmlbook-xsl/opf.xsl +++ b/htmlbook-xsl/opf.xsl @@ -454,7 +454,7 @@ - + From 2c822f0ec9328496d9405e6f5ce08dcd39327248 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Fri, 28 May 2021 14:46:08 -0400 Subject: [PATCH 14/26] Removing TOC from Guide For an unknown reason, the link to the TOC in the element is causing an error when Amazon attempts to ingest our EPUBs. Rather than remove the element entirely, we decided to remove just the TOC item to preserve some of the functionality while still allowing us to send EPUBs to Amazon. --- htmlbook-xsl/opf.xsl | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/htmlbook-xsl/opf.xsl b/htmlbook-xsl/opf.xsl index 853cba5f..e8140e81 100755 --- a/htmlbook-xsl/opf.xsl +++ b/htmlbook-xsl/opf.xsl @@ -421,16 +421,6 @@ - - - - - - - - - - From 4d44141ebff3152ed6ec0a7e62318b527b88bfb2 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Wed, 2 Jun 2021 15:08:42 -0400 Subject: [PATCH 15/26] Updating opf.xspec Based on Changes to opf.xsl We had to change sections of the generate-guide template in opf.xsl because it was causing errors when submitting EPUBs to Amazon. This commit updates the opf.xspec test related to generate-guide to match those changes. * We are no longer incuding a reference to the TOC, so the test was changed to not(exists( * A "title" attribute was required for the reference to the start of text reference, so an exists( test was added for that Unfortunately, we have not been able to get this test working, so it is still marked as pending. --- htmlbook-xsl/xspec/opf.xspec | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/htmlbook-xsl/xspec/opf.xspec b/htmlbook-xsl/xspec/opf.xspec index e29b3fa4..14cee535 100755 --- a/htmlbook-xsl/xspec/opf.xspec +++ b/htmlbook-xsl/xspec/opf.xspec @@ -544,7 +544,9 @@ and the script from https://github.com/xspec/xspec."> - + + + From cb716ff31c7ee1e231bb39d572b3c576038df486 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Fri, 24 Sep 2021 14:22:32 -0400 Subject: [PATCH 16/26] Removing Italics from Titles in XRefs to Appendixes, Chapters, and Parts To conform with the Chicago Manual of Style, I removed the XSL template that added an element around the titles generated by xrefs to Appendixes, Chapters, and Parts. They are now treated like all other elements in that the title is copied without any surrounding element (see the template on lines 602-609 of xrefgen.xsl). --- htmlbook-xsl/xrefgen.xsl | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/htmlbook-xsl/xrefgen.xsl b/htmlbook-xsl/xrefgen.xsl index 30d17956..fb3dba3c 100755 --- a/htmlbook-xsl/xrefgen.xsl +++ b/htmlbook-xsl/xrefgen.xsl @@ -608,23 +608,6 @@ - - - - - - - - - - - - - - - - - From 7398d69237b1a3176b4c7cb718ca59d127fc68b1 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Fri, 24 Sep 2021 14:28:03 -0400 Subject: [PATCH 17/26] Adding Quotes Around Titles in Xrefs to Appendixes, Chapters, and Parts To conform with the Chicago Manual of Style, I've added quotation marks around the titles generated for xrefs to Appendixes, Chapters, and Parts. --- htmlbook-xsl/localizations/en.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/htmlbook-xsl/localizations/en.xml b/htmlbook-xsl/localizations/en.xml index fffff53d..9d991854 100644 --- a/htmlbook-xsl/localizations/en.xml +++ b/htmlbook-xsl/localizations/en.xml @@ -511,13 +511,13 @@ - + - + - + From fd95d8d852b559f235cab2429ae71bf5310d17b0 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Fri, 24 Sep 2021 14:32:59 -0400 Subject: [PATCH 18/26] Updating Test to Match New xref-number-and-title Format Although we could not get this particular test to work, I've updated the elements to match the new format in case we can get it working in the future. --- htmlbook-xsl/xspec/xrefgen.xspec | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/htmlbook-xsl/xspec/xrefgen.xspec b/htmlbook-xsl/xspec/xrefgen.xspec index 198f42a9..739e6107 100755 --- a/htmlbook-xsl/xspec/xrefgen.xspec +++ b/htmlbook-xsl/xspec/xrefgen.xspec @@ -1419,21 +1419,21 @@ and the script from https://github.com/xspec/xspec."> We were using the Saxon JAR file version SAXON HE 9.5.1.2 and the script from https://github.com/xspec/xspec."> - Chapter 1, AWESOME CHAPTER + Chapter 1, “AWESOME CHAPTER“ - Appendix A, Appendix Title + Appendix A, “Appendix Title“ - Part I, I'm Part of the Solution! + Part I, “I'm Part of the Solution!“ + + + From ae65fbbac1b6d03bd55e6364ae14aa4b39e1abc2 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Mon, 25 Oct 2021 08:53:37 -0400 Subject: [PATCH 20/26] Fixing incorrect closing quote character --- htmlbook-xsl/localizations/en.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/htmlbook-xsl/localizations/en.xml b/htmlbook-xsl/localizations/en.xml index 9d991854..77ce24c3 100644 --- a/htmlbook-xsl/localizations/en.xml +++ b/htmlbook-xsl/localizations/en.xml @@ -511,7 +511,7 @@ - + From 2f52672f809dd959ab8dbb6488c283a8bb5b1552 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Tue, 19 Oct 2021 16:02:41 -0400 Subject: [PATCH 21/26] Updating XSpec Tests for New TOC Standard Now that we are including About the Author sections in the TOC, I updated the XSpec tests to match. To do this I added an additional test making sure that the abouttheauthor colophon section is included in the TOC, and adjusted the previous version of the test to indicate that colophons without an aboutheauthor class will continue to be excluded. --- htmlbook-xsl/xspec/tocgen.xspec | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/htmlbook-xsl/xspec/tocgen.xspec b/htmlbook-xsl/xspec/tocgen.xspec index 92c797f6..2662ba5b 100755 --- a/htmlbook-xsl/xspec/tocgen.xspec +++ b/htmlbook-xsl/xspec/tocgen.xspec @@ -235,8 +235,34 @@ and the script from https://github.com/xspec/xspec."> + + + > + + +
+

First chapter

+
+

First sect1

+

A paragraph

+
+
+
+

Second chapter

+

A paragraph

+
+
+

About the Author

+

There should be an entry for this in the TOC

+
+ + + +
  • ...
    • +     +     - + > @@ -252,7 +278,7 @@ and the script from https://github.com/xspec/xspec.">

    A paragraph

    -

    About the Author

    +

    Colophon

    There shouldn't be an entry for this in the TOC

    From 04b537d3895b8230424d5a4358ec6380755b4258 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Mon, 6 Feb 2023 17:13:03 -0500 Subject: [PATCH 22/26] Changing Sidebar Headers from h5 to h1 This commit changes the expected heading element for sidebars from h5 to h1. This is being done to improve the appearance of content on the Platform. --- schema/htmlbook.xsd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/htmlbook.xsd b/schema/htmlbook.xsd index d2961a23..d114f658 100644 --- a/schema/htmlbook.xsd +++ b/schema/htmlbook.xsd @@ -1761,7 +1761,7 @@ - + From 92ae0fed786328c2eb3f2adff6a09ccf5091b7d4 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Tue, 7 Feb 2023 10:35:04 -0500 Subject: [PATCH 23/26] Updating Sidebar info in spec document, and addressing ReSpec Warnings --- index.html | 54 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 26 deletions(-) diff --git a/index.html b/index.html index 1969872a..78a3ade7 100644 --- a/index.html +++ b/index.html @@ -3,43 +3,43 @@ HTMLBook - +