Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated import docs #519

Merged
merged 3 commits into from
Feb 4, 2022
Merged

Updated import docs #519

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
31286b7
Updated import docs
shawntanzk Jan 17, 2022
58244b0
Update _dynamic_files.jinja2
shawntanzk Jan 17, 2022
18655ae
Update _dynamic_files.jinja2
shawntanzk Feb 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 4 additions & 11 deletions template/_dynamic_files.jinja2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -934,7 +934,7 @@ This page discusses how to update the contents of your imports, like adding or r

Note: some ontologies now use a merged-import system to manage dynamic imports, for these please follow instructions in the section title "Using the Base Module approach".

Importing a new term is split into to sub-phases:
Importing a new term is split into two sub-phases:

1. Declaring the terms to be imported
2. Refreshing imports dynamically
Expand Down Expand Up @@ -1083,15 +1083,11 @@ To check if your ontology uses this method, check src/ontology/{{ project.id }}-

If your ontology uses Base Module approach, please use the following steps:

Start by declaring the term to be imported in Protege:
To check if your ontology uses this method, check src/ontology/{{ project.id }}-odk.yaml to see if `use_base_merging: TRUE` is declared under `import_group`

1. Open your ontology (edit file) in Protege (5.5+).
1. Select 'owl:Thing'
1. Add a new class as usual.
1. Paste the _full iri_ in the 'Name:' field, for example, http://purl.obolibrary.org/obo/CHEBI_50906.
1. Click 'OK'
If your ontology uses Base Module approach, please use the following steps:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lines 1086–1088 are duplicate of lines 1082–1084.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whoops, my bad, i accidentally commited on a dirty branch, and was moving things around and missed that. Thanks for spotting :)


<img src="https://raw.githubusercontent.com/INCATools/ontology-development-kit/master/docs/img/AddingClasses.png" alt="Adding Classes" />
First, add the term to be imported to the term file associated with it (see above "Using term files" section if this is not clear to you)

Next, you navigate in your terminal to the ontology directory (underneath src in your hpo root directory).
```
Expand All @@ -1109,9 +1105,6 @@ This requires quite a bit of memory on your local machine, so if you encounter a

Lastly, restart Protege, and the term should be imported in ready to be used.

Warning: Adding declarations on editors file might cause issues if the declared class is no longer used. The declarations should be removed if no longer in use
Warning: If the term is declared, and import is not refreshed, failure of the SPARQL label and definition checks might be triggered.

^^^ docs/odk-workflows/ManageDocumentation.md
# Updating the Documentation

Expand Down