Updated anchors in SQL README.md

c0dd3b6f · Ribary, Marton Dr (School of Law) · 4ae6683b · c0dd3b6f
Commit c0dd3b6f authored 5 years ago by Ribary, Marton Dr (School of Law)
--- a/sql/README.md
+++ b/sql/README.md
@@ -2,23 +2,23 @@

 The _Digest_ is the definitive Roman law compendium compiled under emperor Justinian I (533 CE). The text is arranged in 50 books, 432 thematic sections, 9132 quoted passages and 21055 text units. This relational database presents the _Digest_ in interlinked data tables chained together by unique keys. The `digest.db` database can be used for generating advanced analytical insights about Roman law as represented by the _Digest_ and for searching text and associated data in a staructured and efficient manner.

-### 0. Table of contents
+### [<a id="toc">0. Table of contents</a>](#toc)

-[1. Instructions for using `digest.db`](#1-instructions-for-using-digest-db)
+[1. Instructions for using `digest.db`](#head1)

-[2. Tables of the database](#2-tables-of-the-database)
+[2. Tables of the database](#head2)

-[3. Sample SQL queries](#3-sample-sql-queries)
+[3. Sample SQL queries](#head3)

-[4. Future steps](#4-future-steps)
+[4. Future steps](#head4)

-[5. Support for users](#5-support-for-users)
+[5. Support for users](#head5)

-[6. Footnotes](#6-footnotes)
+[6. Footnotes](#head6)

-### 1. Instructions for using `digest.db`
+### [<a id="head1">1. Instructions for using `digest.db`</a>](#head1)

-The database can be queried with `SQL` statements in four types of `SQLite` interfaces listed below. All of these interfaces are free of charge. They all support exporting the result of `SQL` queries in a `csv` flat file to be opened in a notebook, text or spreadsheet editor. 
+The database can be queried with `SQL` statements in four types of `SQLite` interfaces listed below. All of these interfaces are free of charge. They all support exporting the result of `SQL` queries in a `csv` flat file to be opened in a notebook, text or spreadsheet editor.

 #### 1.1 `Online application - SQLite online`

@@ -38,7 +38,9 @@ The database can be connected directly in a Python script with the `sqlite3` pac

 Alternatively, one may export tables and results of `SQL` statements as `csv` flat files which could be loaded as `pandas` dataframes into a Python code for further processing.

-### 2. Tables of the database
+[Back to Table of contents](#toc)
+
+### [<a id="head2">2. Tables of the database</a>](#head2)

 #### 2.1 `text`

@@ -64,9 +66,11 @@ The "section" table includes the titles of the _Digest_'s 432 thematic sections

 The "bko" table presents information related to the theory about the _Digest_'s compositional structure formulated by Friedrich Bluhme in 1820[<sup id="inline8">8</sup>](#fn8) and revised by Paul Krüger for Theodor Mommsen's edition of the _Digest_. The theory was accompanied by a tabular summary known as the Bluhme-Krüger Ordo (hence "bko") which was revised and expanded by Tony Honoré.[<sup id="inline9">9</sup>](#fn9)

-### 3. Sample SQL queries
+[Back to Table of contents](#toc)
+
+### [<a id="head3">3. Sample SQL queries</a>](#head3)

-There are some sample queries in the `SQL_queries.txt` file to assist users unfamiliar with the `SQL` query language. These queries are ready to be copy-pasted as a multi-line `SQL` statement into the interface of your choice. The queries can be customised by replacing the relevant values. Names of tables and their columns are fixed, but all other values can be customised. Please play around and [send a message](mailto@m.ribary@surrey.ac.uk) for [support](#5-2-support-for-sql-queries).
+There are some sample queries in the `SQL_queries.txt` file to assist users unfamiliar with the `SQL` query language. These queries are ready to be copy-pasted as a multi-line `SQL` statement into the interface of your choice. The queries can be customised by replacing the relevant values. Names of tables and their columns are fixed, but all other values can be customised. Please play around and [send a message](mailto:m.ribary@surrey.ac.uk) for [support](#head5-2).

 #### 3.1 Example analytical query

@@ -115,7 +119,9 @@ ON t.jurist_id = j.id
 WHERE (t.text like '%proprieta%') AND (j.id = 23);
 ```

-### 4. Future steps
+[Back to Table of contents](#toc)
+
+### [<a id="head4">4. Future steps</a>](#head4)

 The current version of `digest.db` is intended to be polished with input from its users. While major flaws and inconsistencies in the data were captured during the pre-processing stage, it is expected that typographical errors and some inconsistencies remain. Please leave a comment or send an [email](mailto:m.ribary@surrey.ac.uk), if you spot an error. A reporting tool or a collaborative editing method will de added in due course.

@@ -123,7 +129,9 @@ The database is also intended to be enriched with additional features in its tab

 Currently there is no custom-made GUI for using `digest.db`. As the project and the database matures, an appropriate user-friendly interface and visualisation tool will be created to open up the database to those less familiar with the `SQL` query language.

-### 5. Support for users
+[Back to Table of contents](#toc)
+
+### [<a id="head5">5. Support for users</a>](#head5)

 #### 5.1 Feedback and collaborative development

@@ -131,11 +139,13 @@ Please leave a comment or send an [email](mailto:m.ribary@surrey.ac.uk) with any

 In time, the database will receive a custom interface which builds on top the `SQLite` database and the `SQL` queries. The interface will be designed according to user feedback. Please let me know what you want to see in future releases and how the database could support your research better. 

-#### 5.2 Support for SQL queries
+#### [<a id="head5-2">5.2 Support for SQL queries</a>](#head5-2)

 Please leave a comment or send an [email](mailto:m.ribary@surrey.ac.uk), if you would like to request a sample `SQL` query for your research, or if you need help with adjusting one of the existing queries. These queries will be continuously added to the `SQL_queries.txt` file.

-### 6. Footnotes
+[Back to Table of contents](#toc)
+
+### [<a id="head6">6. Footnotes</a>](#head6)

 [<sup id="fn1">1</sup>](#inline1) Peter Riedlberger and Günther Rosenbaum, eds. (2020): _Amanuensis_ V5.0. München. URL: http://www.riedlberger.de/08amanuensis.html [Last accessed on 19 May 2020]

@@ -153,4 +163,6 @@ Please leave a comment or send an [email](mailto:m.ribary@surrey.ac.uk), if you

 [<sup id="fn8">8</sup>](#inline8) Friedrich Bluhme, "Die Ordnung der Fragmente in den Pandectentiteln: Ein Beitrag der Entstehungsgeschichte der Pandecten," _Zeitschrift der Savigny-Stiftung für Rechtsgeschichte_ 4 (1820): 257-472.

-[<sup id="fn9">9</sup>](#inline9) Tony Honoré, "Justinian's Digest: The distribution of authors and works to the three committees," _Roman Legal Tradition_ 3 (2006): 1-47.
\ No newline at end of file
+[<sup id="fn9">9</sup>](#inline9) Tony Honoré, "Justinian's Digest: The distribution of authors and works to the three committees," _Roman Legal Tradition_ 3 (2006): 1-47.
+
+[Back to Table of contents](#toc)
\ No newline at end of file