From e07168525486ec6363004407df26baa219a2d369 Mon Sep 17 00:00:00 2001 From: Ivan Herman Date: Thu, 23 Feb 2017 10:25:49 +0100 Subject: [PATCH] Final housekeeping: change of the readme, index file, separating an editing-howto file from readme. --- Editing-Howto.md | 80 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 78 +++------------------------------------------- index.html | 29 ++++++++---------- 3 files changed, 96 insertions(+), 91 deletions(-) create mode 100644 Editing-Howto.md diff --git a/Editing-Howto.md b/Editing-Howto.md new file mode 100644 index 0000000..730d564 --- /dev/null +++ b/Editing-Howto.md @@ -0,0 +1,80 @@ +## Editing and Building the Documents + +### Model + +Only edit the most recent working draft, currently `/model/wd2`. Only edit `index-nametemplate.html` and then follow these steps to build the final HTML document: + +* Run `python ./rename_names.py` — this adds the names to the use cases +* Run `python ./extract_egs.py` — this checks and extracts the examples +* Load `index-respec.html` in a browser and use `respec` to save as HTML +* Move the resulting `index.html` into the directory +* In the directory, `git add -A *`` + +The final files for publication are: + +* `index.html` +* `examples/` +* `images/` +* `orcid_logo.png` + +### Vocab + +Only edit the most recent working draft, currently `/vocab/wd`. Only edit `index-linktemplate.html` and then follow these steps to build the final HTML document: + +* Run `python ./make_links.py` — this makes all of the vocab terms into links +* Run `python ./extract_egs.py` — this checks and extracts the examples +* Load `index-respec.html` in a browser and use `respec` to save as HTML +* Move the resulting `index.html` into the directory +* In the directory, `git add -A *`` + +The final files for publication are: + +* `index.html` +* `examples/` +* `images/` +* `orcid_logo.png` + +### Protocol + +Only edit the most recent working draft, currently `/protocol/wd`. Only edit `index-respec.html` and then follow these steps to build the final HTML document: + +* Load `index-respec.html` in a browser and use `respec` to save as HTML +* Move the resulting `index.html` into the directory +* In the directory, `git add -A *`` + +The final files for publication are: + +* `index.html` +* `orcid_logo.png` + +(There are no scripts associated with the protocol document) + +### HTML serialization note + +Only edit the most recent working draft, currently `/serialization-html-note`. Only edit `index-turtle-not-highligh.html` and the follow these steps build the final HTML document + +* Run `python highlight-turtle.py` — this adds color highlighting to turtle examples +* Load `index-respec.html` in a browser and use `respec` to save as HTML +* Move the resulting `index.html` into the directory +* In the directory, `git add -A *` + +The final files for publication are: + +* `index.html` +* `images/` +* `orcid_logo.png` + +### Selector note + +Only edit the most recent working draft, currently `/selector-note`. Only edit `index-turtle-not-highligh.html` and the follow these steps build the final HTML document + +* Run `python highlight-turtle.py` — this adds color highlighting to turtle examples +* Load `index-respec.html` in a browser and use `respec` to save as HTML5 +* Move the resulting `index.html` into the directory +* In the directory, `git add -A *` + +The final files for publication are: + +* `index.html` +* `images/` +* `orcid_logo.png` diff --git a/README.md b/README.md index 7d5384a..a4bbd78 100644 --- a/README.md +++ b/README.md @@ -1,76 +1,6 @@ -Web-Annotation -========== +Web Annotation Repository +========================= -Documents produced by the [Web Annotation Working Group](http://www.w3.org/annotation/) of the W3C. +Documents produced by the [Web Annotation Working Group](http://www.w3.org/annotation/) of the W3C. The Working Group has published its recommendations, and is now closed; see the separate list of the [published documents](http://w3c.github.io/web-annotation/). -Current in-progress drafts: - * Model: http://w3c.github.io/web-annotation/model/wd2/ - * [Test Results](https://github.com/w3c/test-results/tree/gh-pages/annotation-model#annotation-model-test-results) & [Process](https://github.com/w3c/test-results/tree/gh-pages/annotation-model#adding-new-results) - * Vocab: http://w3c.github.io/web-annotation/vocab/wd/ - * [Test Results](https://github.com/w3c/test-results/tree/gh-pages/annotation-vocab#annotation-vocabulary-test-results) - * Protocol: http://w3c.github.io/web-annotation/protocol/wd/ - * [Test Results](https://github.com/w3c/test-results/tree/gh-pages/annotation-protocol#annotation-protocol-test-results) & [Process](https://github.com/w3c/test-results/tree/gh-pages/annotation-protocol#adding-new-results) - * Selector note: http://w3c.github.io/web-annotation/selector-note/ - -See also a [paged view](http://w3c.github.io/web-annotation/) of the documents served in HTML. - -If you are member of the interest group, and you wish to contribute to the content of this repo, please contact Ivan Herman (), giving him your github login. - - -## Editing and Building the Documents - -### Model - -Only edit the most recent working draft, currently /model/wd2. Only edit index-nametemplate.html and then follow these steps to build the final HTML document: - -* Run `python ./rename_names.py` -- this adds the names to the use cases -* Run `python ./extract_egs.py` -- this checks and extracts the examples -* Load `index-respec.html` in a browser and use respec to save as HTML5 -* Move the resulting `index.html` into the directory -* In the directory, git add -A * - -The final files for publication are: - -* index.html -* examples/ -* images/ - -### Vocab - -Only edit the most recent working draft, currently /vocab/wd. Only edit index-linktemplate.html and then follow these steps to build the final HTML document: - -* Run `python ./make_links.py` -- this makes all of the vocab terms into links -* Run `python ./extract_egs.py` -- this checks and extracts the examples -* Load `index-respec.html` in a browser and use respec to save as HTML5 -* Move the resulting `index.html` into the directory -* In the directory, git add -A * - -The final files for publication are: - -* index.html -* examples/ -* images/ - -### Protocol - -Only edit the most recent working draft, currently /protocol/wd. Only edit index-respec.html and then follow these steps to build the final HTML document: - -* Load `index-respec.html` in a browser and use respec to save as HTML5 -* Move the resulting `index.html` into the directory -* In the directory, git add -A * - -The final files for publication are: - -* index.html - -(There are no scripts associated with the protocol document) - -### Selector note - -Only edit the most recent working draft, currently /selector-note. Only edit index-respec.html and then follow these steps to build the final HTML document: - -* Load `index-respec.html` in a browser and use respec to save as HTML5 -* Move the resulting `index.html` into the directory -* In the directory, git add -A * - -(There are no scripts associated with the Selector note) +This repository is now under the control of the [W3C Open Annotation Community Group](https://www.w3.org/community/openannotation/). Everyone is welcome adding issues to the repository, clearly marked as errata or proposals for future work. The Community group's [mailing list](https://lists.w3.org/Archives/Public/public-openannotation/) is another avenue for further discussion; please, join the Community Group if you are interested in the topic. diff --git a/index.html b/index.html index 15766de..676218a 100644 --- a/index.html +++ b/index.html @@ -164,14 +164,16 @@

Web Annotation WG

Documents

-

Deliverables of W3C’s Web Annotation Working Group. Please consult that page for further details on the goals and deliverables of the that group.

+

Deliverables of W3C’s Web Annotation Working Group. Note that the Working Group is now Closed; for further discussions on the evolution of Web Annotation technologies at W3C, possible errata, etc, please join the W3C Open Annotation Community Group.

Current, published documents:

In progress documents (editor drafts):

@@ -180,23 +182,16 @@

In progress documents (editor drafts):

  • Web Annotation Data Model
  • Web Annotation Vocabulary
  • Web Annotation Protocol
    • -
  • Selectors and States (this is planned to become a WG Note)
    • -
  • Embedding Web Annotations in HTML (this is planned to become a WG Note)
    • - - -

    Other documents

    - -

    Contact Info

    -

    The W3C Team Contact for the Web Annotation Working Group is - Ivan Herman - The Co-Chairs of the Working Group are +

    The W3C Team Contact for the Web Annotation Working Group was + Ivan Herman. + The Co-Chairs of the Working Group were Tim Cole (University of Illinois) and - Robert Sanderson (Stanford University). - If you are member of the Working Group, and you want to gain a “push” right to this repository, please contact ivan@w3.org providing your github ID.

    + Robert Sanderson (Stanford University).