relaton-cli 3.0.7 → 3.1.0

data/docs/README.adoc

@@ -1,589 +0,0 @@
-= Relaton CLI: Command-line Interface for Bibliographic References
-
-image:https://img.shields.io/gem/v/relaton-cli.svg["Gem Version", link="https://rubygems.org/gems/relaton-cli"]
-image:https://github.com/relaton/relaton/actions/workflows/rake.yml/badge.svg["Build Status", link="https://github.com/relaton/relaton/actions/workflows/rake.yml"]
-
-Relaton CLI is a command-line tool for fetching, converting, and managing
-bibliographic references to standards (ISO, IEC, IETF, NIST, IEEE, and many
-more). It is part of the https://github.com/relaton[Relaton] /
-https://www.metanorma.org[Metanorma] ecosystem.
-
-== Installation
-
-Add to your `Gemfile`:
-
-[source,ruby]
-----
-gem "relaton-cli"
-----
-
-Or install directly:
-
-[source,console]
-----
-$ gem install relaton-cli
-----
-
-== Requirements
-
-* Ruby >= 3.3.0
-
-== Usage
-
-Each command supports a `--verbose` (short form `-v`) option to include
-warnings in the output.
-
-=== relaton fetch
-
-[source,console]
-----
-$ relaton fetch CODE -t TYPE -f FORMAT -y YEAR -r RETRIES --all-parts --keep-year --no-cache --publication-date-before DATE --publication-date-after DATE
-----
-
-Fetch the Relaton XML entry corresponding to the document identifier `CODE`.
-
-[[relaton-fetch-types]]
-* `TYPE` is optional and specifies the standards class library to use. Recognized values for `TYPE` are: `3GPP`, `BIPM`, `CCTF`, `CCDS`, `CGPM`, `CIPM`, `JCRB`, `JCGM`, `BSI`, `BS`, `PD`, `CC`, `CCSDS`, `CEN`, `EN`, `ENV`, `CWA`, `HD`, `CR`, `CIE`, `DOI`, `ECMA`, `ETSI`, `CN`, `GB`, `GB/T`, `GB/Z`, `IANA`, `IEC`, `CISPR`, `IEV`, `IEEE`, `ANSI`, `NACE`, `AIEE`, `ASA`, `IRE`, `IETF`, `RFC`, `BCP`, `FYI`, `STD`, `I-D`, `IHO`, `ISBN`, `ISO`, `ISO/IEC`, `ITU`, `JIS`, `TR`, `NIST`, `NBS`, `NISTGCR`, `ITL Bulletin`, `JPCRD`, `NISTIR`, `CSRC`, `FIPS`, `OASIS`, `OGC`, `OMG`, `UN`, `W3C`, `XEP`, `PLATEAU`.
-* `FORMAT` is optional. Recognized values are `xml` (default), `yaml`, `bibtex`.
-* `YEAR` is optional and specifies the year of publication.
-* `RETRIES` is optional, number of network retries (default 1).
-* `--all-parts` fetch all parts of the standard.
-* `--keep-year` undated reference should return an actual reference with year.
-* `--no-cache` do not use cache.
-* `--publication-date-before DATE` fetch only documents published before the specified date. Accepted formats: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`.
-* `--publication-date-after DATE` fetch only documents published after the specified date. Accepted formats: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`.
-
-=== relaton fetch-data
-
-[source,console]
-----
-$ relaton fetch-data DATASET -o DIR -f FORMAT
-----
-
-Fetch all documents from a `DATASET` source and save them to folder `DIR` in format `FORMAT`.
-
-The following datasets are available:
-
-* `nist-tech-pubs` - https://github.com/usnistgov/NIST-Tech-Pubs/releases/download/May2024/allrecords-MODS.xml
-* `cie-techstreet` - https://www.techstreet.com/cie/searches/31156444
-* `calconnect-org` - https://standards.calconnect.org/relaton/index.yaml
-* `ogc-naming-authority` - https://raw.githubusercontent.com/opengeospatial/NamingAuthority/master/incubation/bibliography/bibliography.json
-* `ieee-rawbib` - looks for the IEEE dataset in the local `./ieee-rawbib` directory. The dataset can be downloaded from https://github.com/ietf-ribose/ieee-rawbib
-* `w3c-rdf` - http://www.w3.org/2002/01/tr-automation/tr.rdf
-* `w3c-tr-archive` - looks for the W3C archive dataset in local `./w3c-tr-archive` directory. The dataset can be downloaded from https://github.com/relaton/w3c-tr-archive
-* `iana-registries` - https://github.com/ietf-ribose/iana-registries
-* `status-smg-3GPP` - updates previously downloaded data if a new archive is available in ftp://www.3gpp.org/Information/Databases/
-* `status-smg-3GPP-force` - download data from the latest archive in ftp://www.3gpp.org/Information/Databases/
-* `ietf-rfcsubseries` - https://www.rfc-editor.org/rfc-index.xml (`<bcp-entry>`, `<fyi-entry>`, `<std-entry>`)
-* `ietf-internet-drafts` - looks for the Internet-Drafts dataset in the local `./bibxml-ids` directory. The dataset can be downloaded using `rsync -avcizxL rsync.ietf.org::bibxml-ids ./bibxml-ids`.
-* `ietf-rfc-entries` - https://www.rfc-editor.org/rfc-index.xml (`<rfc-entry>`)
-* `oasis-open` - https://www.oasis-open.org/standards/
-* `bipm-data-outcomes` - looks for the BIPM dataset in the local `./bipm-data-outcomes` directory. The dataset can be downloaded from https://github.com/metanorma/bipm-data-outcomes
-* `si-brochure` - looks for the SI-Brochure dataset in the local `./bipm-si-brochure` directory. The dataset can be downloaded from https://github.com/metanorma/bipm-si-brochure
-* `ecma-standards` - https://www.ecma-international.org/publications/standards/
-* `itu-t` - https://www.itu.int/mws/api/recommendations/searchRecs
-* `itu-r` - **unavailable**: ITU decommissioned the bulk-enumeration endpoint this crawler used, so it raises rather than harvesting (see https://github.com/relaton/relaton/issues/75)
-* `ccsds` - https://public.ccsds.org/Publications/AllPubs.aspx
-* `etsi-csv` - https://www.etsi.org/
-* `plateau-handbooks` - https://www.mlit.go.jp/plateau/_next/data/1.3.0/libraries/handbooks.json
-* `plateau-technical-reports` - https://www.mlit.go.jp/plateau/_next/data/1.3.0/libraries/technical-reports.json
-* `jis-webdesk` - https://webdesk.jsa.or.jp/books/W11M0270
-
-Options:
-
-* `DIR` - folder name to store documents (default `./data`).
-* `FORMAT` - output format: `yaml` (default), `xml`, `bibxml`.
-
-=== relaton extract
-
-[source,console]
-----
-$ relaton extract Metanorma-XML-Directory Relaton-XML-Directory -x EXTENSION
-----
-
-Iterate through all Metanorma XML files in `Metanorma-XML-Directory` and extract the `bibdata` element from each. Save the `bibdata` element to `Relaton-XML-Directory` as the Relaton XML description for that file. If a document identifier is present in `bibdata`, it is used as the filename; otherwise, the original filename is used. The filename is suffixed with `EXTENSION` (default `.rxl`).
-
-=== relaton concatenate
-
-[source,console]
-----
-$ relaton concatenate Source-Directory Relaton-Collection-File -t TITLE -g ORGANIZATION
-----
-
-Iterate through all Relaton files (YAML and XML) in `Source-Directory` and concatenate them into a Relaton Collection file. The extension of the Collection file can be set via the filename (e.g., `.yaml` for YAML, `.rxl` for XML) or using the `-x` (`--extension`) option.
-
-For each Relaton input file in `Source-Directory`, if a document file with the same base name is identified (XML, HTML, PDF, or DOC), a link to that file is inserted.
-
-If `TITLE` or `ORGANIZATION` options are given, they are added to the output as the title and author of the collection.
-
-=== relaton split
-
-[source,console]
-----
-$ relaton split Relaton-Collection-File Relaton-File-Directory -x rxl
-----
-
-Split a `Relaton-Collection-File` into multiple files in `Relaton-File-Directory`. Supports the `-x` (`--extension`) option to set the file extension.
-
-=== relaton convert
-
-[source,console]
-----
-$ relaton convert XML -f FORMAT -o OUTPUT-FILE
-----
-
-Convert a Relaton XML document into YAML, AsciiBib, or BibTeX format. Allowed `--format` values are `yaml`, `asciibib`, `bibtex`. If `--output` is omitted, a new file is created in the same folder with the appropriate extension.
-
-=== relaton yaml2xml
-
-[source,console]
-----
-$ relaton yaml2xml YAML -o OUTPUT-DIRECTORY -x RELATON_EXTENSION -p PREFIX -r LIBRARY
-----
-
-Convert a Relaton YAML file into Relaton Collection XML or separate files. If the YAML file specifies multiple bibliographic items and `OUTPUT-DIRECTORY` is given, also convert into individual Relaton XML files per entry. The document identifier is used as the filename, suffixed with `RELATON_EXTENSION` (default `.rxl`) and prefixed with `PREFIX` (default empty). Libraries required for conversion are specified in `LIBRARY` as a space-delimited list.
-
-[[relaton-yaml]]
-A Relaton Collection YAML file contains initial metadata and a list of bibliographic entries:
-
-[source,yaml]
-----
-root:
-  title: CalConnect Standards Registry
-  author: The Calendaring and Scheduling Consortium
-  items:
-    - id: CC36000
-      type: standard
-      title:
-        - content: Standardization documents -- Vocabulary
-      docidentifier:
-        - type: CC
-          content: CC 36000
-          primary: true
-      date:
-        - type: issued
-          at: '2018-10-25'
-      status:
-        stage:
-          content: proposal
-    - id: CC34000
-      type: standard
-      title:
-        - content: Date and time -- Concepts and vocabulary
-      docidentifier:
-        - type: CC
-          content: CC 34000
-          primary: true
-      date:
-        - type: issued
-          at: '2018-10-25'
-      status:
-        stage:
-          content: proposal
-----
-
-A Relaton YAML file describing an individual bibliographic entry is limited to metadata specific to that entry. The link:https://github.com/relaton/relaton-bib/blob/master/docs/hash.adoc#yaml[Relaton YAML] illustrates the common fields supported by all flavors.
-
-=== relaton xml2yaml
-
-[source,console]
-----
-$ relaton xml2yaml XML -o OUTPUT-DIRECTORY -x RELATON_EXTENSION -p PREFIX -r LIBRARY
-----
-
-Convert a Relaton XML file into Relaton YAML. If the XML file is a collection and `OUTPUT-DIRECTORY` is given, also produce individual YAML files per entry. The document identifier is used as the filename, suffixed with `RELATON_EXTENSION` (default `.yaml`) and prefixed with `PREFIX` (default empty). Libraries required for conversion are specified in `LIBRARY` as a space-delimited list.
-
-[[relaton-xml2html]]
-=== relaton xml2html
-
-[source,console]
-----
-$ relaton xml2html <relaton-xml> [<stylesheet>] [<html-template-dir>]
-----
-
-Render a Relaton Collection XML as an HTML file. Used to generate an HTML index of standards.
-
-* `relaton-xml` is the Relaton Collection XML file.
-* `stylesheet` is the CSS stylesheet to style the output.
-* `html-template-dir` is a directory containing HTML Liquid Template files. Two templates are required:
-
-** Index template (`_index.liquid`) -- recognizes the following parameters:
-*** `css`: the CSS stylesheet content
-*** `title`: the collection title from `./relaton-collection/title`
-*** `author`: the collection author from `./relaton-collection/contributor[role/@type = 'author']/organization/name`
-*** `content`: the list of resources generated by the script
-
-** Individual entry template (`_document.liquid`) -- recognizes attributes of a bibliographic entry (`document`) following the naming convention of <<relaton-yaml,Relaton YAML>>; e.g. `document.html` is the HTML URI for the document.
-
-The default stylesheet and templates are provided in the `templates` directory.
-
-=== relaton yaml2html
-
-[source,console]
-----
-$ relaton yaml2html YAML [<stylesheet>] [<liquid-template-dir>]
-----
-
-Render a Relaton YAML file as an HTML file. The `stylesheet` and `liquid-template-dir` parameters are as for <<relaton-xml2html,relaton xml2html>>.
-
-[[relaton-index]]
-=== relaton index
-
-[source,console]
-----
-$ relaton index [DATA-DIR] [options]
-----
-
-Build a modern, browsable HTML index site from a folder of Relaton
-bibliographic YAML documents (default `./data`, arbitrarily nested). This is the
-command that generates the GitHub Pages index for `relaton-data-<flavor>`
-repositories (e.g. https://relaton.github.io/relaton-data-bipm/).
-
-The generated `index.html` inlines a compiled Vue + Tailwind frontend (search,
-doctype/stage filters, sort, list/grid, dark mode, copy-DocID, responsive
-pagination). It carries **no document data of its own** — the page is a fixed
-~110 KB regardless of whether the corpus holds 200 documents or 200,000. The
-documents live in numbered JSON shards written alongside it, which the page
-fetches:
-
-[source]
-----
-_site/index.html            branding + the inlined bundle + the shard layout
-_site/search-0000.json      summary records, --shard-size each
-_site/search-0001.json      …loaded progressively: the first shard paints,
-                            the rest stream in behind it
-_site/detail-0000.json      the richer fields, --detail-shard-size each
-_site/detail-0001.json      …fetched only when a detail page is opened
-----
-
-This keeps page weight a function of what the reader is looking at rather than
-of corpus size. It matters at the top of the fleet: in the previous
-single-page design `relaton-data-3gpp` (88,464 documents) published a
-151,688,883-byte `index.html`, and `relaton-data-ids` (166,658 documents) would
-have published roughly twice that. The cost is not really the download —
-GitHub Pages gzips, so that page transfers in ~6.4 MB — but the browser still
-has to parse it and build a DOM node per document before anything appears.
-
-Clicking a document opens a shareable **detail page** (`?doc=<id>`) showing its
-full bibliographic details — abstract, contributors, all identifiers and dates,
-edition, languages, keywords, publisher, and the landing/raw-YAML links. Those
-fields come from the `detail-NNNN.json` shard holding that document, fetched
-when the panel opens; each block renders as it arrives, and a document with no
-such fields simply shows its summary and links.
-
-[NOTE]
-====
-Because the page fetches its data, it must be served over `http(s)://`. Opening
-`_site/index.html` straight off the filesystem shows an empty index — browsers
-block `fetch` from `file://`. To preview a build locally:
-
-[source,console]
-----
-$ cd _site && python3 -m http.server
-----
-
-Do **not** pre-compress the shards. GitHub Pages already serves them gzipped
-(verified: a 32.9 MB `search.json` transfers in 4.8 MB); a stored `.json.gz`
-would be served as `application/gzip` with no `Content-Encoding`, so the browser
-would not transparently inflate it.
-====
-
-.Options
-[cols="1,3"]
-|===
-| `-o, --output` | Output directory for the generated site (default `_site`).
-| `--flavor` | Build from `relaton/relaton-data-<flavor>` (shallow-cloned) instead of a local folder.
-| `--repo` | Build from a GitHub repo `ORG/NAME` (shallow-cloned) instead of a local folder.
-| `--branch` | Branch to clone when `--flavor`/`--repo` is used (default: the repo's default branch).
-| `-t, --title` | Index page title.
-| `--description` | Index page description. Emitted as `<meta name="description">` (search-result blurb) and rendered as the header subtitle in place of the default sentence.
-| `--favicon` | Favicon href for `<link rel="icon">`, emitted **verbatim**. Normally an absolute URL (e.g. the SDO's own logo). A site-relative path also works, but `relaton index` copies no assets — only the HTML shell and the JSON shards are written — so the caller must put that file into the deployed site itself. A known image extension (`.svg`, `.png`, `.ico`, `.gif`, `.jpg`) also sets `type`; anything else is left for the browser to sniff.
-| `--base-url` | Base URL for the raw-YAML links (defaults to the raw GitHub URL when cloning).
-| `--shard-size` | Summary records per `search-NNNN.json` (default `5000`, ≈1 MB per shard). Smaller shards paint sooner and cost more requests.
-| `--detail-shard-size` | Detail records per `detail-NNNN.json` (default `500`). This is how much is fetched to open one detail page, so keep it modest.
-| `--[no-]detail` | Emit the detail shards (default `true`). `--no-detail` roughly halves the deployed site and degrades detail pages to the summary fields plus links.
-| `--[no-]static` | Also index a sibling `static/` folder next to `DATA-DIR` (auto-detected, default `true`). Pass `--no-static` to index `DATA-DIR` only.
-| `--pubid-flavor` | Flavor whose pubid `Identifier` parses each docid and whose `INDEXFILE` names the published index (e.g. `iso`, `iho`, `iec`). **Required** unless `--no-machine-index`.
-| `--[no-]machine-index` | Emit the machine-consumable index (default `true`). `--no-machine-index` builds the human site only, and is the way to run without `--pubid-flavor`.
-| `--index-name` | Base name for the published index, overriding the flavor's `INDEXFILE` (e.g. `index-v2`). For a corpus that is not a relaton flavor. Must be a single file name — no `/` and no leading `.`.
-| `--[no-]publish-data` | Copy the scanned corpus to `_site/data/` so document fetches share the Pages origin (default `false`). For a repo whose records are served only from Pages; it roughly doubles the deployed size, and most repos are already served by `raw.githubusercontent.com`.
-| `-f, --overwrite` | Overwrite existing output files (default `true`).
-|===
-
-==== The machine index
-
-Alongside the human site, `relaton index` publishes a machine-consumable copy of
-the index so a Relaton client can resolve a reference from the Pages origin:
-
-[source]
-----
-_site/index-v2.yaml           the whole index, same shape as the repo's own
-_site/index-v2.zip            its zip sibling — what `Relaton::Index url:` fetches
-_site/index/manifest.json     the lookup rule
-_site/index/shard-00000.json  one bucket of rows
-----
-
-The monolith is named from the flavor's own `INDEXFILE` (hence `index-v2` for
-ISO, `index-v3` for IHO), so it is the file that flavor's consumer already
-fetches. Shard buckets are `crc32(pubid.root.number.to_s) % shards`, the same
-key `Relaton::Index` narrows on, so a document family lands in one shard.
-
-The wire contract — manifest fields, shard naming, and what the shards cannot
-serve — is specified in `docs/data-repository-format.adoc` in the `relaton`
-repo.
-
-NOTE: Some `relaton-data-<flavor>` repos keep manually-curated bibliographic YAML
-records (documents the crawler can't fetch — e.g. ISO/IEC Directives, JCGM/GUM
-guides, NIST research-library metadata) in a `static/` folder alongside `data/`.
-These are part of the served corpus (they appear in the repo's `index-vN.yaml`),
-so `relaton index` includes them by default: it auto-detects a `static/` sibling
-of `DATA-DIR` and folds its docs into the same site, with the raw-YAML links
-resolving to `static/<path>`. If a document id appears in both folders the `data/`
-copy wins. Use `--no-static` to suppress this.
-
-.Examples
-[source,console]
-----
-# From the checked-out data repo (as in the GitHub Action):
-$ relaton index data --output _site --pubid-flavor bipm --base-url \
-    https://raw.githubusercontent.com/relaton/relaton-data-bipm/v2
-
-# From a local folder of YAML docs (default ./data), human site only:
-$ relaton index ./my-docs --title "My Standards Index" --no-machine-index
-
-# Branded per flavor — title, search-result blurb and tab icon:
-$ relaton index data --pubid-flavor w3c --title "W3C Index" \
-    --description "Welcome to the World Wide Web Consortium standards index site!" \
-    --favicon https://www.w3.org/assets/logos/w3c/w3c-no-bars.svg
-
-# Ad-hoc, cloning the official data repo by flavor:
-$ relaton index --flavor bipm --pubid-flavor bipm --output _site
-
-# From an arbitrary GitHub repo, pinning the branch to clone:
-$ relaton index --repo relaton/relaton-data-bipm --branch v2 \
-    --pubid-flavor bipm --output _site
-
-# A corpus that is not a relaton flavor: name the index explicitly:
-$ relaton index data --pubid-flavor iso --index-name index-v2 --output _site
-
-# Tune the shard layout for a very large corpus:
-$ relaton index data --pubid-flavor iso --shard-size 10000 \
-    --detail-shard-size 250 --output _site
-
-# Skip the detail shards entirely (smaller site, summary-only detail pages):
-$ relaton index data --pubid-flavor iso --no-detail --output _site
-----
-
-[IMPORTANT]
-====
-`--mode` (`embedded` / `dom` / `static-json`) has been **removed**. Those modes
-existed to trade the crawler-indexable DOM against page weight; there is now one
-delivery mode, so there is nothing to choose. A caller still passing `--mode`
-fails with a usage error and a non-zero exit — deliberately loud, because
-silently ignoring it would publish a site nobody asked for.
-====
-
-NOTE: When building from a git checkout of relaton-cli, the compiled frontend
-must exist first: run `bundle exec rake build_frontend` (or
-`cd frontend && npm install && npm run build`). The released gem already ships
-the compiled bundle, so installed users need only Ruby.
-
-To publish these indexes from CI (GitHub Pages), a `relaton-data-<flavor>` repo
-calls the shared reusable workflow in `relaton/support`:
-
-[source,yaml]
-----
-jobs:
-  deploy:
-    uses: relaton/support/.github/workflows/data-deploy.yml@main
-----
-
-That workflow installs relaton-cli, runs `relaton index`, and deploys the result
-to GitHub Pages.
-
-=== relaton version
-
-[source,console]
-----
-$ relaton version
-----
-
-Display version information for the CLI and the bundled `relaton` gem (every
-flavor now reports the single `relaton` version).
-
-=== relaton collection
-
-The `relaton collection` command provides subcommands for collection manipulation.
-
-==== relaton collection create
-
-----
-$ relaton collection create COLLECTION -d DIRECTORY --author AUTHOR --title TITLE --doctype DOCTYPE
-----
-
-Create a new empty collection with the name `COLLECTION`.
-
-* `DIRECTORY` - optional path to a directory with collections. Default: `$HOME/.relaton/collections`.
-* `AUTHOR`, `TITLE`, and `DOCTYPE` are optional metadata.
-
-==== relaton collection info
-
-----
-$ relaton collection info COLLECTION -d DIRECTORY
-----
-
-Show information about `COLLECTION` (number of items, file size, last updated, name, metadata).
-
-* `DIRECTORY` - optional path to a directory with collections. Default: `$HOME/.relaton/collections`.
-
-==== relaton collection list
-
-----
-$ relaton collection list -d DIRECTORY -e
-----
-
-List all collections.
-
-* `DIRECTORY` - optional path to a directory with collections. Default: `$HOME/.relaton/collections`.
-* `-e` - when set, list the document ID of each entry.
-
-==== relaton collection get
-
-----
-$ relaton collection get CODE -c COLLECTION -d DIRECTORY -f FORMAT -o FILE
-----
-
-Get a document matching `CODE` from `COLLECTION`.
-
-* `COLLECTION` - optional name of a collection. If omitted, fetches the first match across all collections in `DIRECTORY`.
-* `DIRECTORY` - optional path to a directory with collections. Default: `$HOME/.relaton/collections`.
-* `FORMAT` - optional. If omitted, output is in human-readable form. Allowed values: `abb` (AsciiBib), `xml` (XML).
-* `FILE` - optional. Save the document with the given filename. The file extension (`abb`, `xml`) defines the output format.
-
-==== relaton collection find
-
-----
-$ relaton collection find TEXT -c COLLECTION -d DIRECTORY
-----
-
-Full-text search through a collection or all collections.
-
-* `COLLECTION` - optional name of a collection. If omitted, searches across all collections.
-* `DIRECTORY` - optional path to a directory with collections. Default: `$HOME/.relaton/collections`.
-
-==== relaton collection fetch
-
-----
-$ relaton collection fetch CODE -t TYPE -y YEAR -c COLLECTION -d DIRECTORY --publication-date-before DATE --publication-date-after DATE
-----
-
-Fetch the Relaton entry for document identifier `CODE` and save it into `COLLECTION`.
-
-* `TYPE` - specifies the standards class library. See <<relaton-fetch-types,recognized TYPE values>>.
-* `YEAR` - optional year of publication.
-* `COLLECTION` - name of a collection (required).
-* `DIRECTORY` - optional path to a directory with collections. Default: `$HOME/.relaton/collections`.
-* `--publication-date-before DATE` fetch only documents published before the specified date. Accepted formats: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`.
-* `--publication-date-after DATE` fetch only documents published after the specified date. Accepted formats: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`.
-
-==== relaton collection export
-
-----
-$ relaton collection export COLLECTION -d DIRECTORY
-----
-
-Export `COLLECTION` into an XML file.
-
-* `DIRECTORY` - optional path to a directory with collections. Default: `$HOME/.relaton/collections`.
-
-==== relaton collection import
-
-----
-$ relaton collection import FILE -c COLLECTION -d DIRECTORY
-----
-
-Import a document or collection from XML `FILE` into `COLLECTION`.
-
-* `COLLECTION` - optional. If the collection does not exist, it will be created.
-* `DIRECTORY` - optional path to a directory with collections. Default: `$HOME/.relaton/collections`.
-
-=== Database manipulation
-
-==== relaton db create
-
-----
-$ relaton db create DIR
-----
-
-Create a new cache database in directory `DIR` (optional, default: `$HOME/.relaton/cache`). If the target directory exists, it will be used as a database.
-
-==== relaton db mv
-
-----
-$ relaton db mv DIR
-----
-
-Move the cache database to a new directory `DIR`.
-
-==== relaton db clear
-
-----
-$ relaton db clear
-----
-
-Delete all entries from the cache database.
-
-==== relaton db fetch
-
-----
-$ relaton db fetch CODE -t TYPE -f FORMAT -y YEAR --publication-date-before DATE --publication-date-after DATE
-----
-
-Fetch an entry from the cache database. Arguments are the same as for `relaton fetch`.
-
-==== relaton db fetch_all
-
-----
-$ relaton db fetch_all TEXT -e EDITION -y YEAR -f FORMAT
-----
-
-Fetch all entries from the cache database.
-
-* `TEXT` - optional, search for a specific string.
-* `EDITION` - optional, filter documents by edition.
-* `YEAR` - optional, filter documents by year.
-* `FORMAT` - optional output format: `xml` (default), `yaml`, `bibtex`.
-
-==== relaton db doctype
-
-----
-$ relaton db doctype REF
-----
-
-Detect and display the document type from reference `REF`.
-
-----
-$ relaton db doctype 'CN(GB/T 1.1)'
-Chinese Standard
-GB/T 1.1
-----
-
-== Development
-
-[source,console]
-----
-$ bundle install
-$ bundle exec rspec
-$ bundle exec rubocop
-----
-
-== Contributing
-
-Open an issue or pull request at https://github.com/relaton/relaton.
-
-This gem is developed, maintained, and funded by
-https://www.ribose.com[Ribose Inc.]
-
-== License
-
-BSD 2-Clause. See link:../LICENSE[LICENSE] for details.

data/exe/relaton

@@ -1,20 +0,0 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-
-# resolve bin path, ignoring symlinks
-require "pathname"
-bin_file = Pathname.new(__FILE__).realpath
-
-# add self to libpath
-$:.unshift File.expand_path("../../lib", bin_file)
-
-# Fixes https://github.com/rubygems/rubygems/issues/1420
-require "rubygems/specification"
-
-class Gem::Specification
-  def this; self; end
-end
-
-require "relaton-cli"
-
-Relaton::Cli.start(ARGV)

data/frontend/dist/404.html

@@ -1,18 +0,0 @@
-<!doctype html>
-<html>
-  <head>
-    <meta charset="utf-8">
-    <title>Redirecting…</title>
-    <script>
-      // GitHub Pages has no URL rewrites, so path-based document URLs
-      // (/doc/<id>) land on this 404 fallback. Hand the id to the app as
-      // ?doc=<id>, preserving the site's base path wherever it is hosted.
-      (function () {
-        var m = location.pathname.match(/\/doc\/([^/?#]+)$/);
-        var root = m ? location.pathname.slice(0, m.index) : location.pathname.replace(/[^/]*$/, "");
-        location.replace(root + "?doc=" + (m ? m[1] : ""));
-      })();
-    </script>
-  </head>
-  <body></body>
-</html>