Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Extend the prolog to support arbitrary metadata #254

Open
ndw opened this issue Jun 11, 2024 · 2 comments
Open

Extend the prolog to support arbitrary metadata #254

ndw opened this issue Jun 11, 2024 · 2 comments
Assignees

Comments

@ndw
Copy link
Contributor

ndw commented Jun 11, 2024

I sent email about supporting grammar metadata a while back. That discussion petered out on the mailing list, but I still think it's worth persuing, so here's an issue about it.

The salient bit is:

Grammar metadata

The prolog may also contain additional metadata about the grammar.

 metadata: name, (field++msep | RWS, chardata), whitespace*, -".", RS .
    field: RWS, name, whitespace*, -":", whitespace*, chardata .
-chardata: -'"', -dchar+, -'"';
           -"'", -schar+, -"'".
    -msep: whitespace*, -"," .

Each metadata declaration consists of a name followed by either a string or a set of fields. Each field value is a string.

For example:

ixml version "1.1" .
author  givenname: "Norman", surname: "Tovey-Walsh" .
license id: "MIT", name: "The MIT License",
        uri: "https://opensource.org/license/mit" .
date    "2024-03-12" .
release "1.0" .

As a nod towards some level of standardization, I believe this is sufficient to capture the citation metadata suggested for project repositories.

@ndw ndw self-assigned this Aug 6, 2024
@ndw
Copy link
Contributor Author

ndw commented Aug 6, 2024

A suggestion was made that the grammar and the test data are out-of-sync.

@ndw
Copy link
Contributor Author

ndw commented Aug 6, 2024

Also: is chardata needed?

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant