An open API service indexing awesome lists of open source software.

https://github.com/calconnect/cc-transcription-systems

CC/ISO 24229 Codes for transcription systems
https://github.com/calconnect/cc-transcription-systems

standard

Last synced: 18 days ago
JSON representation

CC/ISO 24229 Codes for transcription systems

Awesome Lists containing this project

README

          

= CalConnect/ISO 24229: Information and documentation -- Codes for written language conversion systems

This work item belongs to ISO/TC 46/WG 3 and CalConnect TC LOCALIZATION.

image:https://github.com/CalConnect/csd-transcription-systems/actions/workflows/publish.yml/badge.svg["Publish", link="https://github.com/CalConnect/csd-transcription-systems/actions/workflows/publish.yml"]

This document is available in its rendered forms here:

* https://calconnect.github.io/csd-transcription-systems/[CC/ISO 24229: Information and documentation -- Codes for script conversion systems]

== Fetching the document

[source,sh]
----
git clone https://github.com/CalConnect/csd-transcription-systems
----

== Installing Build Tools

[source,sh]
----
make prep
----

== Building The Document

[source,sh]
----
make
----

The following outputs will be built:

* Document index at `site/documents.html`
* ISO 24229 at `site/documents/iso-24229.html`
* CC 24229 at `site/documents/iso-24229.html`
* HTML (`[filename].html`)
* PDF (`[filename].pdf`)
* Word DOC (`[filename].doc`)

== Iterating the document

[source,sh]
----
make
open site/documents/iso-24229.html
open site/documents/cc-24229.html
----

== Updating gems

Update `Gemfile` with desired modifications and run `bundle install`, then check
in `Gemfile.lock`.

=== Updating gems (with Nix)

After updating gems as decribed above, run the following, then check in
the generated `gemset.nix`.

[source,bash]
----
rm -f .bundle/config # This interferes with the following. May be unneeded for Bundler v3
nix-shell -p bundix zlib libxml2 pkg-config libxslt libiconv --run 'bundix --magic'
# $(nix-build "" -A bundix --no-out-link)/bin/bundix --magic
----

The packages listed are for building nokogiri: `zlib libxml2 pkg-config libxslt libiconv`.