README.md

   1 # FSF History page
   2
   3 This is a timeline project to chronicle the historical events surrounding the Free Software Foundation.
   4
   5 * Development link: <https://static.fsf.org/nosvn/demos/history-static/>
   6 * Production link: <https://www.fsf.org/history/>
   7 * The original image we are drafting from: common/fundraising/biannual-fundraisers/2020-fall/timeline/ (Internal location)
   8 * [Member Forum post with comments](https://forum.members.fsf.org/t/fsf-history-page/3701)
   9 * [[!rt 1748452]] RT ticket about adding fsfe, fsff, fsfi, and fsfla logos. (Internal location)
  10
  11 ## Syntax
  12
  13 Entry syntax:
  14
  15 ```
  16 ## TITLE
  17 * ID: simple-unique-sublink
  18 * MONTH: APR
  19 * YEAR: 1985
  20 * LINK: <https://link.to.relevant.website/>
  21 * IMAGE:  Location of image to use
  22 * IMAGE SHAPE: rectangle or circle
  23 * IMAGE ALT TEXT: Single sentence that explains what the image contains for the visually impaired and search engine optimization.
  24 * IMAGE LICENSE: Copyright 2021 Free Software Foundation, Inc. CC-BY-SA-4.0
  25 * NOTES: Text that will be skipped by the generation.
  26 * TEXT-BODY: Description that can be longer.
  27 * TEXT-MORE: Read more >
  28 ```
  29
  30 Syntax description:
  31
  32 * TITLE
  33   - Required.
  34   - The title of the entry that will be displayed as a bold header.
  35 * ID
  36   - Required.
  37   - The ID is a unique abbreviated short code that can be used to link someone
  38     to a historical item within the context of the rest of the page.
  39 * MONTH
  40   - Optional.
  41   - Three letter abbreviation for the month when the event happened.
  42 * YEAR: 1985
  43   - Required.
  44   - Four digit year when the event happened.
  45 * LINK
  46   - Required.
  47   - The URL most related to the historical event.
  48 * IMAGE
  49   - Optional.
  50   - Location of an image to accompany the event.
  51 * IMAGE SHAPE
  52   - Required if IMAGE is used.
  53   - The shape of the picture.
  54   - Valid answers are `rectangle` or `circle` only.
  55   - Generally, photos are rectangles and logos are circles.
  56 * IMAGE ALT TEXT
  57   - Required if IMAGE is used.
  58   - For accessibility, single sentence that explains what the image contains
  59     for the visually impaired and search engine optimization.
  60 * IMAGE LICENSE
  61   - Required if IMAGE is used.
  62   - The license of the image.
  63 * NOTES
  64   - Optional.
  65   - Notes that will not be generated into the production site.
  66 * TEXT-BODY
  67   - Optional.
  68   - Description of the event.
  69 * TEXT-MORE: Read more >
  70   - Optional.
  71   - Text for the link.  We typically just use `Read more >` for this.
  72
  73 ## Project description
  74
  75 We have a [final page](https://www.fsf.org/history/),
  76 [source and picture files](https://www.fsf.org/history/fsf-history.tar.gz),
  77 a markdown file, and a
  78 [translation](https://flallemand.fr/divers/fsf-history/).
  79
  80 Ideally, we need a way to generate the final output from the
  81 markdown file and add translations. Basically, a custom static site generator
  82 with translation support.
  83
  84 I am picturing git for version control, cron for automation, some basic
  85 scripting language to make one to the other (BASH/Python preferably), and a
  86 program to convert po to other languages like https://www.fsf.org/history/fr
  87 URL format.
  88
  89 Some of the reference locations are only accessible to internal staff. I tried
  90 to mark all of those.  I might have missed pictures, but they should be linked
  91 from the production site.