We would like to have support for notes that operate as annotations. This would be similar to a footnote, but instead of operating on a singular point in the text, it would be associated with a range of text. (How exactly this would be rendered is, for now, not super important. The gist though would be some highlighted text, with the note either in the margin, or linked to at the bottom of the page/text, like footnotes are now.)
Some background
Myself and @mycelian (so far) are working on an idea for a site that integrates a discussion platform into Amusewiki. The broad idea would be something similar to margin notes in a book passed around a group of friends, built around the web annotation standard using client code from Hypothesis. Since this is obviously a huge diversion from the current use-case for Amusewiki, we're developing it as a fork, but our hope is to keep things tracked as closely with upstream as possible, and depending on how well it works, maybe in the future merge the project upstream, behind a feature flag.
The current problem
I'll skip the details of how we plan on integrating the annotation platform over all, but what matters here is that we'd like to stick with the spirit of Amuse, in that we want the annotations to be represented within the markup, so that the annotations can be compiled into LaTeX from the muse file, are tracked via the git backend on Amusewiki, etc.. Ideally, this would mean getting the syntax for representing these annotations implemented here (at some point adding them to your compiler would be nice too, but that's less important). If, for some reason, that's not possible, the next best thing would to at least have a syntax design for our fork that interacts with upstream as nicely as possible, so input would still be appreciated.
Proposed solution
As I said at the beginning, the solution we have in mind treats annotations as akin to footnotes. Unlike the two extant footnotes, the design needs to associate a text range with the note body. The solution we've come up with is a mixture of footnote and link syntax:
First sentence. {{Second sentence.}{id}} Third sentence.
{{id}} Insightful comment.
The above is intended to resemble footnotes, but it could be made to resemble links more by swapping the parameters, {{id}{Second sentence.}}. One point that does involve our integration is that it would be nice, but not necessary, if the id could be a string, rather than an integer (it would make integrating with other web annotation implementations a little easier).
Obviously there's a lot to tweak in the design, and other possible designs work as well. Let us know what you think, or if there's anything we should clarify.
We would like to have support for notes that operate as annotations. This would be similar to a footnote, but instead of operating on a singular point in the text, it would be associated with a range of text. (How exactly this would be rendered is, for now, not super important. The gist though would be some highlighted text, with the note either in the margin, or linked to at the bottom of the page/text, like footnotes are now.)
Some background
Myself and @mycelian (so far) are working on an idea for a site that integrates a discussion platform into Amusewiki. The broad idea would be something similar to margin notes in a book passed around a group of friends, built around the web annotation standard using client code from Hypothesis. Since this is obviously a huge diversion from the current use-case for Amusewiki, we're developing it as a fork, but our hope is to keep things tracked as closely with upstream as possible, and depending on how well it works, maybe in the future merge the project upstream, behind a feature flag.
The current problem
I'll skip the details of how we plan on integrating the annotation platform over all, but what matters here is that we'd like to stick with the spirit of Amuse, in that we want the annotations to be represented within the markup, so that the annotations can be compiled into LaTeX from the muse file, are tracked via the git backend on Amusewiki, etc.. Ideally, this would mean getting the syntax for representing these annotations implemented here (at some point adding them to your compiler would be nice too, but that's less important). If, for some reason, that's not possible, the next best thing would to at least have a syntax design for our fork that interacts with upstream as nicely as possible, so input would still be appreciated.
Proposed solution
As I said at the beginning, the solution we have in mind treats annotations as akin to footnotes. Unlike the two extant footnotes, the design needs to associate a text range with the note body. The solution we've come up with is a mixture of footnote and link syntax:
The above is intended to resemble footnotes, but it could be made to resemble links more by swapping the parameters,
{{id}{Second sentence.}}. One point that does involve our integration is that it would be nice, but not necessary, if theidcould be a string, rather than an integer (it would make integrating with other web annotation implementations a little easier).Obviously there's a lot to tweak in the design, and other possible designs work as well. Let us know what you think, or if there's anything we should clarify.