Add new <xref:xxxx> syntax for Specref auto adding to bibliography #1159
Replies: 1 comment 2 replies
-
|
Thanks @thadguidry. We are also having some conversations around the cross-project links here. Do you know if respec is intended to be adopted wider than the w3c documentation? We are looking at ways to expose cross-references between myst projects, and this might be an option? |
Beta Was this translation helpful? Give feedback.
-
ReSpecReSpec (Specification Documentation platform) can be used for documenting any web standards, spec or technical documents actually. :-) but not the best candidate for your blog I'd say :-) And indeed it's more wider now than just W3C docs, witness:
Its big plus is in fact its shorthands guide shows how similar it is to Bikeshed so it makes it easier to share. Defining concepts, even scoped concepts and variables are really what comes into play with documenting and referencing easily throughout a document. Much more powerful than links, and why folks use ReSpec for those features when having to document APIs, Standards, Request/Responses, Properties, etc. and reference them back and forth. Bibliographical references have been moved out of ReSpec. You want to use specref.org. SpecRefSpecRef (the specification reference database & software) is used by ReSpec, Bikeshed, and others and can be used by any Publisher, Publishing Platform, or Community. Which is here where I am thinking of this discussion and having MyST absorbing some xref syntax, whatever form it might be in MyST that makes it similar enough and simple. Basically SpecRef is a database or tooling (your pick) that provides metadata about a Concept or Standard Reference.
{
"href": "https://www.rfc-editor.org/rfc/rfc8529",
"title": "YANG Data Model for Network Instances",
"authors": [
"L. Berger",
"C. Hopps",
"A. Lindem",
"D. Bogdanovic",
"X. Liu"
],
"status": "Proposed Standard",
"publisher": "IETF",
"id": "rfc8529",
"date": "March 2019"
}Cross-references across projects/standardsRegarding exposing cross-references (or concepts/standards/etc.) between projects is definitely how the shorthands in ReSpec slowly added up (placeholders essentially as mentioned). Case in point, like the Plural Forms Regarding brackets (delimited identifers) versus only prefix tokens like
|
Beta Was this translation helpful? Give feedback.
-
|
I'll just throw in a quick note that the |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
It would be useful to just mention a specification shortname and then MyST would automatically enable hover, as well as add to the bibliography, if configured to do so.
addXrefToBib: trueExample syntax:
<xref:RFC8259>[](xref:RFC8259)[[RFC8259]]See example of how ReSpec handles this: https://github.com/w3c/respec/wiki/ReSpec-Editor's-Guide#references
Beta Was this translation helpful? Give feedback.
All reactions