Skip to content
Permalink
Browse files

docs processes updated development to also mention catalog file

this duplicates the section in development setup, but since it is the
first thing that always comes up it is worth having in two places
  • Loading branch information...
tgbugs committed May 12, 2019
1 parent 2dbda62 commit 6fee8b10eb9195d07bc6100f30cf355a30436720
Showing with 23 additions and 18 deletions.
  1. +2 −2 docs/development-setup.md
  2. +21 −16 docs/processes.md
@@ -75,8 +75,8 @@ otherwise load times can stretch on for many minutes.

## Catalog
There is an example ontology catalog [catalog-v001.xml.example](./../ttl/catalog-v001.xml.example)
which should be installed by `cp catalog-v001.xml.example catalog-v001.xml`. The file itself
is not tracked to preven conflicts when switching branches.
that should be installed by running `cp catalog-v001.xml.example catalog-v001.xml`. The file itself
is not tracked to prevent conflicts when switching branches.

## Reasoners
You can obtain copies of ELK and FACT++ by launching protege and going to
@@ -34,22 +34,10 @@ checks to make sure that the ontology is consistent.

## Development

### Prior to commit
```bash
ttlfmt $(git status -s | grep ttl | grep M | cut -d' ' -f3)
# OR if you are working on files that need to be normalized
qnamefix $(git status -s | grep ttl | grep M | cut -d' ' -f3)
```

### Adding a new remote import
All remote imports should be imported into NIFSTD via a bridge file.
This file will hold any local additions that we want to make.
1. Create a new bridge file by copying an existing bridge file and modifying
as needed to import the remote file from its canonical iri, and to import
`filename-dead.ttl`.
2. Add an entry in [catalog-extras](./../catalog-extras) for the new import.
3. Create `ttl/generated/filename-dead.ttl` by running `necromancy http://myurl.org/filename.owl`.
4. Whenever there is a new release repeat step 3.
### Set up the catalog file
There is an example ontology catalog [catalog-v001.xml.example](./../ttl/catalog-v001.xml.example)
that should be installed by running `cp catalog-v001.xml.example catalog-v001.xml`. The file itself
is not tracked to prevent conflicts when switching branches.

### Load remote imports from local copies
Sometimes we don't want to have to retrieve remote copies of files every time
@@ -106,6 +94,23 @@ example order to make use of the new entry.
Before you run `make_catalog` make sure that the import chain is local (unpatched)
otherwise it will take an extremely long time to fetch files.

### Prior to commit
```bash
ttlfmt $(git status -s | grep ttl | grep M | cut -d' ' -f3)
# OR if you are working on files that need to be normalized
qnamefix $(git status -s | grep ttl | grep M | cut -d' ' -f3)
```

### Adding a new remote import
All remote imports should be imported into NIFSTD via a bridge file.
This file will hold any local additions that we want to make.
1. Create a new bridge file by copying an existing bridge file and modifying
as needed to import the remote file from its canonical iri, and to import
`filename-dead.ttl`.
2. Add an entry in [catalog-extras](./../catalog-extras) for the new import.
3. Create `ttl/generated/filename-dead.ttl` by running `necromancy http://myurl.org/filename.owl`.
4. Whenever there is a new release repeat step 3.

### Integrating a new set of terms
If there is an existing ttl file that has been formatted with ttlfmt as described above then
create a new branch, add the file, and submit a pull request for review.

0 comments on commit 6fee8b1

Please sign in to comment.
You can’t perform that action at this time.