Skip to content
This repository has been archived by the owner on Nov 4, 2022. It is now read-only.

Changes to OASIS templates and Javascript #8

Open
wants to merge 120 commits into
base: feature/oasis-style
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
120 commits
Select commit Hold shift + click to select a range
c87cd6e
adding stopgap jquery map to get dev env working
Mar 21, 2014
d26df62
Reverting stopgap jquery try
Mar 21, 2014
de6a0c4
Merge branch 'gh-pages' of https://github.com/sspeiche/respec into gh…
sspeiche Sep 2, 2014
4121808
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Sep 3, 2014
d043b97
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Sep 3, 2014
1238f59
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Sep 3, 2014
08dff90
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Sep 3, 2014
34e313c
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Sep 3, 2014
cdd655b
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Sep 4, 2014
44a0de8
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Sep 4, 2014
3754430
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Sep 4, 2014
c9a6c61
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Sep 9, 2014
9e01e38
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Sep 16, 2014
bed5f1c
merge
sspeiche Sep 16, 2014
afca84d
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Sep 17, 2014
dcc15f4
merge
sspeiche Sep 23, 2014
f0330e9
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Nov 19, 2014
8029487
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Nov 24, 2014
1635111
Merge of feature/oasis-style
sspeiche Nov 24, 2014
261a234
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Nov 25, 2014
596b7ef
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Dec 2, 2014
350cd60
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Dec 2, 2014
53929b4
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Dec 2, 2014
26c053e
fix n3 release problem
sspeiche Dec 2, 2014
2fc69b1
merge from oasis-style
sspeiche Dec 2, 2014
b88508c
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Dec 2, 2014
3e05f60
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Dec 2, 2014
a4e34f5
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Dec 4, 2014
09b5cef
Merge branch 'feature/oasis-style' into gh-pages
sspeiche Dec 10, 2014
f05c67c
Merge branch 'feature/oasis-style' into gh-pages
ndjc Jun 22, 2015
9fa4778
Merge branch 'gh-pages' of https://github.com/sspeiche/respec into fe…
sspeiche Jun 24, 2015
a9732f4
Merge branch 'feature/oasis-style' into gh-pages
ndjc Aug 25, 2015
2d8b81a
Merge branch 'feature/oasis-style' into gh-pages:
ndjc Aug 25, 2015
c758d09
Merge branch 'gh-pages' of https://github.com/ndjc/respec into gh-pages
ndjc Aug 25, 2015
13d30ae
Ignore .md.html file
ndjc Sep 10, 2015
f54542d
Ignore .md.html files
ndjc Sep 10, 2015
fb7970b
Various fixes for OASIS format specs
ndjc Oct 7, 2015
31e4d6f
Merge branch 'feature/oasis-style' into gh-pages
ndjc Oct 7, 2015
d2bdd3e
Make oslc:range property multiValue
Oct 22, 2015
b2e8a29
Merge remote-tracking branch 'origin/gh-pages' into feature/oasis-style
Oct 22, 2015
ea51a77
Allow ED docs to have no previous version
ndjc Oct 25, 2015
d0b397d
Merge branch 'feature/oasis-style' into gh-pages
ndjc Oct 25, 2015
a9dad23
Merge pull request #2 from imunolion/gh-pages
ndjc Oct 25, 2015
c25e4cf
Merge remote-tracking branch 'sspeiche/feature/oasis-style' into feat…
ndjc Oct 25, 2015
7c1ceec
Merge changes from Steve
ndjc Oct 25, 2015
b1f02ac
Resolve conflicts and merge
ndjc Oct 25, 2015
a47720f
Merge branch 'gh-pages' into feature/oasis-style
ndjc Oct 25, 2015
8fa26c2
Use ndjc github repo as the master (at least for testing purposes)
ndjc Oct 25, 2015
7aea919
Build version with ndjc github as the master, and with chamges from i…
ndjc Oct 25, 2015
f55a6e8
v0.0.9
ndjc Oct 25, 2015
feeda38
v0.0.9
ndjc Oct 25, 2015
a106afc
v0.0.9
ndjc Oct 25, 2015
363b9fc
v0.0.9
ndjc Oct 25, 2015
d02a19e
v0.0.9
ndjc Oct 25, 2015
99aa33a
v0.0.9
ndjc Oct 25, 2015
234f73d
v0.0.9
ndjc Oct 25, 2015
ab8be74
v0.0.9
ndjc Oct 25, 2015
b65232f
v0.0.9
ndjc Oct 25, 2015
3204c32
v0.0.9
ndjc Oct 25, 2015
cb674d2
Add oslc:representation to shape template
ndjc Oct 26, 2015
a04f766
Update shape template to handle oslc:representation as array
ndjc Oct 26, 2015
f035729
Update shape.js to pass oslc:representation as array
ndjc Oct 26, 2015
6782815
Add special handler for oslc:range
ndjc Oct 26, 2015
a534db8
Bump version number
ndjc Oct 26, 2015
6b39e7d
v0.1.0
ndjc Oct 26, 2015
0b106bb
v0.1.0
ndjc Oct 26, 2015
5980a5d
Update location of specref biblio
Jan 4, 2016
2279096
Change bibliography to use W3 site
Feb 1, 2016
21c78c9
Change bibliography to use W3 site
Feb 1, 2016
50b1ca6
Change bibliography to use W3 site
Feb 1, 2016
fad6907
v0.1.2
Feb 1, 2016
100f4e1
v0.1.3
Feb 19, 2016
50bb144
v0.1.4
Feb 24, 2016
74f10da
v0.1.5
Feb 24, 2016
23c2812
v0.1.6
Feb 24, 2016
3f0d22a
v0.1.7
Feb 24, 2016
5686070
v0.1.8
Feb 24, 2016
f99fb16
Add citation label style
Apr 11, 2016
46cdf0e
v0.2.0
Apr 11, 2016
51ea6eb
Add OASIS version of structure.js and biblio.js
Apr 11, 2016
ad113d0
v0.2.1
Apr 11, 2016
2603f1c
Better handling of related work and supersedes
Apr 13, 2016
61ad86e
v0.2.2
Apr 13, 2016
acbd7d6
v0.2.3
Jun 3, 2016
d6df918
v0.2.4
Jun 15, 2016
800dec4
v0.2.5
Jun 27, 2016
4a5fc37
Update example shapes and vocab
Jul 13, 2016
cc450a0
Update examples & template spec
Jul 13, 2016
8349a1a
v0.2.6
Jul 13, 2016
eb09480
v0.2.7
Jul 25, 2016
9f1460d
v0.2.9
ndjc Oct 13, 2016
51f7cbc
v0.3.0
ndjc Jan 4, 2017
92f068f
v0.3.1
ndjc Jan 5, 2017
325e439
v0.3.2
ndjc Jan 5, 2017
7991dfd
v0.3.3
ndjc Jan 13, 2017
1323058
Add 'v' in front of version number in title,
ndjc Oct 2, 2017
7460e06
Titles of references/related docs are in italic,
ndjc Oct 2, 2017
9c0d115
Use https for TC and OASIS URIs
ndjc Oct 2, 2017
e6f2e45
Add paragraph about machine-readable content
ndjc Oct 2, 2017
c85660e
v0.3.4
ndjc Oct 2, 2017
ae7e4c1
v0.3.5
Oct 4, 2017
3ad7bd6
v0.3.5
ndjc Oct 5, 2017
ba8a2e3
v0.3.6
ndjc Jan 18, 2018
405f41b
Remove some obsolete logging messages
ndjc Feb 6, 2018
dfd579e
v0.3.6
ndjc May 15, 2018
0b9e4b4
Remove debug messages
ndjc May 15, 2018
a9c6171
v0.3.6
ndjc May 15, 2018
b1e3b77
v0.3.6
ndjc May 15, 2018
0b73d2b
v0.3.7
ndjc May 15, 2018
9af33e7
Updates for OASIS document guidelines and to generate more directly p…
Jun 20, 2018
302903c
v0.3.8
Jun 20, 2018
aa0b99d
Restore correct contents of build 0.3.7
ndjc Jul 2, 2018
914c95f
Update README.md to apply more specifically to OASIS
ndjc Jul 3, 2018
89a7327
Remove obsolete W3C builds of ReSpec from OASIS fork
ndjc Jul 3, 2018
86cf16c
v0.3.9
ndjc Jul 3, 2018
89d5030
v0.3.10
ndjc Jul 3, 2018
0ed2b2b
v1.0.0
ndjc Jul 3, 2018
e37b1d3
v1.0.1
ndjc Jul 6, 2018
e3359f2
Mark this fork as obsolete
Jul 24, 2019
43912c9
Mark as obsolete
Jul 24, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ bevy.json
.settings
.project
.idea
*.md.html
5 changes: 0 additions & 5 deletions .travis.yml

This file was deleted.

166 changes: 2 additions & 164 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,167 +1,5 @@
ReSpec
======
[![Build Status](https://travis-ci.org/w3c/respec.png?branch=develop)](https://travis-ci.org/w3c/respec)

ReSpec is a JS library that makes it easier to write technical specifications, or documents
that tend to be technical in nature in general. It was originally designed for the purpose
of writing W3C specifications, but has since grown to be able to support other outputs as
well such as OASIS.

Important Note
==============

ReSpec is not endorsed by W3C and nobody should expect the W3C Webmaster to provide advice on
problems encountered with ReSpec, or on why it may be failing to produce pubrules-compliant
content.

Want to change a bibliographical reference?
===========================================

Bibliographical references have been moved out of ReSpec. You want to use this:
https://github.com/tobie/specref

Want to see complete documentation?
===================================

Thorough documentation for ReSpec can be found at http://www.w3.org/respec, with a github repository
for the sources at https://github.com/w3c/respec-docs

What is this version of ReSpec?
===============================

There is the original version of ReSpec that can be found in http://dev.w3.org/2009/dap/ReSpec.js/,
known as v1. That version is the most popular, but is restricted to producing W3C specifications
and the code was organically grown over time in a manner that is not extremely user-friendly or
easy to maintain.

Then there is ReSpec v2 which can be found at http://dvcs.w3.org/hg/respec2/. It is flexible,
modular, and has a number of nice features. But the problem is that it was never completely
finished, and in the meantime v1 has continued to be patched for bugs. This leads to a situation in
which v2 is not a proper superset of v1, and patches to the latter have to be rewritten completely
to also apply to v2. Obviously, that's not a desirable situation.

The version in this repository here is ���ReSpec: Evolution���. What I've done is essentially that I've
imported the v1 source here. I am very quickly going to make a few very small changes to it so as to
make it 100% compatible with the existing v1 but to start making use of the flexible loading
facility included in v2. Then I will cease all development on the other two versions, making this
the only canonical option. Since it will start off v1 it will be guaranteed compatible, but it will
progressively be rewritten over time to attain v2's features ��� without the synchronisation problems.

How to contribute?
==================

It is common for people to contribute to RS, notably to make changes to the biblio references. You
certainly are welcome to submit whatever change you wish to (though if it's a complex feature please
try to coordinate with others first to avoid working long on something that will then be rejected).

If you're familiar with GitHub then contributing is simple: just fork and make pull requests. Please
just be careful to note that the primary branch is `gh-pages` and not `master` (this ensures that
the result gets published on the Web). **More importantly**, please note that the development branch
is `develop`. If you are making patches and pull requests, please base them off this branch.

If you're not familiar with GitHub, you need to follow the following steps:

* Get a GitHub account. This is done quickly, and the GH people will not bother you at all. Plus,
it's pretty much a requirement for the majority of OSS communities these days.
* If all you want to make is a small, simple change, you can use the Web interface. Navigate to the
file that you want to change, click ���Edit this file��� in the toolbar, then save your changes ��� they
will get sent to the project for approval (which ought to be quick).
* If you wish to make more complex changes, you will need to fork the project (click ���Fork���), clone
the resulting repository, make the changes there, and push it back. Then click the ���Pull Request���
button. This allows you to request that the project integrate your changes. Those should normally
get processed relatively fast (depending on how complex they are).

Running the test suite
----------------------

Respec runs a number of high level, end-to-end tests using [Jasmine][jasmine]. These tests are
run by [Travis][travis], a hosted continuous integration solution, on each pull requests.

There are two options to run these tests locally: in a browser or using [PhantomJS][phantomjs].

### Running the test suite in a browser

Tests need to be served from the root of the repository to function properly. Any server will do,
but here's an example using Python's `SimpleHTTPServer`:

```
$ cd /path/to/repo/
$ python -m SimpleHTTPServer
Serving HTTP on 0.0.0.0 port 8000 ...
```

Navigating to `http://localhost:8000/tests/SpecRunner.html` with any recent browser will launch the
test suite.

### Running the test suite in PhantomJS

[PhantomJS][phantomjs] is a headless, WebKit-based browser. It allows running the tests directly
from the command line.

In order to run the test from the command line, you need to [install Node][install-node], [npm][npm]
and [PhantomJS][install-phjs]. _Note that npm comes bundled with recent versions of Node._

Once these dependencies are installed, running the test suite should be as simple as:

```
$ npm test
```


[jasmine]: http://pivotal.github.io/jasmine/
[travis]: https://travis-ci.org/w3c/respec
[phantomjs]: http://phantomjs.org/
[install-phjs]: http://phantomjs.org/download.html
[install-node]: http://nodejs.org/download/
[npm]: https://npmjs.org/

### Building ReSpec

Whenever you run the test suite a new build is made for you. You can run `tools/test-build.js` to
obtain the same result.

### Releasing ReSpec

#### W3C Profile

Normally, only the maintainers make releases. But in the eventuality that they aren't available, others
can follow this process:

1. Make sure you are up to date and on the develop branch (git up; git checkout develop)
2. Bump the version in `package.json`.
3. Run the build script (node tools/build-w3c-common.js). This should respond "OK!" (if not, fix the
issue).
4. Add the new build (git add builds/respec-w3c-common-3.x.y.js).
5. Commit your changes (git commit -am v3.x.y)
6. Merge to gh-pages (git checkout gh-pages; git merge develop)
7. Tag the release (git tag v3.x.y) and be sure that git is pushing tags.
8. Push everything back to the server (make sure you are pushing at least the `develop` and
`gh-pages` branches).

The simplest way of doing this, is to just run `tools/release.js`. This will prompt you a few times
with the above process. Note that you will need gpg and a key with which to sign the tag.

That should be all. Normally, within a few minutes the W3C server will have picked up, gzipped, and
published the latest and greatest version.

#### OASIS Profile

Normally, only @sspeiche makes releases. But in the eventuality that he wouldn't be available, others
can follow this process:

1. Make sure you are up to date and on the 'feature/oasis-style' branch (git up; git checkout feature/oasis-style)
2. Go to 'tools/oasis'
3. Bump the version in `package-oasis.json`.
4. Run the build script (node build-oasis-common.js). This should respond "OK!" (if not, fix the
issue).
5. Add the new build (git add builds/oasis/respec-oasis-common-m.n.r.js).
6. Commit your changes (git commit)
7. Merge to gh-pages (git checkout gh-pages; git merge feature/oasis-style)
8. (when needed) Tag the release (git tag v3.x.y) and be sure that git is pushing tags.
9. Push everything back to the server (make sure you are pushing at least the `feature/oasis-style` and
`gh-pages` branches).

The simplest way of doing this, is to just run `tools/oasis/release.js`. This will prompt you a few times
with the above process. Note that you will need gpg and a key with which to sign the tag.

That should be all. This hasn't been adopted by OASIS, this work is in progress.
This fork is obsolete. Either go to the W3C original at <http://www.w3.org/respec>,
or to the OASIS OSLC Open Project replacement at <https://github.com/oasis-tcs/tab-respec>.
Empty file.
14 changes: 0 additions & 14 deletions builds/oasis/respec-oasis-common-0.0.2.js

This file was deleted.

14 changes: 0 additions & 14 deletions builds/oasis/respec-oasis-common-0.0.3.js

This file was deleted.

15 changes: 0 additions & 15 deletions builds/oasis/respec-oasis-common-0.0.4.js

This file was deleted.

15 changes: 0 additions & 15 deletions builds/oasis/respec-oasis-common-0.0.5.js

This file was deleted.

15 changes: 0 additions & 15 deletions builds/oasis/respec-oasis-common-0.0.6.js

This file was deleted.

Loading