Skip to content

Commit e071685

Browse files
committed
Final housekeeping: change of the readme, index file, separating an editing-howto file from readme.
1 parent 1fdee2c commit e071685

File tree

3 files changed

+96
-91
lines changed

3 files changed

+96
-91
lines changed

Editing-Howto.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
## Editing and Building the Documents
2+
3+
### Model
4+
5+
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:
6+
7+
* Run `python ./rename_names.py` — this adds the names to the use cases
8+
* Run `python ./extract_egs.py` — this checks and extracts the examples
9+
* Load `index-respec.html` in a browser and use `respec` to save as HTML
10+
* Move the resulting `index.html` into the directory
11+
* In the directory, `git add -A *``
12+
13+
The final files for publication are:
14+
15+
* `index.html`
16+
* `examples/`
17+
* `images/`
18+
* `orcid_logo.png`
19+
20+
### Vocab
21+
22+
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:
23+
24+
* Run `python ./make_links.py` — this makes all of the vocab terms into links
25+
* Run `python ./extract_egs.py` — this checks and extracts the examples
26+
* Load `index-respec.html` in a browser and use `respec` to save as HTML
27+
* Move the resulting `index.html` into the directory
28+
* In the directory, `git add -A *``
29+
30+
The final files for publication are:
31+
32+
* `index.html`
33+
* `examples/`
34+
* `images/`
35+
* `orcid_logo.png`
36+
37+
### Protocol
38+
39+
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:
40+
41+
* Load `index-respec.html` in a browser and use `respec` to save as HTML
42+
* Move the resulting `index.html` into the directory
43+
* In the directory, `git add -A *``
44+
45+
The final files for publication are:
46+
47+
* `index.html`
48+
* `orcid_logo.png`
49+
50+
(There are no scripts associated with the protocol document)
51+
52+
### HTML serialization note
53+
54+
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
55+
56+
* Run `python highlight-turtle.py` — this adds color highlighting to turtle examples
57+
* Load `index-respec.html` in a browser and use `respec` to save as HTML
58+
* Move the resulting `index.html` into the directory
59+
* In the directory, `git add -A *`
60+
61+
The final files for publication are:
62+
63+
* `index.html`
64+
* `images/`
65+
* `orcid_logo.png`
66+
67+
### Selector note
68+
69+
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
70+
71+
* Run `python highlight-turtle.py` — this adds color highlighting to turtle examples
72+
* Load `index-respec.html` in a browser and use `respec` to save as HTML5
73+
* Move the resulting `index.html` into the directory
74+
* In the directory, `git add -A *`
75+
76+
The final files for publication are:
77+
78+
* `index.html`
79+
* `images/`
80+
* `orcid_logo.png`

README.md

Lines changed: 4 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,6 @@
1-
Web-Annotation
2-
==========
1+
Web Annotation Repository
2+
=========================
33

4-
Documents produced by the [Web Annotation Working Group](http://www.w3.org/annotation/) of the W3C.
4+
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/).
55

6-
Current in-progress drafts:
7-
* Model: http://w3c.github.io/web-annotation/model/wd2/
8-
* [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)
9-
* Vocab: http://w3c.github.io/web-annotation/vocab/wd/
10-
* [Test Results](https://github.com/w3c/test-results/tree/gh-pages/annotation-vocab#annotation-vocabulary-test-results)
11-
* Protocol: http://w3c.github.io/web-annotation/protocol/wd/
12-
* [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)
13-
* Selector note: http://w3c.github.io/web-annotation/selector-note/
14-
15-
See also a [paged view](http://w3c.github.io/web-annotation/) of the documents served in HTML.
16-
17-
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.
18-
19-
20-
## Editing and Building the Documents
21-
22-
### Model
23-
24-
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:
25-
26-
* Run `python ./rename_names.py` -- this adds the names to the use cases
27-
* Run `python ./extract_egs.py` -- this checks and extracts the examples
28-
* Load `index-respec.html` in a browser and use respec to save as HTML5
29-
* Move the resulting `index.html` into the directory
30-
* In the directory, git add -A *
31-
32-
The final files for publication are:
33-
34-
* index.html
35-
* examples/
36-
* images/
37-
38-
### Vocab
39-
40-
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:
41-
42-
* Run `python ./make_links.py` -- this makes all of the vocab terms into links
43-
* Run `python ./extract_egs.py` -- this checks and extracts the examples
44-
* Load `index-respec.html` in a browser and use respec to save as HTML5
45-
* Move the resulting `index.html` into the directory
46-
* In the directory, git add -A *
47-
48-
The final files for publication are:
49-
50-
* index.html
51-
* examples/
52-
* images/
53-
54-
### Protocol
55-
56-
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:
57-
58-
* Load `index-respec.html` in a browser and use respec to save as HTML5
59-
* Move the resulting `index.html` into the directory
60-
* In the directory, git add -A *
61-
62-
The final files for publication are:
63-
64-
* index.html
65-
66-
(There are no scripts associated with the protocol document)
67-
68-
### Selector note
69-
70-
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:
71-
72-
* Load `index-respec.html` in a browser and use respec to save as HTML5
73-
* Move the resulting `index.html` into the directory
74-
* In the directory, git add -A *
75-
76-
(There are no scripts associated with the Selector note)
6+
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.

index.html

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -164,14 +164,16 @@ <h1>Web Annotation WG</h1>
164164

165165
<h2>Documents</h2>
166166

167-
<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>
167+
<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>
168168

169169
<h3>Current, published documents:</h3>
170170

171171
<ul>
172-
<li><a href="http://www.w3.org/TR/annotation-model/">Web Annotation Data Model, <abbr title="Candidate Recommendation">CR</abbr></a></li>
173-
<li><a href="http://www.w3.org/TR/annotation-vocab/">Web Annotation Vocabulary, <abbr title="Candidate Recommendation">CR</abbr></a></li>
174-
<li><a href="http://www.w3.org/TR/annotation-protocol/">Web Annotation Protocol, <abbr title="Candidate Recommendation">CR</abbr></a></li>
172+
<li><a href="http://www.w3.org/TR/annotation-model/">Web Annotation Data Model, <abbr title="Recommendation">REC</abbr></a></li>
173+
<li><a href="http://www.w3.org/TR/annotation-vocab/">Web Annotation Vocabulary, <abbr title="Recommendation">REC</abbr></a></li>
174+
<li><a href="http://www.w3.org/TR/annotation-protocol/">Web Annotation Protocol, <abbr title="Recommendation">REC</abbr></a></li>
175+
<li><a href="http://www.w3.org/TR/annotation-html/">Embedding Web Annotations in HTML, WG Note</a></li>
176+
<li><a href="http://www.w3.org/TR/selectors-states/">Selectors and States, WG Note</a></li>
175177
</ul>
176178

177179
<h3>In progress documents (editor drafts):</h3>
@@ -180,23 +182,16 @@ <h3>In progress documents (editor drafts):</h3>
180182
<li><a href="model/wd2/">Web Annotation Data Model</a></li>
181183
<li><a href="vocab/wd/">Web Annotation Vocabulary</a></li>
182184
<li><a href="protocol/wd/">Web Annotation Protocol</a></li>
183-
<li><a href="selector-note/index-respec.html">Selectors and States</a> (this is planned to become a WG Note)</li>
184-
<li><a href="serialization-html-note/index-respec.html">Embedding Web Annotations in HTML</a> (this is planned to become a WG Note)</li>
185-
</ul>
186-
187-
<h3>Other documents</h3>
188-
189-
<ul>
190-
<li><a href="http://w3c.github.io/findtext/">FindText API</a> (document currently on hold)</li>
185+
<li><a href="selector-note/">Selectors and States</a> </li>
186+
<li><a href="serialization-html-note/">Embedding Web Annotations in HTML</a></li>
191187
</ul>
192188

193189
<h2>Contact Info</h2>
194190

195-
<p>The W3C Team Contact for the Web Annotation Working Group is
196-
<a href="http://www.w3.org/People/all#herman">Ivan Herman</a>
197-
The Co-Chairs of the Working Group are
191+
<p>The W3C Team Contact for the Web Annotation Working Group was
192+
<a href="http://www.w3.org/People/all#herman">Ivan Herman</a>.
193+
The Co-Chairs of the Working Group were
198194
<a href="mailto:[email protected]">Tim Cole (University of Illinois)</a> and
199-
<a href="mailto:[email protected]">Robert Sanderson (Stanford University)</a>.
200-
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>
195+
<a href="mailto:[email protected]">Robert Sanderson (Stanford University)</a>.</p>
201196
</body>
202197
</html>

0 commit comments

Comments
 (0)