Merge lp:~dholbach/help-app/1430735-pt1 into lp:~ubuntu-touch-coreapps-drivers/help-app/trunk

[Daniel Holbach]

[Nicholas Skaggs (nskaggs)]

With the idea of perhaps making this better later, let's land this and move forward. Thanks Daniel!

review: Approve

[Daniel Holbach (dholbach)]

I'll start landing this now. I filed bug 1433136 to track this. Let's look at this for 0.2.

=== modified file 'edit-here/pelicanconf.py'
--- edit-here/pelicanconf.py	2015-03-10 10:56:31 +0000
+++ edit-here/pelicanconf.py	2015-03-17 09:03:52 +0000
@@ -44,4 +44,18 @@
 TAG_SAVE_AS = ''
 THEME = 'themes/phone'
 
-MD_EXTENSIONS = ['toc']
+MD_EXTENSIONS = ['q-and-a', 'attr_list', 'toc']
+
+META_TAGS = [
+    '[TOC]',
+]
+
+Q_AND_A_CLASSES = [
+    '!!T',
+    '!!I',
+]
+
+HIDE_FROM_POT = Q_AND_A_CLASSES + [
+    '{: .link-cta-ubuntu }',
+    '{: .link-cta-ubuntu}',
+]

=== added file 'edit-here/q-and-a.py'
--- edit-here/q-and-a.py	1970-01-01 00:00:00 +0000
+++ edit-here/q-and-a.py	2015-03-17 09:03:52 +0000
@@ -0,0 +1,77 @@
+from __future__ import absolute_import
+from __future__ import unicode_literals
+from markdown import Extension
+from markdown.blockprocessors import BlockProcessor
+from markdown.util import etree
+import re
+
+from pelicanconf import Q_AND_A_CLASSES
+
+
+class QandAExtension(Extension):
+    def extendMarkdown(self, md, md_globals):
+        md.registerExtension(self)
+        md.parser.blockprocessors.add('q-and-a',
+                                      QandAProcessor(md.parser),
+                                      '_begin')
+
+
+class QandAProcessor(BlockProcessor):
+    statements = r'|'.join(Q_AND_A_CLASSES)
+    RE = re.compile(r'(.*)\s*?(%s)\s*?' % statements)
+
+    def test(self, parent, block):
+        # [('How do I update my system?', '!!T')]
+        matches = self.RE.search(block)
+        if matches:
+            return matches
+        return False
+
+    def run(self, parent, blocks):
+        block = blocks.pop(0)
+        matches = self.RE.search(block)
+        statement = matches.group(2)
+        block = block.replace(statement, '')
+        question = block.split('\n')[0]
+        answer = '\n'.join(block.split('\n')[1:])
+
+        if statement == '!!T':
+            # <div class="row">
+            # <div class="eight-col last-col">
+            # <!-- question & answer -->
+            # </div>
+            # </div>
+            div = etree.SubElement(parent, 'div')
+            div.set('class', 'row')
+            div2 = etree.SubElement(div, 'div')
+            div2.set('class', 'eight-col last-col')
+            self.parser.parseChunk(div2, question)
+            self.parser.parseChunk(div2, answer)
+        elif statement == '!!I':
+            # <div class="row">
+            # <div class="eight-col">
+            # <!-- question & answer -->
+            # </div>
+            # <div class="four-col last-col">
+            # <!-- question & answer -->
+            # </div>
+            # </div>
+            image_block = "..."
+            # XXX: we need to figure out how to parse if an image is
+            # there, etc.
+            div = etree.SubElement(parent, 'div')
+            div.set('class', 'row')
+            text_div = etree.SubElement(div, 'div')
+            text_div.set('class', 'eight-col')
+            img_div = etree.SubElement(div, 'div')
+            img_div.set('class', 'four-col last-col')
+            self.parser.parseChunk(text_div, question)
+            self.parser.parseChunk(text_div, answer)
+            self.parser.parseChunk(img_div, image_block)
+        else:
+            sibling = self.lastChild(parent)
+            self.parser.parseChunk(sibling, block)
+
+
+def makeExtension(*args, **kwargs):
+    return QandAExtension(*args, **kwargs)

=== modified file 'edit-here/translations.py'
--- edit-here/translations.py	2015-03-12 16:30:29 +0000
+++ edit-here/translations.py	2015-03-17 09:03:52 +0000
@@ -29,7 +29,7 @@
 except:
     require('python3-markdown')
 
-from pelicanconf import PATH, MD_EXTENSIONS
+from pelicanconf import PATH, MD_EXTENSIONS, META_TAGS
 
 # This defines how complete we expect translations to be before we
 # generate HTML from them. Needs to be string.
@@ -40,13 +40,11 @@
     ('zh_TW', 'zh-hant'),
 )
 
-META_TAGS = ['[TOC]']
-
 MD_MAGIC_FILE_TYPES = [
     'ASCII text',
     'UTF-8 Unicode text',
     'UTF-8 Unicode text, with very long lines',
-    ]
+]
 
 
 def _temp_write_markdown(fn):