• Icon: Improvement Improvement
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None
    • None
    • None

      Allow simple "wiki-like" markup in annotations, like we have on MusicBrainz (very good if we also copy the formatting from there so as to not have YAMF)

          [BB-500] Allow markup in annotations

          Freso added a comment -

          I would strongly suggest to go with some basic Markdown (CommonMark would be a good target) to begin with. See the discussion on OTHER-77 for what has currently been explored. Yes, this won’t be everything that CQ wants (sorry), but MB’s mediawiki-like annotation markup isn’t that used in the grand scheme of MetaBrainz things. CritiqueBrainz, forums, GitHub, and documentation all use some Markdown flavour or other and per OTHER-77 Markdown is generally the direction we want to move towards. Implementing something other than Markdown now will almost surely mean that we already know we’ll have to figure out how to migrate Soon™ as well.

          Also, IME, WYSIWYG editors for Markdown and similar don’t have the same problems that HTML ones have, where you get a jumbled mess of markup code in the result.

          Freso added a comment - I would strongly suggest to go with some basic Markdown (CommonMark would be a good target) to begin with. See the discussion on OTHER-77 for what has currently been explored. Yes, this won’t be everything that CQ wants (sorry), but MB’s mediawiki-like annotation markup isn’t that used in the grand scheme of MetaBrainz things. CritiqueBrainz, forums, GitHub, and documentation all use some Markdown flavour or other and per OTHER-77 Markdown is generally the direction we want to move towards. Implementing something other than Markdown now will almost surely mean that we already know we’ll have to figure out how to migrate Soon™ as well. Also, IME, WYSIWYG editors for Markdown and similar don’t have the same problems that HTML ones have, where you get a jumbled mess of markup code in the result.

          MonkeyPython added a comment - - edited

          you know you can upload images to the ticket itself (much easier to see and also won't get lots when image hosts go down)

          but no. I really don't like that, having it as an optional "ad-on" sure. but default-wise I think doing it exactly like the mb is the way to go.

          I know I'm biased here, but "rich text editor" will just create loads of bogus html/whatever in the text - like if I paste an url it encodes it as [url=http.example.com/]http.example.com/[/url] or something. I dislike that immensely.

          Like the mb example, having the actual formatting on-page is useful. That way it's easy to see what does what. Also, initially, most of our users are from MB anyway - we also have some from the now defunct bookogs. Eventually we'll have more casual revisioners, so probably not a bad idea to enable an ability for an "add-on" later, but for now, just a simple text area that respects spaces/tabs and wikimarkup is what we need.

          MonkeyPython added a comment - - edited you know you can upload images to the ticket itself (much easier to see and also won't get lots when image hosts go down) but no. I really don't like that, having it as an optional "ad-on" sure. but default-wise I think doing it exactly like the mb is the way to go. I know I'm biased here, but "rich text editor" will just create loads of bogus html/whatever in the text - like if I paste an url it encodes it as [url=http.example.com/] http.example.com/ [/url] or something. I dislike that immensely. Like the mb example, having the actual formatting on-page is useful. That way it's easy to see what does what. Also, initially, most of our users are from MB anyway - we also have some from the now defunct bookogs. Eventually we'll have more casual revisioners, so probably not a bad idea to enable an ability for an "add-on" later, but for now, just a simple text area that respects spaces/tabs and wikimarkup is what we need.

          ooh got it. btw what do you think about instead replacing the normal textarea for annotation to a rich text editor to format annotations. many of the users may not be familiar with Wikitext syntaxes . using a text editor would be handy.

          Example : https://i.ibb.co/WHWZvdW/Screenshot-from-2021-05-04-00-18-03.png

          akashgp9@gmail.com added a comment - ooh got it. btw what do you think about instead replacing the normal textarea for annotation to a rich text editor to format annotations. many of the users may not be familiar with Wikitext syntaxes . using a text editor would be handy. Example :  https://i.ibb.co/WHWZvdW/Screenshot-from-2021-05-04-00-18-03.png

          MonkeyPython added a comment - - edited

          MonkeyPython added a comment - - edited no. I mean it like we have here https://musicbrainz.org/artist/0743b15a-3c32-48c8-ad58-cb325350befa/edit_annotation

          akashgp9@gmail.com added a comment - - edited

          @CatQuest, the Endeavouring Cat! by wiki markup did you mean the text editor( https://i.ibb.co/hfpgQmB/Screenshot-from-2021-05-03-19-03-57.png ) we have in https://wiki.musicbrainz.org/Main_Page to format text ?

           

          akashgp9@gmail.com added a comment - - edited @CatQuest, the Endeavouring Cat! by wiki markup did you mean the text editor(  https://i.ibb.co/hfpgQmB/Screenshot-from-2021-05-03-19-03-57.png ) we have in https://wiki.musicbrainz.org/Main_Page  to format text ?  

            shubh Shubham
            ApekattQuest, MonkeyPython MonkeyPython
            Votes:
            1 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:

                Version Package