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

Citation from/to another Metanorma document #57

Closed
ronaldtse opened this issue May 27, 2019 · 10 comments
Closed

Citation from/to another Metanorma document #57

ronaldtse opened this issue May 27, 2019 · 10 comments
Assignees
Labels
enhancement New feature or request

Comments

@ronaldtse
Copy link
Contributor

Right now we cite like this:

* [[[ISO9001,ISO 9001:2015]]], _AUTOFILL_

Cite: 
<<ISO9001,clause="10.1">>

But we will also want to cite from another Metanorma document on disk or in a registry.

Here's a proposed syntax.

* [[[myanchor,repo:(myrepo/mydoc)]
* [[[myanchor,path:(relative-filepath)]

<<myanchor,clause="10.1">>
<<myanchor,anchor="special-anchor">>
# or
<<myanchor,#special-anchor>>

Something like this.

Thoughts @opoudjis ?

@ronaldtse ronaldtse added the enhancement New feature or request label May 28, 2020
@opoudjis
Copy link
Contributor

Will leave [[[myanchor,repo:(myrepo/mydoc)]]] unprocessed by standoc: it is an "identifier" that needs to be picked up in postprocessing, since there is no generic list of repositories or how to handle them. Metanorma collections processing are assuming repo:(current-metanorma-collection/{{ document identifier }}

@opoudjis
Copy link
Contributor

I will adopt the <<myanchor,anchor="special-anchor">> syntax, for consistency.

@opoudjis
Copy link
Contributor

opoudjis commented Jun 10, 2020

* [[[myanchor,path:(relative-filepath)] still needs a document identifier; so make it

* [[[myanchor,path:(relative-filepath,id)]. Ditto repo:(). We can't get intelligible citations otherwise.

@ronaldtse
Copy link
Contributor Author

* [[[myanchor,path:(relative-filepath,id)] is this id used as a bibliographic reference? Or is it supposed to read the MN AsciiDoc "root" file and therefore have Relaton bibdata already?

opoudjis added a commit to relaton/relaton-models that referenced this issue Jun 10, 2020
opoudjis added a commit to relaton/relaton.org that referenced this issue Jun 10, 2020
@opoudjis
Copy link
Contributor

Bibliographic reference. I haven't worked out where the bibliographic details of path:() references come from yet; currently, I'm not fetching them from Relaton.

We will use repo:() instead for collections, and that will resolve the bibliography locally. I will add path and have it behave the same way, for consistency.

@ronaldtse
Copy link
Contributor Author

Why can't we just do [[[myanchor,path:(relative-filepath)]]]? The myanchor is the bibliographic id. As long as (relative-filepath) points to a Metanorma document, we have its bibdata.

@opoudjis
Copy link
Contributor

Not doing that. Consistency requires us to provide the document identifier in citations consistently.

@ronaldtse
Copy link
Contributor Author

Not doing that. Consistency requires us to provide the document identifier in citations consistently.

The document identifier can be given by that particular document's bibdata? This is just like "auto-fetching" but the auto-fetched copy is local.

@opoudjis
Copy link
Contributor

The document identifier remains mandatory, that is consistent with all of metanorma, it is good practice, and I will not brook further discussion.

I will search for *.rxl and *.xml at the nominated location and ingest Relaton XML if available.

opoudjis added a commit to metanorma/metanorma.org that referenced this issue Jun 12, 2020
opoudjis added a commit to metanorma/isodoc that referenced this issue Jun 12, 2020
opoudjis added a commit to metanorma/metanorma-standoc that referenced this issue Jun 12, 2020
opoudjis added a commit to metanorma/metanorma-standoc that referenced this issue Jun 12, 2020
@opoudjis
Copy link
Contributor

Citation URLs (provided by path citations) are suffixless in Metanorma XML; they are suffixed with doc for Word, and with html for HTML.

opoudjis added a commit to metanorma/metanorma-iso that referenced this issue Jun 12, 2020
opoudjis added a commit to metanorma/metanorma-itu that referenced this issue Jun 12, 2020
ronaldtse pushed a commit to relaton/relaton.org that referenced this issue Jun 15, 2020
opoudjis added a commit to metanorma/metanorma-itu that referenced this issue Jun 19, 2020
ronaldtse pushed a commit to metanorma/metanorma.org that referenced this issue Aug 23, 2020
ronaldtse pushed a commit to metanorma/metanorma.org that referenced this issue Aug 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants