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

Authors / Contributors metadata? #885

Open
equalsJeffH opened this issue Dec 7, 2016 · 4 comments
Open

Authors / Contributors metadata? #885

equalsJeffH opened this issue Dec 7, 2016 · 4 comments

Comments

@equalsJeffH
Copy link

It seems Bikeshed metadata only knows about Editor (and Former Editor) but not about Author or Contributor

It seems the most recent pubrules (https://www.w3.org/pubrules/doc/rules/?profile=WD#front-matter) uses the terms Editor and Author interchangeably, but suggests listing "contributors" in an acknowledgements section.

At times it is useful to list various classes of a spec's co-authors on the title page and distriguish among them e.g. as "Editors" and "contributors / authors".

Thus I suggest adding metadata item of (at least) "Author" to bikeshed.

@tabatkins
Copy link
Collaborator

While the Editor line has some special parsing rules to handle common stuff, you can add whatever additional information you want via custom metadata.

Just put in !Contributors: some person's name here; do it multiple times to get several people listed under the "Contributors" group.

(Note that you can also use Editor Term if you want the spec to say "Authors" instead of "Editors".)

@equalsJeffH
Copy link
Author

Ok, we'll try it out, thanks :)

@equalsJeffH
Copy link
Author

@tabatkins

...you can add whatever additional information you want via custom metadata.

Just put in !Contributors: some person's name here; do it multiple times to get several people listed under the "Contributors" group.

I tried that and the results are suboptimal. This source:

!Contributors: Arnar Birgisson, w3cid 87332, Google, arnarb@google.com
!Contributors: Alexei Czeskis, w3cid 87258, Google, aczeskis@google.com
!Contributors: Hubert Le Van Gong, w3cid 84817, PayPal, hlevangong@paypal.com

..produced this rendered html:

Contributors:
    Arnar Birgisson, w3cid 87332, Google, arnarb@google.com 
    Alexei Czeskis, w3cid 87258, Google, aczeskis@google.com 
    Hubert Le Van Gong, w3cid 84817, PayPal, hlevangong@paypal.com 

Rather than what I wanted, which would be properly-linked rendered HTML as the "Editor" metadata produces, as in:

Contributors:
    Arnar Birgisson (Google) 
    Alexei Czeskis (Google) 
    Hubert Le Van Gong (PayPal) 

It would be helpful if BS would treat "Contributor:" metadata entries the same as "Editor:". Thanks.

@tabatkins tabatkins reopened this Nov 8, 2017
@tabatkins
Copy link
Collaborator

Per @frivoal suggestion, a way to opt a custom metadata into particular parsing rules. Start with Editor-parsing, see what else I need to do.

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

2 participants