Merge pull request #865 from pkgw/html

Sketch out HTML support

Author: pkgw

Cargo.lock

@@ -37,6 +37,7 @@ members = [
   "crates/dep_support",
   "crates/docmodel",
   "crates/engine_bibtex",
+  "crates/engine_spx2html",
   "crates/engine_xdvipdfmx",
   "crates/engine_xetex",
   "crates/errors",
@@ -72,6 +73,7 @@ tectonic_bridge_core = { path = "crates/bridge_core", version = "0.0.0-dev.0" }
 tectonic_bundles = { path = "crates/bundles", version = "0.0.0-dev.0", default-features = false }
 tectonic_docmodel = { path = "crates/docmodel", version = "0.0.0-dev.0", optional = true }
 tectonic_engine_bibtex = { path = "crates/engine_bibtex", version = "0.0.0-dev.0" }
+tectonic_engine_spx2html = { path = "crates/engine_spx2html", version = "0.0.0-dev.0" }
 tectonic_engine_xdvipdfmx = { path = "crates/engine_xdvipdfmx", version = "0.0.0-dev.0" }
 tectonic_engine_xetex = { path = "crates/engine_xetex", version = "0.0.0-dev.0" }
 tectonic_errors = { path = "crates/errors", version = "0.0.0-dev.0" }
@@ -87,6 +89,9 @@ url = "^2.0"
 watchexec = "^1.15.3"
 zip = { version = "^0.5", default-features = false, features = ["deflate"] }
 
+[patch.crates-io]
+pinot = { git = 'https://github.com/tectonic-typesetting/pinot', branch = 'basic-math' }
+
 [features]
 default = ["geturl-reqwest", "serialization"]
 
@@ -135,10 +140,11 @@ tectonic_bridge_icu = "2c1ffcd702a662c003bd3d7d0ca4d169784cb6ad"
 tectonic_bundles = "207e6e796b1827330ee03a4c395fe6db059bddd9"
 tectonic_cfg_support = "thiscommit:aeRoo7oa"
 tectonic_dep_support = "5faf4205bdd3d31101b749fc32857dd746f9e5bc"
-tectonic_docmodel = "cd77b60d48b1ae3ef80d708e6858ea91cd9fa812"
+tectonic_docmodel = "thiscommit:2022-02-20:2SpEl4c"
 tectonic_engine_bibtex = "thiscommit:2021-01-17:KuhaeG1e"
+tectonic_engine_spx2html = "thiscommit:2021-10-29:96yOlD8"
 tectonic_engine_xdvipdfmx = "7dcbc52e58f9774b3d592919a9105377faeac509"
-tectonic_engine_xetex = "b7a4085fa67c831d4532da6661bddafd1f9c24ff"
+tectonic_engine_xetex = "thiscommit:2022-02-20:J4dXT3x"
 tectonic_errors = "317ae79ceaa2593fb56090e37bf1f5cc24213dd9"
 tectonic_geturl = "68c5fc525c5fead75913bd90380043761bde9f61"
 tectonic_io_base = "thiscommit:2021-06-13:XFjtSsZ"

Cargo.toml

@@ -178,10 +178,18 @@ impl Document {
 
         let mut p = self.build_dir.clone();
         p.push(&profile.name);
-        p.push(&profile.name);
-        p.set_extension(match profile.target_type {
-            BuildTargetType::Pdf => "pdf",
-        });
+
+        match profile.target_type {
+            BuildTargetType::Pdf => {
+                p.push(&profile.name);
+                p.set_extension("pdf");
+            }
+
+            BuildTargetType::Html => {
+                p.push("index.html");
+            }
+        }
+
         p
     }
 }
@@ -218,6 +226,9 @@ pub struct OutputProfile {
 /// The output target type of a document build.
 #[derive(Clone, Copy, Debug, Eq, PartialEq)]
 pub enum BuildTargetType {
+    /// Output a tree of HTML files
+    Html,
+
     /// Output to the Portable Document Format (PDF).
     Pdf,
 }
@@ -394,18 +405,21 @@ mod syntax {
 
     #[derive(Clone, Copy, Debug, Eq, PartialEq)]
     pub enum BuildTargetType {
+        Html,
         Pdf,
     }
 
     impl BuildTargetType {
         pub fn from_runtime(rt: &super::BuildTargetType) -> Self {
             match rt {
+                super::BuildTargetType::Html => BuildTargetType::Html,
                 super::BuildTargetType::Pdf => BuildTargetType::Pdf,
             }
         }
 
         pub fn to_runtime(self) -> super::BuildTargetType {
             match self {
+                BuildTargetType::Html => super::BuildTargetType::Html,
                 BuildTargetType::Pdf => super::BuildTargetType::Pdf,
             }
         }
@@ -417,6 +431,7 @@ mod syntax {
             S: Serializer,
         {
             serializer.serialize_str(match *self {
+                BuildTargetType::Html => "html",
                 BuildTargetType::Pdf => "pdf",
             })
         }
@@ -428,8 +443,14 @@ mod syntax {
         {
             let s = String::deserialize(deserializer)?;
             Ok(match s.as_str() {
+                "html" => BuildTargetType::Html,
                 "pdf" => BuildTargetType::Pdf,
-                other => return Err(<D as Deserializer>::Error::unknown_variant(other, &["pdf"])),
+                other => {
+                    return Err(<D as Deserializer>::Error::unknown_variant(
+                        other,
+                        &["html", "pdf"],
+                    ))
+                }
             })
         }
     }

crates/docmodel/src/document.rs

@@ -0,0 +1,8 @@
+# See elsewhere for changelog
+
+This project’s release notes are curated from the Git history of its main
+branch. You can find them by looking at [the version of this file on the
+`release` branch][branch] or the [GitHub release history][gh-releases].
+
+[branch]: https://github.com/tectonic-typesetting/tectonic/blob/release/crates/engine_spx2html/CHANGELOG.md
+[gh-releases]: https://github.com/tectonic-typesetting/tectonic/releases

crates/engine_spx2html/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Copyright 2022 the Tectonic Project
+# Licensed under the MIT License.
+
+# See README.md for discussion of features (or lack thereof) in this crate.
+
+[package]
+name = "tectonic_engine_spx2html"
+version = "0.0.0-dev.0"  # assigned with cranko (see README)
+authors = ["Peter Williams <peter@newton.cx>"]
+description = """
+The Tectonic engine that converts SPX output to HTML.
+"""
+homepage = "https://tectonic-typesetting.github.io/"
+documentation = "https://docs.rs/tectonic_engine_spx2html"
+repository = "https://github.com/tectonic-typesetting/tectonic/"
+readme = "README.md"
+license = "MIT"
+edition = "2018"
+
+[dependencies]
+byteorder = "^1.4"
+percent-encoding = "^2.1"
+pinot = "^0.1"
+tectonic_bridge_core = { path = "../bridge_core", version = "0.0.0-dev.0" }
+tectonic_errors = { path = "../errors", version = "0.0.0-dev.0" }
+tectonic_io_base = { path = "../io_base", version = "0.0.0-dev.0" }
+tectonic_status_base = { path = "../status_base", version = "0.0.0-dev.0" }
+tectonic_xdv = { path = "../xdv", version = "0.0.0-dev.0" }
+tempfile = "^3.1"
+tera = "^1.13"
+
+[package.metadata.internal_dep_versions]
+tectonic_bridge_core = "4e16bf963700aae59772a6fb223981ceaa9b5f57"
+tectonic_errors = "317ae79ceaa2593fb56090e37bf1f5cc24213dd9"
+tectonic_io_base = "thiscommit:2022-02-20:gQ6H0Gx"
+tectonic_status_base = "317ae79ceaa2593fb56090e37bf1f5cc24213dd9"
+tectonic_xdv = "c91f2ef37858d1a0a724a5c3ddc2f7ea46373c77"

crates/engine_spx2html/Cargo.toml

@@ -0,0 +1,18 @@
+# The `tectonic_engine_spx2html` crate
+
+[![](http://meritbadge.herokuapp.com/tectonic_engine_spx2html)](https://crates.io/crates/tectonic_engine_spx2html)
+
+This crate is part of [the Tectonic
+project](https://tectonic-typesetting.github.io/en-US/). It provides and engine
+that converts "SPX" (semantically paginated XDV) files, a customized Tectonic
+output, to HTML.
+
+- [API documentation](https://docs.rs/tectonic_engine_spx2html/).
+- [Main Git repository](https://github.com/tectonic-typesetting/tectonic/).
+
+
+## Cargo features
+
+This crate currently provides no [Cargo features][features].
+
+[features]: https://doc.rust-lang.org/cargo/reference/features.html