Merge lp:~franku/widelands-website/smiley-and-codeblock-enhancements into lp:widelands-website

[kaputtnik]

This branch has following changes:

TOC: Background some brighter

CODEBLOCKS: Added dark background to pre- and code-tags.

SMILEYS: Correct ordering in settings.py; Text-Smileys are only replaced with images, if they aren't in a codeblock; Text-smileys are only replaced with images, if they're not inside a word (i.e. in "http://...") Please take a look at my code in function _insert_smileys()... maybe there is a better solution

QUOTING: I added a space after the ">". This will prevend a failure with smiley ":-))" which will otherwise become ">:-))" and therefor it will not be replaced with the correct image. This is related to the smiley_preescaping of the smiley ">:-)" (the only thing that needs preescaping and make trouble).

Some minor cleanups and some comments added.

See https://wl.widelands.org/forum/topic/1602/ for screenshots to codeblocks. I will add smiley screenshots also there.

[Shevonar (shevonar)]

Your changes look fine. Just one question and an answer to your question in the code below.

review: Approve

[kaputtnik (franku)]

Tanks for approve.

> Your changes look fine. Just one question and an answer to your question in
> the code below.

Yes the "#b"'s (appears twice) are unintendet, better: i forgot to remove them. I used them to trigger an error to debug the code. I haven't found a way to debug the code (make halt points and examine variables) in another way, so i used this possibility. Is there a better way? A hint on that is welcome :-)

Thanks for the answer.

Greetings
franku

[SirVer (sirver)]

> Is there a better way? A hint on that is welcome :-)

printf debugging is what I use most of the times too - pdb is not a great debugger. however I have a snippet in my editor that will format all lines I output like so: print "#sirver: a: %s" % a.

Similarly if i note something that I want to fix in a branch before submitting a merge proposal, I add a comment: NOCOM(#sirver). Before sending stuff for review, I grep for '#sirver' in the code base - if there are none left I know i am done.

review: Needs Fixing

[lp:~franku/widelands-website/smiley-and-codeblock-enhancements]

383. By <email address hidden> on 2015-01-08

smiley-and-codeblock-enhancements-corrected

[kaputtnik (franku)]

Hoping i've done it the right way...

Thank you for review and pointing on some mistakes.

And for the hints to grep.

[SirVer (sirver)]

Merged and deployed. Thanks!

review: Approve

[kaputtnik (franku)]

:-)

=== modified file 'mainpage/templatetags/wl_markdown.py'
--- mainpage/templatetags/wl_markdown.py	2014-12-23 16:59:05 +0000
+++ mainpage/templatetags/wl_markdown.py	2015-01-08 21:40:45 +0000
@@ -55,12 +55,16 @@
 def _insert_smileys( text ):
     """
     This searches for smiley symbols in the current text
-    and replaces them with the correct images
+    and replaces them with the correct images.
+    Only replacing if smiley symbols aren't in a word (e.g. http://....)
     """
+    words = text.split(" ")
     for sc,img in SMILEYS:
-        text = text.replace(sc,"<img src='%s%s' alt='%s' />" % ( SMILEY_DIR, img, img ))
+        if sc in words:
+            words[words.index(sc)] = "<img src='%s%s' alt='%s' />" % ( SMILEY_DIR, img, img )
+    text = " ".join(words)
+    return text
 
-    return text
 def _insert_smiley_preescaping( text ):
     """
     This searches for smiley symbols in the current text
@@ -140,6 +144,7 @@
 
 def do_wl_markdown( value, *args, **keyw ):
     # Do Preescaping for markdown, so that some things stay intact
+    # This is currently only needed for this smiley ">:-)"
     value = _insert_smiley_preescaping( value )
 
     custom = keyw.pop('custom', True)
@@ -154,8 +159,6 @@
         # well, empty soup. Return it
         return unicode(soup)
 
-    ctag = soup.contents[0]
-
     for text in soup.findAll(text=True):
         # Do not replace inside a link
         if text.parent.name == "a":
@@ -167,8 +170,9 @@
         if custom:
             # Replace bzr revisions
             rv = _insert_revision( text )
-            # Replace smileys
-            rv = _insert_smileys( rv )
+            # Replace smileys; only outside "code-tags"
+            if not text.parent.name == "code":
+                rv = _insert_smileys( rv )
 
             for name, (pattern,replacement) in custom_filters.iteritems():
                 if not len(text.strip()) or not keyw.get(name, True):

=== modified file 'media/css/base.css'
--- media/css/base.css	2014-12-23 16:59:05 +0000
+++ media/css/base.css	2015-01-08 21:40:45 +0000
@@ -69,8 +69,25 @@
 	display: inline;
 }
 
+/**************/
+/* Codeblocks */
+/**************/
+
 pre {
 	white-space: pre-wrap;
+	background-image: url("../img/black50.png");
+	padding: 5px 10px;
+	margin: 5px 10px;
+	display: inline-block;
+	border: 1px solid black;
+}
+
+code {
+	background-image: url("../img/black50.png");
+}
+/*No double background*/
+pre > code {
+	background-image: none;
 }
 
 input, button, textarea, .button {
@@ -122,7 +139,7 @@
 }
 
 .posLeft {
-	float: left
+	float: left;
 }
 
 .posRight {
@@ -199,10 +216,6 @@
 	margin: 0px 20px;
 }
 
-div#header {
-
-}
-
 div #main {
 	min-height: 500px;
 }
@@ -225,7 +238,9 @@
 	border-radius: 4px;
 }
 
+/**********/
 /* Header */
+/**********/
 
 div#header  img{
 	position: relative;
@@ -280,7 +295,9 @@
 	color: #ffffff;
 }
 
+/****************/
 /* Right Column */
+/****************/
 
 div#rightColumn {
 	width: 220px;
@@ -418,3 +435,4 @@
 	border: none;
 	clear: left;
 }
+

=== modified file 'media/css/wiki.css'
--- media/css/wiki.css	2014-12-20 18:49:15 +0000
+++ media/css/wiki.css	2015-01-08 21:40:45 +0000
@@ -2,7 +2,7 @@
 	border: 1px solid black;
 	display: inline-block;
 	padding: 0px 8px;
-	background-image: url("../img/black50.png");
+	background-image: url("../img/black20.png");
 	font-size: 12px;
 	margin: 0em 0em 1em 1em;
 	line-height: 18px;

=== modified file 'pybb/util.py'
--- pybb/util.py	2012-04-19 20:21:28 +0000
+++ pybb/util.py	2015-01-08 21:40:45 +0000
@@ -174,7 +174,9 @@
 
     # if markup == 'markdown':
     if markup == 'markdown':
-        return '>'+text.replace('\r','').replace('\n','\n>') + '\n'
+        # Inserting a space after ">" will not change the generated HTML,
+        # but it will unbreak certain constructs like '>:-))'.
+        return '> '+text.replace('\r','').replace('\n','\n> ') + '\n'
     elif markup == 'bbcode':
         return '[quote]\n%s\n[/quote]\n' % text
     else:

=== modified file 'settings.py'
--- settings.py	2013-06-30 12:53:49 +0000
+++ settings.py	2015-01-08 21:40:45 +0000
@@ -139,14 +139,18 @@
     ("O:-)", "face-angel.png"),
     ("O:)", "face-angel.png"),
     (":-/", "face-confused.png"),
-    #(":/", "face-confused.png"),
+    (":/", "face-confused.png"),
     ("B-)", "face-cool.png"),
     ("B)", "face-cool.png"),
     (":'-(", "face-crying.png"),
     (":'(", "face-crying.png"),
+    (":-))", "face-smile-big.png"),
+    (":))", "face-smile-big.png"),
+    (":-)", "face-smile.png"),
+    (":)", "face-smile.png"),
     ("&gt;:-)", "face-devilish.png"), # Hack around markdown replacement. see also SMILEY_PREESCAPING
     ("8-)", "face-glasses.png"),
-    #("8)", "face-glasses.png"), # Might occur unwanted
+    ("8)", "face-glasses.png"),
     (":-D", "face-grin.png"),
     (":D", "face-grin.png"),
     (":-x", "face-kiss.png"),
@@ -164,10 +168,6 @@
     (":(", "face-sad.png"),
     (":-O", "face-shock.png"),
     (":O", "face-shock.png"),
-    (":-)", "face-smile.png"),
-    (":)", "face-smile.png"),
-    (":-))", "face-smile-big.png"),
-    (":))", "face-smile-big.png"),
     (":-o", "face-surprise.png"),
     (":o", "face-surprise.png"),
     (":-P", "face-tongue.png"),
@@ -179,9 +179,7 @@
 ]
 # This needs to be done to keep some stuff hidden from markdown
 SMILEY_PREESCAPING = [
-    (">:-)", "\>:-)"),
-    (":-*", ":-\*"),
-    #(":*", ":\*"),
+    (">:-)", "\>:-)")
 ]
 
 ###############################