]>
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.
14 use externalfiles
::ExternalHtml
;
20 pub external_html
: ExternalHtml
,
26 pub css_class
: &'a
str,
27 pub root_path
: &'a
str,
28 pub description
: &'a
str,
29 pub keywords
: &'a
str,
32 pub fn render
<T
: fmt
::Display
, S
: fmt
::Display
>(
33 dst
: &mut io
::Write
, layout
: &Layout
, page
: &Page
, sidebar
: &S
, t
: &T
,
34 css_file_extension
: bool
)
41 <meta charset="utf-8">
42 <meta name="viewport" content="width=device-width, initial-scale=1.0">
43 <meta name="generator" content="rustdoc">
44 <meta name="description" content="{description}">
45 <meta name="keywords" content="{keywords}">
47 <title>{title}</title>
49 <link rel="stylesheet" type="text/css" href="{root_path}rustdoc.css">
50 <link rel="stylesheet" type="text/css" href="{root_path}main.css">
56 <body class="rustdoc">
59 This old browser is unsupported and will most likely display funky
72 <form class="search-form js-only">
73 <div class="search-container">
74 <input class="search-input" name="search"
76 placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
82 <section id='main' class="content {css_class}">{content}</section>
83 <section id='search' class="content hidden"></section>
85 <section class="footer"></section>
87 <aside id="help" class="hidden">
89 <h1 class="hidden">Help</h1>
91 <div class="shortcuts">
92 <h2>Keyboard Shortcuts</h2>
96 <dd>Show this help dialog</dd>
98 <dd>Focus the search field</dd>
100 <dd>Move up in search results</dd>
102 <dd>Move down in search results</dd>
104 <dd>Go to active search result</dd>
106 <dd>Collapse/expand all sections</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}";
139 <script src="{root_path}jquery.js"></script>
140 <script src="{root_path}main.js"></script>
141 <script defer src="{root_path}search-index.js"></script>
144 css_extension
= if css_file_extension
{
145 format
!("<link rel=\"stylesheet\" type=\"text/css\" href=\"{root_path}theme.css\">",
146 root_path
= page
.root_path
)
151 root_path
= page
.root_path
,
152 css_class
= page
.css_class
,
153 logo
= if layout
.logo
.is_empty() {
156 format
!("<a href='{}{}/index.html'>\
157 <img src='{}' alt='logo' width='100'></a>",
158 page
.root_path
, layout
.krate
,
162 description
= page
.description
,
163 keywords
= page
.keywords
,
164 favicon
= if layout
.favicon
.is_empty() {
167 format
!(r
#"<link rel="shortcut icon" href="{}">"#, layout.favicon)
169 in_header
= layout
.external_html
.in_header
,
170 before_content
= layout
.external_html
.before_content
,
171 after_content
= layout
.external_html
.after_content
,
173 krate
= layout
.krate
,
177 pub fn redirect(dst
: &mut io
::Write
, url
: &str) -> io
::Result
<()> {
178 // <script> triggers a redirect before refresh, so this is fine.
183 <meta http-equiv="refresh" content="0;URL={url}">
186 <p>Redirecting to <a href="{url}">{url}</a>...</p>
187 <script>location.replace("{url}" + location.search + location.hash);</script>