Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update text #78

Merged
merged 2 commits into from
Feb 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 5 additions & 24 deletions .github/workflows/build_deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ on:
push:
branches:
- main
# - staging
pull_request:
repository_dispatch:
workflow_dispatch:
Expand All @@ -22,50 +21,32 @@ concurrency:
cancel-in-progress: false

jobs:
# set_environment:
# outputs:
# my_env: ${{ steps.setenv.outputs.my_env }}
# my_url: ${{ steps.setenv.outputs.my_url }}
# runs-on: ubuntu-latest
# steps:
# - id: setenv
# run: |
# if [ "$GITHUB_REF" = "refs/heads/main" ]
# then
# echo "::set-output name=my_env::production"
# echo "::set-output name=my_url::https://www.tebako.org"
# elif [ "$GITHUB_REF" = "refs/heads/staging" ]
# then
# echo "::set-output name=my_env::staging"
# echo "::set-output name=my_url::https://staging-www.tebako.org"
# fi

build:
runs-on: ubuntu-latest
# needs: [set_environment]
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.1'
ruby-version: '3.3'
bundler-cache: true
cache-version: 0 # Increment this number if you need to re-download cached gems
- name: Setup Pages
id: pages
uses: actions/configure-pages@v3

- name: Build with Jekyll
# Outputs to the './_site' directory by default
run: JEKYLL_LOG_LEVEL=debug bundle exec jekyll build --verbose --trace --baseurl "${{ steps.pages.outputs.base_path }}"
run: bundle exec jekyll build --verbose --trace --baseurl "${{ steps.pages.outputs.base_path }}"
env:
JEKYLL_ENV: production
JEKYLL_LOG_LEVEL: debug

- name: Upload artifact
# Automatically uploads an artifact from the './_site' directory by default
uses: actions/upload-pages-artifact@v2
uses: actions/upload-pages-artifact@v3

# Deployment job
deploy:
Expand All @@ -78,4 +59,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
uses: actions/deploy-pages@v4
45 changes: 27 additions & 18 deletions _specs/relaton-render.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Relaton-Render
description: Templates for rendering Relaton bibliographic items as Metanorma bibliographies.
title: Relaton Render
description: Define and use bibliographic reference styles in Relaton.

feature_with_priority: 8

Expand All @@ -14,9 +14,11 @@ external_links:
Relaton Render (`relaton-render`) is a Ruby gem that transforms Relaton objects
(which represent bibliographic items) into string reference renderings.

The gem supports multiple bibliographic styles through configurable YAML
templates and provides localization for text elements like ordinals, dates, and
abbreviations.
Relaton Render allows you to:

* define bibliographic reference styles
* render bibliographic and citation references using an existing bibliographic reference style
* localize bibliographic reference styles in multiple languages

NOTE: Formatted references are embedded within Metanorma documents as `<formattedref>` elements.

Expand All @@ -27,16 +29,21 @@ to render these items in a human-readable format, a rendering process is needed
to convert the structured data into a formatted reference.

There exists many types of bibliographic citation formats, each with its own
rules and conventions. Given that Relaton models are the digital representation
of the ISO 690 bibliographic standard, the `relaton-render` gem naturally
is able to render bibliographic items according to its provided styles.
rules and conventions.

Given that the Relaton models implement the defined bibliographic models of the
ISO 690 standard, Relaton Render is naturally able to render
bibliographic items according to the ISO 690 bibliographic styles, as well as bibliographic styles that follow the bibliographic style definition framework described in ISO 690.

NOTE: Most well-defined citation styles, such as APA and MLA, can be defined
within the meta-bibliographic framework of ISO 690.

Relaton Render goes beyond commonly used citation rendering libraries and
citation specification languages, such as CSL (Citation Style Language),
CSL-derivatives like CSL-JSON, or Zotero, in that they are unable to handle the
comprehensive data elements and metadata supported by ISO 690.

The ISO 690 is superior in expressibilty to typical styles with some key
The ISO 690 is superior in expressibility to typical styles with some key
differences:

* ISO 690 uses a data model that is a strict superset of typical citation
Expand All @@ -47,16 +54,18 @@ languages, including:

* ISO 690 citation references are expressive yet consistent:

** applies consistent citation rules for every type of supported information resource
** with the ability to round-trip human-readable citations into their
machine-readable counterparts.
** applies deterministic citation rules for every type of supported information
resource

** provides the ability to round-trip human-readable citations into their
machine-readable counterparts in a lossless manner.

NOTE: Metanorma is a standards publication system that embeds Relaton data
inside its documents to serve as both metadata and references. Relaton Render
provides Metanorma with the ability to render these references in a
human-readable format in the Metanorma presentation XML layer under
`bibitem/formattedref`, and can contain formatting (e.g. `<em>` for italics,
`<strong>` for boldface.)
NOTE: https://www.metanorma.org[Metanorma] is a standards publication system
that embeds Relaton data inside its documents to serve as both metadata and
references. Relaton Render provides Metanorma with the ability to render these
references in a human-readable format in the Metanorma presentation XML layer
under `bibitem/formattedref`, and can contain formatting (e.g. `<em>` for
italics, `<strong>` for boldface.)


== Data flow
Expand Down
Loading