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

Anchor IDs: Hyphens vs Underscores #2

Open
3 tasks
tajmone opened this issue Aug 11, 2020 · 0 comments
Open
3 tasks

Anchor IDs: Hyphens vs Underscores #2

tajmone opened this issue Aug 11, 2020 · 0 comments
Assignees
Labels
👮 AsciiDoc conventions Policies: AsciiDoc formatting conventions. ⭐ anchor ID Topic: Anchor IDs (all types) ⚠️ important Priority: High
Milestone

Comments

@tajmone
Copy link
Collaborator

tajmone commented Aug 11, 2020

Ensure consistency in the various Anchor IDs (sections, figures, tables, etc.) by enforcing same word separator — i.e. use hyphen - instead of underscore _.

  • Detect all occurrences of inconsistent word separators and annotate them.
  • Annotate any special cases that might justify using _ as word separator (e.g. after prefixes).
  • Fix all anchor IDs to achieve consistency.

NOTE — in some cases use of an underscore might be justified by the context; the important thing is to adopt a consistent naming convention.

Underscores might be employed as separators after a commonly-recurring prefix (eg. fig_some-picture, table_some-table).

Further discussion might be required.

@tajmone tajmone added the ⭐ anchor ID Topic: Anchor IDs (all types) label Aug 11, 2020
@tajmone tajmone added this to the Anchor IDs milestone Aug 11, 2020
@tajmone tajmone added the 👮 AsciiDoc conventions Policies: AsciiDoc formatting conventions. label Sep 22, 2021
@tajmone tajmone self-assigned this Sep 22, 2021
@tajmone tajmone added the ⚠️ important Priority: High label Sep 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
👮 AsciiDoc conventions Policies: AsciiDoc formatting conventions. ⭐ anchor ID Topic: Anchor IDs (all types) ⚠️ important Priority: High
Projects
None yet
Development

No branches or pull requests

1 participant