- 
+ 
{{book.title}}
diff --git a/_includes/footer.html b/_includes/footer.html index 3762a98d4e..5440bfc177 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -5,7 +5,7 @@{{item.title}}
{% for link in item.links %}
- - {{link.title}} +
- {{link.title}} {% endfor %}
{{ section.title }}
{% for link in section.links %} - +{{link.title}}
@@ -22,7 +22,7 @@{{link.title}}
More Resources:-
{% for resource in section.more-resources %}
-
- {{ resource.title }} +
- {{ resource.title }} {% endfor %}
-
{% for navItem in site.data.nav-header %}
- - {{navItem.title}} + {{navItem.title}} {% endfor %}
-
{% for navItem in site.data.doc-nav-header %}
-
- {{navItem.title}}
+ {{navItem.title}}
{% if navItem.submenu %}
-
{% for subItem in navItem.submenu %}
- - {{ subItem.title }} + {{ subItem.title }} {% endfor %}
-
{% for subItem in navItem.submenu %}
- - {{ subItem.title }} + {{ subItem.title }} {% endfor %}
-
{% for navItem in site.data.doc-nav-header %}
{% if forloop.index > 3 %}
-
- {{ navItem.title }} +
- {{ navItem.title }} {% endif %} {% endfor %}
Contents
{% if page.languages %}-
-
- English +
- English {% for l in page.languages %} {% capture intermediate %}{{ page.url | remove_first: l }}{% endcapture %} {% capture rootTutorialURL %}{{ intermediate | remove_first: '/' }}{% endcapture %} diff --git a/_includes/sidebar-toc-singlepage-overview.html b/_includes/sidebar-toc-singlepage-overview.html index 50a3c59ed5..f605a2ae13 100644 --- a/_includes/sidebar-toc-singlepage-overview.html +++ b/_includes/sidebar-toc-singlepage-overview.html @@ -5,7 +5,7 @@
- English +
- English {% for l in page.languages %} {% capture intermediate %}{{ page.url | remove_first: l }}{% endcapture %} {% capture rootTutorialURL %}{{ intermediate | remove_first: '/' }}{% endcapture %} diff --git a/_includes/sidebar-toc-tour-overview.html b/_includes/sidebar-toc-tour-overview.html index 6167d4901f..df7456ae4d 100644 --- a/_includes/sidebar-toc-tour-overview.html +++ b/_includes/sidebar-toc-tour-overview.html @@ -33,7 +33,7 @@
- English +
- English {% for l in site.data.translations.tour.languages %} {% capture intermediate %}{{ page.url | remove_first: l }}{% endcapture %} {% capture rootTutorialURL %}{{ intermediate | remove_first: '/' }}{% endcapture %} diff --git a/_layouts/cheatsheet.html b/_layouts/cheatsheet.html index 3e6e9cd3ec..6dacd54d46 100644 --- a/_layouts/cheatsheet.html +++ b/_layouts/cheatsheet.html @@ -9,7 +9,7 @@ {{content}} {% if page.languages %}
- English +
- English {% for l in page.languages %} {% capture intermediate %}{{ page.url | remove_first: l }}{% endcapture %} {% capture rootTutorialURL %}{{ intermediate | remove_first: '/' }}{% endcapture %} diff --git a/_overviews/FAQ/index.md b/_overviews/FAQ/index.md index 80b0e657de..417d08280d 100644 --- a/_overviews/FAQ/index.md +++ b/_overviews/FAQ/index.md @@ -16,7 +16,7 @@ provided by Daniel Sobral, adapted from his StackOverflow posts.
- {{ overview.title }} +
- {{ overview.title }} {% endif %} {% endfor %}
Contents
{% if page.languages %}-
-
Contents
-
-
-
-
-
{% for overview in overviews %}
{% if overview.partof == "FAQ" %}
-
trait T { ... }class C extends T { ... }class C extends D with T { ... }traits. +
interfaces-with-implementation. no constructor params. mixin-able.traits.
interfaces-with-implementation. no constructor params. mixin-able.trait T1; trait T2class C extends T1 with T2class C extends D with T1 with T2c.abortcall or an expansion typecheck error) will produce a compilation error. An error in an expansion of a whitebox implicit macro will just remove the macro from the list of implicit candidates in the current implicit search, without ever reporting an actual error to the user. This creates a trade-off: blackbox implicit macros feature better error reporting, while whitebox implicit macros are more flexible, being able to dynamically turn themselves off when necessary. diff --git a/_overviews/macros/overview.md b/_overviews/macros/overview.md index f099131408..8d275f1dad 100644 --- a/_overviews/macros/overview.md +++ b/_overviews/macros/overview.md @@ -22,7 +22,7 @@ A subset of def macros, pending a thorough specification, is tentatively schedul UPDATE This guide has been written for Scala 2.10.0, and now we're well into the Scala 2.11.x release cycle, so naturally the contents of the document are outdated. Nevertheless, this guide is not obsolete - everything written here will still work in both Scala 2.10.x and Scala 2.11.x, so it will be helpful to read it through. -After reading the guide, take a look at the docs on [quasiquotes](/overviews/quasiquotes/intro.html) +After reading the guide, take a look at the docs on [quasiquotes]({{ site.baseurl }}/overviews/quasiquotes/intro.html) and [macro bundles](bundles.html) to familiarize yourself with latest developments that dramatically simplify writing macros. Then it might be a good idea to follow [our macro workshop](https://github.com/scalamacros/macrology201) for more in-depth examples. @@ -136,7 +136,7 @@ This also means that the code below won't work for `printf(get_format(), ...)`, val Literal(Constant(s_format: String)) = format.tree Typical macros (and this macro is not an exception) need to create ASTs (abstract syntax trees) which represent Scala code. -To learn more about generation of Scala code, take a look at [the overview of reflection](http://docs.scala-lang.org/overviews/reflection/overview.html). Along with creating ASTs the code provided below also manipulates types. +To learn more about generation of Scala code, take a look at [the overview of reflection]({{ site.baseurl }}/overviews/reflection/overview.html). Along with creating ASTs the code provided below also manipulates types. Note how we get a hold of Scala types that correspond to `Int` and `String`. Reflection overview linked above covers type manipulations in detail. The final step of code generation combines all the generated code into a `Block`. diff --git a/_overviews/macros/paradise.md b/_overviews/macros/paradise.md index 775b3ebc75..b32a293aa4 100644 --- a/_overviews/macros/paradise.md +++ b/_overviews/macros/paradise.md @@ -22,7 +22,7 @@ permalink: /overviews/macros/:title.html Macro paradise is a plugin for several versions of Scala compilers. It is designed to reliably work with production releases ofscalac, making latest macro developments available way before they end up in future versions Scala. -Refer to the roadmap for [the list of supported features and versions](/overviews/macros/roadmap.html) +Refer to the roadmap for [the list of supported features and versions](roadmap.html) and visit [the paradise announcement](http://scalamacros.org/news/2013/08/07/roadmap-for-macro-paradise.html) to learn more about our support guarantees. @@ -38,11 +38,11 @@ to learn more about our support guarantees. Some features in macro paradise bring a compile-time dependency on the macro paradise plugin, some features do not, however none of those features need macro paradise at runtime. -Proceed to the [the feature list](/overviews/macros/roadmap.html) document for more information. +Proceed to the [the feature list](roadmap.html) document for more information. Consult [https://github.com/scalamacros/sbt-example-paradise](https://github.com/scalamacros/sbt-example-paradise) for an end-to-end example, but in a nutshell working with macro paradise is as easy as adding the following two lines -to your build (granted you’ve already [set up sbt](/overviews/macros/overview.html#using-macros-with-maven-or-sbt) +to your build (granted you’ve already [set up sbt](overview.html#using-macros-with-maven-or-sbt) to use macros). resolvers += Resolver.sonatypeRepo("releases") diff --git a/_overviews/macros/roadmap.md b/_overviews/macros/roadmap.md index 6c24216c8f..5b5e5c5fae 100644 --- a/_overviews/macros/roadmap.md +++ b/_overviews/macros/roadmap.md @@ -26,18 +26,18 @@ the new foundation for metaprogramming Scala, which is simpler, more robust and than the current system based on scala.reflect. We hope that one day scala.meta will supersede scala.reflect and become the new standard way of doing metaprogramming in Scala. -| Feature | Scala 2.10 | [Paradise 2.10](/overviews/macros/paradise.html) | Scala 2.11 | [Paradise 2.11](/overviews/macros/paradise.html) | Scala 2.12 | [Paradise 2.12](/overviews/macros/paradise.html) | +| Feature | Scala 2.10 | [Paradise 2.10](paradise.html) | Scala 2.11 | [Paradise 2.11](paradise.html) | Scala 2.12 | [Paradise 2.12](paradise.html) | |-----------------------------------------------------------------------------------|---------------------------------|--------------------------------------------------|----------------------------|--------------------------------------------------|-----------------------------|--------------------------------------------------| -| [Blackbox/whitebox separation](/overviews/macros/blackbox-whitebox.html) | No | No 1 | Yes | Yes 1 | Yes | Yes 1 | -| [Def macros](/overviews/macros/overview.html) | Yes | Yes 1 | Yes | Yes 1 | Yes | Yes 1 | -| [Macro bundles](/overviews/macros/bundles.html) | No | No 1 | Yes | Yes 1 | Yes | Yes 1 | -| [Implicit macros](/overviews/macros/implicits.html) | Yes (since 2.10.2) | Yes 1 | Yes | Yes 1 | Yes | Yes 1 | -| [Fundep materialization](/overviews/macros/implicits.html#fundep-materialization) | Yes (since 2.10.5) 3 | Yes 2 | Yes | Yes 1 | Yes | Yes 1 | -| [Type providers](/overviews/macros/typeproviders.html) | Partial support (see docs) | Yes 2 | Partial support (see docs) | Yes 2 | Partial support (see docs) | Yes 2 | -| [Quasiquotes](/overviews/quasiquotes/intro.html) | No | Yes 1 | Yes | Yes 1 | Yes | Yes 1 | -| [Type macros](/overviews/macros/typemacros.html) | No | No | No | No | No | No | -| [Untyped macros](/overviews/macros/untypedmacros.html) | No | No | No | No | No | No | -| [Macro annotations](/overviews/macros/annotations.html) | No | Yes 2 | No | Yes 2 | No | Yes 2 | +| [Blackbox/whitebox separation](blackbox-whitebox.html) | No | No 1 | Yes | Yes 1 | Yes | Yes 1 | +| [Def macros](overview.html) | Yes | Yes 1 | Yes | Yes 1 | Yes | Yes 1 | +| [Macro bundles](bundles.html) | No | No 1 | Yes | Yes 1 | Yes | Yes 1 | +| [Implicit macros](implicits.html) | Yes (since 2.10.2) | Yes 1 | Yes | Yes 1 | Yes | Yes 1 | +| [Fundep materialization](implicits.html#fundep-materialization) | Yes (since 2.10.5) 3 | Yes 2 | Yes | Yes 1 | Yes | Yes 1 | +| [Type providers](typeproviders.html) | Partial support (see docs) | Yes 2 | Partial support (see docs) | Yes 2 | Partial support (see docs) | Yes 2 | +| [Quasiquotes]({{ site.baseurl }}/overviews/quasiquotes/intro.html) | No | Yes 1 | Yes | Yes 1 | Yes | Yes 1 | +| [Type macros](typemacros.html) | No | No | No | No | No | No | +| [Untyped macros](untypedmacros.html) | No | No | No | No | No | No | +| [Macro annotations](annotations.html) | No | Yes 2 | No | Yes 2 | No | Yes 2 |1 This feature doesn't bring a compile-time or a runtime dependency on macro paradise. This means that neither compiling against your bytecode that uses this feature, nor running this bytecode requires the macro paradise plugin to be present on classpath.
2 This feature brings a compile-time, but not a runtime dependency on macro paradise. This means that compiling against your bytecode that uses this feature will need the plugin to be added to your users' builds, however running this bytecode or results of macro expansions produced by this bytecode doesn't need additional classpath entries.
diff --git a/_overviews/macros/typemacros.md b/_overviews/macros/typemacros.md index f638aebf74..15ed40ae44 100644 --- a/_overviews/macros/typemacros.md +++ b/_overviews/macros/typemacros.md @@ -13,7 +13,7 @@ permalink: /overviews/macros/:title.html **Eugene Burmako** -Type macros used to be available in previous versions of ["Macro Paradise"](/overviews/macros/paradise.html), +Type macros used to be available in previous versions of ["Macro Paradise"](paradise.html), but are not supported anymore in macro paradise 2.0. Visit [the paradise 2.0 announcement](http://scalamacros.org/news/2013/08/05/macro-paradise-2.0.0-snapshot.html) for an explanation and suggested migration strategy. @@ -30,7 +30,7 @@ Just as def macros make the compiler execute custom functions when it sees invoc Db.Coffees.update(brazilian.copy(price = 10)) println(Db.Coffees.all) -The full source code of the `H2Db` type macro is provided [at GitHub](https://github.com/xeno-by/typemacros-h2db), and this guide covers its most important aspects. First the macro generates the statically typed database wrapper by connecting to a database at compile-time (tree generation is explained in [the reflection overview](http://docs.scala-lang.org/overviews/reflection/overview.html)). Then it uses the NEW `c.introduceTopLevel` API ([Scaladoc](https://scala-webapps.epfl.ch/jenkins/view/misc/job/macro-paradise211-nightly-main/ws/dists/latest/doc/scala-devel-docs/api/index.html#scala.reflect.macros.Synthetics)) to insert the generated wrapper into the list of top-level definitions maintained by the compiler. Finally, the macro returns an `Apply` node, which represents a super constructor call to the generated class. NOTE that type macros are supposed to expand into `c.Tree`, unlike def macros, which expand into `c.Expr[T]`. That's because `Expr`s represent terms, while type macros expand into types. +The full source code of the `H2Db` type macro is provided [at GitHub](https://github.com/xeno-by/typemacros-h2db), and this guide covers its most important aspects. First the macro generates the statically typed database wrapper by connecting to a database at compile-time (tree generation is explained in [the reflection overview]({{ site.baseurl }}/overviews/reflection/overview.html)). Then it uses the NEW `c.introduceTopLevel` API ([Scaladoc](https://scala-webapps.epfl.ch/jenkins/view/misc/job/macro-paradise211-nightly-main/ws/dists/latest/doc/scala-devel-docs/api/index.html#scala.reflect.macros.Synthetics)) to insert the generated wrapper into the list of top-level definitions maintained by the compiler. Finally, the macro returns an `Apply` node, which represents a super constructor call to the generated class. NOTE that type macros are supposed to expand into `c.Tree`, unlike def macros, which expand into `c.Expr[T]`. That's because `Expr`s represent terms, while type macros expand into types. type H2Db(url: String) = macro impl @@ -93,4 +93,4 @@ For example, a type macro used as `TM(2)(3)` in `class C extends TM(2)(3)` can e ### Generating classes and objects -With type macros you might increasingly find yourself in a zone where `reify` is not applicable, as explained [at StackOverflow](http://stackoverflow.com/questions/13795490/how-to-use-type-calculated-in-scala-macro-in-a-reify-clause). In that case consider using [quasiquotes](/overviews/quasiquotes/intro.html), another experimental feature from macro paradise, as an alternative to manual tree construction. +With type macros you might increasingly find yourself in a zone where `reify` is not applicable, as explained [at StackOverflow](http://stackoverflow.com/questions/13795490/how-to-use-type-calculated-in-scala-macro-in-a-reify-clause). In that case consider using [quasiquotes]({{ site.baseurl }}/overviews/quasiquotes/intro.html), another experimental feature from macro paradise, as an alternative to manual tree construction. diff --git a/_overviews/macros/typeproviders.md b/_overviews/macros/typeproviders.md index 99a67437aa..db886a9c4b 100644 --- a/_overviews/macros/typeproviders.md +++ b/_overviews/macros/typeproviders.md @@ -93,7 +93,7 @@ so I refer you to an amazing blog series by Travis Brown for details: [post 1](h ## Public type providers -With the help of [macro paradise](/overviews/macros/paradise.html) and its [macro annotations](/overviews/macros/annotations.html), it becomes +With the help of [macro paradise](paradise.html) and its [macro annotations](annotations.html), it becomes possible to easily generate publicly visible classes, without having to apply workarounds based on structural types. The annotation-based solution is very straightforward, so I won't be writing much about it here. @@ -140,5 +140,5 @@ than bytecode of a full-fledged class. This technique applies to both anonymous ## Blackbox vs whitebox -Both anonymous and public type providers must be [whitebox](/overviews/macros/blackbox-whitebox.html). -If you declare a type provider macro as [blackbox](/overviews/macros/blackbox-whitebox.html), it will not work. +Both anonymous and public type providers must be [whitebox](blackbox-whitebox.html). +If you declare a type provider macro as [blackbox](blackbox-whitebox.html), it will not work. diff --git a/_overviews/macros/untypedmacros.md b/_overviews/macros/untypedmacros.md index 5b1a57c0bd..d03a4f3109 100644 --- a/_overviews/macros/untypedmacros.md +++ b/_overviews/macros/untypedmacros.md @@ -13,7 +13,7 @@ permalink: /overviews/macros/:title.html **Eugene Burmako** -Untyped macros used to be available in previous versions of ["Macro Paradise"](/overviews/macros/paradise.html), +Untyped macros used to be available in previous versions of ["Macro Paradise"](paradise.html), but are not supported anymore in macro paradise 2.0. Visit [the paradise 2.0 announcement](http://scalamacros.org/news/2013/08/05/macro-paradise-2.0.0-snapshot.html) for an explanation and suggested migration strategy. diff --git a/_overviews/quasiquotes/definition-details.md b/_overviews/quasiquotes/definition-details.md index a74ec7e17b..d859b6d136 100644 --- a/_overviews/quasiquotes/definition-details.md +++ b/_overviews/quasiquotes/definition-details.md @@ -115,7 +115,7 @@ The template consists of: ## Val and Var Definitions -`val`s and `var`s allow you to define immutable values and mutable variables respectively. Additionally they can be used to represent [function](/overviews/quasiquotes/expression-details.html#function), [class](#class-definition) and [method](#method-definition) parameters. +`val`s and `var`s allow you to define immutable values and mutable variables respectively. Additionally they can be used to represent [function](expression-details.html#function), [class](#class-definition) and [method](#method-definition) parameters. Each `val` and `var` consistents of four components: modifiers, a name, a type tree and a right hand side: @@ -128,7 +128,7 @@ Each `val` and `var` consistents of four components: modifiers, a name, a type t tpt: universe.Tree =rhs: universe.Tree = 2 -If the type of the `val` isn't explicitly specified by the user an [empty type](/overviews/quasiquotes/type-details.html#empty-type) is used as `tpt`. +If the type of the `val` isn't explicitly specified by the user an [empty type](type-details.html#empty-type) is used as `tpt`. `val`s and `var`s are disjoint (they don't match one another): @@ -216,7 +216,7 @@ Abstract type definitions have the following shape: low: universe.Tree = high: universe.Tree = List[T] -Whenever one of the bounds isn\'t available, it gets represented as an [empty tree](/overviews/quasiquotes/expression-details.html#empty). Here each of the type arguments is a type definition itself. +Whenever one of the bounds isn\'t available, it gets represented as an [empty tree](expression-details.html#empty). Here each of the type arguments is a type definition itself. Another form of type definition is a type alias: @@ -249,7 +249,7 @@ Each method consists of modifiers, a name, type arguments, value arguments, retu tpt: universe.Tree = body: universe.Tree = 1 -Type arguments are [type definitions](#type-definition) and value arguments are [val definitions](#val-and-var-definitions). The inferred return type is represented as an [empty type](/overviews/quasiquotes/type-details.html#empty-type). If the body of the method is an [empty expression](/overviews/quasiquotes/expression-details.html#empty) it means that method is abstract. +Type arguments are [type definitions](#type-definition) and value arguments are [val definitions](#val-and-var-definitions). The inferred return type is represented as an [empty type](type-details.html#empty-type). If the body of the method is an [empty expression](expression-details.html#empty) it means that method is abstract. Alternatively you can also deconstruct arguments, separating implicit and non-implicit parameters: diff --git a/_overviews/quasiquotes/expression-details.md b/_overviews/quasiquotes/expression-details.md index 35af8c09f8..371b7508dc 100644 --- a/_overviews/quasiquotes/expression-details.md +++ b/_overviews/quasiquotes/expression-details.md @@ -42,13 +42,13 @@ All of those values are of type `Literal` except symbols, which have a different scala> val foo = q"'foo" foo: universe.Tree = scala.Symbol("foo") -Thanks to [lifting](/overviews/quasiquotes/lifting.html), you can also easily create literal trees directly from values of corresponding types: +Thanks to [lifting]({{ site.baseurl }}/overviews/quasiquotes/lifting.html), you can also easily create literal trees directly from values of corresponding types: scala> val x = 1 scala> val one = q"$x" one: universe.Tree = 1 -This would work the same way for all literal types (see [standard liftables](/overviews/quasiquotes/lifting.html#standard-liftables) except `Null`. Lifting of the `null` value into the `Null` type isn't supported; use `q"null"` if you really want to create a `null` literal: +This would work the same way for all literal types (see [standard liftables]({{ site.baseurl }}/overviews/quasiquotes/lifting.html#standard-liftables) except `Null`. Lifting of the `null` value into the `Null` type isn't supported; use `q"null"` if you really want to create a `null` literal: scala> val x = null scala> q"$x" @@ -56,12 +56,12 @@ This would work the same way for all literal types (see [standard liftables](/ov q"$x" ^ -During deconstruction you can use [unlifting](/overviews/quasiquotes/unlifting.html) to extract values out of `Literal` trees: +During deconstruction you can use [unlifting]({{ site.baseurl }}/overviews/quasiquotes/unlifting.html) to extract values out of `Literal` trees: scala> val q"${x: Int}" = q"1" x: Int = 1 -Similarly it would work with all the literal types except `Null`. (see [standard unliftables](/overviews/quasiquotes/unlifting.html#standard-unliftables)) +Similarly it would work with all the literal types except `Null`. (see [standard unliftables]({{ site.baseurl }}/overviews/quasiquotes/unlifting.html#standard-unliftables)) ## Identifier and Selection @@ -86,7 +86,7 @@ Although backquoted and non-backquoted identifiers may refer to the same thing t This is because backquoted identifiers have different semantics in pattern patching. -Apart from matching on identifiers with a given name, you can also extract their name values with the help of [unlifting](/overviews/quasiquotes/unlifting.html): +Apart from matching on identifiers with a given name, you can also extract their name values with the help of [unlifting]({{ site.baseurl }}/overviews/quasiquotes/unlifting.html): scala> val q"${name: TermName}" = q"Foo" name: universe.TermName = Foo @@ -273,7 +273,7 @@ It's important to mention that such a pattern won't match if we combine annotati scala.MatchError: (1.$plus(1): Int @positive) (of class scala.reflect.internal.Trees$Typed) ... 32 elided -In this case we need to deconstruct it as an [ascription](#ascription) and then deconstruct `tpt` as an [annotated type](/overviews/quasiquotes/type-details.html#annotated-type). +In this case we need to deconstruct it as an [ascription](#ascription) and then deconstruct `tpt` as an [annotated type]({{ site.baseurl }}/overviews/quasiquotes/type-details.html#annotated-type). ## Tuple @@ -474,7 +474,7 @@ There are three ways to create anonymous function: The first one uses the placeholder syntax. The second one names the function parameter but still relies on type inference to infer its type. An the last one explicitly defines the function parameter. Due to an implementation restriction, the second notation can only be used in parentheses or inside another expression. If you leave them out the you must specify the parameter types. -Parameters are represented as [Vals](/overviews/quasiquotes/definition-details.html#val-and-var-definitions). If you want to programmatically create a `val` that should have its type inferred you need to use the [empty type](/overviews/quasiquotes/type-details.html#empty-type): +Parameters are represented as [Vals]({{ site.baseurl }}/overviews/quasiquotes/definition-details.html#val-and-var-definitions). If you want to programmatically create a `val` that should have its type inferred you need to use the [empty type]({{ site.baseurl }}/overviews/quasiquotes/type-details.html#empty-type): scala> val tpt = tq"" tpt: universe.TypeTree = @@ -504,7 +504,7 @@ You can also tear arguments apart even further: name: universe.TermName = a tpt: universe.Tree = Int -It is recommended that you use the underscore pattern in place of [modifiers](/overviews/quasiquotes/definition-details.html#modifiers), even if you don't plan to work with them as parameters, they may contain additional flags which might cause match failures. +It is recommended that you use the underscore pattern in place of [modifiers]({{ site.baseurl }}/overviews/quasiquotes/definition-details.html#modifiers), even if you don't plan to work with them as parameters, they may contain additional flags which might cause match failures. ## Partial Function @@ -598,7 +598,7 @@ New expressions let you construct an instance of given type, possibly refining i parents: List[universe.Tree] = List(Foo(1), Bar) body: List[universe.Tree] = List(def baz = 2) -See the [templates](/overviews/quasiquotes/definition-details.html#templates) section for details. +See the [templates]({{ site.baseurl }}/overviews/quasiquotes/definition-details.html#templates) section for details. ## Import diff --git a/_overviews/quasiquotes/intro.md b/_overviews/quasiquotes/intro.md index 8ae3d6cb58..fbebb00f77 100644 --- a/_overviews/quasiquotes/intro.md +++ b/_overviews/quasiquotes/intro.md @@ -69,9 +69,9 @@ Each of these contexts is covered by a separate interpolator: | Used for ----|---------------- - q | [expressions](/overviews/quasiquotes/syntax-summary.html#expressions), [definitions](/overviews/quasiquotes/syntax-summary.html#definitions) and [imports](http://localhost:4000/overviews/quasiquotes/expression-details.html#import) - tq | [types](/overviews/quasiquotes/syntax-summary.html#types) - pq | [patterns](/overviews/quasiquotes/syntax-summary.html#patterns) + q | [expressions]({{ site.baseurl }}/overviews/quasiquotes/syntax-summary.html#expressions), [definitions]({{ site.baseurl }}/overviews/quasiquotes/syntax-summary.html#definitions) and [imports](http://localhost:4000/overviews/quasiquotes/expression-details.html#import) + tq | [types]({{ site.baseurl }}/overviews/quasiquotes/syntax-summary.html#types) + pq | [patterns]({{ site.baseurl }}/overviews/quasiquotes/syntax-summary.html#patterns) Syntactical similarity between different contexts doesn\'t imply similarity between underlying trees: @@ -97,10 +97,10 @@ Additionally there are two auxiliary interpolators that let you work with minor | Used for ----|------------------------------------- - cq | [case clause](/overviews/quasiquotes/syntax-summary.html#auxiliary) - fq | [for loop enumerator](/overviews/quasiquotes/syntax-summary.html#auxiliary) + cq | [case clause]({{ site.baseurl }}/overviews/quasiquotes/syntax-summary.html#auxiliary) + fq | [for loop enumerator]({{ site.baseurl }}/overviews/quasiquotes/syntax-summary.html#auxiliary) -See the section [syntax summary](/overviews/quasiquotes/syntax-summary.html) for details. +See the section [syntax summary]({{ site.baseurl }}/overviews/quasiquotes/syntax-summary.html) for details. ## Splicing @@ -154,4 +154,4 @@ So, in general, only one `..$` is allowed per given list. Similar restrictions a case q"f(...$init)(..$first)" => // ok case q"f(...$a)(...$b)" => // not allowed -In this section we only worked with function arguments but the same splicing rules are true for all syntax forms with a variable number of elements. [Syntax summary](/overviews/quasiquotes/syntax-summary.html) and the corresponding details sections demonstrate how you can use splicing with other syntactic forms. +In this section we only worked with function arguments but the same splicing rules are true for all syntax forms with a variable number of elements. [Syntax summary]({{ site.baseurl }}/overviews/quasiquotes/syntax-summary.html) and the corresponding details sections demonstrate how you can use splicing with other syntactic forms. diff --git a/_overviews/quasiquotes/lifting.md b/_overviews/quasiquotes/lifting.md index eea2842479..2c6126a789 100644 --- a/_overviews/quasiquotes/lifting.md +++ b/_overviews/quasiquotes/lifting.md @@ -13,7 +13,7 @@ permalink: /overviews/quasiquotes/:title.html --- **Denys Shabalin** EXPERIMENTAL -Lifting is an extensible way to unquote custom data types in quasiquotes. Its primary use-case is support unquoting of [literal](/overviews/quasiquotes/expression-details.html#literal) values and a number of reflection primitives as trees: +Lifting is an extensible way to unquote custom data types in quasiquotes. Its primary use-case is support unquoting of [literal]({{ site.baseurl }}/overviews/quasiquotes/expression-details.html#literal) values and a number of reflection primitives as trees: scala> val two = 1 + 1 two: Int = 2 @@ -69,7 +69,7 @@ This way, whenever a value of type `Point` is unquoted at runtime it will be aut compatible with the others. This problem is caused by the path-dependent nature of the current reflection API. (see [sharing liftable implementation between universes](#reusing-liftable-implementation-between-universes)) -3. Due to a lack of [hygiene](/overviews/quasiquotes/hygiene.html), the reference to `Point`'s companion +3. Due to a lack of [hygiene]({{ site.baseurl }}/overviews/quasiquotes/hygiene.html), the reference to `Point`'s companion has to be fully qualified to ensure the correctness of this tree in every possible context. Another way to workaround this reference issue is to use symbols instead: diff --git a/_overviews/quasiquotes/pattern-details.md b/_overviews/quasiquotes/pattern-details.md index 5a0349bd80..d6d3597a20 100644 --- a/_overviews/quasiquotes/pattern-details.md +++ b/_overviews/quasiquotes/pattern-details.md @@ -24,7 +24,7 @@ Literal patterns are equivalent to literal expressions on AST level: scala> val equivalent = pq"1" equalsStructure q"1" equivalent: Boolean = true -See the chapter on [literal expressions](/overviews/quasiquotes/expression-details.html#literal) for details. +See the chapter on [literal expressions]({{ site.baseurl }}/overviews/quasiquotes/expression-details.html#literal) for details. ## Binding Pattern @@ -106,7 +106,7 @@ Pattern alternatives represent a pattern that matches whenever, at least, one of ## Tuple Pattern -Similar to [tuple expressions](/overviews/quasiquotes/expression-details.html#tuple) and [tuple types](/overviews/quasiquotes/type-details.html#tuple-type), tuple patterns are just syntactic sugar that expands as a `TupleN` extractor: +Similar to [tuple expressions]({{ site.baseurl }}/overviews/quasiquotes/expression-details.html#tuple) and [tuple types]({{ site.baseurl }}/overviews/quasiquotes/type-details.html#tuple-type), tuple patterns are just syntactic sugar that expands as a `TupleN` extractor: scala> val tup2pat = pq"(a, b)" tup2pat: universe.Tree = scala.Tuple2((a @ _), (b @ _)) diff --git a/_overviews/quasiquotes/setup.md b/_overviews/quasiquotes/setup.md index b1231be7cc..940216b055 100644 --- a/_overviews/quasiquotes/setup.md +++ b/_overviews/quasiquotes/setup.md @@ -52,7 +52,7 @@ On the other side of spectrum there is also a `showRaw` pretty printer that show ## Scala 2.10 -In Scala 2.10, quasiquotes are only available via the [macro paradise compiler plugin](http://docs.scala-lang.org/overviews/macros/paradise.html). +In Scala 2.10, quasiquotes are only available via the [macro paradise compiler plugin]({{ site.baseurl }}/overviews/macros/paradise.html). In short, using quasiquotes in 2.10 is as simple as adding a single `addCompilerPlugin` line to your sbt build for the macro paradise plugin that enables quasiquotes and an additional `libraryDependencies` line for the supporting library that is necessary for quasiquotes to function in Scala 2.10. A full example is provided at [https://github.com/scalamacros/sbt-example-paradise](https://github.com/scalamacros/sbt-example-paradise). diff --git a/_overviews/quasiquotes/syntax-summary.md b/_overviews/quasiquotes/syntax-summary.md index 786723f096..f7de0517f9 100644 --- a/_overviews/quasiquotes/syntax-summary.md +++ b/_overviews/quasiquotes/syntax-summary.md @@ -47,26 +47,26 @@ permalink: /overviews/quasiquotes/:title.html XML Literal | Not natively supported | Tree -[101]: /overviews/quasiquotes/expression-details.html#empty -[102]: /overviews/quasiquotes/expression-details.html#literal -[103]: /overviews/quasiquotes/expression-details.html#identifier-and-selection -[104]: /overviews/quasiquotes/expression-details.html#super-and-this -[105]: /overviews/quasiquotes/expression-details.html#application-and-type-application -[106]: /overviews/quasiquotes/expression-details.html#assign-and-update -[107]: /overviews/quasiquotes/expression-details.html#return -[108]: /overviews/quasiquotes/expression-details.html#throw -[109]: /overviews/quasiquotes/expression-details.html#ascription -[110]: /overviews/quasiquotes/expression-details.html#annotation -[111]: /overviews/quasiquotes/expression-details.html#tuple -[112]: /overviews/quasiquotes/expression-details.html#block -[113]: /overviews/quasiquotes/expression-details.html#if -[114]: /overviews/quasiquotes/expression-details.html#pattern-match -[115]: /overviews/quasiquotes/expression-details.html#try -[116]: /overviews/quasiquotes/expression-details.html#function -[117]: /overviews/quasiquotes/expression-details.html#partial-function -[118]: /overviews/quasiquotes/expression-details.html#while-and-do-while-loops -[119]: /overviews/quasiquotes/expression-details.html#for-and-for-yield-loops -[120]: /overviews/quasiquotes/expression-details.html#new +[101]: expression-details.html#empty +[102]: expression-details.html#literal +[103]: expression-details.html#identifier-and-selection +[104]: expression-details.html#super-and-this +[105]: expression-details.html#application-and-type-application +[106]: expression-details.html#assign-and-update +[107]: expression-details.html#return +[108]: expression-details.html#throw +[109]: expression-details.html#ascription +[110]: expression-details.html#annotation +[111]: expression-details.html#tuple +[112]: expression-details.html#block +[113]: expression-details.html#if +[114]: expression-details.html#pattern-match +[115]: expression-details.html#try +[116]: expression-details.html#function +[117]: expression-details.html#partial-function +[118]: expression-details.html#while-and-do-while-loops +[119]: expression-details.html#for-and-for-yield-loops +[120]: expression-details.html#new ## Types @@ -86,16 +86,16 @@ permalink: /overviews/quasiquotes/:title.html [Tuple Type][209] | `tq"(..$tpts)"` | Tree [Function Type][210] | `tq"(..$tpts) => $tpt"` | Tree -[201]: /overviews/quasiquotes/type-details.html#empty-type -[202]: /overviews/quasiquotes/type-details.html#type-identifier -[203]: /overviews/quasiquotes/type-details.html#singleton-type -[204]: /overviews/quasiquotes/type-details.html#type-projection -[205]: /overviews/quasiquotes/type-details.html#applied-type -[206]: /overviews/quasiquotes/type-details.html#annotated-type -[207]: /overviews/quasiquotes/type-details.html#compound-type -[208]: /overviews/quasiquotes/type-details.html#existential-type -[209]: /overviews/quasiquotes/type-details.html#tuple-type -[210]: /overviews/quasiquotes/type-details.html#function-type +[201]: type-details.html#empty-type +[202]: type-details.html#type-identifier +[203]: type-details.html#singleton-type +[204]: type-details.html#type-projection +[205]: type-details.html#applied-type +[206]: type-details.html#annotated-type +[207]: type-details.html#compound-type +[208]: type-details.html#existential-type +[209]: type-details.html#tuple-type +[210]: type-details.html#function-type ## Patterns @@ -110,13 +110,13 @@ permalink: /overviews/quasiquotes/:title.html [Tuple Pattern][307] | `pq"(..$pats)"` | Apply, UnApply XML Pattern | Not natively supported | Tree -[301]: /overviews/quasiquotes/pattern-details.html#wildcard-pattern -[302]: /overviews/quasiquotes/pattern-details.html#literal-pattern -[303]: /overviews/quasiquotes/pattern-details.html#binding-pattern -[304]: /overviews/quasiquotes/pattern-details.html#extractor-pattern -[305]: /overviews/quasiquotes/pattern-details.html#type-pattern -[306]: /overviews/quasiquotes/pattern-details.html#alternative-pattern -[307]: /overviews/quasiquotes/pattern-details.html#tuple-pattern +[301]: pattern-details.html#wildcard-pattern +[302]: pattern-details.html#literal-pattern +[303]: pattern-details.html#binding-pattern +[304]: pattern-details.html#extractor-pattern +[305]: pattern-details.html#type-pattern +[306]: pattern-details.html#alternative-pattern +[307]: pattern-details.html#tuple-pattern ## Definitions @@ -135,16 +135,16 @@ permalink: /overviews/quasiquotes/:title.html [Package][409] | `q"package $ref { ..$topstats }"` | PackageDef [Package Object][410] | `q"package object $tname extends { ..$earlydefns } with ..$parents { $self => ..$stats }"` | PackageDef -[401]: /overviews/quasiquotes/definition-details.html#val-and-var-definitions -[402]: /overviews/quasiquotes/definition-details.html#pattern-definitions -[403]: /overviews/quasiquotes/definition-details.html#method-definition -[404]: /overviews/quasiquotes/definition-details.html#secondary-constructor-definition -[405]: /overviews/quasiquotes/definition-details.html#type-definition -[406]: /overviews/quasiquotes/definition-details.html#class-definition -[407]: /overviews/quasiquotes/definition-details.html#trait-definition -[408]: /overviews/quasiquotes/definition-details.html#object-definition -[409]: /overviews/quasiquotes/definition-details.html#package-definition -[410]: /overviews/quasiquotes/definition-details.html#package-object-definition +[401]: definition-details.html#val-and-var-definitions +[402]: definition-details.html#pattern-definitions +[403]: definition-details.html#method-definition +[404]: definition-details.html#secondary-constructor-definition +[405]: definition-details.html#type-definition +[406]: definition-details.html#class-definition +[407]: definition-details.html#trait-definition +[408]: definition-details.html#object-definition +[409]: definition-details.html#package-definition +[410]: definition-details.html#package-object-definition ## Auxiliary @@ -157,9 +157,9 @@ permalink: /overviews/quasiquotes/:title.html [Guard Enumerator][503] | `fq"if $expr"` | Tree -[501]: /overviews/quasiquotes/expression-details.html#import -[502]: /overviews/quasiquotes/expression-details.html#pattern-match -[503]: /overviews/quasiquotes/expression-details.html#for-and-for-yield-loops +[501]: expression-details.html#import +[502]: expression-details.html#pattern-match +[503]: expression-details.html#for-and-for-yield-loops ## Abbreviations @@ -171,14 +171,14 @@ Prefixes of unquotees imply the following: * `tpt: Tree` a [type tree](#types) * `pat: Tree` a [pattern tree](#patterns) * `defn: Tree` a [definition tree](#definitions) -* `earlydefn: Tree` an early definion tree ([val](/overviews/quasiquotes/definition-details.html#val-and-var-definitions) or [type definition](/overviews/quasiquotes/definition-details.html#type-definition)) -* `self: Tree` a self definition tree (i.e. [val definition](/overviews/quasiquotes/definition-details.html#val-and-var-definitions)) -* `stat: Tree` a statement tree ([definition](#definitions), [expression](#expressions) or an [import](/overviews/quasiquotes/expression-details.html#import)) -* `topstat: Tree` a top-level statement tree ([class](/overviews/quasiquotes/definition-details.html#class-definition), [trait](/overviews/quasiquotes/definition-details.html#trait-definition), [package](/overviews/quasiquotes/definition-details.html#package-definition), [package object](/overviews/quasiquotes/definition-details.html#package-object-definition) or [import](/overviews/quasiquotes/expression-details.html#import)) -* `enum: Tree` a [for loop](/overviews/quasiquotes/expression-details.html#for-and-for-yield-loops) enumerator -* `param: Tree` a value parameter tree (i.e. [val definition](/overviews/quasiquotes/definition-details.html#val-and-var-definitions)) -* `tparam: Tree` a type paremeter tree (i.e. [type definition](/overviews/quasiquotes/definition-details.html#type-definition)) -* `parent: Tree` a [template](/overviews/quasiquotes/definition-details.html#templates) parent -* `sel: Tree` an [import](/overviews/quasiquotes/expression-details.html#import) selector tree +* `earlydefn: Tree` an early definion tree ([val](definition-details.html#val-and-var-definitions) or [type definition](definition-details.html#type-definition)) +* `self: Tree` a self definition tree (i.e. [val definition](definition-details.html#val-and-var-definitions)) +* `stat: Tree` a statement tree ([definition](#definitions), [expression](#expressions) or an [import](expression-details.html#import)) +* `topstat: Tree` a top-level statement tree ([class](definition-details.html#class-definition), [trait](definition-details.html#trait-definition), [package](definition-details.html#package-definition), [package object](definition-details.html#package-object-definition) or [import](expression-details.html#import)) +* `enum: Tree` a [for loop](expression-details.html#for-and-for-yield-loops) enumerator +* `param: Tree` a value parameter tree (i.e. [val definition](definition-details.html#val-and-var-definitions)) +* `tparam: Tree` a type paremeter tree (i.e. [type definition](definition-details.html#type-definition)) +* `parent: Tree` a [template](definition-details.html#templates) parent +* `sel: Tree` an [import](expression-details.html#import) selector tree Whenever a name has suffix `s` it means that it is a `List` of something. `ss` means List of Lists. So for example `exprss` means a `List` of `List`s of expressions. diff --git a/_overviews/quasiquotes/terminology.md b/_overviews/quasiquotes/terminology.md index 54a868ad77..d528551c4c 100644 --- a/_overviews/quasiquotes/terminology.md +++ b/_overviews/quasiquotes/terminology.md @@ -13,12 +13,12 @@ permalink: /overviews/quasiquotes/:title.html --- EXPERIMENTAL -* **Quasiquote** (not quasi-quote) can refer to either the quasiquote library or any usage of one its [interpolators](/overviews/quasiquotes/intro.html#interpolators). The name is not hyphenated for the sake of consistency with implementations of the same concept in other languages (e.g. [Scheme and Racket](http://docs.racket-lang.org/reference/quasiquote.html), [Haskell](http://www.haskell.org/haskellwiki/Quasiquotation)) +* **Quasiquote** (not quasi-quote) can refer to either the quasiquote library or any usage of one its [interpolators](intro.html#interpolators). The name is not hyphenated for the sake of consistency with implementations of the same concept in other languages (e.g. [Scheme and Racket](http://docs.racket-lang.org/reference/quasiquote.html), [Haskell](http://www.haskell.org/haskellwiki/Quasiquotation)) * **Tree** or **AST** (Abstract Syntax Tree) is a representation of a Scala program or a part of it through means of the Scala reflection API's Tree type. * **Tree construction** refers to usages of quasiquotes as expressions to represent creation of new tree values. * **Tree deconstruction** refers to usages of quasiquotes as patterns to structurally tear apart trees. * **Unquoting** is a way of either putting things in or extracting things out of quasiquotes. Can be performed with `$` syntax within a quasiquote. * **Unquote splicing** (or just splicing) is another form of unquoting that flattens contents of the unquotee into a tree. Can be performed with either `..$` or `...$` syntax. * **Rank** is a degree of flattenning of unquotee: `rank($) == 0`, `rank(..$) == 1`, `rank(...$) == 2`. -* [**Lifting**](/overviews/quasiquotes/lifting.html) is a way to unquote non-tree values and transform them into trees with the help of the `Liftable` typeclass. -* [**Unlifting**](/overviews/quasiquotes/unlifting.html) is a way to unquote non-tree values out of quasiquote patterns with the help of the `Unliftable` typeclass. +* [**Lifting**](lifting.html) is a way to unquote non-tree values and transform them into trees with the help of the `Liftable` typeclass. +* [**Unlifting**](unlifting.html) is a way to unquote non-tree values out of quasiquote patterns with the help of the `Unliftable` typeclass. diff --git a/_overviews/quasiquotes/type-details.md b/_overviews/quasiquotes/type-details.md index af87eb505c..b9d6929f22 100644 --- a/_overviews/quasiquotes/type-details.md +++ b/_overviews/quasiquotes/type-details.md @@ -17,13 +17,13 @@ permalink: /overviews/quasiquotes/:title.html The empty type (`tq""`) is a canonical way to say that the type at given location isn't given by the user and should be inferred by the compiler: -1. [Method](/overviews/quasiquotes/definition-details.html#method-definition) with unknown return type -2. [Val or Var](/overviews/quasiquotes/definition-details.html#val-and-var-definitions) with unknown type -3. [Anonymous function](/overviews/quasiquotes/expression-details.html#function) with unknown argument type +1. [Method](definition-details.html#method-definition) with unknown return type +2. [Val or Var](definition-details.html#val-and-var-definitions) with unknown type +3. [Anonymous function](expression-details.html#function) with unknown argument type ## Type Identifier -Similarly to [term identifiers](/overviews/quasiquotes/expression-details.html#identifier-and-selection) one can construct a type identifier based on a name: +Similarly to [term identifiers](expression-details.html#identifier-and-selection) one can construct a type identifier based on a name: scala> val name = TypeName("Foo") name: universe.TypeName = Foo @@ -31,7 +31,7 @@ Similarly to [term identifiers](/overviews/quasiquotes/expression-details.html#i scala> val foo = tq"$name" foo: universe.Ident = Foo -And deconstruct it back through [unlifting](/overviews/quasiquotes/unlifting.html): +And deconstruct it back through [unlifting](unlifting.html): scala> val tq"${name: TypeName}" = tq"Foo" name: universe.TypeName = Foo @@ -74,7 +74,7 @@ But semantically, such selections are just a shortcut for a combination of singl scala> val projected = tq"scala.type#Int" projected: universe.SelectFromTypeTree = scala.type#Int -Lastly and [similarly to expressions](/overviews/quasiquotes/expression-details.html#super-and-this) one can select members through `super` and `this`: +Lastly and [similarly to expressions](expression-details.html#super-and-this) one can select members through `super` and `this`: scala> val superbar = tq"super.Bar" superbar: universe.Select = super.Bar @@ -159,7 +159,7 @@ Alternatively there is also an underscrore notation: ## Tuple Type -[Similar to expressions](/overviews/quasiquotes/expression-details.html#tuple), tuple types are just syntactic sugar over `TupleN` classes: +[Similar to expressions](expression-details.html#tuple), tuple types are just syntactic sugar over `TupleN` classes: scala> val tup2 = tq"(A, B)" tup2: universe.Tree = scala.Tuple2[A, B] @@ -172,7 +172,7 @@ Analogously the `Unit` type is considered to be a nullary tuple: scala> val tq"(..$tpts)" = tq"_root_.scala.Unit" tpts: List[universe.Tree] = List() -It is important to mention that pattern matching a reference to `Unit` is limited to either fully the qualified path or a reference that contains symbols. (see [hygiene](/overviews/quasiquotes/hygiene.html)) +It is important to mention that pattern matching a reference to `Unit` is limited to either fully the qualified path or a reference that contains symbols. (see [hygiene](hygiene.html)) ## Function Type diff --git a/_overviews/quasiquotes/unlifting.md b/_overviews/quasiquotes/unlifting.md index 72dcc8c8f5..364dd77d97 100644 --- a/_overviews/quasiquotes/unlifting.md +++ b/_overviews/quasiquotes/unlifting.md @@ -13,7 +13,7 @@ permalink: /overviews/quasiquotes/:title.html --- **Denys Shabalin** EXPERIMENTAL -Unlifting is the reverse operation to [lifting](/overviews/quasiquotes/lifting.html): it takes a tree and recovers a value from it: +Unlifting is the reverse operation to [lifting](lifting.html): it takes a tree and recovers a value from it: trait Unliftable[T] { def unapply(tree: Tree): Option[T] @@ -73,11 +73,11 @@ Here one must pay attention to a few nuances: it is expected to return an instance of `T` unconditionally. 2. We've only define `Unliftable` for the runtime universe, it won't be available in macros. - (see [sharing liftable implementations](/overviews/quasiquotes/lifting.html#reusing-liftable-implementation-between-universes)) + (see [sharing liftable implementations](lifting.html#reusing-liftable-implementation-between-universes)) 3. Patterns used in this unliftable will only match a fully qualified reference to `Point` that starts with `_root_`. It won't match other possible shapes of the reference; they have - to be specified by hand. This problem is caused by a lack of [hygiene](/overviews/quasiquotes/hygiene.html). + to be specified by hand. This problem is caused by a lack of [hygiene](hygiene.html). 4. The pattern will only match trees that have literal `Int` arguments. It won't work for other expressions that might evaluate to `Int`. diff --git a/_overviews/reflection/annotations-names-scopes.md b/_overviews/reflection/annotations-names-scopes.md index e5bc6c266d..804fd100e2 100644 --- a/_overviews/reflection/annotations-names-scopes.md +++ b/_overviews/reflection/annotations-names-scopes.md @@ -142,7 +142,7 @@ an abstract syntax tree and an internal type tag to provide access to the type of the tree. `Expr`s are mainly used to simply and conveniently create typed abstract syntax trees for use in a macro. In most cases, this involves methods `reify` and `splice` (see the -[macros guide](http://docs.scala-lang.org/overviews/macros/overview.html) for details). +[macros guide]({{ site.baseurl }}/overviews/macros/overview.html) for details). ## Flags and flag sets diff --git a/_overviews/reflection/changelog211.md b/_overviews/reflection/changelog211.md index ab49dd7842..92c7f2e173 100644 --- a/_overviews/reflection/changelog211.md +++ b/_overviews/reflection/changelog211.md @@ -15,4 +15,4 @@ permalink: /overviews/reflection/:title.html **Eugene Burmako** -The page lives at [/overviews/macros/changelog211.html](/overviews/macros/changelog211.html). +The page lives at [/overviews/macros/changelog211.html]({{ site.baseurl }}/overviews/macros/changelog211.html). diff --git a/_overviews/scaladoc/for-library-authors.md b/_overviews/scaladoc/for-library-authors.md index cb5a733d0f..a0f3639d0d 100644 --- a/_overviews/scaladoc/for-library-authors.md +++ b/_overviews/scaladoc/for-library-authors.md @@ -196,4 +196,4 @@ Some of the standard markup available: ## More details on writing Scaladoc Further information on the formatting and style recommendations can be found in -[Scala-lang scaladoc style guide](http://docs.scala-lang.org/style/scaladoc.html). +[Scala-lang scaladoc style guide]({{ site.baseurl }}/style/scaladoc.html). diff --git a/_overviews/scaladoc/overview.md b/_overviews/scaladoc/overview.md index 3aa7de3d34..efe893b729 100644 --- a/_overviews/scaladoc/overview.md +++ b/_overviews/scaladoc/overview.md @@ -19,14 +19,14 @@ based on other comment based documentation systems like Javadoc. There are two flavors of Scaladoc documentation: - - **[Using the Scaladoc interface](/overviews/scaladoc/interface.html)** – how to navigate and use generated Scaladoc documentation to learn more about a library. - - **[Generating documentation for your library with Scaladoc](/overviews/scaladoc/for-library-authors.html)** – how to use Scaladoc to generate documentation for your library. + - **[Using the Scaladoc interface]({{ site.baseurl }}/overviews/scaladoc/interface.html)** – how to navigate and use generated Scaladoc documentation to learn more about a library. + - **[Generating documentation for your library with Scaladoc]({{ site.baseurl }}/overviews/scaladoc/for-library-authors.html)** – how to use Scaladoc to generate documentation for your library. ### Contributing to Scaladoc If you are interested in contributing to the API documentation of the Scala standard library (the documentation generated by Scaladoc), please read the -[Scaladoc for Library Authors](/overviews/scaladoc/basics.html) first. +[Scaladoc for Library Authors]({{ site.baseurl }}/overviews/scaladoc/basics.html) first. If you'd like to contribute to the actual Scaladoc documentation generation tool itself, then please see the diff --git a/_style/scaladoc.md b/_style/scaladoc.md index 6d21ca49f4..d173a80b11 100644 --- a/_style/scaladoc.md +++ b/_style/scaladoc.md @@ -51,7 +51,7 @@ In particular, text is aligned on a multiple of two columns, since Scala source is usually indented by two columns. See -[Scaladoc for Library Authors](/overviews/scaladoc/for-library-authors.html) +[Scaladoc for Library Authors]({{ site.baseurl }}/overviews/scaladoc/for-library-authors.html) for more technical info on formatting Scaladoc. ## General Style diff --git a/_tour/singleton-objects.md b/_tour/singleton-objects.md index 0ac90f1997..af76b4f90f 100644 --- a/_tour/singleton-objects.md +++ b/_tour/singleton-objects.md @@ -34,7 +34,7 @@ A singleton object can extend classes and traits. In fact, a [case class](case-c Most singleton objects do not stand alone, but instead are associated with a class of the same name. The “singleton object of the same name” of a case class, mentioned above, is an example of this. When this happens, the singleton object is called the *companion object* of the class, and the class is called the *companion class* of the object. -[Scaladoc](/style/scaladoc.html) has special support for jumping between a class and its companion: if the big “C” or “O” circle has its edge folded up at the bottom, you can click the circle to jump to the companion. +[Scaladoc]({{ site.baseurl }}/style/scaladoc.html) has special support for jumping between a class and its companion: if the big “C” or “O” circle has its edge folded up at the bottom, you can click the circle to jump to the companion. A class and its companion object, if any, must be defined in the same source file. Like this: diff --git a/_tour/tour-of-scala.md b/_tour/tour-of-scala.md index 0db0db67ae..5ec4d674b2 100644 --- a/_tour/tour-of-scala.md +++ b/_tour/tour-of-scala.md @@ -19,7 +19,7 @@ Scala is a modern multi-paradigm programming language designed to express common Scala is a pure object-oriented language in the sense that [every value is an object](unified-types.html). Types and behavior of objects are described by [classes](classes.html) and [traits](traits.html). Classes are extended by subclassing and a flexible [mixin-based composition](mixin-class-composition.html) mechanism as a clean replacement for multiple inheritance. ## Scala is functional ## -Scala is also a functional language in the sense that [every function is a value](unified-types.html). Scala provides a [lightweight syntax](basic.html#functions) for defining anonymous functions, it supports [higher-order functions](higher-order-functions.html), it allows functions to be [nested](nested-functions.html), and supports [currying](currying.html). Scala's [case classes](case-classes.html) and its built-in support for [pattern matching](pattern-matching.html) model algebraic types used in many functional programming languages. [Singleton objects](singleton-objects.html) provide a convenient way to group functions that aren't members of a class. +Scala is also a functional language in the sense that [every function is a value](unified-types.html). Scala provides a [lightweight syntax](basics.html#functions) for defining anonymous functions, it supports [higher-order functions](higher-order-functions.html), it allows functions to be [nested](nested-functions.html), and supports [currying](currying.html). Scala's [case classes](case-classes.html) and its built-in support for [pattern matching](pattern-matching.html) model algebraic types used in many functional programming languages. [Singleton objects](singleton-objects.html) provide a convenient way to group functions that aren't members of a class. Furthermore, Scala's notion of pattern matching naturally extends to the [processing of XML data](https://github.com/scala/scala-xml/wiki/XML-Processing) with the help of [right-ignoring sequence patterns](regular-expression-patterns.html), by way of general extension via [extractor objects](extractor-objects.html). In this context, [for comprehensions](for-comprehensions.html) are useful for formulating queries. These features make Scala ideal for developing applications like web services. diff --git a/contribute.md b/contribute.md index 2ce673eb56..6d8866e325 100644 --- a/contribute.md +++ b/contribute.md @@ -124,7 +124,7 @@ At the moment, a tutorial that can be logically placed on **one** page must be p title: YOUR TITLE --- -If you have a **multiple-page** tutorial, like in the case of multiple-page overviews, you must both specify an ordering for your document, and a name must be assigned to the collection of tutorial pages. For example, the following header is used for the [Tour of Scala]({{ site.baseurl }}/tutorials) series of tutorial articles: +If you have a **multiple-page** tutorial, like in the case of multiple-page overviews, you must both specify an ordering for your document, and a name must be assigned to the collection of tutorial pages. For example, the following header is used for the [Tour of Scala]({{ site.baseurl }}/tour/tour-of-scala.html) series of tutorial articles: --- layout: inner-page-no-masthead diff --git a/reference.md b/reference.md index 06e00783bc..b4eda7cc83 100644 --- a/reference.md +++ b/reference.md @@ -7,8 +7,8 @@ includeTOC: true --- ## Quick Reference -* [Glossary](/glossary/) of Scala terms -* [Cheatsheet](/cheatsheets/) for syntax. This can be useful for quickly picking up the syntax once you understand the basics of the language. +* [Glossary]({{ site.baseurl }}/glossary/) of Scala terms +* [Cheatsheet]({{ site.baseurl }}/cheatsheets/) for syntax. This can be useful for quickly picking up the syntax once you understand the basics of the language. ## Search the API The searchable API docs below are an invaluable resource as you make use of the Scala libraries. For newcomers to Scala, start with the [Standard Library API for 2.12.2](http://www.scala-lang.org/api/2.12.2/).