Re: New Wiki Software - Please help testing :)

[Michael Tremer <michael.tremer@ipfire.org>]

[-- Attachment #1: Type: text/plain, Size: 3022 bytes --]

Hello,

Yes, there are differences in plain markdown.

I have seen that you did a couple of changes and I have a couple of notes about those:

* You used absolute links: This is something that should not be done when linking other pages on the wiki. I have spent a lot of time to make the code fast enough when it fetches the headline of the page so that we will show the correct headline. The absolute links don’t work like that.

So wiki links are possible just as they were before with [[page]] and [[page#Other Title]].

* You used the <img> tag to embed an image. The image pages have a short snippet to embed the image:

  https://wiki.dev.ipfire.org/ipfire_tux_512x512.png?action=detail

All images will always be full widths by default (and there is no reason not do to that) because all pages have to be responsive and we need to be able to read them on mobile. So using custom heights and widths naturally won’t work. We don’t know how large the screen is someone is using.

* Matthias saved the same page a couple of times. That definitely shows that we need a preview function :)

I do not want to point any fingers here at all. But I learned things from this. If it felt natural for you to do these things, but it was meant in another way then this is a bug in the software.

But I have no idea how to find a good solution for this. Admittedly nothing is documented yet, but future editors might not read the documentation. People edit first and I do want anyone to edit this wiki. We care about the information first, but we need to make sure that people do not mess up the markup.

I think that Dokuwiki is quite bad in that sense that it allows to be messy with the markup. This is also why conversion into another language is so difficult. There is multiple ways to do something and they can be mixed. Horror.

So what springs to mind here is: We could refuse saving the page when something is not right. But I think that might feel very frustrating. An <img> tag should never show up. If we find that, then we can just throw an error.

What do you guys think could work?

-Michael

P.S. I pushed out a couple of fixes, but I do not have a preview function yet. Not sure whether I can make that update live or if we will have a button. Or maybe a two-step save process. I need to explore that a little. Please send me your thoughts in case you have any ideas. But make them easy to implement :)

> On 24 May 2019, at 23:03, Jon Murphy <jcmurphy26(a)gmail.com> wrote:
> 
> Michael - It seems like there are some differences between Markdown and the new wiki app.  One is the double brackets, e.g., [[relativeLink]]
> 
> With the old wiki I could search thru the Dokuwiki website for hints. What is the name of the new app?  That will give us a better idea of how to use it.
> 
> Jon
> _______________________________________________
> Documentation mailing list
> Documentation(a)lists.ipfire.org
> https://lists.ipfire.org/mailman/listinfo/documentation