Use delimiters for links with space in HyWiki

[matsl]

What

Use delimiters for links with space in HyWiki.

Why

Do no convert links containing dashes to space. Use links as they are
written just like org does. Publishing is thus close to what org
supports and close to how org links are written (without the org link
delimiters.).

Note

HyWiki links will thus be different from Hyperboles path links where
links can be given either as a delimited string with spaces or a
string where dashes represent space in the linked header. So old
behavior remains there.

Docstrings that mentions dash to space conversion has not been updated
yet. Will do that if we choose this solution.

[rswgnu]

Since I believe this works properly already outside of publishing and it is harder when typing a section reference to add delimiters around the reference than to type dashes, let's discuss and decide.

[matsl]

Since I believe this works properly already outside of publishing and it is harder when typing a section reference to add delimiters around the reference than to type dashes, let's discuss and decide.

OK. Since we decided to keep the current behavior I'm now coming back to this task (which will be implemented in another PR but easier to follow up here.)

What do you think of this compromise:

• When the WikiWord is given without any quotes or other delimiters treat dashes in section references as meaning space. This is the current behavior.
• When quotes or delimiters are used do no conversion. Treat section references verbatim. (This is a change.)

This would allow using references to headers that contains dashes by quoting them. I have not checked how easy it is to know if a WikiWord is quoted or "delimited" but should not be to hard I hope.

Or shall we just make headers with dashes not possible to link to?

What do you think? @rswgnu

[rswgnu]

I am open to the suggested change but want to understand the problem better via an example first. Show a header that you can’t link to now and why. If a header has a dash, then the link should encode it as two dashes within Org. In html, we are using Org generated ids instead.

[matsl]

With dash in a link meaning a space in the target you can't link to a header that contains a dash.

Using two dashes for a single dash is of course an alternative. We don't support that now. So you prefer that to using quotes?

And should then the double dash be required if the WikiWord is quoted? "WikiWord#header--header" to link to "* header-header"? It would make implementation easier but looks a bit strange to me.

[rswgnu]

If you replace spaces with dashes, then you don’t need delimiters, so if you use delimiters, it is reasonable to just include the header literally and not do any dash replacement.

[matsl]

If you replace spaces with dashes, then you don’t need delimiters, so if you use delimiters, it is reasonable to just include the header literally and not do any dash replacement.

Yes, I think that makes sense. So to summarize:

• When the WikiWord is given without any quotes or other delimiters treat dashes in section references as meaning space. (This is the current behavior.)
• To allow dashes in headers when no quotes are used you can use two dashes. (This is a change)
• If more than two dashes is used do the transformation from left to right. ("---" -> "- ") (This is a change)
• When quotes or delimiters are used do no conversion. Treat section references verbatim. (This is a change.)

Examples:

WikiPage#header                                -> "* header"
WikiPage#header-one                            -> "* header one"
WikiPage#header one                            -> "* header"
(WikiPage#header one)                          -> "* header one"
WikiPage#header--two                           -> "* header-two"
(WikiPage#header--two)                         -> "* header--two"
WikiPage#header---three                        -> "* header- three"

Right?

This also means we need to understand if the action is invoked within delimiters or not.

[rswgnu]

Yes, that all looks right.

…

Message ID: ***@***.***>

[matsl]

Thanks. I'll close this PR and start working on implementing the described functionality.