Merge pull request #640 from jsuarezb/tutorial-pagination

Add pagination to Style guide and generalize pager

Author: heathermiller

_includes/pager.txt

@@ -0,0 +1,10 @@
+<nav>
+  <ul class="pager">
+  {% if page.previous-page %}
+      <li class="previous"><a href="{{ page.previous-page }}.html""><span aria-hidden="true">&larr;</span> Previous</a></li>
+   {% endif %}
+   {% if page.next-page %}
+      <li class="next"><a href="{{ page.next-page }}.html">Next <span aria-hidden="true">&rarr;</span></a></li>
+   {% endif %}
+  </ul>
+</nav>

_includes/tutorial-pager.txt

@@ -37,6 +37,7 @@
 
     <div class="span10">
       {{ content }}
+      {% include pager.txt %}
       {% if page.disqus == true %}{% include disqus.txt %}{% endif %}
     </div>
 

_layouts/overview-large.html

@@ -43,13 +43,13 @@
       {{ content }}
       {% if page.disqus == true %}{% include disqus.txt %}{% endif %}
     </div>
-    
+
     <div class="span6">
       {% include toc.txt %}
     </div>
-    
-	
+
+
   </div>
 </div>
 
-{% include footer.txt %}    
+{% include footer.txt %}

_layouts/overview.html

@@ -34,19 +34,19 @@
         </ul>
         {% endif %}
       </div>
-    
+
       <div class="span10">
         {{ content }}
-        {% include tutorial-pager.txt %}
+        {% include pager.txt %}
         {% if page.disqus == true %}{% include disqus.txt %}{% endif %}
       </div>
-    
+
       <div class="span6">
         {% include tutorial-toc.txt %}
       </div>
-	
+
     </div>
   </div>
   <div class="push"></div>
 </div>
-{% include footer.txt %}    
+{% include footer.txt %}

_layouts/tutorial.html

@@ -7,8 +7,8 @@ disqus: true
 tutorial: scala-tour
 num: 12
 language: es
-tutorial-next: xml-processing
-tutorial-previous: pattern-matching
+next-page: xml-processing
+previous-page: pattern-matching
 ---
 
 Métodos y valores que no están asociados con instancias individuales de una [clase](classes.html) se denominan *objetos singleton* y se denotan con la palabra reservada `object` en vez de `class`.

es/tutorials/tour/singleton-objects.md

@@ -4,6 +4,9 @@ title: Control Structures
 
 partof: style-guide
 num: 7
+
+previous-page: files
+next-page: method-invocation
 ---
 
 All control structures should be written with a space following the
@@ -13,7 +16,7 @@ defining keyword:
     if (foo) bar else baz
     for (i <- 0 to 10) { ... }
     while (true) { println("Hello, World!") }
-    
+
     // wrong!
     if(foo) bar else baz
     for(i <- 0 to 10) { ... }
@@ -37,7 +40,7 @@ Remember the following guidelines:
     only a single line.
 -   `case` - Always omit braces in case clauses.
 
-<!-- necessary to separate the following example from the above bullet list --> 
+<!-- necessary to separate the following example from the above bullet list -->
 
     val news = if (foo)
       goodNews()
@@ -60,7 +63,7 @@ one generator (usually, more than one `<-` symbol). In such cases, there
 are two alternative syntaxes which may be used:
 
     // wrong!
-    for (x <- board.rows; y <- board.files) 
+    for (x <- board.rows; y <- board.files)
       yield (x, y)
 
     // right!

style/control-structures.md

@@ -3,7 +3,10 @@ layout: overview-large
 title: Declarations
 
 partof: style-guide
-num: 6
+num: 9
+
+previous-page: method-invocation
+next-page: scaladoc
 ---
 
 ## Classes
@@ -37,7 +40,7 @@ constructor arguments and extensions:
         birthdate: Date,
         astrologicalSign: String,
         shoeSize: Int,
-        favoriteColor: java.awt.Color) 
+        favoriteColor: java.awt.Color)
       extends Entity
       with Logging
       with Identifiable
@@ -114,14 +117,14 @@ applicable):
 4.  Final modifier (`final`)
 5.  `def`
 
-<!-- necessary to separate the following example from the above bullet list --> 
+<!-- necessary to separate the following example from the above bullet list -->
 
     @Transaction
     @throws(classOf[IOException])
-    override protected final def foo() { 
+    override protected final def foo() {
       ...
     }
-    
+
 #### Body
 
 When a method body comprises a single expression which is less than 30
@@ -186,7 +189,7 @@ There are three main reasons you should do this:
     structures":
 
         def unless(exp: Boolean)(code: => Unit): Unit = if (!exp) code
-        unless(x < 5) { 
+        unless(x < 5) {
           println("x was not less than five")
         }
 
@@ -217,7 +220,7 @@ open-paren of the parameter lists, one list per line (i.e. if you can't
 put them all on one line, put one each per line):
 
     protected def forResource(resourceInfo: Any)
-                             (f: (JsonNode) => Any) 
+                             (f: (JsonNode) => Any)
                              (implicit urlCreator: URLCreator, configurer: OAuthConfiguration): Any = {
       ...
     }
@@ -275,20 +278,20 @@ function value.
 When styles (1) and (4) are used exclusively, it becomes very easy to
 distinguish places in the source code where function values are used.
 Both styles make use of parentheses, since they look clean on a single line.  
- 
+
 ### Spacing
 
 There should be no space between parentheses and the code they contain.  
-Curly braces should be separated from the code within them by a one-space gap, 
+Curly braces should be separated from the code within them by a one-space gap,
 to give the visually busy braces "breathing room".
 
 ### Multi-Expression Functions
 
 Most function values are less trivial than the examples given above.
 Many contain more than one expression. In such cases, it is often more
 readable to split the function value across multiple lines. When this
-happens, only style (1) should be used, substituting braces for parentheses. 
-Style (4) becomes extremely difficult to follow when enclosed in large amounts 
+happens, only style (1) should be used, substituting braces for parentheses.
+Style (4) becomes extremely difficult to follow when enclosed in large amounts
 of code. The declaration itself should loosely follow the declaration style for
 methods, with the opening brace on the same line as the assignment or
 invocation, while the closing brace is on its own line immediately

style/declarations.md

@@ -3,7 +3,10 @@ layout: overview-large
 title: Files
 
 partof: style-guide
-num: 9
+num: 6
+
+previous-page: nested-blocks
+next-page: control-structures
 ---
 
 As a rule, files should contain a *single* logical compilation unit. By
@@ -63,4 +66,3 @@ declarations. These filenames may be based upon a significant type which
 they contain (e.g. `option.scala` for the example above), or may be
 descriptive of the logical property shared by all units within (e.g.
 `ast.scala`).
-

style/files.md

@@ -4,6 +4,9 @@ title: Indentation
 
 partof: style-guide
 num: 2
+
+previous-page: overview
+next-page: naming-conventions
 ---
 
 Indentation should follow the "2-space convention". Thus, instead of

style/indentation.md

@@ -4,6 +4,9 @@ title: Method Invocation
 
 partof: style-guide
 num: 8
+
+previous-page: control-structures
+next-page: declarations
 ---
 
 Generally speaking, method invocation in Scala follows Java conventions.
@@ -62,14 +65,14 @@ Scala allows methods of arity-0 to be invoked using suffix notation:
     names toList // Unsafe, don't use!
 
 This style is unsafe, and should not be used.  Since semicolons are
-optional, the compiler will attempt to treat it as an infix method 
+optional, the compiler will attempt to treat it as an infix method
 if it can, potentially taking a term from the next line.  
 
     names toList
     val answer = 42        // will not compile!
 
-This may result in unexpected compile errors at best, and happily 
-compiled faulty code at worst.  Although the syntax is used by some 
+This may result in unexpected compile errors at best, and happily
+compiled faulty code at worst.  Although the syntax is used by some
 DSLs, it should be considered deprecated, and avoided.
 
 As of Scala 2.10, using suffix operator notation will result in a compiler warning.
@@ -152,4 +155,3 @@ Finally, the use of the `/:` and `:\` should be avoided in preference to
 the more explicit `foldLeft` and `foldRight` method of `Iterator`. The
 right-associativity of the `/:` can lead to extremely confusing code, at
 the benefit of saving a few characters.
-

style/method-invocation.md

@@ -4,6 +4,9 @@ title: Naming Conventions
 
 partof: style-guide
 num: 3
+
+previous-page: indentation
+next-page: types
 ---
 
 Generally speaking, Scala uses "camel case" naming. That is,

style/naming-conventions.md

@@ -4,6 +4,9 @@ title: Nested Blocks
 
 partof: style-guide
 num: 5
+
+previous-page: types
+next-page: files
 ---
 
 ## Curly Braces
@@ -31,13 +34,13 @@ lines as their content (Lisp-style):
     (this + is a very ++ long *
       expression)
 
-Parentheses also serve to disable semicolon inference, and so allow the developer 
+Parentheses also serve to disable semicolon inference, and so allow the developer
 to start lines with operators, which some prefer:
-     
+
     (  someCondition
     || someOtherCondition
     || thirdCondition
     )
-    
-A trailing parenthesis on the following line is acceptable in this case, for 
+
+A trailing parenthesis on the following line is acceptable in this case, for
 aesthetic reasons.

style/nested-blocks.md

@@ -1,9 +1,12 @@
 ---
 layout: overview-large
 title: Overview
+
 partof: style-guide
 num: 1
 outof: 10
+
+next-page: indentation
 ---
 
-Please see the [table of contents of the style guide]({{ site.baseurl }}/style) for an outline-style overview.
+Please see the [table of contents of the style guide]({{ site.baseurl }}/style) for an outline-style overview.