Support Markdown in description of points & tracks
Some of my points & tracks contain a longer description, e.g. for a climbing spot, what to bring, approach info, sector and route notes, when sun comes & leaves in the course of the year,...
I'd like to format such texts using markdown which is much faster + easier to enter than HTML. The Locus addon FieldNotes seems to supports markdown since 2016.
Details on the motivation and ideas for implementation:
Plain text is easy & quick to enter – but makes it hard to quickly grasp or scan the information, because everything looks the same (no bold/italic/size).
Formatting via HTML is possible and helps to highlight core information in bold/italic and structre text via OL/UL/H2 etc. but it's cumbersome and time consuming to manually enter it on a computer but even more on location in the app having no toolbar and using the virtual keyboard showing either letters & numbers xor syntax characters like < so one needs to constantly switch back & forth between the keyboard types – for example for typing "in winter" I need to
- Type "in "
- switch 2 keyboard types
- Type <
- switch 1 keyboard type
- type i
- switch 2 keyboard types
- type >
- switch 1 keyboard type
- type winter
- switch 2 keyboard types
- Type <
- switch 2 keyboard types
- type /
- switch 2 keyboard types
- type i
- switch 2 keyboard types
- type >
Formatting via markdown would be better than HTML, because
- most text formatting & structuring elements of HTML are available
- less structural overhead needs to be typed because closing "tags" are required for less elements, e.g. not for headings or closing lists, but still required for bold or italic
- most syntax elements are available from letters & number keyboard in many keyboard locales & apps, e.g. space and -_. which allows italic, bold, unstructred & ordered lists, headings, horizontal lines – IMHO these are very likely formatting types in a point/track description.
For example for typing "in winter" – being "cumbersome" because it requires a closing tag – I need to
- Type "in "
- long press . to type _
- type winter
- long press . to type _
I thought whether markdown shall require to be activated in settings. On the one hand, that will avoid unsavy users from being surprised what happens with their text. On the other hand, they'll not coincidently discover that formatting is possible, HTML does also not need to be activated, and it would block that imported points & tracks containing markdown do render nicely for everyone.
As markdown is converted into HTML, the current point & track display code could be kept mostly unchanged, which reduces development effort. But it would be a great "nice to have" if already in edit mode, the markdown would be interpreted/visualized like e.g. android markdown note-taking app Markor or Windows app Notepad++ do, i.e. not "in _winter_" but "in _winter_" is shown, so users get an instant feedback their syntax was correct and what it means – avoiding cycles of edit, save, scroll, check, press button, scroll, edit, save, scroll, check.
Another great "nice to have" would be a toolbar making formatting available without knowing syntax by heart and also making it even more convenient & quick to add it. Maybe show a ".md" icon right of current diplayed text "Description" – so a similar display like in section "style on map" with the pencil icon right of the line – and pressing it will toggle a formatting toolbar. Or when entering the first markdown syntax (or starting to edit a point/track where markdown is used), a foldable toolbar appears.
Replies have been locked on this page!