diff --git a/docs/about/digital.md b/docs/about/digital.md index 8bccfc6..96787f9 100644 --- a/docs/about/digital.md +++ b/docs/about/digital.md @@ -26,16 +26,16 @@ The texts conform to a schema developed iteratively by the Project as the transc Use of the XML in the Edition --- -The XML encoded in the paleography and text workshops and painstakingly revised by the editorial team over the course of the project, is stored in a GitHub repository. The XML markup drives a number of important functions of the digital edition: +The XML files encoded during the paleography and text workshops and painstakingly revised by the editorial team over the course of the project are stored in the [ms-xml/ directory](https://github.com/cu-mkp/m-k-manuscript-data/ms-xml) of the Project's Github repository. The XML markup drives a number of important functions of the Edition: -* It specifies the layout of each page exactly, so that it can easily compared with an image of the original -* It encodes transcription marks such as deletions, insertions, and gaps in the text. -* It encodes editorial notes that contextualize the choices made in transcription and offer immediate insight into the lanuage of the period. -* It cross references concepts such as materials used in an entry, names of plants and animals. -* It links entries to the scholarly essays provided on the Making and Knowing website. -* It embeds close up shots of certain parts of the manuscript which are diagrams, icons, and other non-textual elements. +* It organizes the manuscript text into the component entries with Project-assigned unique identifiers and thematic categories +* It specifies the relative positions of the textual blocks on each page to approximate the layout of the original manuscript +* It designates the occurrence of figures, illustration, marks, and other non-textual elements of the manuscript +* It indicates textual features such as authorial deletions, additions, insertions, and gaps in the text +* It labels segments of text related to concepts of interests to the Project, such as materials, tools, plants, and animals mentioned in an entry +* It encodes editorial notes that provide additional information, such as historical context, technical and material explanations, and transcription and translation decisions -To convert all of this information into HTML and JSON, as well as to index the material for search, we created a tool called the Lizard. Lizard is named after one of the more popular doodles found in the manuscript that is also in the project logo. It is a command line tool that performs these functions to generate the static content of the site. Here are some of the functions you can do with Lizard: +All of this information is converted into HTML and JSON as well as complied into a search index by "Lizard," a command line tool that performs these functions to generate the static content of the site. Lizard is named after one of the more popular figures found on fol. [124v](/#folios/124v) that also serves as the Project's logo. Some of Llizard's functions include: ``` $ scripts/lizard.js help @@ -55,16 +55,16 @@ A helpful lizard that responds to the following s: is the target key from the edition_data/config.json file. Defaults to 'local'. ``` -Once Lizard has done its job, the generated site is then packaged up and sent to a web server. We used Amazon Web Services (AWS) for hosting the edition. The files are uploaded to an AWS S3 Bucket for display on the web. Each build has a unique ID, so it easy to roll back to a previous version. +Once Lizard has done its job, the generated site is then packaged up and sent to a web server, currently hosted on Amazon Web Services (AWS). The files are uploaded to an AWS S3 Bucket for display on the web. Each build has a unique ID, so it easy to roll back to a previous version. -For a more technical review of these functions, please see the project README on GitHub: https://github.com/cu-mkp/making-knowing-edition . +For a more technical review of these functions, please see the README in the [Github repository of the Edition's software](https://github.com/cu-mkp/making-knowing-edition). Layout of the Texts of Ms. Fr. 640 ---- The Making and Knowing Grid Layout is a rendering scheme is designed to faithfully render the layout of a single column of text, consisting of multiple entries, surrounded by marginalia. Each entry is given a unique id and may contain zero or more marginal notes. The marginal notes are wrapped in `` tags. The editor may specify the arrangement of these notes relative to the entry using the `` tag. Valid values for the margin tag are: -* top note is above the entry and in the same column as the entry +* top note is above the entry and in the same column as the entry * left-top note is above and to the left of the entry * left-middle note is beside the entry to the left * left-bottom note is below and to the left of the entry