Skip to content

Change to using XML syntax for XHTML files. #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mwhapples merged 1 commit into from
May 27, 2026
Merged

Change to using XML syntax for XHTML files. #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions brailleblaster-ebraille/src/main/kotlin/org/brailleblaster/ebraille/EBraillePackager.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ object EBraillePackager {
}
}
fun createEbraillePackage(outPath: Path, docs: List<Document>, title: String = "-", translationEngine: ITranslationEngine = UTDTranslationEngine()) {
val docItems = docs.mapIndexed { i, doc -> HtmlItem("ebraille/document${i}.html", doc) }
val navDoc = HtmlItem("index.html", NavigationHtml.createNavigationHtml(docItems, title = title, translationEngine = translationEngine), properties = "nav")
val docItems = docs.mapIndexed { i, doc -> XHtmlItem("ebraille/document${i}.html", doc) }
val navDoc = XHtmlItem("index.html", NavigationHtml.createNavigationHtml(docItems, title = title, translationEngine = translationEngine), properties = "nav")
packageDocument(outPath, docItems + RESOURCE_ITEMS + navDoc)
}
private fun packageDocument(outPath: Path, packageItems: List<PackageItem>) {
Expand Down
6 changes: 3 additions & 3 deletions brailleblaster-ebraille/src/main/kotlin/org/brailleblaster/ebraille/NavigationHtml.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ object NavigationHtml {
<body></body>
</html>
""".trimIndent()
fun createNavigationHtml(docs: Iterable<HtmlItem>, title: String, translationEngine: ITranslationEngine): Document {
fun createNavigationHtml(docs: Iterable<XHtmlItem>, title: String, translationEngine: ITranslationEngine): Document {
val titleBrl: String = translateToBraille(title, translationEngine)
val template = javaClass.getResourceAsStream("/org/brailleblaster/ebraille/index_template.html")?.bufferedReader(Charsets.UTF_8)?.readText() ?: FALLBACK_TEMPLATE
val html = Jsoup.parse(template)
Expand All @@ -51,7 +51,7 @@ object NavigationHtml {
html.body().appendChild(createPageList(docs, headingBrl = translateToBraille("List of pages", translationEngine)))
return html
}
private fun createHeadingsList(docs: Iterable<HtmlItem>, headingBrl: String = "⠠⠞⠁⠼ ⠷ ⠒⠞⠢⠞⠎"): Element = Element("nav").attr("role", "doc-toc").attr("aria-label", "Contents").attr("epub:type", "toc").appendChild(Element("h2").appendText(headingBrl)).apply {
private fun createHeadingsList(docs: Iterable<XHtmlItem>, headingBrl: String = "⠠⠞⠁⠼ ⠷ ⠒⠞⠢⠞⠎"): Element = Element("nav").attr("role", "doc-toc").attr("aria-label", "Contents").attr("epub:type", "toc").appendChild(Element("h2").appendText(headingBrl)).apply {
val idGenerator = IdGenerator()
val headings = docs.flatMap { doc -> doc.document.select(HEADINGS_LEVEL_MAP.keys.joinToString(separator = ", ")).map {
if (it.id().isEmpty()) {
Expand All @@ -61,7 +61,7 @@ object NavigationHtml {
} }
appendChild(headings.toHtml(level = 0, containerFactory = { Element("ol") }, itemFactory = { listOf(Element("li").appendChild(Element("a").attr("href", "${it.element.path}#${it.element.element.id()}").appendText(it.element.element.text()))) }))
}
private fun createPageList(docs: Iterable<HtmlItem>, headingBrl: String = "⠠⠇⠊⠌ ⠷ ⠏⠁⠛⠑⠎"): Element = Element("nav").attr("role", "doc-pagelist").attr("epub:type", "page-list").attr("aria-label", "Page list").attr("hidden", "").appendChild(Element("h2").appendText(headingBrl)).apply {
private fun createPageList(docs: Iterable<XHtmlItem>, headingBrl: String = "⠠⠇⠊⠌ ⠷ ⠏⠁⠛⠑⠎"): Element = Element("nav").attr("role", "doc-pagelist").attr("epub:type", "page-list").attr("aria-label", "Page list").attr("hidden", "").appendChild(Element("h2").appendText(headingBrl)).apply {
val idGenerator = IdGenerator()
val pages = docs.flatMap { doc -> doc.document.select("""span[role="doc-pagebreak"]""").map {
if (it.id().isEmpty()) {
Expand Down
6 changes: 3 additions & 3 deletions brailleblaster-ebraille/src/main/kotlin/org/brailleblaster/ebraille/OpfUtils.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,12 @@ interface PackageItem {
fun write(output: OutputStream)
}

data class HtmlItem(override val path: String, val document: org.jsoup.nodes.Document, override val includeInSpine: Boolean = true,
override val properties: String? = null) : PackageItem {
data class XHtmlItem(override val path: String, val document: org.jsoup.nodes.Document, override val includeInSpine: Boolean = true,
override val properties: String? = null) : PackageItem {
override val mediaType: String = "application/xhtml+xml"
override fun write(output: OutputStream) {
output.bufferedWriter(Charsets.UTF_8).also {
document.html(it)
document.outputSettings(document.outputSettings().syntax(org.jsoup.nodes.Document.OutputSettings.Syntax.xml)).html(it)
}.flush()
}
}
Expand Down
Loading