Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tomdyson committed Jun 30, 2008
1 parent 3687d40 commit c120258
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 10 deletions.
7 changes: 5 additions & 2 deletions static/styles-site.css
Expand Up @@ -23,10 +23,13 @@ body, h1, h2, h4, h5, h6,ol, ul, li, p, input, textarea, select {
font-size: 12px; font-size: 12px;
} }


p a, .entry a { p, li {font-size: 12px;line-height: 16px;}

p a, .entry a, li a {
color: #588E03; color: #588E03;
border-bottom: 1px dotted #588E03; border-bottom: 1px dotted #588E03;
text-decoration: none; } text-decoration: none;
}


#menu a { #menu a {
color: brown; color: brown;
Expand Down
3 changes: 2 additions & 1 deletion templates/about-api.html
Expand Up @@ -2,6 +2,7 @@


{% block content %} {% block content %}
<p> <p>
wordoff has an api Use wordoff through its API by POSTing to the <strong>/api/clean</strong> method with a single <strong>html</strong> argument:
</p> </p>
<pre>curl -d html=&lt;Dirty HTML&gt; http://wordoff.org/api/clean</pre>
{% endblock %} {% endblock %}
22 changes: 17 additions & 5 deletions templates/about.html
Expand Up @@ -2,12 +2,24 @@


{% block content %} {% block content %}
<p> <p>
wordoff applies the following rules to strip the cruft that is pasted into Wordoff applies the following rules to strip the cruft that is pasted into
wysiwyg editors from word: WYSIWYG editors from Word:</p>
<ul> <ul>
<li>all attributes are removed</li> <li>Attributes are removed for all elements except &lt;a&gt;s</li>
<li>spans are removed</li> <li>&lt;span&gt;s and &lt;div&gt;s are removed</li>
<li>empty elements are removed</li> <li>Empty elements are removed</li>
<li>Consecutive line breaks are reduced to two</li>
</ul> </ul>
<p>
Wordoff is written in Python and runs on Django in Google App Engine. It was designed as a demonstration
project for a short talk at <a href = "http://oxford.geeknights.net/2008/jun-25th/">Oxford Geek Nights</a>.
The logo uses the <a href = "http://www.dafont.com/sketch-rockwell.font">Sketch Rockwell</a> font.
</p>
<p>
Please improve Wordoff:
</p> </p>
<ul>
<li>Issues - <a href = "http://wordoff.lighthouseapp.com/projects/13552-wordoff/tickets/new">Wordoff @ Lighthouse</a></li>
<li>Git - <a href = "git://github.com/tomdyson/wordoff.git">git://github.com/tomdyson/wordoff.git</a></li>
</ul>
{% endblock %} {% endblock %}
1 change: 0 additions & 1 deletion templates/base.html
Expand Up @@ -26,7 +26,6 @@
<a href = "/">start</a> | <a href = "/">start</a> |
<a href="/about">about</a> | <a href="/about">about</a> |
<a href="/api">api</a> | <a href="/api">api</a> |
<a href = "http://wordoff.lighthouseapp.com/projects/13552-wordoff/tickets/new">bugs</a> |
&copy; <a href = "http://www.throwingbeans.org/">tom dyson</a> 2008 &copy; <a href = "http://www.throwingbeans.org/">tom dyson</a> 2008
</div> </div>


Expand Down
2 changes: 1 addition & 1 deletion wordoff.py
Expand Up @@ -46,7 +46,7 @@ def superClean(str):
clean = stripAttributes(str) clean = stripAttributes(str)
cleaner = stripSpans(clean) cleaner = stripSpans(clean)
cleaner = stripDivs(cleaner) cleaner = stripDivs(cleaner)
cleaner = xenophobia(cleaner) #cleaner = xenophobia(cleaner)
cleaner = stripEmptyElements(cleaner) cleaner = stripEmptyElements(cleaner)
cleaner = stripEmptyElements(cleaner) cleaner = stripEmptyElements(cleaner)
cleaner = stripEmptyElements(cleaner) cleaner = stripEmptyElements(cleaner)
Expand Down

0 comments on commit c120258

Please sign in to comment.