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

Add anchors for each requirement/example/etc. #225

Closed
cportele opened this issue Jun 5, 2019 · 4 comments
Closed

Add anchors for each requirement/example/etc. #225

cportele opened this issue Jun 5, 2019 · 4 comments
Assignees
Labels
Editorial Editorial changes and document updates outside of requirements classes Part 1: Core Issue related to Part 1 - Core

Comments

@cportele
Copy link
Member

cportele commented Jun 5, 2019

This will support deep links to specific parts of the document, not just the sections.

@cportele cportele added the Part 1: Core Issue related to Part 1 - Core label Jun 5, 2019
@cportele cportele added this to the Part 1, Second Draft Release milestone Jun 5, 2019
@cportele cportele self-assigned this Jun 5, 2019
@cportele cportele added this to Backlog in Features Part 1: Core via automation Jun 5, 2019
@cmheazel
Copy link
Contributor

In API Common I separated requirements from recommendations. I also made some formatting changes in an attempt to improve readabilty. Take a look at these and let me know if you want the same in API-Features.

@cmheazel
Copy link
Contributor

@cportele Can you provide an example of what you have in mind?

@cportele
Copy link
Member Author

I also made some formatting changes in an attempt to improve readabilty. Take a look at these and let me know if you want the same in API-Features.

The change is that you combined multiple requirements into one and created "sub-names" like A, B, etc.? I have concerns about this approach. Separate requirements should remain separate requirements, each with their own URI.

@cportele Can you provide an example of what you have in mind?

I want to be able to have links to each relevant element in the HTML version of the document. Currently I can only reference sections (eg http://docs.opengeospatial.org/DRAFTS/17-069r1.html#string_i18n references 7.10) or select document elements (eg http://docs.opengeospatial.org/DRAFTS/17-069r1.html#tldnr references table 1). I want to extend this so that one can create references to each table, example, requirement, recommendation or permission. And maybe more elements. I.e., there will be an anchor ("[[anchor]]") before every of these elements in the adoc source.

@cmheazel
Copy link
Contributor

@cportele No, I have not combined requirements. I have taken the existing multi-part requirements and broken out the individual parts. If you look at older versions you will find the same content, but all run together into a single body of text.
Permissions, recommendations, and requirements now have anchors.

@cmheazel cmheazel moved this from Backlog to In Progress in Features Part 1: Core Jun 14, 2019
@cportele cportele added the Editorial Editorial changes and document updates outside of requirements classes label Jun 21, 2019
Features Part 1: Core automation moved this from In Progress to Done Jun 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Editorial Editorial changes and document updates outside of requirements classes Part 1: Core Issue related to Part 1 - Core
Projects
Development

No branches or pull requests

2 participants