Dave Jarvis' Repositories

git clone https://repo.autonoma.ca/repo/keenwrite.git

Define metadata usage

AuthorDaveJarvis <email>
Date2022-01-01 17:12:42 GMT-0800
Commit13b94f355b02fc84a64c5d9f519fb5b986a55c95
Parent8cce4c3
Delta41 lines added, 3 lines removed, 38-line increase
docs/images/screenshots/09.png
Binary files differ
docs/metadata.md
+# Document metadata
+
+Document metadata is information about a document. Metadata often includes
+a title, author name, copyright date, and keywords.
+
+# Custom metadata
+
+The following screenshot shows example metadata preferences:
+
+![Metadata screenshot](images/screenshots/09.png)
+
+The **Key** column lists metadata names and the **Value** column lists
+the metadata content for each corresponding **Key**. The content may
+include references to variable definitions. When the document is typeset,
+the values for the variables will be substituted upon export.
+
+When the document is exported as XHTML, the header will include the
+keys and values conforming to the XHTML specification. For example:
+
+``` html
+<head>
+ <title>Document Title</title>
+ <meta content="science, nature" name="keywords"/>
+ <meta content="Penn Surnom" name="author"/>
+ <meta content="4311" name="count"/>
+</head>
+```
+
+# Special metadata
+
+When exporting the document, note the following special metadata:
+
+* **author** -- Included as PDF metadata
+* **byline** -- Replaces author in PDF metadata (e.g., for pen names)
+* **count** -- Total word count in document, automatically included
+* **keywords** -- Included as PDF metadata
+* **title** -- Included as a `<title>` tag, rather than a `<meta>` tag
+
docs/r.md
1. Set the **R Startup Script** contents to:
``` r
- setwd( '{{application.r.working.directory}}' );
- source( 'library.R' );
+ setwd( v$application$r$working$directory );
+ source( "library.R" );
```
1. Change `sum.Rmd` to:
```
-Calling `setwd` using `'{{application.r.working.directory}}'` changes the
+Calling `setwd` using `v$application$r$working$directory` changes the
working directory where the R engine searches for source files.