]>
git.proxmox.com Git - rustc.git/blob - src/librustdoc/html/layout.rs
1 // Copyright 2013 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
12 use std
::io
::prelude
::*;
15 use externalfiles
::ExternalHtml
;
21 pub external_html
: ExternalHtml
,
23 pub playground_url
: String
,
29 pub root_path
: &'a
str,
30 pub description
: &'a
str,
31 pub keywords
: &'a
str,
34 pub fn render
<T
: fmt
::Display
, S
: fmt
::Display
>(
35 dst
: &mut io
::Write
, layout
: &Layout
, page
: &Page
, sidebar
: &S
, t
: &T
,
36 css_file_extension
: bool
)
43 <meta charset="utf-8">
44 <meta name="viewport" content="width=device-width, initial-scale=1.0">
45 <meta name="generator" content="rustdoc">
46 <meta name="description" content="{description}">
47 <meta name="keywords" content="{keywords}">
49 <title>{title}</title>
51 <link rel="stylesheet" type="text/css" href="{root_path}rustdoc.css">
52 <link rel="stylesheet" type="text/css" href="{root_path}main.css">
58 <body class="rustdoc">
61 This old browser is unsupported and will most likely display funky
74 <form class="search-form js-only">
75 <div class="search-container">
76 <input class="search-input" name="search"
78 placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
84 <section id='main' class="content {ty}">{content}</section>
85 <section id='search' class="content hidden"></section>
87 <section class="footer"></section>
89 <aside id="help" class="hidden">
91 <h1 class="hidden">Help</h1>
93 <div class="shortcuts">
94 <h2>Keyboard Shortcuts</h2>
98 <dd>Show this help dialog</dd>
100 <dd>Focus the search field</dd>
102 <dd>Move up in search results</dd>
104 <dd>Move down in search results</dd>
106 <dd>Go to active search result</dd>
111 <h2>Search Tricks</h2>
114 Prefix searches with a type followed by a colon (e.g.
115 <code>fn:</code>) to restrict the search to a given type.
119 Accepted types are: <code>fn</code>, <code>mod</code>,
120 <code>struct</code>, <code>enum</code>,
121 <code>trait</code>, <code>type</code>, <code>macro</code>,
122 and <code>const</code>.
126 Search functions by type signature (e.g.
127 <code>vec -> usize</code> or <code>* -> vec</code>)
136 window.rootPath = "{root_path}";
137 window.currentCrate = "{krate}";
138 window.playgroundUrl = "{play_url}";
140 <script src="{root_path}jquery.js"></script>
141 <script src="{root_path}main.js"></script>
143 <script defer src="{root_path}search-index.js"></script>
146 css_extension
= if css_file_extension
{
147 format
!("<link rel=\"stylesheet\" type=\"text/css\" href=\"{root_path}theme.css\">",
148 root_path
= page
.root_path
)
153 root_path
= page
.root_path
,
155 logo
= if layout
.logo
.is_empty() {
158 format
!("<a href='{}{}/index.html'>\
159 <img src='{}' alt='logo' width='100'></a>",
160 page
.root_path
, layout
.krate
,
164 description
= page
.description
,
165 keywords
= page
.keywords
,
166 favicon
= if layout
.favicon
.is_empty() {
169 format
!(r
#"<link rel="shortcut icon" href="{}">"#, layout.favicon)
171 in_header
= layout
.external_html
.in_header
,
172 before_content
= layout
.external_html
.before_content
,
173 after_content
= layout
.external_html
.after_content
,
175 krate
= layout
.krate
,
176 play_url
= layout
.playground_url
,
177 play_js
= if layout
.playground_url
.is_empty() {
180 format
!(r
#"<script src="{}playpen.js"></script>"#, page.root_path)
185 pub fn redirect(dst
: &mut io
::Write
, url
: &str) -> io
::Result
<()> {
186 // <script> triggers a redirect before refresh, so this is fine.
191 <meta http-equiv="refresh" content="0;URL={url}">
194 <p>Redirecting to <a href="{url}">{url}</a>...</p>
195 <script>location.replace("{url}" + location.search + location.hash);</script>