Skip to content

Commit

Permalink
Added documentation validation task
Browse files Browse the repository at this point in the history
  • Loading branch information
jroper committed Apr 12, 2013
1 parent 7d3349b commit 80b6ccc
Show file tree
Hide file tree
Showing 81 changed files with 412 additions and 591 deletions.
3 changes: 3 additions & 0 deletions documentation/build
@@ -0,0 +1,3 @@
#! /bin/sh

../framework/build $@
4 changes: 2 additions & 2 deletions documentation/manual/Highlights.md
Expand Up @@ -128,7 +128,7 @@ GET / @controllers.Application.index()

Play will invoke the `getControllerInstance` method which in return will provide an instance of `controllers.Application` (by default this is happening via the default constructor). Therefore, if you want to manage controller class instantiation either via a dependency injection framework or manually you can do so by overriding getControllerInstance in your application’s Global class.

As this example [[demonstrates it|https://github.com/guillaumebort/play20-spring-demo]], it allows to wire any dependency injection framework such as __Spring__ into your Play application.
As this example [demonstrates it](https://github.com/guillaumebort/play20-spring-demo), it allows to wire any dependency injection framework such as __Spring__ into your Play application.

## New Scala JSON API

Expand Down Expand Up @@ -156,7 +156,7 @@ The `filters` project that is part of the standard Play distribution contain a s

## RequireJS

In play 2.0 the default behavior for Javascript was to use google closure's commonJS module support. In 2.1 this was changed to use [[requireJS|http://requirejs.org/]] instead.
In play 2.0 the default behavior for Javascript was to use google closure's commonJS module support. In 2.1 this was changed to use [requireJS](http://requirejs.org/) instead.

What this means in practice is that by default Play will only minify and combine files in stage, dist, start modes only. In dev mode Play will resolve dependencies client side.

Expand Down
17 changes: 11 additions & 6 deletions documentation/manual/Home.md
Expand Up @@ -15,7 +15,7 @@
1. [[Using the Play console | PlayConsole ]]
1. [[Setting up your preferred IDE | IDE]]
1. [[Sample applications | Samples]]
1. [[Security policy | http://www.playframework.com/code/security]]
1. [Security policy](http://www.playframework.com/code/security)

## Working with Play

Expand Down Expand Up @@ -49,11 +49,11 @@

## Additional documentation

1. [[Scala|http://docs.scala-lang.org/]]
1. [[Akka|http://akka.io/docs/]]
1. [[sbt|http://www.scala-sbt.org/learn.html]]
1. [[Configuration|https://github.com/typesafehub/config]]
1. [[Logback|http://logback.qos.ch/documentation.html]]
1. [Scala](http://docs.scala-lang.org/)
1. [Akka](http://akka.io/docs/)
1. [sbt](http://www.scala-sbt.org/learn.html)
1. [Configuration](https://github.com/typesafehub/config)
1. [Logback](http://logback.qos.ch/documentation.html)

## Hacking Play

Expand All @@ -63,6 +63,11 @@
1. [[Issue tracker | Issues]]
1. [[Contributor guidelines | Guidelines]]

## About Play

1. [[Play Philosophy|Philosophy]]
1. [[Play User Groups|PlayUserGroups]]

## Modules and plugins

1. [[Temporary modules directory | Modules]]
Expand Down
12 changes: 6 additions & 6 deletions documentation/manual/_Sidebar.md
Expand Up @@ -6,7 +6,7 @@
- [[Using the Play console | PlayConsole ]]
- [[Setting-up your preferred IDE | IDE]]
- [[Sample applications | Samples]]
- [[Security policy | http://www.playframework.com/code/security]]
- [Security policy](http://www.playframework.com/code/security)

### Working with Play

Expand All @@ -23,8 +23,8 @@

### Additional documentation

- [[Scala|http://docs.scala-lang.org/]]
- [[Akka|http://akka.io/docs/]]
- [[sbt|http://www.scala-sbt.org/learn.html]]
- [[Configuration|https://github.com/typesafehub/config]]
- [[Logback|http://logback.qos.ch/documentation.html]]
- [Scala](http://docs.scala-lang.org/)
- [Akka](http://akka.io/docs/)
- [sbt](http://www.scala-sbt.org/learn.html)
- [Configuration](https://github.com/typesafehub/config)
- [Logback](http://logback.qos.ch/documentation.html)
2 changes: 1 addition & 1 deletion documentation/manual/about/Philosophy.md
@@ -1,6 +1,6 @@
# Introducing Play 2.0

Since 2007, we have been working on making Java web application development easier. Play started as an internal project at [[Zenexity|http://www.zenexity.com]] and was heavily influenced by our way of doing web projects: focusing on developer productivity, respecting web architecture, and using a fresh approach to packaging conventions from the start - breaking so-called JEE best practices where it made sense.
Since 2007, we have been working on making Java web application development easier. Play started as an internal project at [Zenexity](http://www.zenexity.com) and was heavily influenced by our way of doing web projects: focusing on developer productivity, respecting web architecture, and using a fresh approach to packaging conventions from the start - breaking so-called JEE best practices where it made sense.

In 2009, we decided to share these ideas with the community as an open source project. The immediate feedback was extremely positive and the project gained a lot of traction. Today - after two years of active development - Play has several versions, an active community of 4,000 people, with a growing number of applications running in production all over the globe.

Expand Down
5 changes: 2 additions & 3 deletions documentation/manual/book/BookDetailledTopics.md
Expand Up @@ -11,7 +11,7 @@
1. [[Managing database evolutions | Evolutions]]
1. [[Configuration file syntax and features | Configuration]]
1. [[Configuring the JDBC connection pool | SettingsJDBC]]
1. [[Configuring the internal Akka system | AkkaCore]]
1. [[Configuring the thread pools | ThreadPools]]
1. [[Configuring logging | SettingsLogger]]
1. [[Deploying your application | Production]]
1. [[Creating a standalone version of your application | ProductionDist]]
Expand All @@ -23,5 +23,4 @@
1. [[CI server at Cloudbees | CIServer]]
1. [[Repositories | Repositories]]
1. [[Issue tracker | Issues]]
1. [[Pull requests | PullRequests]]
1. [[Contributor guidelines | Guidelines]]
1. [[Contributor guidelines | Guidelines]]
@@ -1,6 +1,6 @@
# Using CoffeeScript

[[CoffeeScript | http://jashkenas.github.com/coffee-script/]] is a small and elegant language that compiles into JavaScript. It provides a nicer syntax for writing JavaScript code.
[CoffeeScript](http://jashkenas.github.com/coffee-script/) is a small and elegant language that compiles into JavaScript. It provides a nicer syntax for writing JavaScript code.

Compiled assets in Play must be defined in the `app/assets` directory. They are handled by the build process, and CoffeeScript sources are compiled into standard JavaScript files. The generated JavaScript files are distributed as standard resources into the same `public/` folder as other unmanaged assets, meaning that there is no difference in the way you use them once compiled.

Expand Down Expand Up @@ -49,4 +49,4 @@ coffeescriptOptions := Seq("native", "/usr/local/bin/coffee -p")
By default, the JavaScript code is generated inside a top-level function safety wrapper, preventing it from polluting the global scope. The `bare` option removes this function wrapper.
> **Next:** [[Using LESS CSS | AssetsLess]]
> **Next:** [[Using LESS CSS | AssetsLess]]
4 changes: 2 additions & 2 deletions documentation/manual/detailledTopics/assets/AssetsLess.md
@@ -1,6 +1,6 @@
# Using LESS CSS

[[LESS CSS | http://lesscss.org/]] is a dynamic stylesheet language. It allows greater flexibility in the way you write CSS files: including support for variables, mixins and more.
[LESS CSS](http://lesscss.org/) is a dynamic stylesheet language. It allows greater flexibility in the way you write CSS files: including support for variables, mixins and more.

Compilable assets in Play must be defined in the `app/assets` directory. They are handled by the build process, and LESS sources are compiled into standard CSS files. The generated CSS files are distributed as standard resources into the same `public/` folder as the unmanaged assets, meaning that there is no difference in the way you use them once compiled.

Expand Down Expand Up @@ -67,4 +67,4 @@ For example, to compile `app/assets/stylesheets/main.less` and nothing else:
)
```

> **Next:** [[Using Google Closure Compiler | AssetsGoogleClosureCompiler]]
> **Next:** [[Using Google Closure Compiler | AssetsGoogleClosureCompiler]]
10 changes: 5 additions & 5 deletions documentation/manual/detailledTopics/assets/_Sidebar.md
Expand Up @@ -29,8 +29,8 @@

### Additional documentation

- [[Scala|http://docs.scala-lang.org/]]
- [[Akka|http://akka.io/docs/]]
- [[sbt|http://www.scala-sbt.org/learn.html]]
- [[Configuration|https://github.com/typesafehub/config]]
- [[Logback|http://logback.qos.ch/documentation.html]]
- [Scala](http://docs.scala-lang.org/)
- [Akka](http://akka.io/docs/)
- [sbt](http://www.scala-sbt.org/learn.html)
- [Configuration](https://github.com/typesafehub/config)
- [Logback](http://logback.qos.ch/documentation.html)
2 changes: 1 addition & 1 deletion documentation/manual/detailledTopics/build/Build.md
@@ -1,6 +1,6 @@
# The Build System

The Play build system is based on [[sbt|http://www.scala-sbt.org/]], a minimally non-intrusive build tool for Scala and Java projects.
The Play build system is based on [sbt](http://www.scala-sbt.org/), a minimally non-intrusive build tool for Scala and Java projects.

## The `/project` directory

Expand Down
Expand Up @@ -54,7 +54,7 @@ val appDependencies = Seq(

### Resolvers

Not all packages live on the same server; sbt uses the standard Maven2 repository and the Scala Tools Releases ([[http://scala-tools.org/repo-releases]]) repositories by default. If your dependency isn’t on one of the default repositories, you’ll have to add a resolver to help Ivy find it.
Not all packages live on the same server; sbt uses the standard Maven2 repository and the Scala Tools Releases (<http://scala-tools.org/repo-releases>) repositories by default. If your dependency isn’t on one of the default repositories, you’ll have to add a resolver to help Ivy find it.

Use the `resolvers` setting key to add your own resolver.

Expand Down
2 changes: 1 addition & 1 deletion documentation/manual/detailledTopics/build/SBTSettings.md
Expand Up @@ -2,7 +2,7 @@

## About sbt settings

The sbt build script defines settings for your project. You can also define your own custom settings for your project, as described in the [[sbt documentation | http://www.scala-sbt.org]]. In particular, it helps to be familiar with the [[settings | http://www.scala-sbt.org/release/docs/Getting-Started/More-About-Settings]] in sbt.
The sbt build script defines settings for your project. You can also define your own custom settings for your project, as described in the [sbt documentation](http://www.scala-sbt.org). In particular, it helps to be familiar with the [settings](http://www.scala-sbt.org/release/docs/Getting-Started/More-About-Settings) in sbt.

To set a basic setting, use the `:=` operator:

Expand Down
10 changes: 5 additions & 5 deletions documentation/manual/detailledTopics/build/_Sidebar.md
Expand Up @@ -28,8 +28,8 @@

### Additional documentations

- [[Scala|http://docs.scala-lang.org/]]
- [[Akka|http://akka.io/docs/]]
- [[sbt|http://www.scala-sbt.org/learn.html]]
- [[Configuration|https://github.com/typesafehub/config]]
- [[Logback|http://logback.qos.ch/documentation.html]]
- [Scala](http://docs.scala-lang.org/)
- [Akka](http://akka.io/docs/)
- [sbt](http://www.scala-sbt.org/learn.html)
- [Configuration](https://github.com/typesafehub/config)
- [Logback](http://logback.qos.ch/documentation.html)
@@ -1,6 +1,6 @@
# Configuration file syntax and features

> The configuration file used by Play is based on the [[Typesafe config library | https://github.com/typesafehub/config]].
> The configuration file used by Play is based on the [Typesafe config library](https://github.com/typesafehub/config).
The default configuration file of a Play 2.0 application must be defined in `conf/application.conf`. It uses the HOCON format ( "Human-Optimized Config Object Notation").

Expand Down
@@ -1,6 +1,6 @@
# Configuring the JDBC pool.

The Play JDBC datasource is managed by [[BoneCP | http://jolbox.com/]].
The Play JDBC datasource is managed by [BoneCP](http://jolbox.com/).

## Special URLs

Expand Down Expand Up @@ -91,4 +91,4 @@ db.default.logStatements=false

# The maximum connection age.
db.default.maxConnectionAge=1 hour
```
```
@@ -1,6 +1,6 @@
# Configuring logging

Play 2.0 uses [[logback | http://logback.qos.ch/]] as its logging engine.
Play 2.0 uses [logback](http://logback.qos.ch/) as its logging engine.

## Configuration logging level in application.conf

Expand Down
10 changes: 5 additions & 5 deletions documentation/manual/detailledTopics/configuration/_Sidebar.md
Expand Up @@ -28,8 +28,8 @@

### Additional documentations

- [[Scala|http://docs.scala-lang.org/]]
- [[Akka|http://akka.io/docs/]]
- [[sbt|http://www.scala-sbt.org/learn.html]]
- [[Configuration|https://github.com/typesafehub/config]]
- [[Logback|http://logback.qos.ch/documentation.html]]
- [Scala](http://docs.scala-lang.org/)
- [Akka](http://akka.io/docs/)
- [sbt](http://www.scala-sbt.org/learn.html)
- [Configuration](https://github.com/typesafehub/config)
- [Logback](http://logback.qos.ch/documentation.html)
6 changes: 3 additions & 3 deletions documentation/manual/detailledTopics/production/HTTPServer.md
Expand Up @@ -14,7 +14,7 @@ Note that using a front-end HTTP server will rarely give you better performance

## Set-up with lighttpd

This example shows you how to configure [[lighttpd | http://www.lighttpd.net/]] as a front-end web server. Note that you can do the same with Apache, but if you only need virtual hosting or load balancing, lighttpd is a very good choice and much easier to configure!
This example shows you how to configure [lighttpd](http://www.lighttpd.net/) as a front-end web server. Note that you can do the same with Apache, but if you only need virtual hosting or load balancing, lighttpd is a very good choice and much easier to configure!

The `/etc/lighttpd/lighttpd.conf` file should define things like this:

Expand All @@ -40,7 +40,7 @@ $HTTP["host"] =~ "www.loadbalancedapp.com" {

## Set-up with nginx

This example shows you how to configure [[nginx| http://wiki.nginx.org/Main]] as a front-end web server. Note that you can do the same with Apache, but if you only need virtual hosting or load balancing, nginx is a very good choice and much easier to configure!
This example shows you how to configure [nginx](http://wiki.nginx.org/Main) as a front-end web server. Note that you can do the same with Apache, but if you only need virtual hosting or load balancing, nginx is a very good choice and much easier to configure!

The `/etc/nginx/nginx.conf` file should define things like this:

Expand Down Expand Up @@ -80,7 +80,7 @@ http {
## Set-up with Apache

The example below shows a simple set-up with [[Apache httpd server | http://httpd.apache.org/]] running in front of a standard Play configuration.
The example below shows a simple set-up with [Apache httpd server](http://httpd.apache.org/) running in front of a standard Play configuration.

```
LoadModule proxy_module modules/mod_proxy.so
Expand Down
@@ -1,6 +1,6 @@
# Deploying to Heroku

[[Heroku | http://www.heroku.com/]] is a cloud application platform – a new way of building and deploying web apps.
[Heroku](http://www.heroku.com/) is a cloud application platform – a new way of building and deploying web apps.

To get started:

Expand Down Expand Up @@ -113,4 +113,4 @@ This instructs Heroku that for the process named `web` it will run Play and over
* [Optimizing Play 2 for Database-Driven Apps](http://www.jamesward.com/2012/06/25/optimizing-play-2-for-database-driven-apps)
* [Play 2 Scala Console on Heroku](http://www.jamesward.com/2012/06/11/play-2-scala-console-on-heroku)
* [Play 2 App with a Scheduled Job on Heroku](https://github.com/jamesward/play2-scheduled-job-demo)
* [Using Amazon S3 for File Uploads with Java and Play 2](https://devcenter.heroku.com/articles/using-amazon-s3-for-file-uploads-with-java-and-play-2)
* [Using Amazon S3 for File Uploads with Java and Play 2](https://devcenter.heroku.com/articles/using-amazon-s3-for-file-uploads-with-java-and-play-2)
10 changes: 5 additions & 5 deletions documentation/manual/detailledTopics/production/_Sidebar.md
Expand Up @@ -31,8 +31,8 @@

### Additional documentations

- [[Scala|http://docs.scala-lang.org/]]
- [[Akka|http://akka.io/docs/]]
- [[sbt|http://www.scala-sbt.org/learn.html]]
- [[Configuration|https://github.com/typesafehub/config]]
- [[Logback|http://logback.qos.ch/documentation.html]]
- [Scala](http://docs.scala-lang.org/)
- [Akka](http://akka.io/docs/)
- [sbt](http://www.scala-sbt.org/learn.html)
- [Configuration](https://github.com/typesafehub/config)
- [Logback](http://logback.qos.ch/documentation.html)
4 changes: 2 additions & 2 deletions documentation/manual/gettingStarted/Anatomy.md
Expand Up @@ -50,7 +50,7 @@ You can of course add your own packages, for example an `app/utils` package.

> Note that in Play, the controllers, models and views package name conventions are now just that and can be changed if needed (such as prefixing everything with `com.yourcompany`).
There is also an optional directory called `app/assets` for compiled assets such as [[LESS sources | http://lesscss.org/]] and [[CoffeeScript sources | http://jashkenas.github.com/coffee-script/]].
There is also an optional directory called `app/assets` for compiled assets such as [LESS sources](http://lesscss.org/) and [CoffeeScript sources](http://jashkenas.github.com/coffee-script/).

## The public/ directory

Expand Down Expand Up @@ -106,4 +106,4 @@ dist
.cache
```

> **Next:** [[Using the Play console | PlayConsole ]]
> **Next:** [[Using the Play console | PlayConsole ]]
4 changes: 2 additions & 2 deletions documentation/manual/gettingStarted/Installing.md
Expand Up @@ -2,7 +2,7 @@

## Prerequisites

To run the Play framework, you need [[JDK 6 or later| http://www.oracle.com/technetwork/java/javase/downloads/index.html]].
To run the Play framework, you need [JDK 6 or later](http://www.oracle.com/technetwork/java/javase/downloads/index.html).

> If you are using MacOS, Java is built-in. If you are using Linux, make sure to use either the Sun JDK or OpenJDK (and not gcj, which is the default Java command on many Linux distros). If you are using Windows, just download and install the latest JDK package.
Expand All @@ -12,7 +12,7 @@ Be sure to have the `java` and `javac` commands in the current path (you can che

## Download the binary package

Download the latest [[Play binary package | http://www.playframework.com/download]] (take the latest official version) and extract the archive to a location where you have both read **and write** access. (Running `play` writes some files to directories within the archive, so don't install to `/opt`, `/usr/local` or anywhere else you’d need special permission to write to.)
Download the latest [Play binary package](http://www.playframework.com/download) (take the latest official version) and extract the archive to a location where you have both read **and write** access. (Running `play` writes some files to directories within the archive, so don't install to `/opt`, `/usr/local` or anywhere else you’d need special permission to write to.)

## Add the play script to your PATH

Expand Down
4 changes: 2 additions & 2 deletions documentation/manual/gettingStarted/NewApplication.md
Expand Up @@ -28,7 +28,7 @@ $ play

You can also create a new Play application without installing Play, by using sbt.

> First install [[sbt| http://www.scala-sbt.org/]] if needed.
> First install [sbt](http://www.scala-sbt.org/) if needed.
Just create a new directory for your new application and configure your sbt build script with two additions.

Expand Down Expand Up @@ -79,4 +79,4 @@ $ sbt

sbt will load your project and fetch the dependencies.

> **Next:** [[Anatomy of a Play application | Anatomy]]
> **Next:** [[Anatomy of a Play application | Anatomy]]
4 changes: 2 additions & 2 deletions documentation/manual/gettingStarted/Samples.md
Expand Up @@ -24,7 +24,7 @@ This is a classic CRUD application, backed by a JDBC database. It demonstrates:

- accessing a JDBC database, using Ebean in Java and Anorm in Scala
- table pagination and CRUD forms
- integrating with a CSS framework ([[Twitter Bootstrap | http://twitter.github.com/bootstrap/]]).
- integrating with a CSS framework ([Twitter Bootstrap](http://twitter.github.com/bootstrap/)).

Twitter Bootstrap requires a different form layout to the default layout provided by the Play 2.0 form helper, so this application also provides an example of integrating a custom form input constructor.

Expand Down Expand Up @@ -79,4 +79,4 @@ This mobile web application monitors Play server performance. It demonstrates:
> **Next:**
>
> [[Play for Scala developers | ScalaHome]]
> [[Play for Java developers | JavaHome]]
> [[Play for Java developers | JavaHome]]

0 comments on commit 80b6ccc

Please sign in to comment.