Skip to content

Conversation

Jym77
Copy link
Collaborator

@Jym77 Jym77 commented Nov 18, 2021

Showcasing how we could use dfn elements for defining terms in definitions and conditional lists.
Some of the changes are not really needed but used to illustrate some possibilities 😄

In order to ensure name uniqueness (the definitions are included inside the rules), I namespace the IDs in definition with the definition key, as far as I understand the : in an ID shouldn't be a problem. (otherwise we can just namespace with _). IDs in rules are namespaced by the rule ID.

Pros:

  • Semantically correct 😁
  • Can link to the precise part of the definition that is of interest.
  • Can backlink to a precise condition in a conditional list.

Closes issue(s):

Need for Call for Review:
This will require a 1 week Call for Review (should be purely cosmetic, but could be touching a lot of stuff).


Pull Request Etiquette

When creating PR:

  • Make sure you're requesting to pull a branch (right side) to the develop branch (left side).
  • Make sure you do not remove the "How to Review and Approve" section in your pull request description

After creating PR:

  • Add yourself (and co-authors) as "Assignees" for PR.
  • Add label to indicate if it's a Rule, Definition or Chore.
  • Link the PR to any issue it solves. This will be done automatically by referencing the issue at the top of this comment in the indicated place.
  • Optionally request feedback from anyone in particular by assigning them as "Reviewers".

When merging a PR:

  • Close any issue that the PR resolves. This will happen automatically upon merging if the PR was correctly linked to the issue, e.g. by referencing the issue at the top of this comment.

How to Review And Approve

  • Go to the “Files changed” tab
  • Here you will have the option to leave comments on different lines.
  • Once the review is completed, find the “Review changes” button in the top right, select “Approve” (if you are really confident in the rule) or "Request changes" and click “Submit review”.
  • Make sure to also review the proposed Call for Review period. In case of disagreement, the longer period wins.

@Jym77 Jym77 added Editorial For editorial changes that does not change the meaning of a rule or Glossary term reviewers wanted labels Nov 18, 2021
@Jym77 Jym77 self-assigned this Nov 18, 2021
#### Inapplicable Example 1

There are no HTML elements in this document.
This document is not [HTML](#html).
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This (and following changes in that rule) is not really needed (and actually makes the description worse, in that case).
This is to illustrate the possibility to backlink to the exact condition in a list that is under consideration.

@Jym77
Copy link
Collaborator Author

Jym77 commented Nov 18, 2021

Putting this back on Agenda so we can discuss (follow up to https://www.w3.org/2021/10/14-act-r-minutes.html#t05) and decide whether it is something we want to do or not…

@Jym77
Copy link
Collaborator Author

Jym77 commented Nov 25, 2021

Add doc on writing defs and listed conditions.

@Jym77
Copy link
Collaborator Author

Jym77 commented Nov 25, 2021

Namespace ids in rules by the rule ID.

@kengdoj
Copy link
Collaborator

kengdoj commented Dec 2, 2021

No objection to this change inside the rules.

This is a while ago, but I recall discussion of a single ACT glossary and taking definitions out of rules. Is that no longer being considered?

@Jym77 Jym77 marked this pull request as ready for review December 9, 2021 13:22
@Jym77 Jym77 requested a review from WilcoFiers December 9, 2021 13:22
@Jym77
Copy link
Collaborator Author

Jym77 commented Feb 3, 2022

Call for Reviews ends on February 10.

@Jym77 Jym77 added Review Call 1 week Call for review for small changes and removed reviewers wanted labels Feb 3, 2022
@Jym77
Copy link
Collaborator Author

Jym77 commented Feb 14, 2022

Call for Review has ended, merging.

@Jym77 Jym77 merged commit 245eb40 into develop Feb 14, 2022
@Jym77 Jym77 deleted the dfn-element-definition branch February 14, 2022 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Editorial For editorial changes that does not change the meaning of a rule or Glossary term Review Call 1 week Call for review for small changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Wrap defined term in dfn elements

9 participants