Skip to content

Latest commit

 

History

History
209 lines (130 loc) · 8.17 KB

README.md

File metadata and controls

209 lines (130 loc) · 8.17 KB
Raw

RR0 Build Status Code Climate Test Coverage

This repository hosts both data and code for the RR0 website.

Motivation

This website was created around 1998 as the publication of personal notes regarding the study of Unidentified Flying Objects (UFOs). It was further motivated by the lack of french-speaking resources about the subject, especially when it comes to cases synthesis, history and objective reporting.

Analysis

RR0 is:

  • Data-centric : The pages are the data. They contain semantic only, not how to display them. Display is performed automatically once the pages are loaded, by parsing the semantic tags/classes/attributes contained in the page . These can be about places, people, time, etc.
  • Contextual : Display rendering not only takes into account the semantic tags/classes/attributes, but also the ways they are assembled. For example a month tag can be resolved as in the context of a previous year tag.

To do

  • User settings to customize rendering of directives (i18n, how to display people names, which units to use for expressing measurements)

Design

RR0 has been designed in different ways over the years:

  1. a vanilla JS app (parsing tags and updating the client HTML)
  2. an AngularJS app with RR0-specific directives.
  3. Static Site Generated (SSG) pages with a bit of client-side code, using the ssg-api.

So today the design is basically about converting page templates to final HTML, including a bit of client-side JS when interactivity is supported.

Steps

The SSG steps to build RR0 are (in order):

  1. the include step, which replaces all includes (header and footer, notably) by their contents;
  2. the directory steps which generate directory pages:
    1. UFO cases
    2. People (by occupation, typically)
  3. the content step, which replaces tags in the pages contents;
  4. Books directory
  5. Rebuild of the search index
  6. Rebuild of the sources index
  7. the copy step, which copies resources files (CSS, etc.)

Content step replacers

During website generation, a number of tags are replaced by specific HTML:

time

This is an override of the standard <time> HTML5 tag that aims to automate the rendering of a full human-readable date (including day of week) or duration.

For both, a slash / can be used to express intervals (starting and end date, minimum and maximum duration, respectively, as stated in the ISO_8601 standard.

Dates

By default, rendered dates add a checkedLink towards a possible page documenting this date (all examples below using a french locale):

<time>1952</time> renders as <a href="/time/1/9/5/2/">1952</a>.

<time datetime="">1952-07</time> renders as <a href="/time/1/9/5/2/07" title="Juillet 1952">Juillet 1952</a>.

<time datetime="1952-07-01"></time> renders as <a href="/time/1/9/5/2/07/01" title="Mardi 1er Juillet 1952">Mardi 1er Juillet 1952</a>.

<time datetime="1952-07-01/03"></time> will render Mardi 1er au Jeudi 3 Juillet 1952.

Once a date as been rendered, it sets the new new current/contextual time. All next times will be interpreted relatively to this new time. For example :

<time datetime="1952-07-02"></time> will render la veille.

<time datetime="1952-07-04"></time> will render le lendemain.

<time datetime="1952-07-05"></time> will render le surlendemain.

<time datetime="1952-07-07"></time> will render le Mardi suivant.

<time datetime="05"></time> will be rendered as Samedi 5 Juillet 1952, if stated after the latest date above.

Durations

According to the HTML5 specification, Durations can be expressed in the datetime attribute if starting with a P.

<time datetime="P1D"></time> renders as <time datetime="P2D" class="duration">1 jour</time>.

<time datetime="P15M"></time> renders as <time datetime="P15M" class="duration">15 minutes</time>.

<time datetime="P20S"></time> renders as <time datetime="P20S" class="duration">20 secondes</time>.

<time datetime="P1D15M20S"></time> renders as <time datetime="P15M20S" class="duration">1 jour, 15 minutes et 20 secondes</time>.

<time datetime="P30S/1M"></time> renders as <time datetime="P30S/1M" class="duration">30 secondes à 1 minute</time>.

<time datetime="P2H/3H"></time> renders as <time datetime="P2H/3H" class="duration">2 à 3 heures</time>.

place

This is a class-restricted directive that aims to provide additional information on a given place.

Examples

<span class="place">Hasselbach (Allemagne)</time>

will render as

<span class="place" id="place1" title="Cliquez pour voir la carte" style="cursor: pointer;">Hasselbach (Allemagne)</span>.

A click on the rendered element will trigger the display of a Google Map zoomed on the relevant place latitude/longitude (as geocoded by the Google Geocoding API).

people

This is a class-restricted directive that aims to provide a link to a people's bio.

Examples

<span class="people">Claude Poher</time>

will render as:

<a href="/people/p/PoherClaude" translate="no">Poher</a>.

Any text equal to the rendered last name further in the page will be automatically rendered the same. So only tagging is required only once to handle multiple mentions of the same person.

Also, as names can be expressed in multiple ways, the following patterns are also recognized:

<span class="people">Poher, Claude</time>

<span class="people" title="Claude Poher">Poher</time>

Note that when more than two words are used to express a people's name, only the latter one will be assumed to be the last name. For example : <span class="people">Carl Gustav Jung</time>

will render as:

<a href="/people/p/JungCarlGustav" translate="no">Carl Gustav Jung</a>.

In case the last name contain multiple words, just write it in camel case, like below:

<span class="people">Werner VonBraun</time>

section

Contextual effects
  • Adds a hierarchical entry (depending on the depth of the section, possibly in other sections) in the 'Contents' contextual menu.

Implementation

Setup

  1. Make sure NodeJS 18+ is installed
  2. Install NodeJS packages required by this project: npm install

Directory structure

  • time/ hosts chronological data. Chronology is the base data of other data (for instance, a UFO case photograph will be hosted in its relevant time directory, and the case file will link to it). The subdirectories represent date components in the form Y/Y/Y/Y/MM/DD/
  • croyance/ hosts beliefs data, that is, opinions that do not rely on proof. This includes religion, conspirationism, occultism and other cults.
  • org/ hosts data about all kinds of human organizations, from countries to towns, including state agencies, universities, etc.
  • org/ hosts data about people, regardless of their nationalities, occupations, etc.

Deployment

Build

RR0.org is built through a Static Site Generation (SSG) using the ssg-api. To run it:

  1. Make sure you have a Google Maps embed API keys and set its value to the GOOGLE_MAPS_API_KEY env var.
  2. Build the website using npm run build --reindex true. This will generate the website in the out subdirectory, including a refreshed index of pages to be used in the search form.

Publish

  1. Make sure the netlify CLI is installed: npm install netlify-cli -g
  2. Login in your netlify account: netlify login. This will ask you to authorize the CLI to access your Netlify account.
  3. Link your current project dir to the relevant Netlify website: netlify link.
  4. Publish the generated website: netlify deploy --prod

Test

Unit tests

  • To run all tests: npm run test
  • To run/debug a single test: specify its file name in the test-one script in package.json, then run/debug npm run test-one.