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.

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

anchors for sections of ontology description; TOC refinements #127

Open
VladimirAlexiev opened this issue Apr 15, 2021 · 0 comments
Open

Comments

@VladimirAlexiev
Copy link

Related to #126

You handle Markdown headings in ontology description (thanks!), eg see this screen from http://rawgit2.com/euBusinessGraph/eubg-data/master/ontology/doc.html (euBusinessGraph/eubg-data#18)

image

Please also:

  • Move the TOC above Overview because good ontologies have long overviews, and a TOC should be before the main body of text
  • include the extra sections as headings in the TOC
  • generate github-like anchors for these headings, eg _registered_organization_company for "Registered organization (company)"
  • Use bulleted list rather than numbered list for the TOC because your document sections are not numbered.

So overall, it should look like this:


euBusinessGraph ontology

...
Code Repository
https://github.com/euBusinessGraph/eubg-data

Table of Contents

  • Overview
    • Registered Organization (company)
    • Identifier System
    • Officer
    • Dataset Descriptions
  • Classes
  • Object Properties
  • Datatype Properties
  • Namespaces
  • Legend

Overview

...

Registered Organization (company)

...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant