rwf2
/
Rocket
mirror of https://github.com/rwf2/Rocket.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve templates guide documentation.

This commit is contained in:
Sergio Benitez 2018-10-26 20:52:06 -07:00
parent ed15e6685d
commit 38536b58b5
3 changed files with 35 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
site/guide/5-responses.md
View File

@ -305,21 +305,11 @@ a template and a context to render the template with. The context can be any
type that implements `Serialize` and serializes into an `Object` value, such as type that implements `Serialize` and serializes into an `Object` value, such as
structs, `HashMaps`, and others. structs, `HashMaps`, and others.
Rocket searches for a template with the given name in the [configurable] For a template to be renderable, it must first be registered. The `Template`
`template_dir` directory. Templating support in Rocket is engine agnostic. The fairing automatically registers all discoverable templates when attached.T he
engine used to render a template depends on the template file's extension. For [Fairings](../fairings) sections of the guide provides more information on
example, if a file ends with `.hbs`, Handlebars is used, while if a file ends fairings. To attach the template fairing, simply call
with `.tera`, Tera is used. `.attach(Template::fairing())` on an instance of `Rocket` as follows:
When your application is compiled in `debug` mode (without the `--release` flag
passed to `cargo`), templates are automatically reloaded when they are modified.
This means that you don't need to rebuild your application to observe template
changes: simply refresh! In release builds, reloading is disabled.
For templates to be properly registered, the template fairing must be attached
to the instance of Rocket. The [Fairings](../fairings) sections of the guide
provides more information on fairings. To attach the template fairing, simply
call `.attach(Template::fairing())` on an instance of `Rocket` as follows:
```rust ```rust
fn main() { fn main() {
@ -329,24 +319,44 @@ fn main() {
} }
``` ```
Rocket discovers templates in the [configurable] `template_dir` directory.
Templating support in Rocket is engine agnostic. The engine used to render a
template depends on the template file's extension. For example, if a file ends
with `.hbs`, Handlebars is used, while if a file ends with `.tera`, Tera is
used.
! note: The name of the template _does not_ include its extension.
For a template file named `index.html.tera`, call `render("index")` and use
the name `"index"` in templates, i.e, `{% extends "index" %}` or `{% extends
"base" %}` for `base.html.tera`.
When your application is compiled in `debug` mode (without the `--release` flag
passed to `cargo`), templates are automatically reloaded when they are modified
on supported platforms. This means that you don't need to rebuild your
application to observe template changes: simply refresh! In release builds,
reloading is disabled.
The [`Template`] API documentation contains more information about templates, The [`Template`] API documentation contains more information about templates,
including how to customize a template engine to add custom helpers and filters. including how to customize a template engine to add custom helpers and filters.
The [Handlebars Templates example on GitHub](@example/handlebars_templates) is a The [Handlebars templates example](@example/handlebars_templates) is a
fully composed application that makes use of Handlebars templates. fully composed application that makes use of Handlebars templates, while the
[Tera templates example](@example/tera_templates) does the same for Tera.
[`Template`]: @api/rocket_contrib/templates/struct.Template.html [`Template`]: @api/rocket_contrib/templates/struct.Template.html
[configurable]: ../configuration/#extras [configurable]: ../configuration/#extras
## Typed URIs ## Typed URIs
Rocket's [`uri!`] macro allows you to build URIs routes in your application in a Rocket's [`uri!`] macro allows you to build URIs to routes in your application
robust, type-safe, and URI-safe manner. Type or route parameter mismatches are in a robust, type-safe, and URI-safe manner. Type or route parameter mismatches
caught at compile-time. are caught at compile-time.
The `uri!` returns an [`Origin`] structure with the URI of the supplied route The `uri!` macro returns an [`Origin`] structure with the URI of the supplied
interpolated with the given values. Note that `Origin` implements `Into<Uri>` route interpolated with the given values. Note that `Origin` implements
(and by extension, `TryInto<Uri>`), so it can be converted into a [`Uri`] using `Into<Uri>` (and by extension, `TryInto<Uri>`), so it can be converted into a
`.into()` as needed and passed into methods such as [`Redirect::to()`]. [`Uri`] using `.into()` as needed and passed into methods such as
[`Redirect::to()`].
For example, given the following route: For example, given the following route:

5
site/index.toml
View File

@ -2,11 +2,6 @@
# Top features: displayed in the header under the introductory text. # Top features: displayed in the header under the introductory text.
############################################################################### ###############################################################################
[release]
url = "https://crates.io/crates/rocket"
version = "0.4.0-dev"
date = "Jul 14, 2017"
[[top_features]] [[top_features]]
title = "Type Safe" title = "Type Safe"
text = "From request to response Rocket ensures that your types mean something." text = "From request to response Rocket ensures that your types mean something."

2
site/overview.toml
View File

@ -154,7 +154,7 @@ The `launch` call starts the server. In development, Rocket prints useful
information to the console to let you know everything is okay. information to the console to let you know everything is okay.
```sh ```sh
🚀 Rocket has launched from http://localhost:8000... 🚀 Rocket has launched from http://localhost:8000
``` ```
''' '''