|
|
2134.
|
|
|
HTML Documentation Standard for Twisted
|
|
|
type: Content of: <html><body><h1>
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
development/policy/doc-standard.xhtml:7 development/policy/doc-standard.xhtml:11
|
|
|
2135.
|
|
|
Allowable Tags
|
|
|
type: Content of: <html><body><h2>
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
development/policy/doc-standard.xhtml:13
|
|
|
2136.
|
|
|
Please try to restrict your HTML usage to the following tags (all only for the original logical purpose, and not whatever visual effect you see): <code><html></code>, <code><title></code>, <code><head></code>, <code><body></code>, <code><h1></code>, <code><h2</code>, <code><h3></code>, <code><ol></code>, <code><ul></code>, <code><dl></code>, <code><li></code>, <code><dt></code>, <code><dd></code>, <code><p></code>, <code><code></code>, <code><img></code>, <code><blockquote></code>, <code><a></code>, <code><cite></code>, <code><div></code>, <code><span></code>, <code><strong></code>, <code><em></code>, <code><pre></code>, <code><q></code>, <code><table></code>,<code><tr></code>, <code><td></code> and <code><th></code>.
|
|
|
type: Content of: <html><body><p>
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
development/policy/doc-standard.xhtml:15
|
|
|
2137.
|
|
|
Please avoid using the quote sign (<code>"</code>) for quoting, and use the relevant html tags (<code><q></q></code>) -- it is impossible to distinguish right and left quotes with the quote sign, and some more sophisticated output methods work better with that distinction.
|
|
|
type: Content of: <html><body><p>
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
development/policy/doc-standard.xhtml:17
|
|
|
2138.
|
|
|
Multi-line Code Snippets
|
|
|
type: Content of: <html><body><h2>
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
development/policy/doc-standard.xhtml:19
|
|
|
2139.
|
|
|
Multi-line code snippets should be delimited with a <pre> tag, with a mandatory <q>class</q> attribute. The conventionalized classes are <q>python</q>, <q>python-interpreter</q>, and <q>shell</q>. For example:
|
|
|
type: Content of: <html><body><p>
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
development/policy/doc-standard.xhtml:21
|
|
|
2140.
|
|
|
<q>python</q>
|
|
|
type: Content of: <html><body><h3>
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
development/policy/doc-standard.xhtml:26
|
|
|
2141.
|
|
|
<p> 
For example, this is how one defines a Resource:
</p>
<pre class="python">
from twisted.web import resource
class MyResource(resource.Resource):
def render_GET(self, request):
return "Hello, world!"
</pre>
|
|
|
type: Content of: <html><body><pre>
|
|
|
represents a line break.
Start a new line in the equivalent position in the translation.
|
|
|
represents a space character.
Enter a space in the equivalent position in the translation.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
development/policy/doc-standard.xhtml:28
|
|
|
2142.
|
|
|
For example, this is how one defines a Resource:
|
|
|
type: Content of: <html><body><p>
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
development/policy/doc-standard.xhtml:41
|
|
|
2143.
|
|
|
from twisted.web import resource
class MyResource(resource.Resource):
def render_GET(self, request):
return "Hello, world!"
|
|
|
type: Content of: <html><body><pre>
|
|
|
represents a line break.
Start a new line in the equivalent position in the translation.
|
|
|
represents a space character.
Enter a space in the equivalent position in the translation.
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
development/policy/doc-standard.xhtml:43
|
