Permalink
Browse files

Working on documentation for 1.2 release candidate

  • Loading branch information...
1 parent 82ed6fa commit d16138b9a18685abd1fea20f9061fcf5d045a941 @guillaumebort guillaumebort committed Apr 3, 2011
View
@@ -8,11 +8,11 @@ h2. Getting started
1. Install the latest version of Play framework and unzip it anywhere you want:
-bc. unzip play-1.1.zip -d /opt/play-1.1
+bc. unzip play-1.2.zip -d /opt/play-1.2
2. Add the **play** script to your PATH:
-bc. export PATH=$PATH:/opt/play-1.1
+bc. export PATH=$PATH:/opt/play-1.2
3. Create a new Play application:
@@ -17,9 +17,12 @@ Now you can import this route client side:
bc. <script type="text/javascript">
var listAction = #{jsAction @list(':search', ':size', ':page') /}
- $('#result').load(listAction({search: 'x', size: '10', page: '1'}), function() {
- $('#content').css('visibility', 'visible')
- })
+ $('#result').load(
+ listAction({search: 'x', size: '10', page: '1'}),
+ function() {
+ $('#content').css('visibility', 'visible')
+ }
+ )
</script>
In this example we are requesting the list method from the default Application controller. We are also passing three parameters: search, size and page. The request we perform is then saved into the listAction variable. Now using jQuery and the **load** function we are performing a request (an HTTP GET request in fact).
@@ -1,8 +1,8 @@
h1. Documentation
-Welcome to the play framework documentation. This documentation is intended for the *1.1 release* and may significantly differs from previous versions of the framework.
+Welcome to the play framework documentation. This documentation is intended for the *1.2 release* and may significantly differs from previous versions of the framework.
-Check the "version 1.1 release notes":releasenotes-1.1.
+Check the "version 1.2 release notes":releasenotes-1.2.
h2. <a name="started">Getting started</a>
@@ -17,13 +17,6 @@ Your first steps with Play and your first 5 minutes of fun.
# "Setting-up your preferred IDE":ide
# "Your first application — the ‘Hello World’ tutorial":firstapp
# "Sample applications":samples
-# "Live coding script - to practice, and impress your colleagues with":http://www.lunatech-research.fr/archives/2010/06/14/how-demo-play-framework-live-coding-script
-# "Play framework cheat sheets - Controllers":cheatsheet/controllers
-# "Play framework cheat sheets - Templates":cheatsheet/templates
-# "Play framework cheat sheets - Model":cheatsheet/model
-# "Play framework cheat sheets - Testing":cheatsheet/tests
-# "Play framework cheat sheets - Multi Environment":cheatsheet/multiEnvironment
-# "Play framework cheat sheets - Command Line":cheatsheet/commandLine
h2. <a name="guide">Tutorial -- Play guide, a real world app step-by-step</a>
@@ -93,37 +86,21 @@ Everything you need to know about Play.
## "Counting objects":jpa#counting
## "Explicit save":jpa#save
## "More about generic typing problems":jpa#typing
-# "Logging configuration":logs
-## "Logging from your application":logs#logging
-## "Configure log levels":logs#levels
-# "Configuration in several environments":ids
-## "The framework ID":ids#id
-## "Setting the framework ID from the command line":ids#command
-# "Testing the application":test
-## "Writing tests":test#writing
-## "Fixtures":test#fixtures
-## "Running the tests":test#running
-## "Continuous integration":test#continuous
-# "Dependency management":dependency
-## "Dependency format":dependency#format
-## "dependencies.yml":dependency#yml
-## "Conflicts resolution":dependency#conflicts
-## "Adding new repositories":dependency#repositories
-# "Deployment options":deployment
-## "Standalone Play application":deployment#standalone
-## "Running on JEE application servers":deployment#appservers
-## "Google Application Engine":deployment#gae
-## "Stax cloud hosting platform":deployment#stax
-# "Production deployment":production
-## "Configure your application.conf":production#application
-## "Configure logging":production#logging
-## "Set-up a front-end HTTP server":production#server
-# "Modules and the module repository":modules
-## "What is a module?":modules#what
-## "How to load a module from an application":modules#loading
-## "Load default routes from modules":modules#routes
-## "Using the module repository":modules#repository
-## "Contributing a new module to the module repository":modules#contributing
+# "Play libs":libs
+## "Parsing XML using XPath":libs#ParsingXMLusingXPath
+## "Web Service client":libs#WebServiceclient
+## "Functional programming with Java":libs#FunctionalprogrammingwithJava
+## "OAuth":libs#OAuth
+## "OpenID":libs#OpenID
+# "Asynchronous Jobs":jobs
+## "Bootstrap jobs":jobs#concepts
+## "Scheduled jobs":jobs#scheduling
+## "Triggering task jobs":jobs#taks
+# "Asynchronous programming with HTTP":asynchronous
+## "Suspending HTTP requests":asynchronous#suspendable
+## "Using WebSockets":asynchronous#websockets
+# "Ajax requests":ajax
+## "Making ajax requests with JQuery":ajax#jsaction
# "Internationalization":i18n
## "Only use UTF-8":i18n#utf8
## "Externalize your messages":i18n#messages
@@ -134,43 +111,82 @@ Everything you need to know about Play.
## "The cache API":cache#api
## "Don’t use the Session as a cache":cache#session
## "Configure memcached":cache#memcached
-# "Asynchronous execution using jobs":jobs
-## "Bootstrap jobs":jobs#concepts
-## "Scheduled jobs":jobs#scheduling
-## "Suspendable requests":jobs#suspendable
# "Sending e-mail":emails
## "Mail and MVC integration":emails#mvc
## "SMTP configuration":emails#smtp
## "More about configuration":emails#configuration
## "Using Gmail":emails#gmail
+# "Testing the application":test
+## "Writing tests":test#writing
+## "Fixtures":test#fixtures
+## "Running the tests":test#running
+## "Continuous integration":test#continuous
# "Security Guide":security
## "Sessions":security#sessions
## "Cross-Site Scripting":security#xss
## "SQL Injection":security#sql
## "Cross-Site Request Forgery":security#csrf
-# "Ajax with JQuery":ajax
-# "OpenID integration":openid
-# "OAuth integration":oauth
+# "Modules and the module repository":modules
+## "What is a module?":modules#what
+## "How to load a module from an application":modules#loading
+## "Load default routes from modules":modules#routes
+## "Using the module repository":modules#repository
+## "Contributing a new module to the module repository":modules#contributing
+# "Dependency management":dependency
+## "Dependency format":dependency#format
+## "dependencies.yml":dependency#yml
+## "Conflicts resolution":dependency#conflicts
+## "Adding new repositories":dependency#repositories
+# "Logging configuration":logs
+## "Logging from your application":logs#logging
+## "Configure log levels":logs#levels
+# "Configuration in several environments":ids
+## "The framework ID":ids#id
+## "Setting the framework ID from the command line":ids#command
+# "Managing your database evolutions":evolutions
+## "Evolutions scripts":evolutions#scripts
+## "Evolutions commands":evolutions#commands
+# "Production deployment":production
+## "Configure your application.conf":production#application
+## "Configure logging":production#logging
+## "Set-up a front-end HTTP server":production#server
+# "Deployment options":deployment
+## "Standalone Play application":deployment#standalone
+## "Running on JEE application servers":deployment#appservers
+## "Google Application Engine":deployment#gae
+## "Stax cloud hosting platform":deployment#stax
+h2. <a name="references">References</a>
+
+Extended references for day-to-day hacking.
+
+# "Quick index":index
+# "Browse API documentation (Javadoc)":/@api/index.html
+# "Cheat sheets":cheatsheet/commandLine
+## "Command Line":cheatsheet/commandLine
+## "Controllers":cheatsheet/controllers
+## "Templates":cheatsheet/templates
+## "Model":cheatsheet/model
+## "Testing":cheatsheet/tests
+## "Multi Environment":cheatsheet/multiEnvironment
+# "Built-in extensions":#
+## "Template tags":tags
+## "Java extensions":javaextensions
+## "Validations":validation-builtin
+
h2. <a name="modules">Distribution Modules</a>
These optional modules are included with the standard distribution. "More modules":http://www.playframework.org/modules.
# "CRUD":crud
# "Secure":secure
-h2. <a name="references">References</a>
-
-Extended references for day-to-day hacking.
-
-# "The missing cheat sheet":http://download.playframework.org/miscellaneous/play-cheat-sheet.pdf
-# "The ultimate Play cheat sheet":http://www.crionics.com/products/opensource/play/TheUltimatePlayCheatSheet.pdf
-# "Browse API documentation":/@api/index.html (Javadoc)
-# "Template tags and extensions reference":tags
-# "Java extensions":javaextensions
-# "Built-in validations":validation-builtin
-
h2. <a name="versionnotes">Version notes</a>
-New versions of Play include certain changes. Check release notes for "Play 1.1":releasenotes-1.1, "Play 1.0.3":releasenotes-1.0.3, "Play 1.0.2":releasenotes-1.0.2, and "Play 1.0.1":releasenotes-1.0.1.
+New versions of Play include certain changes. Check older release notes for:
+
+# "Play 1.1":releasenotes-1.1
+# "Play 1.0.3":releasenotes-1.0.3
+# "Play 1.0.2":releasenotes-1.0.2
+# "Play 1.0.1":releasenotes-1.0.1
@@ -0,0 +1,118 @@
+h1. Index
+
+Use this page to navigate quickly to a specific Play framework function.
+
+h2. Implicits Template variables
+
+<div class="index">
+# "errors":/@api/play/data/validation/Validation.html#errors%28%29
+# "flash":/@api/play/mvc/Scope.Flash.html
+# "lang":/@api/play/i18n/Lang.html
+# "messages":/@api/play/i18n/Messages.html
+# "out":http://download.oracle.com/javase/1.5.0/docs/api/java/io/PrintWriter.html
+# "params":/@api/play/mvc/Scope.Params.html
+# "play":/@api/play/Play.html
+# "request":/@api/play/mvc/Http.Request.html
+# "session":/@api/play/mvc/Scope.Session.html
+</div>
+
+h2. Built-in Tags
+
+<div class="index">
+# "a":tags#a
+# "doLayout":tags#doLayout
+# "else":tags#else
+# "elseif":tags#elseif
+# "errors":tags#errors
+# "ifError":tags#ifError
+# "ifErrors":tags#ifErrors
+# "extends":tags#extends
+# "field":tags#field
+# "form":tags#form
+# "get":tags#get
+# "i18n":tags#i18n
+# "if":tags#if
+# "ifnot":tags#ifnot
+# "include":tags#include
+# "jsAction":tags#jsAction
+# "list":tags#list
+# "option":tags#option
+# "select":tags#select
+# "set":tags#set
+# "stylesheet":tags#stylesheet
+# "verbatim":tags#verbatim
+</div>
+
+h2. Built-in Java Extensions
+
+<div class="index">
+# "Collection extensions":javaextensions#collection
+# "join(separator)":javaextensions#join
+# "pluralize()":javaextensions#pluralize
+# "pluralize(plural)":javaextensions#pluralize-plural
+# "pluralize(singular, plural)":javaextensions#pluralize-singular-plural
+# "Date extensions":javaextensions#date
+# "format(format)":javaextensions#format
+# "format(format, lang)":javaextensions#format-language
+# "since()":javaextensions#since
+# "since(condition)":javaextensions#since-condition
+# "Long extensions":javaextensions#long
+# "asdate(format)":javaextensions#asdate
+# "asdate(format, lang)":javaextensions#asdate-language
+# "formatSize()":javaextensions#formatSize
+# "Map extensions":javaextensions#map
+# "asAttr()":javaextensions#asAttr
+# "asAttr(condition)":javaextensions#asAttr-condition
+# "Number extensions":javaextensions#number
+# "divisibleBy(divisor)":javaextensions#number-divisibleBy
+# "format(format)":javaextensions#number-format
+# "formatCurrency(code)":javaextensions#number-formatCurrency
+# "page(pageSize)":javaextensions#number-page
+# "pluralize()":javaextensions#number-pluralize
+# "pluralize(plural)":javaextensions#number-pluralize-plural
+# "pluralize(singular, plural)":javaextensions#number-pluralize-singular-plural
+# "Object extensions":javaextensions#object
+# "addSlashes()":javaextensions#addSlashes
+# "capAll()":javaextensions#capAll
+# "capFirst()":javaextensions#capFirst
+# "cut(substring)":javaextensions#cut
+# "escape()":javaextensions#escape
+# "nl2br()":javaextensions#nl2br
+# "raw()":javaextensions#raw
+# "raw(condition)":javaextensions#raw-condition
+# "yesNo(‘yes’, ‘no’)":javaextensions#yesNo
+# "String extensions":javaextensions#string
+# "asXml()":javaextensions#asXml
+# "camelCase()":javaextensions#camelCase
+# "capitalizeWords()":javaextensions#capitalizeWords
+# "escapeHtml()":javaextensions#escapeHtml
+# "escapeJavaScript()":javaextensions#escapeJavaScript
+# "escapeXml()":javaextensions#escapeXml
+# "last()":javaextensions#last
+# "noAccents()":javaextensions#noAccents
+# "pad(length)":javaextensions#pad
+# "slugify()":javaextensions#slugify
+# "urlEncode()":javaextensions#urlEncode
+# "String array extensions":javaextensions#string-array
+# "add(value)":javaextensions#add
+# "contains(string)":javaextensions#contains
+# "remove(string) ":javaextensions#remove
+</div>
+
+h2. Built-in validation
+
+<div class="index">
+# "email":validation-builtin#email
+# "equals":validation-builtin#equals
+# "future":validation-builtin#future
+# "isTrue":validation-builtin#isTrue
+# "match":validation-builtin#match
+# "max":validation-builtin#max
+# "maxSize":validation-builtin#maxSize
+# "min":validation-builtin#min
+# "minSize":validation-builtin#minSize
+# "past":validation-builtin#past
+# "range":validation-builtin#range
+# "required":validation-builtin#required
+# "url":validation-builtin#url
+</div>
Oops, something went wrong.

0 comments on commit d16138b

Please sign in to comment.