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

[Framework] New "See also" column in summary tables #266

Merged
merged 2 commits into from
Jun 24, 2018

Conversation

tidoust
Copy link
Member

@tidoust tidoust commented Jun 22, 2018

The framework can now render a "See also" column that contains useful links to resources related to the specification, notably:

  • a link to the Editor's Draft
  • a link to the repository that contains the Editor's Draft
  • specific links defined in the description of the spec.

The "See also" column is only rendered in the (currently unused) versions type of summary table. The exact links that need to be rendered can be customized in the toc.json file. The README explains how to customize the summary tables.

The repository property is either constructed from the URL of the Editor's Draft or retrieved from Specref.

See related need expressed in #90

NB: The framework more or less already supported a versions column but that wasn't flexible enough, and name seemed badly chosen.

The framework can now render a "See also" column that contains useful links to
resources related to the specification, notably:
- a link to the Editor's Draft
- a link to the repository that contains the Editor's Draft
- specific links defined in the description of the spec.

The "See also" column is only rendered in the (currently unused) `versions`
type of summary table. The exact links that need to be rendered can be
customized in the `toc.json` file. The README explains how to customize the
summary tables.

See related need expressed in w3c#90

NB: The framework more or less already supported a `versions` column but that
wasn't flexible enough, and name seemed badly chosen.
}
else if (edDraft.match(/^https?:\/\/drafts\.csswg\.org\//)) {
return 'https://github.com/w3c/csswg-drafts';
}
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point! I'll add these rules. Obviously, it would be better if the W3C API returned that information directly (and it should be able to extract that info from the front metadata section)

Copy link
Member

@xfq xfq left a comment

Choose a reason for hiding this comment

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

LGTM with nits

@tidoust tidoust merged commit ae7ce49 into w3c:master Jun 24, 2018
@xfq xfq deleted the framework-seealso branch June 25, 2018 03:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants