Merge pull request #1120 from rm-dr/toml-metadata

Added metadata in Tectonic.toml

Author: pkgw

crates/docmodel/src/document.rs

@@ -49,6 +49,12 @@ pub struct Document {
     /// this will be a subdirectory of `src_dir` named `build`.
     build_dir: PathBuf,
 
+    /// Arbitrary document metadata.
+    /// This has no effect on tectonic's build process.
+    /// Rather, allows users to add easily-accessible information to their documents,
+    /// which may be read by external tools.
+    pub metadata: Option<toml::Value>,
+
     /// The document name. This will be used to name build artifacts and the
     /// like, and so should be relatively filesystem-friendly. It does not
     /// need to be the same as the document title.
@@ -103,6 +109,7 @@ impl Document {
             build_dir: build_dir.into(),
             name: doc.doc.name,
             bundle_loc: doc.doc.bundle,
+            metadata: doc.doc.metadata,
             outputs,
         })
     }
@@ -124,6 +131,7 @@ impl Document {
             doc: syntax::DocSection {
                 name: self.name.clone(),
                 bundle: self.bundle_loc.clone(),
+                metadata: None,
             },
             outputs,
         };
@@ -288,6 +296,7 @@ impl Document {
             name,
             bundle_loc,
             outputs: crate::document::default_outputs(),
+            metadata: None,
         })
     }
 }
@@ -329,6 +338,7 @@ mod syntax {
     pub struct DocSection {
         pub name: String,
         pub bundle: String,
+        pub metadata: Option<toml::Value>,
     }
 
     #[derive(Debug, Deserialize, Serialize)]

docs/src/ref/tectonic-toml.md

@@ -17,6 +17,14 @@ the file are detailed below.
 name = <string>  # the document name
 bundle = <url or filesystem path>  # the source of the TeX bundle
 
+# The doc.metadata table may contain arbitrary data.
+# It does not affect Tectonic in any way.
+[doc.metadata]
+pubish = false
+arr = [1, 2, [6, 7]]
+
+
+
 [[output]]  # one or more output specifications
 name = <string>  # the output's name
 type = <"pdf">  # the output's type
@@ -51,6 +59,12 @@ or a directory of support files. This mode of operation is discouraged because
 it limits reproducibility. URLs with a `file:` protocol are also treated
 identically to filesystem paths.
 
+### `doc.metadata`
+
+Arbitrary metadata, not read by Tectonic. This table allows us to
+save parameters for external scripts without creating an extra file.
+
+
 ### `output`
 
 A list of dictionaries defining different outputs to be created from the