WikiLinks Support about wiki HOT 7 CLOSED

I don't mind the extra dependency if it enables a good solution. What I am worried about is the escaping you are talking about, can you elaborate on why and when it happens?

from wiki.

The extra dependency is simple and pure-python, so its friendly to a broad spectrum of environments. I agree that the key concerns are about behavior.

from wiki.

Here's my Usability concerns:

1. Included WikiLinks support:

   If I had a paragraph that I wanted to render as follows:

   In this scenario the fatigue stress is lower than the yield stress due to material properties.

   I could do this:

   In this scenario the [[fatigue stress]] is lower than the [[yield stress]] due to material properties.

   But that would yield:

   In this scenario the fatigue stress is lower than the yield stress due to material properties.

   The links are not the same. So I would have to reword it:

   In this scenario the [[strength/fatigue]] is lower than the [[strength/yield]] due to material properties.

   Yielding:

   In this scenario the strength/fatigue is lower than the strength/fatigue due to material properties.

   That is ugly and sort of removes some context to the statement. There's no real easy way to fix this with the default extension.

2. With the semantic wikilinks extension, it is a bit easier:

   I can get exactly what I want by typing my WikiLinks like this:

   In this scenario the [[/strength/fatigue|fatigue stress]] is lower than the [[/strength/yield|yield stress]] due to material properties.

   This outputs exactly what I need (it also pays attention to absolute and relative paths). But what if I just want to use the defaults [[]] behavior? Say I'm on the page: /tolerance_example/

   If you like this, then the [[Tolerance Toolbox]] can elaborate on everything explained here.

   This would yield:

   If you like this, then the [Tolerance Toolbox](/tolerance_example/Tolerance Toolbox) can elaborate on everything explained here.

   As you can see the link is wrong, implying that it's a sub-page of tolerance_example as well as maintaining capitalization and spaces. So we use it's config feature to correct for all this:

   def wikilink_builder(self, md, rel, target, label):
       link = target.lower().replace(' ', '_')
       output = '<a rel="{0}" href="/{1}">{2}</a>'.format(rel, link, label or target)
       return output

   This breaks everything out and assumes it's at the root (meaning to go to subpages you'll need to use the [[first/second|Title]] syntax). I thought this would work well, but the output is actually:

   If you like this, then the <a rel="None" href="/tolerance_toolbox">Tolerance Toolbox</a> can elaborate on everything explained here.

So as you can see, I haven't quite figured out the best option. I think the Semantic Wikilinks is the best way to go. But it may require me to dig into that code to submit a bug report, not completely sure at this point.

from wiki.

as far as I understood from a quick check from the readme, it appears that it is not a string that is expected as a return element but much rather some type of etree.Element instance? Might this be the issue here?

from wiki.

Yeah, I looked into it early on. What I got was an error:

TypeError: must be Element, not Element

Since that is so informative, I tried making it a string. I figured it would simply pass the string, but it wasn't. So I'll go back and try to figure out which Element it wants.

from wiki.

I've added autolinking support In restructuredtext with a very simple trick: just try to render the document: every missing link is reported as an error so retry but adding (manipulating the content input) the missing links targets as "internal wiki links" (using the same urlifing function we use when create a new page).

See mgaitan@3341a8f92dc3da78 for details

from wiki.

Closed. Ref: #36

from wiki.