/[volute]/trunk/projects/vocabularies/README
ViewVC logotype

Contents of /trunk/projects/vocabularies/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 46 - (show annotations)
Tue Feb 5 17:27:16 2008 UTC (13 years, 5 months ago) by norman.x.gray
File size: 3404 byte(s)
Distribution tweaks (fix broken links)
Release 0.04

1
2 Build tree for the IVOA vocabulary SKOS files.
3
4
5 Configuring and building from a checkout
6 ========================================
7
8 To build everything, including both the document and the distributed
9 SKOS files, you need:
10
11 * rapper: from <http://librdf.org/raptor/>
12 * cwm: you need the CVS version from
13 <http://www.w3.org/2000/10/swap/doc/cwm.html>
14 * BibTeX, to build the bibliography in doc/
15 * xsltproc or Saxon (xsltproc built with libxslt 10111 is OK; Saxon 8 is OK)
16
17 Then do:
18
19 % ./configure 'CWM=python "/path/to/checked out/cwm.py"'
20 % make
21
22 (yes, autoconf is slightly over the top for a project which isn't
23 designed to be built after distribution, but it's the most
24 straightforward way to do the various substitutions required, avoiding
25 a lot of Makefile fuss).
26
27 The cwm command can be given as shown (which works from a checked out
28 but not installed SWAP), but note the quotes. If you install cwm in a
29 standard python way, so that just 'cwm' at the command line works,
30 then setting this should be unnecessary (but I haven't been able to
31 work out how one is actually supposed to install cwm, so I can't
32 really check this).
33
34 If you have problems installing xsltproc, install Saxon (which
35 requires Java) <http://saxon.sourceforge.net/> and give the
36 ./configure option --with-saxon=/path/to/saxon8.jar
37
38 Document only
39 =============
40
41 If you only want to build the document, then all you need to have
42 installed is BibTeX, plus either xsltproc or Saxon; and all you need to do is:
43
44 % ./configure
45 % cd doc
46 % make
47
48 It doesn't matter in this case if rapper, python and tar aren't found,
49 and you don't need to install cwm in this case.
50
51 Note that this works because the (generated) configure script is
52 checked in to the repository, to make this step more convenient: this
53 implies that if you do need to adjust configure.ac you do need to
54 regenerate the ./configure script by hand.
55
56 There is nothing to build after distribution.
57
58
59 Maintenance
60 ===========
61
62 To add a vocabulary:
63
64 1. Create the appropriate subdirectory under src/, say src/NewVocab
65 2. Add a Makefile.in in that directory which creates at least
66 src/NewVocab/NewVocab.ttl, src/NewVocab/NewVocab.rdf and
67 src/NewVocab/Notes. The Makefile.in should allow its release
68 information to be set in the same way that src/AOIM/Makefile.in (for
69 example) does.
70 3. Add NewVocab to src/Makefile.in's SUBDIRS variable.
71 4. Add the new Makefile.in to the bottom of configure.ac and
72 regenerate ./configure using autoconf.
73
74 To make a release:
75
76 1. Copy the trunk to a tagged tree using, for example,
77
78 % svn copy https://volute.googlecode.com/svn/trunk/ \
79 https://volute.googlecode.com/svn/tags/vocabularies-0.01 \
80 -m "Tag release 0.01 of vocabularies project"
81
82 2. Check out that tag using
83
84 % svn export https://volute.googlecode.com/svn/tags/vocabularies-0.01
85
86 and build a distribution using just the instructions above. If
87 any minor fixes are required, it's probably OK to check out a
88 working copy, fix things on that tag-branch, then and re-merge
89 them with the trunk, but I haven't done that myself.
90
91 3. Upload the distribution tarball to the 'downloads' section of
92 volute.googlecode.com (at present). In future, (the contents of)
93 this distribution tarball should be submitted to the IVOA
94 documents process. Details to come.

msdemlei@ari.uni-heidelberg.de
ViewVC Help
Powered by ViewVC 1.1.26