Revision: 1863
Author: [email protected]
Date: Wed Mar 31 10:53:43 2010
Log: PJAL conversion - just a start
http://code.google.com/p/jallib/source/detail?r=1863
Added:
/trunk/doc/dita/extended_language_ref
/trunk/doc/dita/extended_language_ref/Makefile
/trunk/doc/dita/extended_language_ref/code
/trunk/doc/dita/extended_language_ref/images
/trunk/doc/dita/extended_language_ref/images/Thumbs.db
/trunk/doc/dita/extended_language_ref/images/logo.jpg
/trunk/doc/dita/extended_language_ref/language.ditamap
/trunk/doc/dita/extended_language_ref/language_basics.xml
/trunk/doc/dita/extended_language_ref/language_changelog.xml
/trunk/doc/dita/extended_language_ref/language_comments.xml
/trunk/doc/dita/extended_language_ref/language_format.xml
/trunk/doc/dita/extended_language_ref/language_includes.xml
/trunk/doc/dita/extended_language_ref/language_intro.xml
/trunk/doc/dita/extended_language_ref/language_introduction.xml
/trunk/doc/dita/extended_language_ref/language_program.xml
/trunk/doc/dita/extended_language_ref/license.xml
/trunk/doc/dita/extended_language_ref/tutorial_book.xml
=======================================
--- /dev/null
+++ /trunk/doc/dita/extended_language_ref/Makefile Wed Mar 31 10:53:43 2010
@@ -0,0 +1,29 @@
+
+
+VERSION=0.3
+JAPPCONF=japp_config.py
+
+prepare:
+ -rm -fr tmp
+ -mkdir tmp
+
+pdf: prepare
+ ant -f $$DITA_HOME/build_demo.xml
-Dprompt.ditamap.filename=`pwd`/tutorials.ditamap -Dprompt.output.type=pdf
-Dprompt.output.directory=`pwd`/tmp -Dprompt.output.confirm=y
+ mv `pwd`/tmp/tutorials.pdf `pwd`/tmp/Tutorial_Book_${VERSION}.pdf
+
+html: prepare
+ ant -f $$DITA_HOME/build_demo.xml
-Dprompt.ditamap.filename=`pwd`/tutorials.ditamap -Dprompt.output.type=web
-Dprompt.output.directory=`pwd`/tmp -Dprompt.output.confirm=y
+
+front: html
+ # this page is only dedicated to website, it needs to integrate TOC
+ # prepare generated TOC for web publishing
+ cd ../../../tools/japp && python2.5 htmlizer.py
${JAPPCONF} ../../doc/dita/tutorials/tmp/toc.html
+ ant -Dargs.transtype=xhtml -Doutput.dir=`pwd`/tmp
-Dargs.input=`pwd`/tutorial_book.xml -Dargs.target=init -f
$$DITA_HOME/build.xml dita2xhtml
+ # the beauty and magic of sed :)
+ cat tmp/tutorial_book.html | sed -e '/Table of
Content/rtmp/topublish/content' -e "s...@version@#${VERSION}#g" >
tmp/tutorial_book.html.toc
+ mv tmp/tutorial_book.html.toc tmp/tutorial_book.html
+ mv tmp/topublish tmp/topublish.toc
+ cd ../../../tools/japp && python2.5 htmlizer.py
${JAPPCONF} ../../doc/dita/tutorials/tmp/tutorial_book.html
+
+publish-front: front
+ cd ../../../tools/japp && python2.5 publish.py
${JAPPCONF} ../../doc/dita/tutorials/tmp/topublish
=======================================
--- /dev/null
+++ /trunk/doc/dita/extended_language_ref/images/Thumbs.db Wed Mar 31
10:53:43 2010
Binary file, no diff available.
=======================================
--- /dev/null
+++ /trunk/doc/dita/extended_language_ref/images/logo.jpg Wed Mar 31
10:53:43 2010
Binary file, no diff available.
=======================================
--- /dev/null
+++ /trunk/doc/dita/extended_language_ref/language.ditamap Wed Mar 31
10:53:43 2010
@@ -0,0 +1,39 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE
bookmap PUBLIC "-//OASIS//DTD DITA BookMap//EN" "bookmap.dtd" []>
+<bookmap id="bookmap_tutorials">
+ <booktitle>
+ <mainbooktitle>JalV2/Jallib Extended Language Ref</mainbooktitle>
+ <booktitlealt><image href="images/logo.jpg" width="300"
placement="break"/>Extended language reference.</booktitlealt>
+ </booktitle>
+ <bookmeta>
+ <bookrights>
+ <copyrfirst>
+ <year>2008</year>
+ </copyrfirst>
+ <copyrlast>
+ <year>2010</year>
+ </copyrlast>
+ <bookowner>
+ <organization>Jallib Group</organization>
+ </bookowner>
+ <summary>Extended Language Reference, covering features of JalV2
compiler and Jallib libraries (version 0.1)</summary>
+ </bookrights>
+ </bookmeta>
+ <frontmatter>
+ <booklists>
+ <toc/>
+ </booklists>
+ </frontmatter>
+ <chapter href="language_intro.xml">
+ <topicref href="language_introduction.xml"/>
+ </chapter>
+ <chapter href="language_basics.xml">
+ <topicref href="language_format.xml"/>
+ <topicref href="language_comments.xml"/>
+ <topicref href="language_includes.xml"/>
+ </chapter>
+ <appendix navtitle="Appendix">
+ <topicref href="license.xml"/>
+ <topicref href="language_changelog.xml"/>
+ </appendix>
+</bookmap>
=======================================
--- /dev/null
+++ /trunk/doc/dita/extended_language_ref/language_basics.xml Wed Mar 31
10:53:43 2010
@@ -0,0 +1,8 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE topic
PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd" []>
+<topic id="topic-1">
+ <title>Basics</title>
+ <body>
+ <p>This chapter introduces you to some basic JalV2/Jallib Code</p>
+ </body>
+</topic>
=======================================
--- /dev/null
+++ /trunk/doc/dita/extended_language_ref/language_changelog.xml Wed Mar 31
10:53:43 2010
@@ -0,0 +1,116 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE topic
PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd" []>
+<topic id="template_id">
+ <title>Changelog</title>
+ <prolog>
+ <author>Jallib Group</author>
+ <publisher>Jallib Group</publisher>
+ </prolog>
+ <body>
+ <p>Jallib Tutorial Book Changes & Updates</p>
+ <table>
+ <title>Version 0.4 (Release date: To Be Released</title>
+ <tgroup cols="2">
+ <colspec/>
+ <colspec/>
+ <thead>
+ <row>
+ <entry>Date</entry>
+ <entry>Comments</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>2010/03/25</entry>
+ <entry>Updated ICSP schematic and tutorial to reflect PIC Kit
2 pinouts. ICSP schematic matches Microchip Specification</entry>
+ </row>
+ <row>
+ <entry>2010/03/12</entry>
+ <entry>Updated SD Card schematic. Added pull-up resistor on
chip-select line, changed resistor values for 5v-3v conversion</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <table frame="all" pgwide="1">
+ <title>Version 0.3 (Release Date: 2010/03/12)</title>
+ <tgroup cols="2">
+ <colspec/>
+ <colspec/>
+ <thead>
+ <row>
+ <entry>Date</entry>
+ <entry>Comments</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>2010/01/27</entry>
+ <entry>Fixed I²C bus schematic and modified I²C titles</entry>
+ </row>
+ <row>
+ <entry>2010/01/21</entry>
+ <entry>Added ADC introduction, re-organized PWM tutorials and
titles</entry>
+ </row>
+ <row>
+ <entry>2010/01/20</entry>
+ <entry>Better quality Images on Getting Started, serial board,
blink a led tutorials.</entry>
+ </row>
+ <row>
+ <entry>2010/01/19</entry>
+ <entry>Added serial & rs-232 tutorial</entry>
+ </row>
+ <row>
+ <entry>2010/01/15</entry>
+ <entry>New ICSP Schematic</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <table>
+ <title>Version 0.2 (Release date: 2009/12/30)</title>
+ <tgroup cols="2">
+ <colspec/>
+ <colspec/>
+ <thead>
+ <row>
+ <entry>Date</entry>
+ <entry>Comments</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>2009/12/06</entry>
+ <entry>Added SD Card tutorial</entry>
+ </row>
+ <row>
+ <entry>2009/12/06</entry>
+ <entry>Added PATA Hard Disk tutorial</entry>
+ </row>
+ <row>
+ <entry>2009/12/06</entry>
+ <entry>Added ICSP tutorial</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <table>
+ <title>Version 0.1 (Release date: 2009/11/22)</title>
+ <tgroup cols="2">
+ <colspec/>
+ <colspec/>
+ <thead>
+ <row>
+ <entry>Date</entry>
+ <entry>Comments</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>2009/11/22</entry>
+ <entry>Initial Release</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </body>
+</topic>
=======================================
--- /dev/null
+++ /trunk/doc/dita/extended_language_ref/language_comments.xml Wed Mar 31
10:53:43 2010
@@ -0,0 +1,20 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE topic
PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd" []>
+<topic id="template_id">
+ <title>Comments</title>
+ <prolog>
+ <author>Matthew Schinkel</author>
+ <publisher>Jallib Group</publisher>
+ </prolog>
+ <body>
+ <p id="firstcontent">JALv2 code commenting</p>
+ <section>
+ <title>Comments</title>
+ <p>You may comment your code using either -- or ; characters.
Anything after the comment will be ignored by the compiler.</p>
+ <p><b>Example:</b></p>
+ <codeblock>-- This is a sample comment
+; This is also a sample comment
+</codeblock>
+ </section>
+ </body>
+</topic>
=======================================
--- /dev/null
+++ /trunk/doc/dita/extended_language_ref/language_format.xml Wed Mar 31
10:53:43 2010
@@ -0,0 +1,32 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE topic
PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd" []>
+<topic id="template_id">
+ <title>Format</title>
+ <prolog>
+ <author>Matthew Schinkel</author>
+ <publisher>Jallib Group</publisher>
+ </prolog>
+ <body>
+ <p id="firstcontent">Introduction to JALv2 code writing &
formatting.</p>
+ <section>
+ <title>Intro to JALv2/Jallib code format</title>
+ <p>The JALv2 language is free-format (there is no separator
character between lines), and is not case-sensitive. All characters
+with an ASCII value below the space (tab, carriage return, new line, form
feed, etc.) are treated
+as spaces, except that the end of a line terminates a comment.</p>
+ <p>Although JALv2 is not case sensitive, it is a good idea to keep
some consistency in your writing. Jallib has come up with a "Style
Guide" which basically involves all lower case, with "_"
characters between words in variables. An example of a variable would be in
the form: hello_world</p>
+ <p>Jallib also specifies that 3 spaces should be used for
indenting.</p>
+ <p>You may read more about the Jallib Style Guide here: <xref
href="http://www.justanotherlanguage.org/content/jsg";
format="html">http://www.justanotherlanguage.org/content/jsg</xref></p>
+ <p>Here's a short code example:</p>
+ <codeblock>-- if statement in preferred format
+if hello_a > hello_b then
+ hello_a = hello_b + 1
+else
+ hello_a = hello_b - 1
+end if
+
+-- but this has exactly the same effect
+if hello_a > hello_b then hello_a = hello_b + 1 else hello_a = hello_b
- 1 end if
+</codeblock>
+ </section>
+ </body>
+</topic>
=======================================
--- /dev/null
+++ /trunk/doc/dita/extended_language_ref/language_includes.xml Wed Mar 31
10:53:43 2010
@@ -0,0 +1,21 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE topic
PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd" []>
+<topic id="template_id">
+ <title>Includes</title>
+ <prolog>
+ <author>Matthew Schinkel</author>
+ <publisher>Jallib Group</publisher>
+ </prolog>
+ <body>
+ <p id="firstcontent">JALv2 file includes</p>
+ <section>
+ <title>File Includes</title>
+ <p>An include causes the content of the included file to be read. A
duplicate include with the same name will be ignored, this makes it
possible for a library file to include all required lower libraries.</p>
+ <p>Includes are seen first in the current directory, and next in
each location indicated by the compilers search path. All JALv2 files have
the extension ".JAL". Do not put this extension in the include
statement.</p>
+ <p><b>Example:</b></p>
+ <codeblock>include serial -- includes file named serial.jal
+include print -- includes file named print.jal
+</codeblock>
+ </section>
+ </body>
+</topic>
=======================================
--- /dev/null
+++ /trunk/doc/dita/extended_language_ref/language_intro.xml Wed Mar 31
10:53:43 2010
@@ -0,0 +1,8 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE topic
PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd" []>
+<topic id="topic-1">
+ <title>Introduction</title>
+ <body>
+ <p>This chapter introduces you to JalV2 and Jallib. JalV2 is a
high-level language for Microchip PIC microcontrollers. Jallib is a set of
libraries & sample code to make things work. </p>
+ </body>
+</topic>
=======================================
--- /dev/null
+++ /trunk/doc/dita/extended_language_ref/language_introduction.xml Wed Mar
31 10:53:43 2010
@@ -0,0 +1,71 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE topic
PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd" []>
+<topic id="template_id">
+ <title>Introduction</title>
+ <prolog>
+ <author>Matthew Schinkel</author>
+ <publisher>Jallib Group</publisher>
+ </prolog>
+ <body>
+ <p id="firstcontent">Introduction to JALv2 & Jallib</p>
+ <section>
+ <title>What is JALv2/Jallib</title>
+ <p>Jalv2 a high level language for PIC microcontrollers. Jalv2 was
created by Kyle York, who also wrote the PICbsc compiler. STEF MIENTKI got
+in touch with Kyle York and ask him if he could look into rewriting JAL
using the PICbsc
+engine, the prospect intrigued him. </p>
+ <p>JAL 2.0 not only shares the same JAL syntax, but adds
+new features (like new types, arrays, etc.) to JAL, keeping the PICbsc
internal compiler design as
+well.
+</p>
+ <p>This manual covers all aspects of JAL 2.0 without any reference
to JAL (also known as JAL 0.4x). trying to be useful
+for all novices and users with or without JAL experience.</p>
+ <p>JAL 0.4x was developed by Wouter Van OOijen. He created JAL
because he did not like any of
+the low-cost (or free) languages for these chips and implementing a high
level language looked
+like a nice project.</p>
+ <p>JALv2 can be found at Kyle Yorks website: <xref
href="http://www.casadeyork.com/jalv2/";
format="html">http://www.casadeyork.com/jalv2/</xref></p>
+ </section>
+ <section>
+ <title>What is Jallib?</title>
+ <p>Jallib is a set of libraries & samples that make things work.
Jallib provides PIC device files as well as libraries that allow
interaction between the PIC and other devices such as LCDs, RAM memories,
eeprom, etc.</p>
+ <p>You can find out more about Jallib at these locations:</p>
+ <p>Jallib Website: <xref href="http://justanotherlanguage.org/";
format="html">http://justanotherlanguage.org/</xref></p>
+ <p>Jallib Project Home: <xref
href="http://code.google.com/p/jallib/";
format="html">http://code.google.com/p/jallib/</xref></p>
+ </section>
+ <section>
+ <title>Who is Jallib Group?</title>
+ <p>Jallib Group is the group of contributors whom work together to
make these libraries possible. If you wish to contribute or need a library
updated, you may find them here:</p>
+ <p>Jallib Group Discussion: <xref
href="http://groups.google.com/group/jallib";
format="html">http://groups.google.com/group/jallib</xref></p>
+ </section>
+ <section>
+ <title>Where do I get additional Support?</title>
+ <p>JALLIST Support Mailing List: <xref
href="http://tech.groups.yahoo.com/group/jallist/";
format="html">http://tech.groups.yahoo.com/group/jallist/</xref></p>
+ </section>
+ <section>
+ <title>Example JALv2/Jallib Code</title>
+ <codeblock>-- microchip definition file
+include 18f4620
+
+-- choose oscillator frequency
+pragma target clock 20_000_000
+
+-- configure settings (fuses)
+pragma target OSC HS -- HS crystal or resonator
+pragma target WDT disabled -- no watchdog
+pragma target LVP disabled -- no Low Voltage Programming
+pragma target MCLR external -- reset externally
+
+-- disable analog pins
+enable_digital_io()
+
+-- set a pin as output
+pin_A0_direction = output
+
+forever loop
+ pin_A0 = on -- set pin level high
+ _usec_delay(250000) -- delay 250ms
+ pin_A0 = off -- set pin level low
+ _usec_delay(250000) -- delay 250ms
+end loop</codeblock>
+ </section>
+ </body>
+</topic>
=======================================
--- /dev/null
+++ /trunk/doc/dita/extended_language_ref/language_program.xml Wed Mar 31
10:53:43 2010
@@ -0,0 +1,21 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE topic
PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd" []>
+<topic id="template_id">
+ <title>Includes</title>
+ <prolog>
+ <author>Matthew Schinkel</author>
+ <publisher>Jallib Group</publisher>
+ </prolog>
+ <body>
+ <p id="firstcontent">JALv2 file includes</p>
+ <section>
+ <title>File Includes</title>
+ <p>An include causes the content of the included file to be read. A
duplicate include with the same name will be ignored, this makes it
possible for a library file to include all required lower libraries.</p>
+ <p>Includes are seen first in the current directory, and next in
each location indicated by the compilers search path. All JALv2 files have
the extension ".JAL". Do not put this extension in the include
statement.</p>
+ <p><b>Example:</b></p>
+ <codeblock>include serial -- includes file named serial.jal
+include print -- includes file named print.jal
+</codeblock>
+ </section>
+ </body>
+</topic>
=======================================
--- /dev/null
+++ /trunk/doc/dita/extended_language_ref/license.xml Wed Mar 31 10:53:43
2010
@@ -0,0 +1,20 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
+<topic id="template_id">
+ <title>License</title>
+ <body>
+ <p id="firstcontent">We, <xref
href="http://groups.google.com/group/jallib"; format="html">Jallib
Group</xref>, want this book to be as <i>open</i> and <i>free</i> as
possible. We decided to release it under <xref
href="http://creativecommons.org/licenses/by-nc-sa/3.0/";
format="html">Creative Common Attribution-Noncommercial-Share Alike 3.0
</xref> license.</p>
+ <p><image href="images/cc_by_nc_sa.png" align="center"
placement="break"/></p>
+ <p>Basically (and repeating what's on Creative Common website),
you are free:<ul>
+ <li><b>to Share</b> - to copy, distribute, and transmit the
work</li>
+ <li><b>to Remix</b> - to adapt the work</li>
+ </ul></p>
+ <p>Under the following conditions:<ul>
+ <li><b>Attribution</b> - You must attribute the work in the manner
specified by the author or licensor (but not in any way that suggests that
they endorse you or your use of the work).</li>
+ <li><b>Noncommercial</b> - You may not use this work for
commercial purposes.</li>
+ <li><b>Share Alike</b> - If you alter, transform, or build upon
this work, you may distribute the resulting work only under the same,
similar or a compatible license.</li>
+ </ul></p>
+ <p>Full license lecal code can be read at: <xref
href="http://creativecommons.org/licenses/by-nc-sa/3.0/legalcode";
format="html">http://creativecommons.org/licenses/by-nc-sa/3.0/legalcode</xref></p>
+ <p>This license applies to the book content itself, not on codes,
libraries, examples, etc... you may find, or when it's explicitely
stated work is released under another license. For instance, most work on
Jallib is released under BSD and ZLIB license, not under this Creative
Common license. In doubt, please ask on Jallib Group (<xref
href="http://groups.google.com/group/jallib";
format="html">http://groups.google.com/group/jallib</xref>)</p>
+ </body>
+</topic>
=======================================
--- /dev/null
+++ /trunk/doc/dita/extended_language_ref/tutorial_book.xml Wed Mar 31
10:53:43 2010
@@ -0,0 +1,24 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE topic
PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd" []>
+<topic id="template_id">
+ <title>The Tutorial Book</title>
+ <prolog>
+ <author>Jallib Team</author>
+ <publisher>Jallib Group</publisher>
+ </prolog>
+ <body>
+ <p><image href="images/logo.jpg" width="200" align="center"
placement="break"/></p>
+ <section>
+ <title>
+ <b>Have fun with PIC microcontrollers, Jal v2 and Jallib</b>
+ </title>
+ <p><b>Step-by-step tutorials, covering basic features of PIC
microcontrollers, using jalv2 compiler and jallib libraries (version
@VERSION@)</b></p>
+ </section>
+ <p id="firstcontent">This is the online HTML version of "The
Tutorial Book" PDF version. You can also <xref
href="http://jallib.googlecode.com/files/tutorial_bo...@[email protected]";
format="html">download</xref> the PDF version from Jallib download <xref
href="http://code.google.com/p/jallib/downloads/list";
format="html">section</xref>, where you'll also jallib packages needed
to experiment tutorials.</p>
+ <p>We hope you'll enjoy the journey and... have fun !</p>
+ <p>The Jallib Team</p>
+ <section>
+ <title>Table of Content</title>
+<!--keep the following empty, this is a placeholder for generated
TOC--> </section>
+ </body>
+</topic>
--
You received this message because you are subscribed to the Google Groups
"jallib" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/jallib?hl=en.
