wizard: use markdown for description formatting

diff --git a/Makefile.webui b/Makefile.webui
index 99774ec9e7eea2b5678db18dd11ebd6a7b90d4b2..5505979d64e893fcaaa7f346aa7877d44cbbeabd 100644 (file)
--- a/Makefile.webui
+++ b/Makefile.webui
@@ -75,6 +75,7 @@ CSS += static/app/ext.css
 
 JAVASCRIPT += $(ROOTPATH)/app/i18n.js
 JAVASCRIPT += $(ROOTPATH)/app/extensions.js
+JAVASCRIPT += $(ROOTPATH)/app/micromarkdown.js
 JAVASCRIPT += $(ROOTPATH)/livegrid/livegrid-all.js
 JAVASCRIPT += $(ROOTPATH)/lovcombo/lovcombo-all.js
 JAVASCRIPT += $(ROOTPATH)/multiselect/multiselect.js

diff --git a/src/webui/static/app/micromarkdown.js b/src/webui/static/app/micromarkdown.js
new file mode 100644 (file)
index 0000000..da2fa55
--- /dev/null
+++ b/src/webui/static/app/micromarkdown.js
@@ -0,0 +1,427 @@
+/*
+ * µmarkdown.js
+ * markdown in under 5kb
+ *
+ * Copyright 2015, Simon Waldherr - http://simon.waldherr.eu/
+ * Released under the MIT Licence
+ * http://simon.waldherr.eu/license/mit/
+ *
+ * The MIT License (MIT)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the »Software«), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED »AS IS«, WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ *
+ * Github:  https://github.com/simonwaldherr/micromarkdown.js/
+ * Version: 0.3.4
+ */
+
+/*jslint browser: true, node: true, plusplus: true, indent: 2, regexp: true, ass: true */
+/*global ActiveXObject, define */
+
+var micromarkdown = {
+  useajax: false,
+  regexobject: {
+    headline: /^(\#{1,6})([^\#\n]+)$/m,
+    code: /\s\`\`\`\n?([^`]+)\`\`\`/g,
+    hr: /^(?:([\*\-_] ?)+)\1\1$/gm,
+    lists: /^((\s*((\*|\-)|\d(\.|\))) [^\n]+)\n)+/gm,
+    bolditalic: /(?:([\*_~]{1,3}))([^\*_~\n]+[^\*_~\s])\1/g,
+    links: /!?\[([^\]<>]+)\]\(([^ \)<>]+)( "[^\(\)\"]+")?\)/g,
+    reflinks: /\[([^\]]+)\]\[([^\]]+)\]/g,
+    smlinks: /\@([a-z0-9]{3,})\@(t|gh|fb|gp|adn)/gi,
+    mail: /<(([a-z0-9_\-\.])+\@([a-z0-9_\-\.])+\.([a-z]{2,7}))>/gmi,
+    tables: /\n(([^|\n]+ *\| *)+([^|\n]+\n))((:?\-+:?\|)+(:?\-+:?)*\n)((([^|\n]+ *\| *)+([^|\n]+)\n)+)/g,
+    include: /[\[<]include (\S+) from (https?:\/\/[a-z0-9\.\-]+\.[a-z]{2,9}[a-z0-9\.\-\?\&\/]+)[\]>]/gi,
+    url: /<([a-zA-Z0-9@:%_\+.~#?&\/=]{2,256}\.[a-z]{2,4}\b(\/[\-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)?)>/g,
+    url2: /[ \t\n]([a-zA-Z]{2,16}:\/\/[a-zA-Z0-9@:%_\+.~#?&=]{2,256}.[a-z]{2,4}\b(\/[\-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)?)[ \t\n]/g
+  },
+  codeblocks: {},
+  parse: function (str, strict) {
+    'use strict';
+    var line, nstatus = 0,
+      status, cel, calign, indent, helper, helper1, helper2, count, repstr, stra, trashgc = [],
+      casca = 0,
+      i = 0,
+      j = 0,
+      crc32str = '';
+    str = '\n' + str + '\n';
+
+    if (strict !== true) {
+      micromarkdown.regexobject.lists = /^((\s*(\*|\d\.) [^\n]+)\n)+/gm;
+    }
+
+    str = str.replace('$&', '&#x0024&amp;');
+
+    /* code */
+    while ((stra = micromarkdown.regexobject.code.exec(str)) !== null) {
+      crc32str = micromarkdown.crc32(stra[0]);
+      micromarkdown.codeblocks[crc32str] = '<code>\n' + micromarkdown.htmlEncode(stra[1]).replace(/\n/gm, '<br/>').replace(/\ /gm, '&nbsp;') + '</code>\n';
+      str = str.replace(stra[0], ' §§§' + crc32str + '§§§ '); 
+    }
+
+    /* headlines */
+    while ((stra = micromarkdown.regexobject.headline.exec(str)) !== null) {
+      count = stra[1].length;
+      str = str.replace(stra[0], '<h' + count + '>' + stra[2] + '</h' + count + '>' + '\n');
+    }
+
+    /* lists */
+    while ((stra = micromarkdown.regexobject.lists.exec(str)) !== null) {
+      casca = 0;
+      if ((stra[0].trim().substr(0, 1) === '*') || (stra[0].trim().substr(0, 1) === '-')) {
+        repstr = '<ul>';
+      } else {
+        repstr = '<ol>';
+      }
+      helper = stra[0].split('\n');
+      helper1 = [];
+      status = 0;
+      indent = false;
+      for (i = 0; i < helper.length; i++) {
+        if ((line = /^((\s*)((\*|\-)|\d(\.|\))) ([^\n]+))/.exec(helper[i])) !== null) {
+          if ((line[2] === undefined) || (line[2].length === 0)) {
+            nstatus = 0;
+          } else {
+            if (indent === false) {
+              indent = line[2].replace(/\t/, '    ').length;
+            }
+            nstatus = Math.round(line[2].replace(/\t/, '    ').length / indent);
+          }
+          while (status > nstatus) {
+            repstr += helper1.pop();
+            status--;
+            casca--;
+          }
+          while (status < nstatus) {
+            if ((line[0].trim().substr(0, 1) === '*') || (line[0].trim().substr(0, 1) === '-')) {
+              repstr += '<ul>';
+              helper1.push('</ul>');
+            } else {
+              repstr += '<ol>';
+              helper1.push('</ol>');
+            }
+            status++;
+            casca++;
+          }
+          repstr += '<li>' + line[6] + '</li>' + '\n';
+        }
+      }
+      while (casca > 0) {
+        repstr += '</ul>';
+        casca--;
+      }
+      if ((stra[0].trim().substr(0, 1) === '*') || (stra[0].trim().substr(0, 1) === '-')) {
+        repstr += '</ul>';
+      } else {
+        repstr += '</ol>';
+      }
+      str = str.replace(stra[0], repstr + '\n');
+    }
+
+    /* tables */
+    while ((stra = micromarkdown.regexobject.tables.exec(str)) !== null) {
+      repstr = '<table><tr>';
+      helper = stra[1].split('|');
+      calign = stra[4].split('|');
+      for (i = 0; i < helper.length; i++) {
+        if (calign.length <= i) {
+          calign.push(0);
+        } else if ((calign[i].trimRight().slice(-1) === ':') && (strict !== true)) {
+          if (calign[i][0] === ':') {
+            calign[i] = 3;
+          } else {
+            calign[i] = 2;
+          }
+        } else if (strict !== true) {
+          if (calign[i][0] === ':') {
+            calign[i] = 1;
+          } else {
+            calign[i] = 0;
+          }
+        } else {
+          calign[i] = 0;
+        }
+      }
+      cel = ['<th>', '<th align="left">', '<th align="right">', '<th align="center">'];
+      for (i = 0; i < helper.length; i++) {
+        repstr += cel[calign[i]] + helper[i].trim() + '</th>';
+      }
+      repstr += '</tr>';
+      cel = ['<td>', '<td align="left">', '<td align="right">', '<td align="center">'];
+      helper1 = stra[7].split('\n');
+      for (i = 0; i < helper1.length; i++) {
+        helper2 = helper1[i].split('|');
+        if (helper2[0].length !== 0) {
+          while (calign.length < helper2.length) {
+            calign.push(0);
+          }
+          repstr += '<tr>';
+          for (j = 0; j < helper2.length; j++) {
+            repstr += cel[calign[j]] + helper2[j].trim() + '</td>';
+          }
+          repstr += '</tr>' + '\n';
+        }
+      }
+      repstr += '</table>';
+      str = str.replace(stra[0], repstr);
+    }
+
+    /* bold and italic */
+    for (i = 0; i < 3; i++) {
+      while ((stra = micromarkdown.regexobject.bolditalic.exec(str)) !== null) {
+        repstr = [];
+        if (stra[1] === '~~') {
+          str = str.replace(stra[0], '<del>' + stra[2] + '</del>');
+        } else {
+          switch (stra[1].length) {
+          case 1:
+            repstr = ['<i>', '</i>'];
+            break;
+          case 2:
+            repstr = ['<b>', '</b>'];
+            break;
+          case 3:
+            repstr = ['<i><b>', '</b></i>'];
+            break;
+          }
+          str = str.replace(stra[0], repstr[0] + stra[2] + repstr[1]);
+        }
+      }
+    }
+
+    /* links */
+    while ((stra = micromarkdown.regexobject.links.exec(str)) !== null) {
+      if (stra[0].substr(0, 1) === '!') {
+        str = str.replace(stra[0], '<img src="' + stra[2] + '" alt="' + stra[1] + '" title="' + stra[1] + '" />\n');
+      } else {
+        str = str.replace(stra[0], '<a ' + micromarkdown.mmdCSSclass(stra[2], strict) + 'href="' + stra[2] + '">' + stra[1] + '</a>\n');
+      }
+    }
+    while ((stra = micromarkdown.regexobject.mail.exec(str)) !== null) {
+      str = str.replace(stra[0], '<a href="mailto:' + stra[1] + '">' + stra[1] + '</a>');
+    }
+    while ((stra = micromarkdown.regexobject.url.exec(str)) !== null) {
+      repstr = stra[1];
+      if (repstr.indexOf('://') === -1) {
+        repstr = 'http://' + repstr;
+      }
+      str = str.replace(stra[0], '<a ' + micromarkdown.mmdCSSclass(repstr, strict) + 'href="' + repstr + '">' + repstr.replace(/(https:\/\/|http:\/\/|mailto:|ftp:\/\/)/gmi, '') + '</a>');
+    }
+    while ((stra = micromarkdown.regexobject.reflinks.exec(str)) !== null) {
+      helper1 = new RegExp('\\[' + stra[2] + '\\]: ?([^ \n]+)', "gi");
+      if ((helper = helper1.exec(str)) !== null) {
+        str = str.replace(stra[0], '<a ' + micromarkdown.mmdCSSclass(helper[1], strict) + 'href="' + helper[1] + '">' + stra[1] + '</a>');
+        trashgc.push(helper[0]);
+      }
+    }
+    for (i = 0; i < trashgc.length; i++) {
+      str = str.replace(trashgc[i], '');
+    }
+    while ((stra = micromarkdown.regexobject.smlinks.exec(str)) !== null) {
+      switch (stra[2]) {
+      case 't':
+        repstr = 'https://twitter.com/' + stra[1];
+        break;
+      case 'gh':
+        repstr = 'https://github.com/' + stra[1];
+        break;
+      case 'fb':
+        repstr = 'https://www.facebook.com/' + stra[1];
+        break;
+      case 'gp':
+        repstr = 'https://plus.google.com/+' + stra[1];
+        break;
+      case 'adn':
+        repstr = 'https://alpha.app.net/' + stra[1];
+        break;
+      }
+      str = str.replace(stra[0], '<a ' + micromarkdown.mmdCSSclass(repstr, strict) + 'href="' + repstr + '">' + stra[1] + '</a>');
+    }
+    while ((stra = micromarkdown.regexobject.url2.exec(str)) !== null) {
+      repstr = stra[1];
+      str = str.replace(stra[0], '<a ' + micromarkdown.mmdCSSclass(repstr, strict) + 'href="' + repstr + '">' + repstr + '</a>');
+    }
+
+    /* horizontal line */
+    while ((stra = micromarkdown.regexobject.hr.exec(str)) !== null) {
+      str = str.replace(stra[0], '\n<hr/>\n');
+    }
+
+    /* include */
+    if ((micromarkdown.useajax !== false) && (strict !== true)) {
+      while ((stra = micromarkdown.regexobject.include.exec(str)) !== null) {
+        helper = stra[2].replace(/[\.\:\/]+/gm, '');
+        helper1 = '';
+        if (document.getElementById(helper)) {
+          helper1 = document.getElementById(helper).innerHTML.trim();
+        } else {
+          micromarkdown.ajax(stra[2]);
+        }
+        if ((stra[1] === 'csv') && (helper1 !== '')) {
+          helper2 = {
+            ';': [],
+            '\t': [],
+            ',': [],
+            '|': []
+          };
+          helper2[0] = [';', '\t', ',', '|'];
+          helper1 = helper1.split('\n');
+          for (j = 0; j < helper2[0].length; j++) {
+            for (i = 0; i < helper1.length; i++) {
+              if (i > 0) {
+                if (helper2[helper2[0][j]] !== false) {
+                  if ((helper2[helper2[0][j]][i] !== helper2[helper2[0][j]][i - 1]) || (helper2[helper2[0][j]][i] === 1)) {
+                    helper2[helper2[0][j]] = false;
+                  }
+                }
+              }
+            }
+          }
+          if ((helper2[';'] !== false) || (helper2['\t'] !== false) || (helper2[','] !== false) || (helper2['|'] !== false)) {
+            if (helper2[';'] !== false) {
+              helper2 = ';';
+            } else if (helper2['\t']) {
+              helper2 = '\t';
+            } else if (helper2[',']) {
+              helper2 = ',';
+            } else if (helper2['|']) {
+              helper2 = '|';
+            }
+            repstr = '<table>';
+            for (i = 0; i < helper1.length; i++) {
+              helper = helper1[i].split(helper2);
+              repstr += '<tr>';
+              for (j = 0; j < helper.length; j++) {
+                repstr += '<td>' + micromarkdown.htmlEncode(helper[j]) + '</td>';
+              }
+              repstr += '</tr>';
+            }
+            repstr += '</table>';
+            str = str.replace(stra[0], repstr);
+          } else {
+            str = str.replace(stra[0], '<code>' + helper1.join('\n') + '</code>');
+          }
+        } else {
+          str = str.replace(stra[0], '');
+        }
+      }
+    }
+
+    str = str.replace(/ {2,}[\n]{1,}/gmi, '<br/>');
+
+    str = str.replace(/[\n]{2,}/gmi, '<br/><br/>');
+
+    for(var index in micromarkdown.codeblocks) { 
+      if(micromarkdown.codeblocks.hasOwnProperty(index)) {
+        str = str.replace('§§§' + index + '§§§', micromarkdown.codeblocks[index]); 
+      }
+    }
+    str = str.replace('&#x0024&amp;', '$&');
+
+    return str;
+  },
+  ajax: function (str) {
+    'use strict';
+    var xhr;
+    if (document.getElementById(str.replace(/[\.\:\/]+/gm, ''))) {
+      return false;
+    }
+    if (window.ActiveXObject) {
+      try {
+        xhr = new ActiveXObject("Microsoft.XMLHTTP");
+      } catch (e) {
+        xhr = null;
+        return e;
+      }
+    } else {
+      xhr = new XMLHttpRequest();
+    }
+    xhr.onreadystatechange = function () {
+      if (xhr.readyState === 4) {
+        var ele = document.createElement('code');
+        ele.innerHTML = xhr.responseText;
+        ele.id = str.replace(/[\.\:\/]+/gm, '');
+        ele.style.display = 'none';
+        document.getElementsByTagName('body')[0].appendChild(ele);
+        micromarkdown.useajax();
+      }
+    };
+    xhr.open('GET', str, true);
+    xhr.setRequestHeader('Content-type', 'application/x-www-form-urlencoded');
+    xhr.send();
+  },
+  crc32: function (string) {
+    "use strict";
+    var crc = 0,
+      n, x, i, len, table = ["00000000", "77073096", "EE0E612C", "990951BA", "076DC419", "706AF48F", "E963A535", "9E6495A3", "0EDB8832", "79DCB8A4", "E0D5E91E", "97D2D988", "09B64C2B", "7EB17CBD", "E7B82D07", "90BF1D91", "1DB71064", "6AB020F2", "F3B97148", "84BE41DE", "1ADAD47D", "6DDDE4EB", "F4D4B551", "83D385C7", "136C9856", "646BA8C0", "FD62F97A", "8A65C9EC", "14015C4F", "63066CD9", "FA0F3D63", "8D080DF5", "3B6E20C8", "4C69105E", "D56041E4", "A2677172", "3C03E4D1", "4B04D447", "D20D85FD", "A50AB56B", "35B5A8FA", "42B2986C", "DBBBC9D6", "ACBCF940", "32D86CE3", "45DF5C75", "DCD60DCF", "ABD13D59", "26D930AC", "51DE003A", "C8D75180", "BFD06116", "21B4F4B5", "56B3C423", "CFBA9599", "B8BDA50F", "2802B89E", "5F058808", "C60CD9B2", "B10BE924", "2F6F7C87", "58684C11", "C1611DAB", "B6662D3D", "76DC4190", "01DB7106", "98D220BC", "EFD5102A", "71B18589", "06B6B51F", "9FBFE4A5", "E8B8D433", "7807C9A2", "0F00F934", "9609A88E", "E10E9818", "7F6A0DBB", "086D3D2D", "91646C97", "E6635C01", "6B6B51F4", "1C6C6162", "856530D8", "F262004E", "6C0695ED", "1B01A57B", "8208F4C1", "F50FC457", "65B0D9C6", "12B7E950", "8BBEB8EA", "FCB9887C", "62DD1DDF", "15DA2D49", "8CD37CF3", "FBD44C65", "4DB26158", "3AB551CE", "A3BC0074", "D4BB30E2", "4ADFA541", "3DD895D7", "A4D1C46D", "D3D6F4FB", "4369E96A", "346ED9FC", "AD678846", "DA60B8D0", "44042D73", "33031DE5", "AA0A4C5F", "DD0D7CC9", "5005713C", "270241AA", "BE0B1010", "C90C2086", "5768B525", "206F85B3", "B966D409", "CE61E49F", "5EDEF90E", "29D9C998", "B0D09822", "C7D7A8B4", "59B33D17", "2EB40D81", "B7BD5C3B", "C0BA6CAD", "EDB88320", "9ABFB3B6", "03B6E20C", "74B1D29A", "EAD54739", "9DD277AF", "04DB2615", "73DC1683", "E3630B12", "94643B84", "0D6D6A3E", "7A6A5AA8", "E40ECF0B", "9309FF9D", "0A00AE27", "7D079EB1", "F00F9344", "8708A3D2", "1E01F268", "6906C2FE", "F762575D", "806567CB", "196C3671", "6E6B06E7", "FED41B76", "89D32BE0", "10DA7A5A", "67DD4ACC", "F9B9DF6F", "8EBEEFF9", "17B7BE43", "60B08ED5", "D6D6A3E8", "A1D1937E", "38D8C2C4", "4FDFF252", "D1BB67F1", "A6BC5767", "3FB506DD", "48B2364B", "D80D2BDA", "AF0A1B4C", "36034AF6", "41047A60", "DF60EFC3", "A867DF55", "316E8EEF", "4669BE79", "CB61B38C", "BC66831A", "256FD2A0", "5268E236", "CC0C7795", "BB0B4703", "220216B9", "5505262F", "C5BA3BBE", "B2BD0B28", "2BB45A92", "5CB36A04", "C2D7FFA7", "B5D0CF31", "2CD99E8B", "5BDEAE1D", "9B64C2B0", "EC63F226", "756AA39C", "026D930A", "9C0906A9", "EB0E363F", "72076785", "05005713", "95BF4A82", "E2B87A14", "7BB12BAE", "0CB61B38", "92D28E9B", "E5D5BE0D", "7CDCEFB7", "0BDBDF21", "86D3D2D4", "F1D4E242", "68DDB3F8", "1FDA836E", "81BE16CD", "F6B9265B", "6FB077E1", "18B74777", "88085AE6", "FF0F6A70", "66063BCA", "11010B5C", "8F659EFF", "F862AE69", "616BFFD3", "166CCF45", "A00AE278", "D70DD2EE", "4E048354", "3903B3C2", "A7672661", "D06016F7", "4969474D", "3E6E77DB", "AED16A4A", "D9D65ADC", "40DF0B66", "37D83BF0", "A9BCAE53", "DEBB9EC5", "47B2CF7F", "30B5FFE9", "BDBDF21C", "CABAC28A", "53B39330", "24B4A3A6", "BAD03605", "CDD70693", "54DE5729", "23D967BF", "B3667A2E", "C4614AB8", "5D681B02", "2A6F2B94", "B40BBE37", "C30C8EA1", "5A05DF1B", "2D02EF8D"];
+    n = 0;
+    x = 0;
+    len = string.length;
+    crc = crc ^ (-1);
+    for (i = 0; i < len; i++) {
+      n = (crc ^ string.charCodeAt(i)) & 0xFF;
+      x = "0x" + table[n];
+      crc = (crc >>> 8) ^ x;
+    }
+    return crc ^ (-1);
+  },
+  countingChars: function (str, split) {
+    'use strict';
+    str = str.split(split);
+    if (typeof str === 'object') {
+      return str.length - 1;
+    }
+    return 0;
+  },
+  htmlEncode: function (str) {
+    'use strict';
+    var div = document.createElement('div');
+    div.appendChild(document.createTextNode(str));
+    str = div.innerHTML;
+    div = undefined;
+    return str;
+  },
+  mmdCSSclass: function (str, strict) {
+    'use strict';
+    var urlTemp;
+    if ((str.indexOf('/') !== -1) && (strict !== true)) {
+      urlTemp = str.split('/');
+      if (urlTemp[1].length === 0) {
+        urlTemp = urlTemp[2].split('.');
+      } else {
+        urlTemp = urlTemp[0].split('.');
+      }
+      return 'class="mmd_' + urlTemp[urlTemp.length - 2].replace(/[^\w\d]/g, '') + urlTemp[urlTemp.length - 1] + '" ';
+    }
+    return '';
+  }
+};
+
+(function (root, factory) {
+  "use strict";
+  if (typeof define === 'function' && define.amd) {
+    define([], factory);
+  } else if (typeof exports === 'object') {
+    module.exports = factory();
+  } else {
+    root.returnExports = factory();
+  }
+}(this, function () {
+  'use strict';
+  return micromarkdown;
+}));

diff --git a/src/webui/static/app/wizard.js b/src/webui/static/app/wizard.js
index a784993078e61cc9040d10b5b582b7530bca8fda..79266d8aa8e9b72ed85bb1635049febb94f2fc80 100644 (file)
--- a/src/webui/static/app/wizard.js
+++ b/src/webui/static/app/wizard.js
@@ -101,12 +101,8 @@ tvheadend.wizard_start = function(page) {
         var c = '';
         if (icon)
             c += '<img class="x-wizard-icon" src="' + icon + '"/>';
-        if (text) {
-            var a = text.split('\n');
-            text = '';
-            for (var i = 0; i < a.length; i++)
-                text += '<p>' + a[i] + '</p>';
-        }
+        if (text)
+            text = micromarkdown.parse(text);
         c += '<div class="x-wizard-description">' + text + '</div>';
         var p = new Ext.Panel({
             width: 570,

diff --git a/src/wizard.c b/src/wizard.c
index fcad5239843b2f0a7e914bb0e96b782cf3a752fa..d8800e816211e711e450a337d3772e72c085d4ec 100644 (file)
--- a/src/wizard.c
+++ b/src/wizard.c
@@ -16,6 +16,10 @@
  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/*
+ * Use http://spec.commonmark.org/ as reference for description formatting.
+ */
+
 #include "tvheadend.h"
 #include "config.h"
 #include "access.h"
@@ -163,17 +167,17 @@ Welcome to Tvheadend, your TV streaming server and video recorder. This \
 wizard will help you get up and running fast. Let`s start by configuring \
 the basic language settings. Please select the default user interface \
 and EPG language(s).\n\n\
-<b>This wizard should be run only on the initial setup. Please, cancel \
-it, if you are not willing to touch the current configuration. </b>\
+**This wizard should be run only on the initial setup. Please, cancel \
+it, if you are not willing to touch the current configuration.**\
 \
-\n\n<b>Notes</b>\n\
+\n\n**Notes**: \
 If you cannot see your preferred language in the language list and would \
 like to help translate Tvheadend see \
-<a href=\"https://tvheadend.org/projects/tvheadend/wiki/Internationalization\" target=\"new\">here</a>.\n\
+[here](https://tvheadend.org/projects/tvheadend/wiki/Internationalization).\n\
 If you don't enter a preferred language, US English will be used as a default.\n\
 Not selecting the correct EPG \
 language can result in garbled EPG text; if this happens, don't panic, \
-as you can easily change it later. \n\
+as you can easily change it later.\n\
 "))
 wizard_page_t *wizard_hello(const char *lang)
 {
@@ -386,16 +390,16 @@ or 0.0.0.0/0 or empty value for access from any system.\n\
 This works alongside the second part, which is a familiar \
 username/password combination, so provide these for both \
 an administrator and regular (day-to-day) user. \
-\n\n<b>Notes</b>\n\
+\n\n**Notes**: \
 You may enter a comma-separated list of network prefixes (IPv4/IPv6).\n\
 if you were asked to enter a username and password during installation, \
 we'd recommend not using the same details for a user here as it may cause \
 unexpected behavior, incorrect permissions etc.\n\
 To allow anonymous access for any account (administrative or regular user) enter \
-an asterisk (*) in the username and password fields. <u>It is not</u> \
-recommended that you allow anonymous access to the admin account.</u> \n\
+an asterisk (*) in the username and password fields. ___It is not___ \
+recommended that you allow anonymous access to the admin account.\n\
 If you plan on accessing Tvheadend over the Internet, make sure you use \
-strong credentials and <u>do not allow anonymous access at all</u>. \n\n\
+strong credentials and ___do not allow anonymous access at all___.\n\n\
 "))
 
 wizard_page_t *wizard_login(const char *lang)