Skip to content

Enable README rendering in GitHub #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chickenkiller wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Enable README rendering in GitHub #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
codiicsa.txt
23 changes: 11 additions & 12 deletions codiicsa.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,14 +100,13 @@ from the XML

is

[source,python]
ifdef::docname[[source,python]]
----

out = Out( '<<' ) + elem.get( 'linkend' ) + ',' + elem.text \
+ self.Children( elem ) + '>>' + elem.tail

----


Note that if the first item had not been made into an _Out_ object it would
still have worked but the first four items ( '<<', the 'linkedn' attribute
value, the ',' and the elements text) would have been catenated into a
Expand Down Expand Up @@ -146,7 +145,7 @@ boilerplate.

The user python file (say my_file.py) is:

[source,python]
ifdef::docname[[source,python]]
----
import codiicsa # <1>
import sys # to get the command line args
Expand Down Expand Up @@ -209,15 +208,15 @@ that provide common processing capabilities.
All names begin with an uppercase to minimise clashes with methods named for
tag names. If tag names do clash call the library method by:

[source,python]
ifdef::docname[[source,python]]
----
self.Processing.method( ... )
----

Pre
~~~

[source,python]
ifdef::docname[[source,python]]
----
self.Pre( elem, inline = False, attrs = [] )
----
Expand All @@ -238,7 +237,7 @@ line by itself.
Process
~~~~~~~

[source,python]
ifdef::docname[[source,python]]
----
self.Process( elem )
----
Expand All @@ -251,7 +250,7 @@ NOTE: Use __self.Children()__ to process children.
Children
~~~~~~~~

[source,python]
ifdef::docname[[source,python]]
----
self.Children( elem, do = None, dont = set() )
----
Expand All @@ -270,7 +269,7 @@ returns:: an _Out_ object
Strip, Stripl, Stripr
~~~~~~~~~~~~~~~~~~~~~

[source,python]
ifdef::docname[[source,python]]
----
self.Strip( from, chars )
self.Stripl( from, chars )
Expand All @@ -295,7 +294,7 @@ Underline_title
Generates an Asciidoc underlined title from the _<title>_ child of the element.
The underline character used is chosen from the current _<section>_ nesting level.

[source,python]
ifdef::docname[[source,python]]
----
self.Underline_title( elem )
----
Expand All @@ -309,7 +308,7 @@ Block_title
~~~~~~~~~~~

Generates an Asciidoc block title from the _<title>_ child of the element.
[source,python]
ifdef::docname[[source,python]]
----
self.Block_title( elem )
----
Expand All @@ -330,7 +329,7 @@ convert

Use the specified class to convert the input file to the output file.

[source,python]
ifdef::docname[[source,python]]
----
convert( infile, outfile, \
dbclass = None, cargs = [], kcargs = {}, \
Expand Down