Markdown (#214)

* Add basic markdown support site wide

* Improved MD support.

Add some styling for images in MD

Add support for the bastardisation of the MD html for RML.

* Add processing for <ul> in RML

* Add OL processing to RML

* Fix a bug with squares appearing around the last page number

* Remove rml formatting in event_detail

* Improve handling of code blocks in RML

* Add MD to rigboard

Reduce MD title sizes as they were offensively large

* Add parsing of markdown when editing event items

* Improved list handling in RML

* Add tests for markdown support.

Focuses mainly on RML as that's where it will break

* Add indications of where MD support is enabled as per comment by @samozzy in #178.

Isn't quite a full description, but for the most part this should be enough for the people who know how to use it see where they can use it.

* Add failing test for markdown processing none

* Fix for failing test in e0d56e

* Add failing test for using single line breaks as per comment on #214

* Enable line break extension for single breaks in paragraphs by new lines.

Pass tests in ef3de607c3

* Enable GH flavour linebreaks in JS rendered markdown

* Made RML bullets pretty :)

* Added WYSIWYG editor. Works for notes & description, fails miserably for items :(

* Fixed for event items. Will probably fail tests because selenium can't type in simpleMDE :(

* FIX: Re-enable markdown on paperwork

Strikethrough is broken in all sorts of places for whatever reason

* FEAT: Markdown support on asset comments

* FIX: Prevent js injection through markdown fields

* Initial fixes

* Basic dark theme for simplemde

* Swap to locally delivered SimpleMDE

* Region for selenium testing of SimpleMDE

Bleh, Javascript all around

* Tests passing!

Fixed not using region for item modal, and overflow error on paperwork with really long description. Looks junk but I'm not really bothered

* Pep8 fixes

* Fallback for null HCapatcha sitekey

I.e. when we're on a branch

* Fix item description print being broken

* Actually fix sitekey problem

* Fixes for using markdown in asset comments

* Properly initialise markdown on asset comments

Co-authored-by: David Taylor <david@taylorhq.com>
Co-authored-by: FreneticScribbler <aj@aronajones.com>

RIGS/templates/event_detail.html

@@ -1,5 +1,7 @@
 {% extends request.is_ajax|yesno:"base_ajax.html,base_rigs.html" %}
 
+{% load markdown_tags %}
+
 {% block content %}
 <div class="row my-3 py-3">
     {% if not request.is_ajax %}
@@ -43,7 +45,7 @@
                     {% if perms.RIGS.view_event %}
                     <h4>Notes</h4>
                     <hr>
-                    <p class="dont-break-out">{{ event.notes|linebreaksbr }}</p>
+                    <p class="dont-break-out">{{ event.notes|markdown }}</p>
                     {% endif %}
                     <br>
                     {% include 'partials/item_table.html' %}

RIGS/templates/event_form.html

@@ -8,11 +8,13 @@
 {% block css %}
     {{ block.super }}
     <link rel="stylesheet" type="text/css" href="{% static 'css/selects.css' %}"/>
+    <link rel="stylesheet" type="text/css" href="{% static 'css/simplemde.min.css' %}">
 {% endblock %}
 
 {% block preload_js %}
     {{ block.super }}
     <script src="{% static 'js/selects.js' %}"></script>
+    <script src="{% static 'js/simplemde.min.js' %}"></script>
 {% endblock %}
 
 {% block js %}
@@ -63,6 +65,16 @@
             {% endif %}
         });
         $(document).ready(function () {
+            setupMDE('#id_description');
+            setupMDE('#id_notes');
+            setupMDE('#item_description');
+
+            $('#itemModal').on('shown.bs.modal', function (e) {
+                $('#item_description').data('mde_editor').value(
+                    $('#item_description').val()
+                    );
+            });
+
             setupItemTable($("#{{ form.items_json.id_for_label }}").val());
         });
         $(function () {
@@ -168,7 +180,7 @@
                         <label for="{{ form.description.id_for_label }}"
                                class="col-sm-4 col-form-label">{{ form.description.label }}</label>
 
-                        <div class="col-sm-8">
+                        <div class="col-sm-12">
                             {% render_field form.description class+="form-control" %}
                         </div>
                     </div>
@@ -345,7 +357,7 @@
                     <div class="col-sm-12">
                         <div class="form-group" data-toggle="tooltip" title="Notes on the event. This is only visible to keyholders, and is not displayed on the paperwork">
                             <label for="{{ form.notes.id_for_label }}">{{ form.notes.label }}</label>
-                            {% render_field form.notes class+="form-control" %}
+                            {% render_field form.notes class+="form-control md-enabled" %}
                         </div>
                     </div>
                     {% include 'partials/item_table.html' %}

RIGS/templates/event_print.xml

@@ -74,6 +74,14 @@
             <lineStyle kind="linebelow" start="3,0" stop="3,0" colorName="black"/>
             <lineStyle kind="linebelow" start="5,0" stop="5,0" colorName="black"/>
         </blockTableStyle>
+
+        <listStyle name="ol"
+                   bulletFormat="%s."
+                   bulletFontSize="10" />
+
+        <listStyle name="ul"
+                   start="bulletchar"
+                   bulletFontSize="10"/>
     </stylesheet>
 
     <template > {# Note: page is 595x842 points (1 point=1/72in) #}

RIGS/templates/event_print_page.xml

@@ -1,4 +1,6 @@
+{% load markdown_tags %}
 {% load filters %}
+
 <setNextFrame name="main"/>
 <nextFrame/>
 <blockTable style="headLayout" colWidths="330,165">
@@ -10,10 +12,8 @@
         <b>{{object.start_date|date:"D jS N Y"}}</b>
         </para>
 
-        <keepInFrame>
-            <para style="style.event_description">
-            {{ object.description|default_if_none:""|linebreaksxml }}
-                </para>
+        <keepInFrame maxHeight="500" onOverflow="shrink">
+            {{ object.description|default_if_none:""|markdown:"rml" }}
         </keepInFrame>
     </td>
     <td>
@@ -184,7 +184,7 @@
                 {% if item.description %}
                     </para>
                     <para style="item_description">
-                    <em>{{ item.description|linebreaksxml }}</em>
+                        {{ item.description|markdown:"rml" }}
                     </para>
                     <para>
                 {% endif %}

RIGS/templates/item_modal.html

@@ -16,10 +16,10 @@
                                    id="item_name"/>
                         </div>
                     </div>
-                    <div class="form-group form-row">
+                    <div class="form-group form-row" data-toggle="tooltip" title="A detailed description of the kit. MD enabled.">
                         <label for="item_description" class="col-sm-2 col-form-label">Description</label>
                         <div class="col-sm-10">
-                            <textarea type="text" placeholder="Description" class="form-control"
+                            <textarea type="text" placeholder="Description" class="form-control md-enabled"
                                       id="item_description" rows="8"></textarea>
                         </div>
                     </div>

RIGS/templates/partials/event_details.html

@@ -1,4 +1,5 @@
 {% load namewithnotes from filters %}
+{% load markdown_tags %}
 <div class="card card-info">
     <div class="card-header">Event Info</div>
     <div class="card-body">
@@ -46,7 +47,7 @@
             <dd class="col-sm-12">&nbsp;</dd>
 
             <dt class="col-sm-6">Event Description</dt>
-            <dd class="dont-break-out col-sm-12">{{ event.description|linebreaksbr }}</dd>
+            <dd class="dont-break-out col-sm-12">{{ event.description|markdown }}</dd>
 
             <dd class="col-sm-12">&nbsp;</dd>
 

RIGS/templates/partials/item_row.html

@@ -1,8 +1,9 @@
+{% load markdown_tags %}
 <tr id="item-{{item.pk}}" data-pk="{{item.pk}}" class="item_row">
 	<th scope="row">
 		<span class="name">{{ item.name }}</span>
         <div class="item-description">
-            <em class="description">{{item.description|linebreaksbr}}</em>
+            <em class="description">{{item.description|markdown}}</em>
         </div>
 	</th>
     {% if perms.RIGS.view_event %}