rust/src/librustdoc/html/layout.rs

use std::path::PathBuf;

use crate::externalfiles::ExternalHtml;
use crate::html::render::ensure_trailing_slash;
use crate::html::format::{Buffer, Print};

#[derive(Clone)]
pub struct Layout {
    pub logo: String,
    pub favicon: String,
    pub external_html: ExternalHtml,
    pub krate: String,
    /// The given user css file which allow to customize the generated
    /// documentation theme.
    pub css_file_extension: Option<PathBuf>,
    /// If false, the `select` element to have search filtering by crates on rendered docs
    /// won't be generated.
    pub generate_search_filter: bool,
}

pub struct Page<'a> {
    pub title: &'a str,
    pub css_class: &'a str,
    pub root_path: &'a str,
    pub static_root_path: Option<&'a str>,
    pub description: &'a str,
    pub keywords: &'a str,
    pub resource_suffix: &'a str,
    pub extra_scripts: &'a [&'a str],
    pub static_extra_scripts: &'a [&'a str],
}

pub fn render<T: Print, S: Print>(
    layout: &Layout,
    page: &Page<'_>,
    sidebar: S,
    t: T,
    themes: &[PathBuf],
) -> String {
    let static_root_path = page.static_root_path.unwrap_or(page.root_path);
    format!("<!DOCTYPE html>\
<html lang=\"en\">\
<head>\
    <meta charset=\"utf-8\">\
    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\
    <meta name=\"generator\" content=\"rustdoc\">\
    <meta name=\"description\" content=\"{description}\">\
    <meta name=\"keywords\" content=\"{keywords}\">\
    <title>{title}</title>\
    <link rel=\"stylesheet\" type=\"text/css\" href=\"{static_root_path}normalize{suffix}.css\">\
    <link rel=\"stylesheet\" type=\"text/css\" href=\"{static_root_path}rustdoc{suffix}.css\" \
          id=\"mainThemeStyle\">\
    {themes}\
    <link rel=\"stylesheet\" type=\"text/css\" href=\"{static_root_path}dark{suffix}.css\">\
    <link rel=\"stylesheet\" type=\"text/css\" href=\"{static_root_path}light{suffix}.css\" \
          id=\"themeStyle\">\
    <script src=\"{static_root_path}storage{suffix}.js\"></script>\
    <noscript><link rel=\"stylesheet\" href=\"{static_root_path}noscript{suffix}.css\"></noscript>\
    {css_extension}\
    {favicon}\
    {in_header}\
    <style type=\"text/css\">\
    #crate-search{{background-image:url(\"{static_root_path}down-arrow{suffix}.svg\");}}\
    </style>\
</head>\
<body class=\"rustdoc {css_class}\">\
    <!--[if lte IE 8]>\
    <div class=\"warning\">\
        This old browser is unsupported and will most likely display funky \
        things.\
    </div>\
    <![endif]-->\
    {before_content}\
    <nav class=\"sidebar\">\
        <div class=\"sidebar-menu\">&#9776;</div>\
        {logo}\
        {sidebar}\
    </nav>\
    <div class=\"theme-picker\">\
        <button id=\"theme-picker\" aria-label=\"Pick another theme!\">\
            <img src=\"{static_root_path}brush{suffix}.svg\" \
                 width=\"18\" \
                 alt=\"Pick another theme!\">\
        </button>\
        <div id=\"theme-choices\"></div>\
    </div>\
    <script src=\"{static_root_path}theme{suffix}.js\"></script>\
    <nav class=\"sub\">\
        <form class=\"search-form js-only\">\
            <div class=\"search-container\">\
                <div>{filter_crates}\
                    <input class=\"search-input\" name=\"search\" \
                           autocomplete=\"off\" \
                           spellcheck=\"false\" \
                           placeholder=\"Click or press ‘S’ to search, ‘?’ for more options…\" \
                           type=\"search\">\
                </div>\
                <a id=\"settings-menu\" href=\"{root_path}settings.html\">\
                    <img src=\"{static_root_path}wheel{suffix}.svg\" \
                         width=\"18\" \
                         alt=\"Change settings\">\
                </a>\
            </div>\
        </form>\
    </nav>\
    <section id=\"main\" class=\"content\">{content}</section>\
    <section id=\"search\" class=\"content hidden\"></section>\
    <section class=\"footer\"></section>\
    {after_content}\
    <script>\
        window.rootPath = \"{root_path}\";\
        window.currentCrate = \"{krate}\";\
    </script>\
    <script src=\"{root_path}aliases{suffix}.js\"></script>\
    <script src=\"{static_root_path}main{suffix}.js\"></script>\
    {static_extra_scripts}\
    {extra_scripts}\
    <script defer src=\"{root_path}search-index{suffix}.js\"></script>\
</body>\
</html>",
    css_extension = if layout.css_file_extension.is_some() {
        format!("<link rel=\"stylesheet\" \
                       type=\"text/css\" \
                       href=\"{static_root_path}theme{suffix}.css\">",
                static_root_path = static_root_path,
                suffix=page.resource_suffix)
    } else {
        String::new()
    },
    content   = Buffer::html().to_display(t),
    static_root_path = static_root_path,
    root_path = page.root_path,
    css_class = page.css_class,
    logo      = {
        let p = format!("{}{}", page.root_path, layout.krate);
        let p = ensure_trailing_slash(&p);
        if layout.logo.is_empty() {
            format!("<a href='{path}index.html'>\
                     <div class='logo-container'>\
                     <img src='{static_root_path}rust-logo{suffix}.png' alt='logo'></div></a>",
                    path=p,
                    static_root_path=static_root_path,
                    suffix=page.resource_suffix)
        } else {
            format!("<a href='{}index.html'>\
                     <div class='logo-container'><img src='{}' alt='logo'></div></a>",
                    p,
                    layout.logo)
        }
    },
    title     = page.title,
    description = page.description,
    keywords = page.keywords,
    favicon   = if layout.favicon.is_empty() {
        format!(r#"<link rel="shortcut icon" href="{static_root_path}favicon{suffix}.ico">"#,
                static_root_path=static_root_path,
                suffix=page.resource_suffix)
    } else {
        format!(r#"<link rel="shortcut icon" href="{}">"#, layout.favicon)
    },
    in_header = layout.external_html.in_header,
    before_content = layout.external_html.before_content,
    after_content = layout.external_html.after_content,
    sidebar   = Buffer::html().to_display(sidebar),
    krate     = layout.krate,
    themes = themes.iter()
                   .filter_map(|t| t.file_stem())
                   .filter_map(|t| t.to_str())
                   .map(|t| format!(r#"<link rel="stylesheet" type="text/css" href="{}{}{}.css">"#,
                                    static_root_path,
                                    t,
                                    page.resource_suffix))
                   .collect::<String>(),
    suffix=page.resource_suffix,
    static_extra_scripts=page.static_extra_scripts.iter().map(|e| {
        format!("<script src=\"{static_root_path}{extra_script}.js\"></script>",
                static_root_path=static_root_path,
                extra_script=e)
    }).collect::<String>(),
    extra_scripts=page.extra_scripts.iter().map(|e| {
        format!("<script src=\"{root_path}{extra_script}.js\"></script>",
                root_path=page.root_path,
                extra_script=e)
    }).collect::<String>(),
    filter_crates=if layout.generate_search_filter {
        "<select id=\"crate-search\">\
            <option value=\"All crates\">All crates</option>\
        </select>"
    } else {
        ""
    },
    )
}

pub fn redirect(url: &str) -> String {
    // <script> triggers a redirect before refresh, so this is fine.
    format!(
r##"<!DOCTYPE html>
<html lang="en">
<head>
    <meta http-equiv="refresh" content="0;URL={url}">
</head>
<body>
    <p>Redirecting to <a href="{url}">{url}</a>...</p>
    <script>location.replace("{url}" + location.search + location.hash);</script>
</body>
</html>"##,
    url = url,
    )
}
-												Fasten even more theme switch

											
										
										
											2018-01-23 00:45:34 +01:00
+								use std::path::PathBuf;
-												Implement a web backend for rustdoc_ng

This large commit implements and `html` output option for rustdoc_ng. The
executable has been altered to be invoked as "rustdoc_ng html <crate>" and
it will dump everything into the local "doc" directory. JSON can still be
generated by changing 'html' to 'json'.

This also fixes a number of bugs in rustdoc_ng relating to comment stripping,
along with some other various issues that I found along the way.

The `make doc` command has been altered to generate the new documentation into
the `doc/ng/$(CRATE)` directories.

											
										
										
											2013-09-18 22:18:38 -07:00
-												Transition librustdoc to 2018 edition

											
										
										
											2019-02-23 16:40:07 +09:00
+								use crate::externalfiles::ExternalHtml;
-												Replace SlashChecker with ensure_trailing_slash

											
										
										
											2019-09-13 09:26:11 -04:00
+								use crate::html::render::ensure_trailing_slash;
-												Move sidebar to Buffer-printing

											
										
										
											2019-08-31 09:07:29 -04:00
+								use crate::html::format::{Buffer, Print};
-												Fix image link in the settings menu

											
										
										
											2019-01-31 15:42:45 +01:00
-												sed -i -s 's/#\[deriving(/#\[derive(/g' **/*.rs

											
										
										
											2015-01-03 22:54:18 -05:00
+								#[derive(Clone)]
-												Implement a web backend for rustdoc_ng

This large commit implements and `html` output option for rustdoc_ng. The
executable has been altered to be invoked as "rustdoc_ng html <crate>" and
it will dump everything into the local "doc" directory. JSON can still be
generated by changing 'html' to 'json'.

This also fixes a number of bugs in rustdoc_ng relating to comment stripping,
along with some other various issues that I found along the way.

The `make doc` command has been altered to generate the new documentation into
the `doc/ng/$(CRATE)` directories.

											
										
										
											2013-09-18 22:18:38 -07:00
+								pub struct Layout {
-												core: rename strbuf::StrBuf to string::String

[breaking-change]

											
										
										
											2014-05-22 16:57:53 -07:00
+								    pub logo: String,
 								    pub favicon: String,
-												Allow external html in rustdoc for crates.

Updated documentation to reflect md->html.
Modularized external file loading.

											
										
										
											2014-06-28 03:35:25 -07:00
+								    pub external_html: ExternalHtml,
-												core: rename strbuf::StrBuf to string::String

[breaking-change]

											
										
										
											2014-05-22 16:57:53 -07:00
+								    pub krate: String,
-												Move constant parameters to render to Layout struct

											
										
										
											2019-08-30 10:51:13 -04:00
+								    /// The given user css file which allow to customize the generated
 								    /// documentation theme.
 								    pub css_file_extension: Option<PathBuf>,
 								    /// If false, the `select` element to have search filtering by crates on rendered docs
 								    /// won't be generated.
 								    pub generate_search_filter: bool,
-												Implement a web backend for rustdoc_ng

This large commit implements and `html` output option for rustdoc_ng. The
executable has been altered to be invoked as "rustdoc_ng html <crate>" and
it will dump everything into the local "doc" directory. JSON can still be
generated by changing 'html' to 'json'.

This also fixes a number of bugs in rustdoc_ng relating to comment stripping,
along with some other various issues that I found along the way.

The `make doc` command has been altered to generate the new documentation into
the `doc/ng/$(CRATE)` directories.

											
										
										
											2013-09-18 22:18:38 -07:00
+								}
-												Make 'self lifetime illegal.

Also remove all instances of 'self within the codebase.

This fixes #10889.

											
										
										
											2013-12-09 23:16:18 -08:00
+								pub struct Page<'a> {
-												rustdoc: Switch field privacy as necessary

											
										
										
											2014-03-28 10:27:24 -07:00
+								    pub title: &'a str,
-												rustdoc: refactoring and tidying up

pulled out of #35020

											
										
										
											2016-08-03 13:14:59 +12:00
+								    pub css_class: &'a str,
-												rustdoc: Switch field privacy as necessary

											
										
										
											2014-03-28 10:27:24 -07:00
+								    pub root_path: &'a str,
-												new --static-root-path flag for controlling static file locations

											
										
										
											2018-12-20 10:18:45 -06:00
+								    pub static_root_path: Option<&'a str>,
-												rustdoc: Emit keywords for all crate pages

cc #12466

											
										
										
											2014-08-04 14:30:06 -07:00
+								    pub description: &'a str,
-												Add --extend-css option to rustdoc

											
										
										
											2016-03-13 15:36:01 +01:00
+								    pub keywords: &'a str,
-												Add resource-suffix option for rustdoc

											
										
										
											2018-02-24 19:14:36 +01:00
+								    pub resource_suffix: &'a str,
-												split extra_scripts to handle root_path shenanigans

											
										
										
											2018-12-20 10:57:03 -06:00
+								    pub extra_scripts: &'a [&'a str],
 								    pub static_extra_scripts: &'a [&'a str],
-												Implement a web backend for rustdoc_ng

This large commit implements and `html` output option for rustdoc_ng. The
executable has been altered to be invoked as "rustdoc_ng html <crate>" and
it will dump everything into the local "doc" directory. JSON can still be
generated by changing 'html' to 'json'.

This also fixes a number of bugs in rustdoc_ng relating to comment stripping,
along with some other various issues that I found along the way.

The `make doc` command has been altered to generate the new documentation into
the `doc/ng/$(CRATE)` directories.

											
										
										
											2013-09-18 22:18:38 -07:00
+								}
-												layout::render takes Print instead of fmt::Display

											
										
										
											2019-08-31 12:18:25 -04:00
+								pub fn render<T: Print, S: Print>(
-												Add no-crate filter option on rustdoc

											
										
										
											2018-12-20 13:28:55 +01:00
+								    layout: &Layout,
-												Transition librustdoc to 2018 edition

											
										
										
											2019-02-23 16:40:07 +09:00
+								    page: &Page<'_>,
-												Implement Print for FnOnce(&mut Buffer)

This means that callers can pass in a closure like
`|buf| some_function(..., &mut buf)` and pass in arbitrary arguments to
that function without complicating the trait definition. We also keep
the impl for str and String, since it's useful to be able to just pass
in "" or format!("{}"...) results in some cases.

This changes Print's definition to take self, instead of &self, because
otherwise FnOnce cannot be called directly. We could instead take FnMut
or even Fn, but that seems like it'd merely complicate matters -- most
of the time, the FnOnce does not constrain us at all anyway. If it does,
a custom Print impl for &'_ SomeStruct is not all that painful.

											
										
										
											2019-08-31 11:22:51 -04:00
+								    sidebar: S,
-												layout::render takes Print instead of fmt::Display

											
										
										
											2019-08-31 12:18:25 -04:00
+								    t: T,
-												Add no-crate filter option on rustdoc

											
										
										
											2018-12-20 13:28:55 +01:00
+								    themes: &[PathBuf],
-												Create buffers in top-level rendering

This avoids needlessly creating and threading the buffers through when
we only use them once.

											
										
										
											2019-08-30 10:35:14 -04:00
+								) -> String {
-												new --static-root-path flag for controlling static file locations

											
										
										
											2018-12-20 10:18:45 -06:00
+								    let static_root_path = page.static_root_path.unwrap_or(page.root_path);
-												Remove unnecessary Buffer in layout::render

											
										
										
											2019-08-31 08:52:04 -04:00
+								    format!("<!DOCTYPE html>\
-												Small size reduction

											
										
										
											2018-04-14 17:13:46 +02:00
+								<html lang=\"en\">\
 								<head>\
 								    <meta charset=\"utf-8\">\
 								    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\
 								    <meta name=\"generator\" content=\"rustdoc\">\
 								    <meta name=\"description\" content=\"{description}\">\
 								    <meta name=\"keywords\" content=\"{keywords}\">\
 								    <title>{title}</title>\
-												new --static-root-path flag for controlling static file locations

											
										
										
											2018-12-20 10:18:45 -06:00
+								    <link rel=\"stylesheet\" type=\"text/css\" href=\"{static_root_path}normalize{suffix}.css\">\
 								    <link rel=\"stylesheet\" type=\"text/css\" href=\"{static_root_path}rustdoc{suffix}.css\" \
-												Small size reduction

											
										
										
											2018-04-14 17:13:46 +02:00
+								          id=\"mainThemeStyle\">\
 								    {themes}\
-												new --static-root-path flag for controlling static file locations

											
										
										
											2018-12-20 10:18:45 -06:00
+								    <link rel=\"stylesheet\" type=\"text/css\" href=\"{static_root_path}dark{suffix}.css\">\
 								    <link rel=\"stylesheet\" type=\"text/css\" href=\"{static_root_path}light{suffix}.css\" \
-												Small size reduction

											
										
										
											2018-04-14 17:13:46 +02:00
+								          id=\"themeStyle\">\
-												new --static-root-path flag for controlling static file locations

											
										
										
											2018-12-20 10:18:45 -06:00
+								    <script src=\"{static_root_path}storage{suffix}.js\"></script>\
 								    <noscript><link rel=\"stylesheet\" href=\"{static_root_path}noscript{suffix}.css\"></noscript>\
-												Small size reduction

											
										
										
											2018-04-14 17:13:46 +02:00
+								    {css_extension}\
 								    {favicon}\
 								    {in_header}\
-												Add arrow to the crate select box

											
										
										
											2018-11-29 01:29:49 +01:00
+								    <style type=\"text/css\">\
-												new --static-root-path flag for controlling static file locations

											
										
										
											2018-12-20 10:18:45 -06:00
+								    #crate-search{{background-image:url(\"{static_root_path}down-arrow{suffix}.svg\");}}\
-												Add arrow to the crate select box

											
										
										
											2018-11-29 01:29:49 +01:00
+								    </style>\
-												Small size reduction

											
										
										
											2018-04-14 17:13:46 +02:00
+								</head>\
 								<body class=\"rustdoc {css_class}\">\
 								    <!--[if lte IE 8]>\
 								    <div class=\"warning\">\
 								        This old browser is unsupported and will most likely display funky \
 								        things.\
 								    </div>\
 								    <![endif]-->\
 								    {before_content}\
 								    <nav class=\"sidebar\">\
 								        <div class=\"sidebar-menu\">&#9776;</div>\
 								        {logo}\
 								        {sidebar}\
 								    </nav>\
 								    <div class=\"theme-picker\">\
 								        <button id=\"theme-picker\" aria-label=\"Pick another theme!\">\
-												new --static-root-path flag for controlling static file locations

											
										
										
											2018-12-20 10:18:45 -06:00
+								            <img src=\"{static_root_path}brush{suffix}.svg\" \
 								                 width=\"18\" \
 								                 alt=\"Pick another theme!\">\
-												Small size reduction

											
										
										
											2018-04-14 17:13:46 +02:00
+								        </button>\
 								        <div id=\"theme-choices\"></div>\
 								    </div>\
-												new --static-root-path flag for controlling static file locations

											
										
										
											2018-12-20 10:18:45 -06:00
+								    <script src=\"{static_root_path}theme{suffix}.js\"></script>\
-												Small size reduction

											
										
										
											2018-04-14 17:13:46 +02:00
+								    <nav class=\"sub\">\
 								        <form class=\"search-form js-only\">\
 								            <div class=\"search-container\">\
-												Add no-crate filter option on rustdoc

											
										
										
											2018-12-20 13:28:55 +01:00
+								                <div>{filter_crates}\
-												Add crate filtering

											
										
										
											2018-10-01 00:47:54 +02:00
+								                    <input class=\"search-input\" name=\"search\" \
 								                           autocomplete=\"off\" \
 								                           spellcheck=\"false\" \
 								                           placeholder=\"Click or press ‘S’ to search, ‘?’ for more options…\" \
 								                           type=\"search\">\
 								                </div>\
-												Add rustdoc settings menu

											
										
										
											2018-04-13 22:54:09 +02:00
+								                <a id=\"settings-menu\" href=\"{root_path}settings.html\">\
-												new --static-root-path flag for controlling static file locations

											
										
										
											2018-12-20 10:18:45 -06:00
+								                    <img src=\"{static_root_path}wheel{suffix}.svg\" \
 								                         width=\"18\" \
 								                         alt=\"Change settings\">\
-												Add rustdoc settings menu

											
										
										
											2018-04-13 22:54:09 +02:00
+								                </a>\
-												Small size reduction

											
										
										
											2018-04-14 17:13:46 +02:00
+								            </div>\
 								        </form>\
 								    </nav>\
 								    <section id=\"main\" class=\"content\">{content}</section>\
 								    <section id=\"search\" class=\"content hidden\"></section>\
 								    <section class=\"footer\"></section>\
 								    {after_content}\
 								    <script>\
 								        window.rootPath = \"{root_path}\";\
 								        window.currentCrate = \"{krate}\";\
 								    </script>\
-												Apply resource-suffix to search-index and source-files scripts as well

											
										
										
											2019-04-07 18:09:28 +02:00
+								    <script src=\"{root_path}aliases{suffix}.js\"></script>\
-												new --static-root-path flag for controlling static file locations

											
										
										
											2018-12-20 10:18:45 -06:00
+								    <script src=\"{static_root_path}main{suffix}.js\"></script>\
-												split extra_scripts to handle root_path shenanigans

											
										
										
											2018-12-20 10:57:03 -06:00
+								    {static_extra_scripts}\
-												Add source file sidebar

											
										
										
											2018-11-06 01:40:12 +01:00
+								    {extra_scripts}\
-												Apply resource-suffix to search-index and source-files scripts as well

											
										
										
											2019-04-07 18:09:28 +02:00
+								    <script defer src=\"{root_path}search-index{suffix}.js\"></script>\
-												Small size reduction

											
										
										
											2018-04-14 17:13:46 +02:00
+								</body>\
 								</html>",
-												Move constant parameters to render to Layout struct

											
										
										
											2019-08-30 10:51:13 -04:00
+								    css_extension = if layout.css_file_extension.is_some() {
-												new --static-root-path flag for controlling static file locations

											
										
										
											2018-12-20 10:18:45 -06:00
+								        format!("<link rel=\"stylesheet\" \
 								                       type=\"text/css\" \
 								                       href=\"{static_root_path}theme{suffix}.css\">",
 								                static_root_path = static_root_path,
-												Add resource-suffix option for rustdoc

											
										
										
											2018-02-24 19:14:36 +01:00
+								                suffix=page.resource_suffix)
-												Add --extend-css option to rustdoc

											
										
										
											2016-03-13 15:36:01 +01:00
+								    } else {
-												use String::new() instead of String::from(""), "".to_string(), "".to_owned() or "".into()

											
										
										
											2018-08-23 10:14:52 +02:00
+								        String::new()
-												Add --extend-css option to rustdoc

											
										
										
											2016-03-13 15:36:01 +01:00
+								    },
-												layout::render takes Print instead of fmt::Display

											
										
										
											2019-08-31 12:18:25 -04:00
+								    content   = Buffer::html().to_display(t),
-												new --static-root-path flag for controlling static file locations

											
										
										
											2018-12-20 10:18:45 -06:00
+								    static_root_path = static_root_path,
-												Implement a web backend for rustdoc_ng

This large commit implements and `html` output option for rustdoc_ng. The
executable has been altered to be invoked as "rustdoc_ng html <crate>" and
it will dump everything into the local "doc" directory. JSON can still be
generated by changing 'html' to 'json'.

This also fixes a number of bugs in rustdoc_ng relating to comment stripping,
along with some other various issues that I found along the way.

The `make doc` command has been altered to generate the new documentation into
the `doc/ng/$(CRATE)` directories.

											
										
										
											2013-09-18 22:18:38 -07:00
+								    root_path = page.root_path,
-												rustdoc: refactoring and tidying up

pulled out of #35020

											
										
										
											2016-08-03 13:14:59 +12:00
+								    css_class = page.css_class,
-												Fix image link in the settings menu

											
										
										
											2019-01-31 15:42:45 +01:00
+								    logo      = {
 								        let p = format!("{}{}", page.root_path, layout.krate);
-												Replace SlashChecker with ensure_trailing_slash

											
										
										
											2019-09-13 09:26:11 -04:00
+								        let p = ensure_trailing_slash(&p);
-												Fix image link in the settings menu

											
										
										
											2019-01-31 15:42:45 +01:00
+								        if layout.logo.is_empty() {
 								            format!("<a href='{path}index.html'>\
-												Wrap logo in container to prevent layout reflow

											
										
										
											2019-04-27 15:09:57 +02:00
+								                     <div class='logo-container'>\
-												Fix image position and display

											
										
										
											2019-04-29 11:45:06 +02:00
+								                     <img src='{static_root_path}rust-logo{suffix}.png' alt='logo'></div></a>",
-												Fix image link in the settings menu

											
										
										
											2019-01-31 15:42:45 +01:00
+								                    path=p,
 								                    static_root_path=static_root_path,
 								                    suffix=page.resource_suffix)
 								        } else {
 								            format!("<a href='{}index.html'>\
-												Fix image position and display

											
										
										
											2019-04-29 11:45:06 +02:00
+								                     <div class='logo-container'><img src='{}' alt='logo'></div></a>",
-												Fix image link in the settings menu

											
										
										
											2019-01-31 15:42:45 +01:00
+								                    p,
 								                    layout.logo)
 								        }
-												std: Remove i18n/l10n from format!

* The select/plural methods from format strings are removed
* The # character no longer needs to be escaped
* The \-based escapes have been removed
* '{{' is now an escape for '{'
* '}}' is now an escape for '}'

Closes #14810
[breaking-change]

											
										
										
											2014-05-28 09:24:28 -07:00
+								    },
-												Implement a web backend for rustdoc_ng

This large commit implements and `html` output option for rustdoc_ng. The
executable has been altered to be invoked as "rustdoc_ng html <crate>" and
it will dump everything into the local "doc" directory. JSON can still be
generated by changing 'html' to 'json'.

This also fixes a number of bugs in rustdoc_ng relating to comment stripping,
along with some other various issues that I found along the way.

The `make doc` command has been altered to generate the new documentation into
the `doc/ng/$(CRATE)` directories.

											
										
										
											2013-09-18 22:18:38 -07:00
+								    title     = page.title,
-												rustdoc: Use more descriptive description metadata.

This text appears in and improves search results.

cc #12466

											
										
										
											2014-08-04 13:53:33 -07:00
+								    description = page.description,
-												rustdoc: Emit keywords for all crate pages

cc #12466

											
										
										
											2014-08-04 14:30:06 -07:00
+								    keywords = page.keywords,
-												Positive case of `len()` -> `is_empty()`

`s/(?<!\{ self)(?<=\.)len\(\) == 0/is_empty()/g`

											
										
										
											2015-03-24 16:53:34 -07:00
+								    favicon   = if layout.favicon.is_empty() {
-												Add default favicon for documentation

											
										
										
											2019-01-12 22:27:09 +01:00
+								        format!(r#"<link rel="shortcut icon" href="{static_root_path}favicon{suffix}.ico">"#,
 								                static_root_path=static_root_path,
 								                suffix=page.resource_suffix)
-												std: Remove i18n/l10n from format!

* The select/plural methods from format strings are removed
* The # character no longer needs to be escaped
* The \-based escapes have been removed
* '{{' is now an escape for '{'
* '}}' is now an escape for '}'

Closes #14810
[breaking-change]

											
										
										
											2014-05-28 09:24:28 -07:00
+								    } else {
 								        format!(r#"<link rel="shortcut icon" href="{}">"#, layout.favicon)
 								    },
-												Allow external html in rustdoc for crates.

Updated documentation to reflect md->html.
Modularized external file loading.

											
										
										
											2014-06-28 03:35:25 -07:00
+								    in_header = layout.external_html.in_header,
 								    before_content = layout.external_html.before_content,
 								    after_content = layout.external_html.after_content,
-												Move sidebar to Buffer-printing

											
										
										
											2019-08-31 09:07:29 -04:00
+								    sidebar   = Buffer::html().to_display(sidebar),
-												Replace `crate` usage with `krate`

This patch replaces all `crate` usage with `krate` before introducing the
new keyword. This ensures that after introducing the keyword, there
won't be any compilation errors.

krate might not be the most expressive substitution for crate but it's a
very close abbreviation for it. `module` was already used in several
places already.

											
										
										
											2014-02-05 22:15:24 +01:00
+								    krate     = layout.krate,
-												Fasten even more theme switch

											
										
										
											2018-01-23 00:45:34 +01:00
+								    themes = themes.iter()
 								                   .filter_map(|t| t.file_stem())
 								                   .filter_map(|t| t.to_str())
-												Add rustdoc settings menu

											
										
										
											2018-04-13 22:54:09 +02:00
+								                   .map(|t| format!(r#"<link rel="stylesheet" type="text/css" href="{}{}{}.css">"#,
-												new --static-root-path flag for controlling static file locations

											
										
										
											2018-12-20 10:18:45 -06:00
+								                                    static_root_path,
-												Add rustdoc settings menu

											
										
										
											2018-04-13 22:54:09 +02:00
+								                                    t,
 								                                    page.resource_suffix))
-												Fasten even more theme switch

											
										
										
											2018-01-23 00:45:34 +01:00
+								                   .collect::<String>(),
-												Add resource-suffix option for rustdoc

											
										
										
											2018-02-24 19:14:36 +01:00
+								    suffix=page.resource_suffix,
-												split extra_scripts to handle root_path shenanigans

											
										
										
											2018-12-20 10:57:03 -06:00
+								    static_extra_scripts=page.static_extra_scripts.iter().map(|e| {
 								        format!("<script src=\"{static_root_path}{extra_script}.js\"></script>",
 								                static_root_path=static_root_path,
 								                extra_script=e)
 								    }).collect::<String>(),
 								    extra_scripts=page.extra_scripts.iter().map(|e| {
-												Don't generate suffix for source-file.js

											
										
										
											2018-12-03 22:37:34 +01:00
+								        format!("<script src=\"{root_path}{extra_script}.js\"></script>",
-												Add source file sidebar

											
										
										
											2018-11-06 01:40:12 +01:00
+								                root_path=page.root_path,
-												Don't generate suffix for source-file.js

											
										
										
											2018-12-03 22:37:34 +01:00
+								                extra_script=e)
-												Add source file sidebar

											
										
										
											2018-11-06 01:40:12 +01:00
+								    }).collect::<String>(),
-												Move constant parameters to render to Layout struct

											
										
										
											2019-08-30 10:51:13 -04:00
+								    filter_crates=if layout.generate_search_filter {
-												Add no-crate filter option on rustdoc

											
										
										
											2018-12-20 13:28:55 +01:00
+								        "<select id=\"crate-search\">\
 								            <option value=\"All crates\">All crates</option>\
 								        </select>"
 								    } else {
 								        ""
 								    },
-												Remove unnecessary Buffer in layout::render

											
										
										
											2019-08-31 08:52:04 -04:00
+								    )
-												Implement a web backend for rustdoc_ng

This large commit implements and `html` output option for rustdoc_ng. The
executable has been altered to be invoked as "rustdoc_ng html <crate>" and
it will dump everything into the local "doc" directory. JSON can still be
generated by changing 'html' to 'json'.

This also fixes a number of bugs in rustdoc_ng relating to comment stripping,
along with some other various issues that I found along the way.

The `make doc` command has been altered to generate the new documentation into
the `doc/ng/$(CRATE)` directories.

											
										
										
											2013-09-18 22:18:38 -07:00
+								}
-												Create buffers in top-level rendering

This avoids needlessly creating and threading the buffers through when
we only use them once.

											
										
										
											2019-08-30 10:35:14 -04:00
+								pub fn redirect(url: &str) -> String {
-												rustdoc: Preserve query/fragment in redirects whenever possible.

We heavily rely on queries and fragments in the URL structure, so
it is desired to preserve them even in the redirects. The generated
redirect pages try to preserve them with scripts, which take
precedence over the original `Refresh` metadata. Non-scripting
browsers would continue to work (with no queries and fragments).

											
										
										
											2014-12-04 12:48:16 +09:00
+								    // <script> triggers a redirect before refresh, so this is fine.
-												Create buffers in top-level rendering

This avoids needlessly creating and threading the buffers through when
we only use them once.

											
										
										
											2019-08-30 10:35:14 -04:00
+								    format!(
-												rustdoc: Fix cross-crate links to reexported items

Cross crate links can target items which are not rendered in the documentation.
If the item is reexported at a higher level, the destination of the link (a
concatenation of the fully qualified name) may actually lead to nowhere. This
fixes this problem by altering rustdoc to emit pages which redirect to the local
copy of the reexported structure.

cc #14515
Closes #14137

											
										
										
											2014-05-29 13:50:47 -07:00
+								r##"<!DOCTYPE html>
 								<html lang="en">
 								<head>
 								    <meta http-equiv="refresh" content="0;URL={url}">
 								</head>
 								<body>
-												rustdoc: Preserve query/fragment in redirects whenever possible.

We heavily rely on queries and fragments in the URL structure, so
it is desired to preserve them even in the redirects. The generated
redirect pages try to preserve them with scripts, which take
precedence over the original `Refresh` metadata. Non-scripting
browsers would continue to work (with no queries and fragments).

											
										
										
											2014-12-04 12:48:16 +09:00
+								    <p>Redirecting to <a href="{url}">{url}</a>...</p>
 								    <script>location.replace("{url}" + location.search + location.hash);</script>
-												rustdoc: Fix cross-crate links to reexported items

Cross crate links can target items which are not rendered in the documentation.
If the item is reexported at a higher level, the destination of the link (a
concatenation of the fully qualified name) may actually lead to nowhere. This
fixes this problem by altering rustdoc to emit pages which redirect to the local
copy of the reexported structure.

cc #14515
Closes #14137

											
										
										
											2014-05-29 13:50:47 -07:00
+								</body>
 								</html>"##,
 								    url = url,
 								    )
 								}