Comments (4)
kaj
commented on August 18, 2024
I also would like SpanLinkType::Reference to contain the (unresolved) reference (or for Container::Link to contain it some other way).
My reason is that I would like to handle some (locally defined) automatic reference. For exemple, I would like the document [Some word][wp] to render as a <a href="https://en.wikipedia.org/wiki/Some+word" title="Some word (in wikipedia)">Some word</a>.
from jotdown.
hellux
commented on August 18, 2024
My reason is that I would like to handle some (locally defined)
automatic reference. For exemple, I would like the document
`[Some word][wp]` to render as a
`<a> href="https://en.wikipedia.org/wiki/Some+word" title="Some word (in wikipedia)">Some word</a>`.
I think this is something that we wish to be able to support.
I also would like `SpanLinkType::Reference` to contain the
(unresolved) reference.
It would be possible to always provide the reference link, regardless if
it is unresolved or not, but that may increase the size of Event (which
may or may not be very important) because I think the links already are
the biggest variants in the enum.
or for `Container::Link` to contain it some other way
We have been considering moving to a single-pass parser, which would
require us to represent unresolved links (letting user optionally
perform multiple passes to resolve links). We could maybe add this to
the Event type already now, and use it for reference events that do not
have a matching link definition.
A different approach is to use a callback function that is called when
unresolved links are encountered. I don't think there is any benefit to
this, though. pulldown_cmark does this but I think it is because
Markdown must know whether the inline link is valid or not in order to
parse it correctly.
I'm leaning towards adding an unresolved variant, but perhaps also worth
exploring always keeping the reference.
from jotdown.
kaj
commented on August 18, 2024
One way of handling this, that shouldn't make Event any bigger, is to add a variant SpanLinkType::Unresolved (to the existing Inline and Reference), and in that case let the url in Container::Link(url, type) be the unresolved string.
Than an automatic link handler could match for that, calculate the actual url, and replace the Container::Link(refstr, LinkType::Span(Unresolved)) with Container::Link(actual_url, LinkType::Span(Reference)). Note that for my use-case, I would need to handle the content of the link container to calculate the actual url (and possibly other attributes (e.g. title or hreflang), so this would be a lot easier given the AST suggested in #17 .
from jotdown.
hellux
commented on August 18, 2024
One way of handling this, that shouldn't make `Event` any bigger, is
to add a variant `SpanLinkType::Unresolved` (to the existing `Inline`
and `Reference`), and in that case let the `url` in
`Container::Link(url, type)` be the unresolved string.
Yes, something like that was what I had in mind. I'm guessing it is very
rare to need both the tag and the resolved URL. I think we should go
ahead with this as we will need it anyway for a single-pass parser. Also
makes it possible to detect unresolved links, e.g. for erroring out.
Note that for my use-case, I would need to handle the _content_ of the
link container to calculate the actual url (and possibly other
attributes (e.g. title or hreflang), so this would be a lot easier
given the AST suggested in #17 .
Yeah, this is a drawback when dealing with events directly, it is quite
inconvenient to collect the content.
Another option, that might be more by design, is to use a span with a
class: `[Some word]{.wp}`. A benefit of `[Some word][wp]` is that it
indicates that it is a link, but it might be confusing as it looks a
normal reference link.
Also, if the unresolved tag is available in the Event, then if you were
to use `[Some word][]{.wp}`, the content would be placed in the `url` as
the tag.
Both of `[Some word][wp]` and `[Some word][]{.wp}` have the risk of
colliding with existing link definitions, though. `[Some word](){.wp}`
could also be an option, and doesn't have this problem.
from jotdown.
Related Issues (20)
- `Render` trait HOT 5
- bug: attributes disappear from raw inline
- Add an AST HOT 9
- bug: disappearing attributes
- CowStr HOT 2
- Provide C API HOT 2
- bug: formatting is kept in link reference text tag
- Render from borrowed events? HOT 3
- Expose tag for unresolved links in Event
- Emit Footnotes as they are encountered
- impl IntoIterator for Attributes HOT 2
- bug: consecutive attributes are ignored HOT 1
- Attributes are parsed inside math HOT 2
- Comments don't work with headings HOT 1
- paragraph tags disappear after numbered list
- Ambiguity between alphabetical and Roman numeral lists HOT 3
- Provide a shortcut to just render to String HOT 2
- Escapes in inline links
- Multi-line block attributes
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from jotdown.