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
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@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@lists.ipfire.org https://lists.ipfire.org/mailman/listinfo/documentation
On 27.05.2019 18:27, Michael Tremer wrote:
Hello,
...
- Matthias saved the same page a couple of times. That definitely shows that we need a preview function :)
Yep. My opinion: I/we need this. Every now and then it happens that you'll miss something or produce a typo. A preview function would help avoiding this.
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.
That's why I - personally - would like to have something like 'Markdown'.
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.
I wrote this with DokuWiki and I think, I know what you mean: http://www.copfilter.org/wiki
But I liked the editing tools... ;-)
So what springs to mind here is: We could refuse saving the page when something is not right.
+1
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?
We should at least throw an error, refuse to save and go back to editing mode.
-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 :)
I need a documentation... ;-)
First thing that puzzled me today, e.g.:
On https://wiki.dev.ipfire.org/actions/edit/installation/step1 at page bottom there is a link to the next step: [[./step2]].
This leads to https://wiki.dev.ipfire.org/installation/step1/step2
But this link doesn't work ("Page does not exist") and I have no chance to test it. I can only change something, save the page and and pray that it works. I tried and get: "oops, something went wrong". Hm. Yes. Great. ;-)
But what is the right syntax at this point? I'll try on weekend...
Best, Matthias
Hi,
On 27 May 2019, at 18:10, Matthias Fischer matthias.fischer@ipfire.org wrote:
On 27.05.2019 18:27, Michael Tremer wrote:
Hello,
...
- Matthias saved the same page a couple of times. That definitely shows that we need a preview function :)
Yep. My opinion: I/we need this. Every now and then it happens that you'll miss something or produce a typo. A preview function would help avoiding this.
Okay, I just pushed some changes.
There is now a preview function which automatically updates. I quite like it. Tell me what you think.
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.
That's why I - personally - would like to have something like 'Markdown’.
We sort of have markdown, but actually we almost use it to highlight words in bold.
I have added an image tag that works like the ones on Dokuwiki using {{…}}.
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.
I wrote this with DokuWiki and I think, I know what you mean: http://www.copfilter.org/wiki
But I liked the editing tools... ;-)
We will get something done there.
So what springs to mind here is: We could refuse saving the page when something is not right.
+1
I was rather pointing out that that is a bad idea lol
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?
We should at least throw an error, refuse to save and go back to editing mode.
This is a horrible UI.
-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 :)
I need a documentation... ;-)
You will get it. But since I am dropping the content of the whole wiki again and again to test the import, I cannot write anything yet.
First thing that puzzled me today, e.g.:
On https://wiki.dev.ipfire.org/actions/edit/installation/step1 at page bottom there is a link to the next step: [[./step2]].
This leads to https://wiki.dev.ipfire.org/installation/step1/step2
So links work like this:
When you are in /installation/step1, then using a link like [[step2]] will translate to /installation/step2.
If you are using [[./something]], then that will result in /installation/step1/something.
And [[../blah]] of course will go back one step and result in /blah.
But this link doesn't work ("Page does not exist") and I have no chance to test it. I can only change something, save the page and and pray that it works. I tried and get: "oops, something went wrong". Hm. Yes. Great. ;-)
But what is the right syntax at this point? I'll try on weekend...
Best, Matthias
-Michael
Michael - The preview does not work for me. I see the word "Preview" and then to the far right I see a spinning circle. Below that I see "Loading...".
Jon
From: Michael Tremer Sent: Thursday, May 30, 2019, 9:50 AM To: Matthias Fischer Cc: Jon Murphy; documentation@lists.ipfire.org mailto:documentation@lists.ipfire.org Subject: Re: New Wiki Software - Please help testing :)
Okay, I just pushed some changes.
There is now a preview function which automatically updates. I quite like it. Tell me what you think.
Just so I understand - Is this an example of the absolute link you are referring to? https://wiki.dev.ipfire.org/installation
Or is a link like this? /installation
Sorry, I just want to make sure I do things correct.
Jon From: Michael Tremer Sent: Monday, May 27, 2019, 11:27 AM To: Jon Murphy Cc: documentation@lists.ipfire.org Subject: Re: New Wiki Software - Please help testing :)
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.
Hi,
On 28 May 2019, at 03:59, Jon Murphy jcmurphy26@gmail.com wrote:
Just so I understand - Is this an example of the absolute link you are referring to? https://wiki.dev.ipfire.org/installation
Or is a link like this? /installation
Sorry, I just want to make sure I do things correct.
Yes, that would have been an absolute URL.
The advantage of using [[/installation]] is that the software fetches the title of the link and we might make links a different colour if the page does not exist or something.
-Michael
Jon From: Michael Tremer Sent: Monday, May 27, 2019, 11:27 AM To: Jon Murphy Cc: documentation@lists.ipfire.org Subject: Re: New Wiki Software - Please help testing :)
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.
I tied to update the links on the index page but I keep getting this error:
Error 405 oops, something went wrong
Jon
From: Michael Tremer Sent: Monday, May 27, 2019, 11:27 AM To: Jon Murphy Cc: documentation@lists.ipfire.org Subject: Re: New Wiki Software - Please help testing :)
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.
Hi,
Thank you for reporting that. This is now fixed.
-Michael
On 28 May 2019, at 04:05, Jon Murphy jcmurphy26@gmail.com wrote:
I tied to update the links on the index page but I keep getting this error:
Error 405 oops, something went wrong
Jon
From: Michael Tremer Sent: Monday, May 27, 2019, 11:27 AM To: Jon Murphy Cc: documentation@lists.ipfire.org Subject: Re: New Wiki Software - Please help testing :)
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.
documentation@lists.ipfire.org
-
Jon Murphy -
Matthias Fischer -
Michael Tremer