adding YAML at top of markdown files

markburns · markburns · commit cc260f180de2 · 2012-05-20T00:31:14.000+01:00
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset=utf-8 />
+  <title> {% if page.title %} {{ page.title }} | {% endif %} Ruby Hacking Guide </title>
+  <link rel="stylesheet" href="/css/styles.css" />
+</head>
+<body>
+
+  <div id="main">
+
+    <header>
+      <h1><a href="/">Ruby Hacking Guide</a></h1>
+    <header>
+
+    <nav role="navigation">
+      <ul>
+      </ul>
+    </nav>
+
+    {{ content }}
+
+    <footer>
+      The original work is Copyright © 2002 - 2004 Minero AOKI.
+      Translated by Vincent ISAMBART and Clifford Escobar CAOILE
+      This work is licensed under a
+      <p>
+        <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/2.5/">Creative Commons Attribution-NonCommercial-ShareAlike2.5 License</a>
+      </p>
+    </footer>
+
+  </div>
+</body>
+</html>
diff --git a/_posts/index.txt b/_posts/index.txt
@@ -1,4 +1,7 @@
-$comment(-*- coding: utf-8 -*- vim:set encoding=utf-8:)$
+---
+layout: default
+---
+
 Translated by Vincent ISAMBART and Clifford Escobar CAOILE
 
 h1. Ruby Hacking Guide
diff --git a/chapter02.md b/chapter02.md
@@ -1,4 +1,7 @@
-$comment(-*- coding: utf-8 -*- vim:set encoding=utf-8:)$
+---
+layout: default
+title: Objects - Structure of Ruby objects
+---
 Translated by Vincent ISAMBART
 
 h1. Chapter 2: Objects
@@ -48,7 +51,7 @@ this capability, even if some time ago there were quite a few of them.
 
 Several structures are available according to object classes:
 
-| `struct RObject`		| all things for which none of the following 
+| `struct RObject`		| all things for which none of the following
 						  applies |
 | `struct RClass`		| class object |
 | `struct RFloat`		| small numbers |
@@ -57,7 +60,7 @@ Several structures are available according to object classes:
 | `struct RRegexp`		| regular expression |
 | `struct RHash`		| hash table |
 | `struct RFile`		| `IO`, `File`, `Socket`, etc... |
-| `struct RData`		| all the classes defined at C level, except the 
+| `struct RData`		| all the classes defined at C level, except the
 						  ones mentioned above |
 | `struct RStruct`		| Ruby's `Struct` class |
 | `struct RBignum`		| big integers |
@@ -866,7 +869,7 @@ library, you can write `RSTRING(str)->ptr` or `RSTRING(str)->len`, and access
 
 # you have to check before if `str` really points to a `struct RString`
 # you can read the members, but you must not modify them
-# you can't store `RSTRING(str)->ptr` in something like a local variable and 
+# you can't store `RSTRING(str)->ptr` in something like a local variable and
 use it later
 
 Why is that? First, there is an important software engineering principle:
diff --git a/chapter03.md b/chapter03.md
@@ -1,4 +1,8 @@
-$comment(-*- coding: utf-8 -*- vim:set encoding=utf-8:)$
+---
+layout: default
+title: Names and Name Table
+---
+
 Translated by Clifford Escobar CAOILE
 
 h1. Chapter 3: Names and Name Table
@@ -80,7 +84,7 @@ For example, given the previous hash function "key % 64", keys 65 and 129
 will have a hash value of 1. This is called a hash value collision. There
 are many ways to resolve a collision.
 
-For example, if a collision occurs, then insert into the next element. 
+For example, if a collision occurs, then insert into the next element.
 This is called open addressing. (Figure 3).
 
 !images/ch_name_nexti.png(Open addressing)!
@@ -98,7 +102,7 @@ collisions. This type of function is called a "perfect hash function".
 Actually, there are tools which create a perfect hash function given a set
 of arbitrary strings. GNU gperf is one of those. `ruby`'s parser
 implementation uses GNU gperf but... this is not the time to discuss it.
-We'll discuss this in the second part of the book. 
+We'll discuss this in the second part of the book.
 
 h3. Data Structure
 
@@ -424,7 +428,7 @@ Since the name is all uppercase, we can anticipate that is a macro.
 
 The first `if` is an exception case so I will explain it afterwards.
 
-(A) Allocate and initialize a `st_table_entry`. 
+(A) Allocate and initialize a `st_table_entry`.
 
 (B) Insert the `entry` into the start of the list.
 This is the idiom for handling the list. In other words,
@@ -626,7 +630,7 @@ where the data structure's member is accessed.
 
 Let's read the code. First, `rb_raise()` is merely error handling so we ignore
 it for now. The `rb_intern()` we previously examined is here, and also ID2SYM
-is here. `ID2SYM()` is a macro that converts `ID` to `Symbol`. 
+is here. `ID2SYM()` is a macro that converts `ID` to `Symbol`.
 
 And the reverse operation is accomplished using `Symbol#to_s` and such.
 The implementation is in `sym_to_s`.
diff --git a/chapter04.md b/chapter04.md
@@ -1,4 +1,8 @@
-$comment(-*- coding: utf-8 -*- vim:set encoding=utf-8:)$
+---
+layout: default
+title: Classes and modules
+---
+
 Translated by Vincent ISAMBART
 
 h1. Chapter 4: Classes and modules
diff --git a/chapter06.md b/chapter06.md
@@ -1,4 +1,8 @@
-$comment(-*- coding: utf-8 -*- vim:set encoding=utf-8:)$
+---
+layout: default
+title: Variables and constants
+---
+
 Translated by Vincent ISAMBART
 
 h1. Chapter 6: Variables and constants
@@ -483,7 +487,7 @@ Knowing that you can hook assignment of global variables, you should
 understand easily how this can be done. By the way, `$KCODE`'s K comes
 from "kanji" (the name of Chinese characters in Japanese).
 
-You might say that even with `alias` or hooks, 
+You might say that even with `alias` or hooks,
 global variables just aren't used much, so it's functionality that doesn't
 really mater. It's adequate not to talk much about unused
 functions, and I need some pages for the analysis of the parser and
diff --git a/chapter07.md b/chapter07.md
@@ -1,4 +1,8 @@
-$comment(-*- coding: utf-8 -*- vim:set encoding=utf-8:)$
+---
+layout: default
+title: Security
+---
+
 Translated by Clifford Escobar CAOILE
 
 h1. Chapter 7: Security
@@ -81,7 +85,7 @@ but I will show an example here:
 # Raise the security level in a different thread
 p($SAFE)   # 0 is the default
 Thread.fork {    # Start a different thread
-    $SAFE = 4    # Raise the level 
+    $SAFE = 4    # Raise the level
     eval(str)    # Run the dangerous program
 }
 p($SAFE)   # Outside of the block, the level is still 0
diff --git a/chapter09.md b/chapter09.md
@@ -1,4 +1,8 @@
-$comment(-*- coding: utf-8 -*- vim: set encoding=utf-8:)$
+---
+layout: default
+title: YACC crash course
+---
+
 Translated by Vincent ISAMBART
 
 h1. Chapter 9: `yacc` crash course
diff --git a/chapter10.md b/chapter10.md
@@ -1,4 +1,8 @@
-$comment(-*- coding: utf-8 -*- vim:set encoding=utf-8:)$ 
+---
+layout: default
+title: Classes and modules
+---
+
 Translated by Robert GRAVINA
 
 h1. Chapter 10: Parser
@@ -28,7 +32,7 @@ h3. Disecting `parse.y`
 Let's now look at `parse.y` in a bit more detail. The following figure presents
 a rough outline of the contents of `parse.y`.
 
-▼ parse.y 
+▼ parse.y
 <pre class="longlist">
 %{
 header
@@ -124,10 +128,10 @@ compstmt        : stmts opt_terms
 The output is quite long - over 450 lines of grammar rules - and as such I have
 only included the most important parts in this chapter.
 
-Which symbols, then, are the most important? Symbols such as `program`, `expr`, 
-`stmt`,`primary`, `arg` etc. represent the more general grammatical elements of 
-a programming language and it is to these which we shall focus our attention. 
-The following table outlines these general elements and the symbol names used 
+Which symbols, then, are the most important? Symbols such as `program`, `expr`,
+`stmt`,`primary`, `arg` etc. represent the more general grammatical elements of
+a programming language and it is to these which we shall focus our attention.
+The following table outlines these general elements and the symbol names used
 to represent them.
 
 |Syntax element|Relevant symbol names|
@@ -147,36 +151,36 @@ In general, programming lanaguages tend to have the following symbol heiarchy.
 
 |Program element|Properties|
 |Statement|Can not be combined with other symbols. A syntax tree trunk.|
-|Expression|Can be combined with itself or be part of other 
+|Expression|Can be combined with itself or be part of other
 expressions. A syntax tree interal node.|
-|Primary|An element which can not be further decomposed. A syntax tree leaf node.| 
+|Primary|An element which can not be further decomposed. A syntax tree leaf node.|
 
-C function definitions and Java class definitions are examples of statements in 
-other languages. An expression can be a procedure call, an arithmetic expression 
-etc. while a primary usually refers to a string literal or number. Some languages 
-do not contain all of these symbol types, however they generally contain some 
+C function definitions and Java class definitions are examples of statements in
+other languages. An expression can be a procedure call, an arithmetic expression
+etc. while a primary usually refers to a string literal or number. Some languages
+do not contain all of these symbol types, however they generally contain some
 kind of hierarchy of symbols such as `program`→`stmt`→`expr`→`primary`.
 
-It is often the case that symbol types lower in this heirarchy can be promoted 
-to higher levels and vice versa. For example, in C function calls are expressions 
+It is often the case that symbol types lower in this heirarchy can be promoted
+to higher levels and vice versa. For example, in C function calls are expressions
 yet can be may also be statements.
 
 Conversely, when surrounded in parenthesis expressions become primaries.
 
-Scoping rules differ considerably between programming languages. Consider 
-substitution. In C, the value of expressions can be used in substitutions 
+Scoping rules differ considerably between programming languages. Consider
+substitution. In C, the value of expressions can be used in substitutions
 whereas in Pascal substitution occurs only at the statement level. Also,
-function and class definitions are typically statements however in languages 
-such as Lisp and Scheme, since everything is an expression, they too are 
+function and class definitions are typically statements however in languages
+such as Lisp and Scheme, since everything is an expression, they too are
 expressions. Ruby follows Lisp's design in this regard.
 
 h3. Program structure
 
-Now let's turn our attention to the grammer rules of `ruby`. Firstly, 
-`yacc` will begin by examining the first rule defined in `parse.y`, and as 
-we can see from the following table, this is `program`. From here we can see 
-the ruby grammar unfold and the existance of the `program stmt expr primary` 
-heierarchy mentioned earlier. However there is an extra rule here for `arg`. 
+Now let's turn our attention to the grammer rules of `ruby`. Firstly,
+`yacc` will begin by examining the first rule defined in `parse.y`, and as
+we can see from the following table, this is `program`. From here we can see
+the ruby grammar unfold and the existance of the `program stmt expr primary`
+heierarchy mentioned earlier. However there is an extra rule here for `arg`.
 Let's now take a look at this.
 
 ▼ `ruby` grammar (outline)
@@ -222,9 +226,9 @@ primary         : literal
                 | kRETRY
 </pre>
 
-If you look at each of the final alternatives for each of the rules you should 
+If you look at each of the final alternatives for each of the rules you should
 be able to clearly make out a hierarchy of `program`→`stmt`→`expr`→`arg`→
-`primary`. 
+`primary`.
 
 I'd like to focus on the rule for `primary`.
 
@@ -235,11 +239,11 @@ primary         : literal
                 | tLPAREN_ARG expr  ')'      /* here */
 </pre>
 
-The name `tLPAREN_ARG` comes from `t` for terminal symbol, `L` for left and 
-`PAREN` for parentheses - it is the open parenthesis. Why this isn't `'('` 
-is covered in the next section "Context-dependent scanner". The purpose of this 
-rule is demote an `expr` to a `primary`, and is shown in Figure 2. This creates 
-a cycle which can the seen in Figure 2, and the arrow shows how this rule is 
+The name `tLPAREN_ARG` comes from `t` for terminal symbol, `L` for left and
+`PAREN` for parentheses - it is the open parenthesis. Why this isn't `'('`
+is covered in the next section "Context-dependent scanner". The purpose of this
+rule is demote an `expr` to a `primary`, and is shown in Figure 2. This creates
+a cycle which can the seen in Figure 2, and the arrow shows how this rule is
 reduced during parsing.
 
 !images/ch_parser_exprloop.png(`expr` demotion)!
@@ -253,14 +257,14 @@ primary         : literal
                 | tLPAREN compstmt ')'   /* here */
 </pre>
 
-A `compstmt`, which represents code for an entire program, can be demoted to 
+A `compstmt`, which represents code for an entire program, can be demoted to
 a `primary` with this rule. The next figure illustrates this rule in action.
 
 !images/ch_parser_progloop.png(`program`の縮退)!
 
-This means that for any syntax element in Ruby, if we surround it with 
-parenthesis it will become a `primary` and can be passed as an argument to a 
-function, be used as the right hand side of an expression etc. It helps to 
+This means that for any syntax element in Ruby, if we surround it with
+parenthesis it will become a `primary` and can be passed as an argument to a
+function, be used as the right hand side of an expression etc. It helps to
 see an example of this to grasp what this truly means.
 
 <pre class="emlist">
@@ -271,7 +275,7 @@ p((if true then nil else nil end))
 p((1 + 1 * 1 ** 1 - 1 / 1 ^ 1))
 </pre>
 
-If we invoke `ruby` with the `-c` option (syntax check), we get the following 
+If we invoke `ruby` with the `-c` option (syntax check), we get the following
 output.
 
 <pre class="screen">
@@ -281,11 +285,11 @@ Syntax OK
 
 Although it might look surprising at first, yes you really can do this in Ruby!
 
-The details of this are covered when we look at semantic analysis (in Chaper 12 
-"Syntax tree construction") however it is important to note there are exceptions 
-to this rule. For example passing a `return` statement as an argument to a 
-function will result in an error. For the most part, however, the "surrounding 
-anything in parenthesis means it can be passed as an argument to a function" 
+The details of this are covered when we look at semantic analysis (in Chaper 12
+"Syntax tree construction") however it is important to note there are exceptions
+to this rule. For example passing a `return` statement as an argument to a
+function will result in an error. For the most part, however, the "surrounding
+anything in parenthesis means it can be passed as an argument to a function"
 rule does hold.
 
 In the next section I will cover the most important grammar rules in some detail.
@@ -303,8 +307,8 @@ stmts           : none
                 | stmts terms stmt
 </pre>
 
-As mentioned earlier, `program` represents an entire program in the grammar. 
-For all intents and purposes `compstmts` is equivilent to `program`. 
+As mentioned earlier, `program` represents an entire program in the grammar.
+For all intents and purposes `compstmts` is equivilent to `program`.
 
 前述の通り`program`は文法全体、即ちプログラム全体を表している。その
 `program`は`compstmts`と同じであり、`compstmts`は`stmts`とほぼ同じである。
diff --git a/chapter18.md b/chapter18.md
@@ -1,4 +1,8 @@
-$comment(-*- coding: utf-8 -*- vim: set encoding=utf-8:)$
+---
+layout: default
+title: Loading
+---
+
 Translated by Vincent ISAMBART
 
 h1. Chapter 18: Loading
@@ -461,7 +465,7 @@ part inside `rb_f_require()`'s `load_rb` loading Ruby programs.
 </pre>
 
 Here the `rb_load()` that is called is in fact the real form of the
-Ruby level load. 
+Ruby level load.
 
 さてここで呼んでいる`rb_load()`、これは実はRubyレベルの`load`の実体である。
 ということは探索がもう一回必要になるわけで、同じ作業をもう一回見るなん
diff --git a/css/styles.css b/css/styles.css
diff --git a/index.html b/index.html
