Lady’s Gitweb - Fortune/blob - README.markdown

   1 <!--
   2 SPDX-FileCopyrightText: 2024 Lady <https://www.ladys.computer/about/#lady>
   3 SPDX-License-Identifier: CC0-1.0
   4 -->
   5 # 🥠📇 Fortune
   6
   7 <b>Text excerpts worth considering.</b>
   8
   9 ## Directory Structure
  10
  11 Each fortune source (in `data/`) is provided in directory of the
  12   form `AUTHOR__YEAR__IDENTIFIER`, where :⁠—
  13
  14 - **`AUTHOR`** is the author of the work.
  15   For people, the family name is given first, in all capitals, followed
  16     by their personal name(s).
  17
  18 - **`YEAR`** is the copyright year of the work.
  19
  20 - **`IDENTIFIER`** is a humanreadable identifier uniquely identifying
  21     the work among all the sources.
  22
  23 Within this directory, the following files can be found :⁠—
  24
  25 - **`bibl`:**
  26   The bibliographic citation for the source.
  27   This is an X·M·L file consisting of a single [T·E·I][TEI]
  28     `<biblStruct>` element.
  29
  30 - **`info`:**
  31   Information and commentary on the source.
  32   This is an X·M·L file consisting of a single [T·E·I][TEI] `<div>`
  33     element.
  34
  35 - **`fortunes/FORTUNE_IDENTIFIER`:**
  36   A single fortune from the source.
  37   This is an X·M·L file consisting of a single [T·E·I][TEI] `<cit>`
  38     element.
  39   Bibliographic information from the corresponding `bibl` file is not
  40     repeated; however, additional bibliographic specificity (e·g
  41     `<citedRange>`) may be provided in a `<bibl>` element.
  42
  43 ## Encoding Principles
  44
  45 Punctuation and spelling choices should adhere to the original rather
  46   than be normalized, but line and page breaking (and any associated
  47   hyphenation) should not be preserved.
  48 Sentence‐terminal punctuation should be marked with
  49   `<pc unit="sentence">`.
  50 An empty `<pc unit="sentence">` may be used at the end of sentences
  51   where the terminating punctuation is nested in quotes or unclear.
  52
  53 A short phrase within the fortune, suitable for recognition of its
  54   contents, should be marked up with `<seg type="callout">`.
  55 This phrase is typically also the source of the fortunes identifier.
  56
  57 The intention is that encoding be kept simple and easy to process.
  58 A D·T·D is provided at `DTD` which all files are expected to validate
  59   under; loading this DTD is _not_ intended to be necessary for
  60   processing, altho the documents are not technically `standalone` (as
  61   elements with element content _do_ contain additional white·space).
  62
  63 ## Licence
  64
  65 As many of the fortunes are copyrighted texts with no corresponding
  66   licences, this repository is unable to conform to [REUSE][].
  67 These copyrighted excerpts are provided with the understanding that
  68   their inclusion here is fair use, but the applicability of this
  69   sentiment to any downstream usage must be independently evaluated.
  70
  71 Lack of complete conformance notwithstanding, REUSE‐compatible comments
  72   are provided on those files for which they are applicable.
  73
  74 [REUSE]: <https://reuse.software/spec/>
  75 [TEI]: <https://tei-c.org>