public inbox for documentation@lists.ipfire.org
 help / color / mirror / Atom feed
From: Michael Tremer <michael.tremer@ipfire.org>
To: documentation@lists.ipfire.org
Subject: Re: New Wiki Software - Please help testing :)
Date: Thu, 30 May 2019 15:50:01 +0100	[thread overview]
Message-ID: <9D612114-964E-4D2C-823E-D90DDBCBE97F@ipfire.org> (raw)
In-Reply-To: <c34f1b17-563f-3051-54a3-d33db3b4f423@ipfire.org>

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

Hi,

> On 27 May 2019, at 18:10, Matthias Fischer <matthias.fischer(a)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


  reply	other threads:[~2019-05-30 14:50 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-24 22:03 Jon Murphy
2019-05-27 16:27 ` Michael Tremer
2019-05-27 17:10   ` Matthias Fischer
2019-05-30 14:50     ` Michael Tremer [this message]
2019-05-28  3:05   ` Jon Murphy
2019-05-30 14:51     ` Michael Tremer
     [not found] <2CAE7946-C451-4D11-B3C6-9C64CAFC1220@gmail.com>
2019-07-17 15:57 ` Michael Tremer
2019-07-17 22:57   ` Jon Murphy
2019-07-18 10:16     ` Michael Tremer
     [not found] <4BB6A887-545C-4194-B497-16E08FE82231@gmail.com>
2019-05-30 19:04 ` Michael Tremer
2019-05-30 19:23   ` Jon Murphy
2019-05-30 19:24     ` Michael Tremer
2019-05-30 19:30       ` Jon Murphy
2019-06-02 22:13         ` Michael Tremer
     [not found] <3917C587-0660-4EA5-A997-081C3A69D045@gmail.com>
2019-05-30 18:17 ` Michael Tremer
     [not found] <0E1A43E9-96F5-487C-8974-ED25DC70D05B@gmail.com>
2019-05-30 17:31 ` Michael Tremer
     [not found] <630732F1-CA01-43FD-8EB5-4601C6BF3162@gmail.com>
2019-05-30 17:07 ` Michael Tremer
2019-05-30 17:22 ` Michael Tremer
     [not found] <AF378EE0-6263-41AA-A6A0-5442D9C5FCC3@gmail.com>
2019-05-30 14:50 ` Michael Tremer
  -- strict thread matches above, loose matches on Subject: below --
2019-05-24 16:48 Jon Murphy
2019-05-23 13:35 Michael Tremer
2019-05-24 10:58 ` Carlo Fusco
2019-05-24 11:07   ` Carlo Fusco
2019-05-26 10:43     ` Michael Tremer
2019-05-26  8:28 ` Matthias Fischer
2019-05-26 10:54   ` Michael Tremer
2019-05-26 10:55   ` Michael Tremer
2019-06-01 12:09 ` ummeegge
2019-06-02 22:10   ` Michael Tremer
2019-06-06  3:30     ` Jon Murphy
2019-07-16 16:34       ` Michael Tremer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=9D612114-964E-4D2C-823E-D90DDBCBE97F@ipfire.org \
    --to=michael.tremer@ipfire.org \
    --cc=documentation@lists.ipfire.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox