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 structure #4

Merged
merged 2 commits into from
Dec 9, 2024
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
3 changes: 0 additions & 3 deletions .bundle/config

This file was deleted.

177 changes: 0 additions & 177 deletions Makefile

This file was deleted.

82 changes: 55 additions & 27 deletions README.adoc
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.
3 changes: 2 additions & 1 deletion sources/sections/00-abstract.adoc
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.
2 changes: 2 additions & 0 deletions sources/sections/09-newproperties.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Possible category resources are the various proprietary systems,
something like the dmoz.org data.

Format Definition::
+
--
This property is defined by the following notation:

Expand Down Expand Up @@ -169,6 +170,7 @@ Description:: The value of this property is a text identifier that
have the same REFID value.

Format Definition::
+
--
This property is defined by the following notation:

Expand Down
Loading