search

mbakeranalecta / sam

Semantic Authoring Markdown
Other
79 stars 8 forks source link

Serializing citations #178

Closed mbakeranalecta closed 6 years ago

mbakeranalecta commented 6 years ago

Three things I think we should change in the serialization of citations.

  1. Instead of <citation value="foo"/> we should do <citation>foo</citation>.

  2. Instead of <citation idref="bar" extra="page 2"/> we should do <citation idref="bar">page 2</citation>

  3. Instead of wrapping a citation on a phrase around the phrase we should put it at the beginning of the phrase like we do with citations on blockquotes. (Proposals 1 and 2 seem to depend on this to avoid confusion.)

mbakeranalecta commented 6 years ago

This would mean that 

<phrase><citation extra="page 1"><reference-elements><reference-element method="nameref" value="Melville"/><reference-element method="idref" value="MobyDick"/></reference-elements>call me Ishmael</citation></phrase>

would become:

page 1call me Ishmael

Is there anything wrong with that?

mbakeranalecta commented 6 years ago

It seems like it would make life easier if a citation on a phrase were placed at the end of the phrase element rather than the beginning. However you intend to represent the citation on output, its natural position is at the end of the phrase, so why may the application layer do extra work to move it there.

mbakeranalecta commented 6 years ago

Addressed at 50dd3bfb24be92ee547fa5f29770108379f95029