-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Final housekeeping: change of the readme, index file, separating an e…
…diting-howto file from readme.
- Loading branch information
Showing
3 changed files
with
96 additions
and
91 deletions.
There are no files selected for viewing
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 |
|---|---|---|
| @@ -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` |
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,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 (<[email protected]>), 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. |
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 |
|---|---|---|
|
|
@@ -164,14 +164,16 @@ <h1>Web Annotation WG</h1> | |
|
|
||
| <h2>Documents</h2> | ||
|
|
||
| <p>Deliverables of W3C’s <a href="http://www.w3.org/annotation">Web Annotation Working Group</a>. Please consult that page for further details on the goals and deliverables of the that group.</p> | ||
| <p>Deliverables of W3C’s <a href="http://www.w3.org/annotation">Web Annotation Working Group</a>. Note that <strong><em>the Working Group is now Closed;</em></strong> for further discussions on the evolution of Web Annotation technologies at W3C, possible errata, etc, please join the <a href="https://www.w3.org/community/openannotation/">W3C Open Annotation Community Group</a>.</p> | ||
|
|
||
| <h3>Current, published documents:</h3> | ||
|
|
||
| <ul> | ||
| <li><a href="http://www.w3.org/TR/annotation-model/">Web Annotation Data Model, <abbr title="Candidate Recommendation">CR</abbr></a></li> | ||
| <li><a href="http://www.w3.org/TR/annotation-vocab/">Web Annotation Vocabulary, <abbr title="Candidate Recommendation">CR</abbr></a></li> | ||
| <li><a href="http://www.w3.org/TR/annotation-protocol/">Web Annotation Protocol, <abbr title="Candidate Recommendation">CR</abbr></a></li> | ||
| <li><a href="http://www.w3.org/TR/annotation-model/">Web Annotation Data Model, <abbr title="Recommendation">REC</abbr></a></li> | ||
| <li><a href="http://www.w3.org/TR/annotation-vocab/">Web Annotation Vocabulary, <abbr title="Recommendation">REC</abbr></a></li> | ||
| <li><a href="http://www.w3.org/TR/annotation-protocol/">Web Annotation Protocol, <abbr title="Recommendation">REC</abbr></a></li> | ||
| <li><a href="http://www.w3.org/TR/annotation-html/">Embedding Web Annotations in HTML, WG Note</a></li> | ||
| <li><a href="http://www.w3.org/TR/selectors-states/">Selectors and States, WG Note</a></li> | ||
| </ul> | ||
|
|
||
| <h3>In progress documents (editor drafts):</h3> | ||
|
|
@@ -180,23 +182,16 @@ <h3>In progress documents (editor drafts):</h3> | |
| <li><a href="model/wd2/">Web Annotation Data Model</a></li> | ||
| <li><a href="vocab/wd/">Web Annotation Vocabulary</a></li> | ||
| <li><a href="protocol/wd/">Web Annotation Protocol</a></li> | ||
| <li><a href="selector-note/index-respec.html">Selectors and States</a> (this is planned to become a WG Note)</li> | ||
| <li><a href="serialization-html-note/index-respec.html">Embedding Web Annotations in HTML</a> (this is planned to become a WG Note)</li> | ||
| </ul> | ||
|
|
||
| <h3>Other documents</h3> | ||
|
|
||
| <ul> | ||
| <li><a href="http://w3c.github.io/findtext/">FindText API</a> (document currently on hold)</li> | ||
| <li><a href="selector-note/">Selectors and States</a> </li> | ||
| <li><a href="serialization-html-note/">Embedding Web Annotations in HTML</a></li> | ||
| </ul> | ||
|
|
||
| <h2>Contact Info</h2> | ||
|
|
||
| <p>The W3C Team Contact for the Web Annotation Working Group is | ||
| <a href="http://www.w3.org/People/all#herman">Ivan Herman</a> | ||
| The Co-Chairs of the Working Group are | ||
| <p>The W3C Team Contact for the Web Annotation Working Group was | ||
| <a href="http://www.w3.org/People/all#herman">Ivan Herman</a>. | ||
| The Co-Chairs of the Working Group were | ||
| <a href="mailto:[email protected]">Tim Cole (University of Illinois)</a> and | ||
| <a href="mailto:[email protected]">Robert Sanderson (Stanford University)</a>. | ||
| If you are member of the Working Group, and you want to gain a “push” right to this repository, please contact <a href="mailto:[email protected]">[email protected]</a> providing your github ID.</p> | ||
| <a href="mailto:[email protected]">Robert Sanderson (Stanford University)</a>.</p> | ||
| </body> | ||
| </html> | ||