-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
57 additions
and
208 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,68 +1,96 @@ | ||
:repo-name: csd-ical-relations | ||
|
||
= CalConnect Standard: Calendaring and scheduling -- Support for iCalendar Relationships | ||
|
||
This work item belongs to TC FREEBUSY. | ||
This work item belongs to TC CALENDAR. | ||
|
||
image:https://travis-ci.com/CalConnect/csd-ical-relations.svg?branch=master["Build Status", link="https://travis-ci.com/CalConnect/csd-ical-relations"] | ||
image:https://github.com/CalConnect/cc-ical-relations/actions/workflows/generate.yml/badge.svg["Build Status", link="https://github.com/CalConnect/cc-ical-relations/actions/workflows/generate.yml"] | ||
|
||
This document is available in its rendered forms here: | ||
|
||
* https://calconnect.github.io/csd-ical-relations/[CalConnect Standard: Calendaring and scheduling -- Support for iCalendar Relationships (HTML)] | ||
* https://calconnect.github.io/csd-ical-relations/csd-ical-relations.pdf[PDF] | ||
* https://calconnect.github.io/csd-ical-relations/csd-ical-relations.xml[Metanorma XML] | ||
* https://calconnect.github.io/csd-ical-relations/csd-ical-relations.rxl[Relaton XML (Bibliographic item)] | ||
* https://calconnect.github.io/cc-ical-relations/[CalConnect+IETF: Calendaring and scheduling -- Support for iCalendar Relationships] | ||
== General | ||
|
||
This document updates RELATED-TO defined in RFC 5545 and introduces new | ||
iCalendar properties LINK, CONCEPT and REFID to allow better linking and | ||
grouping of iCalendar components and related data. | ||
|
||
The document is published as the following: | ||
|
||
* CalConnect CC 51004 | ||
* IETF draft-ietf-calext-ical-relations | ||
|
||
|
||
== Structure | ||
|
||
`sources/`:: | ||
source of documents and models | ||
|
||
`sources/cc-51004.adoc`:: | ||
CalConnect CC 51004 standard. | ||
|
||
`sources/draft-ietf-calext-ical-relations.adoc`:: | ||
IETF draft-ietf-calext-ical-relations, dual-published from CC 51004. | ||
|
||
`_site/`:: | ||
(automatically generated using `metanorma site generate`) published document. | ||
|
||
|
||
== Fetching the document | ||
|
||
[source,sh] | ||
---- | ||
git clone https://github.com/CalConnect/csd-ical-relations/ | ||
git clone https://github.com/CalConnect/cc-ical-relations/ | ||
---- | ||
|
||
== Installing Build Tools | ||
|
||
See https://www.metanorma.com/overview/getting-started/ | ||
== Installing build tools | ||
|
||
See https://www.metanorma.org/install/ | ||
|
||
|
||
== Running via Docker or locally | ||
|
||
If you have installed the build tools locally, and wish to run the | ||
locally-installed compilation tools, there is nothing further to set. | ||
|
||
If you don't want to deal with local dependencies, use the docker | ||
version by: | ||
If you don't want to deal with local dependencies, use the docker: | ||
|
||
[source,sh] | ||
---- | ||
export METANORMA_DOCKER=1 | ||
docker run -v "$(pwd)":/metanorma -w /metanorma -it metanorma/mn metanorma site generate --agree-to-terms | ||
---- | ||
|
||
The `Makefile` will automatically choose the proper command to | ||
execute. | ||
|
||
|
||
== Building The Document | ||
== Building the document | ||
|
||
[source,sh] | ||
---- | ||
make clean all | ||
metanorma site generate --agree-to-terms | ||
---- | ||
|
||
The following outputs will be built: | ||
|
||
* CSD XML (https://github.com/calconnect/metanorma-model-csd) (`[filename].xml`) | ||
* HTML (`[filename].html`) | ||
* PDF (`[filename].pdf`) | ||
* Word DOC (`[filename].doc`) | ||
The generated documents are accessible under `_site/`. | ||
|
||
|
||
== Iterating the document | ||
|
||
[source,sh] | ||
---- | ||
make html | ||
open csd-*.html | ||
metanorma site generate --agree-to-terms | ||
open _site/index.html | ||
---- | ||
|
||
|
||
== IETF: Checking against idnits | ||
|
||
https://tools.ietf.org/tools/idnits/[idnits] is the RFC checking tool prior to | ||
submissions. | ||
|
||
[source,sh] | ||
---- | ||
idnits draft-ietf-calext-ical-relations.nits | ||
---- | ||
|
||
|
||
== License | ||
|
||
Copyright its respective authors and CalConnect. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
|
||
[abstract] | ||
.Abstract | ||
|
||
This document updates RELATED-TO defined in <<RFC5545>> and | ||
introduces new iCalendar properties LINK, CONCEPT and REFID to allow | ||
better linking and grouping of iCalendar components and related data. |