Permalink
Browse files

Edited the documentation to deploy the 1.0.2 version.

  • Loading branch information...
1 parent 991f5ee commit cbc4079f4ad6416a8d439fbdace792b1d8160b60 lreal committed Jul 22, 2008
@@ -24,7 +24,7 @@ These and other causes drove us into this project.
Tubaina was developed using an agile methodology called Extreme Programming
( http://en.wikipedia.org/wiki/Extreme_Programming ).
We were couched by Mariana Vivian Bravo, grad student on agile methodologies at "Universidade de São Paulo".
-Since [label Extreme Programmig]XP[/label] is a incremental methodologie, we had Tubaina running and generating
+Since [label Extreme Programming]XP[/label] is a incremental methodology, we had Tubaina running and generating
some Html after the first week. It was really interesting to have something working so soon because this was
Caelum's Trainees first project.
@@ -7,7 +7,7 @@ therefore it is ::opensource:: and can be used as long as its rights are kept.
[section Dependencies]
-Tubaina should work properly on any computer running Java5, but you will need a Latex compiller so
+Tubaina should work properly on any computer running Java5, but you will need a LaTeX compiler so
as to deliver a *.pdf output.
[list]
@@ -37,8 +37,8 @@ should be set to your java directory. ($JAVA_HOME/bin/java must be your JVM).
* TUBAINA_HOME: This should point to Tubaina's base dir (the one you get right after unpacking our zip or tgz).
[/list]
-To build Tubaina from our source packages, you need to have **jakarta-oro** inside your %%ant%% build path.
-Then just run %%ant build.xml%% on the root folder.
+To build Tubaina from our source packages, you need to have **maven** ( http://maven.apache.org )
+installed and in your path. Then just run %%ant build.xml%% on the root folder.
[section Running Tubaina]
@@ -56,7 +56,7 @@ For further options, check the Tubaina help.
[box Why can't I see the *.dvi from the Latex?]
For allowing users to use many image formats - not only *.eps - we use a Latex package called
::graphicx::. This package only works on *.pdf outputs and, therefore, will prevent Latex from
-compilling *.tex to *.dvi.
+compiling *.tex to *.dvi.
This means you can never read your Tubaina generated latex in dvi format. Don't get too upset,
though. Your *.pdf output will do fine!
View
@@ -8,7 +8,7 @@ This a short introduction to the *.afc format syntax.
[code][chapter chapter name][/code]
-**Section:** The section tag builds a section in a chapter. It also adds a reference on the Table of
+**Section:** The %%section%% tag builds a section in a chapter. It also adds a reference on the Table of
Contents.
[code][section section name][/code]
@@ -28,7 +28,7 @@ fact that no other tags are allowed on the label text.
[code][label the label] what is beeing labeled [/label][/code]
-**Box:** The box tag places its content in a new environment slightly indented and appart from the
+**Box:** The %%box%% tag places its content in a new environment slightly indented and appart from the
rest of the text.
[code][box <box title>] <content> [/box][/code]
@@ -49,7 +49,7 @@ OR
[/exercise][/code]
**Instructors' Note:** in case you need your teacher's textbook to have extra information, you might
-use the note tag. It adds Instructor Notes to the textbook when compiling with instructors option on.
+use the %%note%% tag. It adds Instructor Notes to the textbook when compiling with instructors option on.
[code][note]Note to the instructor[/note][/code]
@@ -71,13 +71,18 @@ use the note tag. It adds Instructor Notes to the textbook when compiling with i
**XML:** [code][xml]XML code[/xml][/code]
+**Ruby:** [code][ruby]Ruby code[/ruby][/code]
+
**.properties:** [code][code properties]Properties code[/code][/code]
**Outras linguagens:** [code][code]Any other code[/code][/code]
In order to emphasize code lines, use the option: %%h=line1,line2,...%% like this:
[code][java h=1,2,3]....[/java][/code]
+If you want to number the lines of the output code, use the parameter %%#%%, like this:
+[code][java #]...[/java][/code]
+
[section Special tags]
**Link:** Tubaina automatically adds links whenever you use "http://"
@@ -86,7 +91,7 @@ In order to emphasize code lines, use the option: %%h=line1,line2,...%% like thi
[code][index anchor name][/code]
-**To do:** The tag ::to do:: allows you making reminders of those edits you must do on your textbook,
+**To do:** The tag %%todo%% allows you making reminders of those edits you must do on your textbook,
but have not enough time or material to work on. It builds a log of all the open tasks in your book.
[code][todo task reminder][/code]
@@ -118,10 +123,18 @@ but have not enough time or material to work on. It builds a log of all the open
* item
[/list][/code]
+[section Tables]
+**Tables:** the structure of tags used to create a table is similar to that of the HTML language. First,
+to start a table, you use the tag %%table%%. This tag may specify two parameters: a title and the
+keyword %%noborder%%, which specifies that the generated table will not have borders. The title must
+be inside double quotation marks ("). Inside the %%table%% tag, use a %%row%% tag to start a line and, inside
+a row, use a %%col%% tag to add a cell to the table. Inside a %%col%% tag, you can type text, code and/or
+put images.
+
[section Images]
-**Images:** in order to add images to your textbook, you must use the tag ::img::. This tag has two
+**Images:** in order to add images to your textbook, you must use the tag %%img%%. This tag has two
specialties: you may choose the percentage of the width of the page your image must fill by using the
-tag **w** and you can add a comment about the image on a floating tab.
+tag %%w%% and you can add a comment about the image on a floating tab.
-[code][img path/imagem.png w=scale% "tab comment"][/code]
+[code][img path/image.png w=scale% "tab comment"][/code]
View
@@ -32,6 +32,26 @@ Here, you'll have some simple examples of *.afc text that intend to show the eas
including where it keeps the e-mail you send or how do you delete
unwanted e-mail.
[/box]
+
+ [chapter Navigators]
+ [table "Navigators and Operating Systems"]
+ [row]
+ [col]Internet Explorer[/col]
+ [col]Windows, Mac OSX[/col]
+ [/row]
+ [row]
+ [col]Safari[/col]
+ [col]Mac OSX[/col]
+ [/row]
+ [row]
+ [col]Firefox[/col]
+ [col]Windows, Mac OSX, Linux[/col]
+ [/row]
+ [row]
+ [col]Opera[/col]
+ [col]Windows, Mac OSX, Linux[/col]
+ [/row]
+ [/table]
[/code]
[section Example 2]
@@ -55,5 +75,11 @@ Here, you'll have some simple examples of *.afc text that intend to show the eas
return 0;
}
[/code]
+
+ * **in Ruby**
+
+ [ruby]
+ puts "Hello, world!"
+ [/ruby]
[/list]
[/code]
@@ -43,6 +43,19 @@ int main(){
}
[/code]
+**Ruby:**
+[ruby]
+class CreateComentarios < ActiveRecord::Migration
+ def self.up
+ create_table :comentarios do |t|
+ t.text :conteudo
+ t.integer :comentavel_id
+ t.string :comentavel_type
+ t.timestamps
+ end
+end
+[/ruby]
+
**Code properties:**
[code properties]
print: "Hello world!"
@@ -75,6 +88,19 @@ public static void main (String[] args) {
</printIt>
[/xml]
+**Ruby:**
+[ruby h=1,3]
+class CreateComentarios < ActiveRecord::Migration
+ def self.up
+ create_table :comentarios do |t|
+ t.text :conteudo
+ t.integer :comentavel_id
+ t.string :comentavel_type
+ t.timestamps
+ end
+end
+[/ruby]
+
**Code:**
[code h=2]
int main(){
@@ -133,6 +159,67 @@ the Latex output.
* item
[/list]
+[title Tables]
+**Simple table:**
+[table]
+ [row]
+ [col]
+ A cell
+ [/col]
+ [col]
+ Another cell
+ [/col]
+ [/row]
+ [row]
+ [col]
+ Yet another cell
+ [/col]
+ [col]
+ The last cell
+ [/col]
+ [/row]
+[/table]
+
+**Table with title:**
+[table "Test table with border"]
+ [row]
+ [col]
+ A cell
+ [/col]
+ [col]
+ Another cell
+ [/col]
+ [/row]
+ [row]
+ [col]
+ Yet another cell
+ [/col]
+ [col]
+ The last cell
+ [/col]
+ [/row]
+[/table]
+
+**Table without border:**
+[table noborder]
+ [row]
+ [col]
+ A cell
+ [/col]
+ [col]
+ Another cell
+ [/col]
+ [/row]
+ [row]
+ [col]
+ Yet another cell
+ [/col]
+ [col]
+ The last cell
+ [/col]
+ [/row]
+[/table]
+
[title Links and Images]
**Links:**
View
@@ -13,7 +13,14 @@ Building a Jar
execute in a terminal:
> cd /path/to/tubaina
> mvn package
-
+
+Building a distributable file
+
+ execute in a terminal:
+ > cd /path/to/tubaina
+ > ant
+
+ This will generate the distributable files inside a folder called temp.
Getting a *.pdf compiled
View
@@ -3,7 +3,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>br.com.caelum</groupId>
<artifactId>tubaina</artifactId>
- <version>1.0.2-SNAPSHOT</version>
+ <version>1.0.2</version>
<packaging>jar</packaging>
<dependencies>
<dependency>
View
@@ -8,10 +8,10 @@ elif [ -z "$TUBAINA_HOME" ]; then
#echo "Could not find TUBAINA_HOME. Will work only if inside Tubaina bin directory";
WHICH=`which $0`;
export TUB_REL_PATH="${WHICH%/tubaina}/@TUB_HOME_MOD";
- $JAVA_HOME/bin/java -classpath @CLASSPATH br.com.caelum.tubaina.Tubaina $@;
+ $JAVA_HOME/bin/java -classpath @CLASSPATH br.com.caelum.tubaina.Tubaina "$@";
else
export TUB_REL_PATH=$TUBAINA_HOME;
- $JAVA_HOME/bin/java -classpath @CLASSPATH br.com.caelum.tubaina.Tubaina $@;
+ $JAVA_HOME/bin/java -classpath @CLASSPATH br.com.caelum.tubaina.Tubaina "$@";
fi;

0 comments on commit cbc4079

Please sign in to comment.