feat(templs): lots of sidebars

and fixes

Author: fiji-flo

Diff for: crates/rari-doc/src/helpers/subpages.rs

@@ -64,6 +64,7 @@ pub fn write_li_with_badges(
     out: &mut impl Write,
     page: &Page,
     locale: Locale,
+    closed: bool,
 ) -> Result<(), DocError> {
     let locale_page = if locale != Default::default() {
         &url_path_to_page_with_other_locale_and_fallback(page.url(), Some(locale))?
@@ -85,33 +86,54 @@ pub fn write_li_with_badges(
     if page.status().contains(&FeatureStatus::Deprecated) {
         write_deprecated(out, locale)?;
     }
-    Ok(write!(out, "</li>")?)
+    if closed {
+        write!(out, "</li>")?;
+    }
+    Ok(())
+}
+
+pub fn list_sub_pages_reverse_internal(
+    out: &mut String,
+    url: &str,
+    locale: Locale,
+    sorter: Option<SubPagesSorter>,
+    page_types: &[PageType],
+) -> Result<(), DocError> {
+    let sub_pages = get_sub_pages(url, Some(1), sorter.unwrap_or_default())?;
+
+    for sub_page in sub_pages {
+        if !page_types.is_empty() && !page_types.contains(&sub_page.page_type()) {
+            continue;
+        }
+        write_li_with_badges(out, &sub_page, locale, true)?;
+    }
+    Ok(())
 }
 
 pub fn list_sub_pages_internal(
-    out: &mut impl Write,
+    out: &mut String,
     url: &str,
     locale: Locale,
     depth: Option<usize>,
-    reverse: bool,
     sorter: Option<SubPagesSorter>,
     page_types: &[PageType],
 ) -> Result<(), DocError> {
-    let sub_pages = get_sub_pages(url, depth, sorter.unwrap_or_default())?;
+    let sub_pages = get_sub_pages(url, Some(1), sorter.unwrap_or_default())?;
 
-    if reverse {
-        for sub_page in sub_pages.into_iter().rev() {
-            if !page_types.is_empty() && !page_types.contains(&sub_page.page_type()) {
-                continue;
-            }
-            write_li_with_badges(out, &sub_page, locale)?;
+    let depth = depth.map(|i| i.saturating_sub(1));
+    for sub_page in sub_pages {
+        if !page_types.is_empty() && !page_types.contains(&sub_page.page_type()) {
+            continue;
         }
-    } else {
-        for sub_page in sub_pages {
-            if !page_types.is_empty() && !page_types.contains(&sub_page.page_type()) {
-                continue;
-            }
-            write_li_with_badges(out, &sub_page, locale)?;
+        let sub_sub_pages = get_sub_pages(sub_page.url(), depth, sorter.unwrap_or_default())?;
+        if sub_sub_pages.is_empty() {
+            write_li_with_badges(out, &sub_page, locale, true)?;
+        } else {
+            write_li_with_badges(out, &sub_page, locale, false)?;
+            out.push_str("<ol>");
+            list_sub_pages_internal(out, sub_page.url(), locale, depth, sorter, page_types)?;
+            out.push_str("</ol>");
+            out.push_str("</li>");
         }
     }
     Ok(())
@@ -154,7 +176,7 @@ pub fn list_sub_pages_grouped_internal(
             out.push_str("-*</summary><ol>");
         }
         for sub_page in group {
-            write_li_with_badges(out, sub_page, locale)?;
+            write_li_with_badges(out, sub_page, locale, true)?;
         }
         if keep_group {
             out.push_str("</ol></details></li>");

Diff for: crates/rari-doc/src/html/sidebar.rs

@@ -32,6 +32,12 @@ fn cache_side_bar(sidebar: &str) -> bool {
                 | "htmlsidebar"
                 | "accessibilitysidebar"
                 | "firefoxsidebar"
+                | "webassemblysidebar"
+                | "xsltsidebar"
+                | "mdnsidebar"
+                | "gamessidebar"
+                | "mathmlref"
+                | "pwasidebar"
         )
 }
 
@@ -203,6 +209,8 @@ pub struct BasicEntry {
     pub code: bool,
     #[serde(default)]
     pub children: Vec<SidebarEntry>,
+    #[serde(default)]
+    pub details: Details,
 }
 
 #[derive(Serialize, Deserialize, Default, Debug)]
@@ -214,7 +222,7 @@ pub struct SubPageEntry {
     #[serde(deserialize_with = "t_or_vec", default)]
     pub tags: Vec<PageType>,
     #[serde(default)]
-    pub details: bool,
+    pub details: Details,
 }
 
 #[derive(Serialize, Deserialize, Default, Debug)]
@@ -227,7 +235,6 @@ pub struct WebExtApiEntry {
 #[serde(rename_all = "camelCase", tag = "type")]
 pub enum SidebarEntry {
     Section(BasicEntry),
-    Details(BasicEntry),
     ListSubPages(SubPageEntry),
     ListSubPagesGrouped(SubPageEntry),
     WebExtApi(WebExtApiEntry),
@@ -265,7 +272,8 @@ impl Default for SidebarMetaEntryContent {
     }
 }
 
-#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
+#[derive(Serialize, Deserialize, Debug, Clone, Copy, Default, PartialEq, Eq)]
+#[serde(rename_all = "camelCase")]
 pub enum Details {
     #[default]
     None,
@@ -283,16 +291,6 @@ impl Details {
     }
 }
 
-impl From<bool> for Details {
-    fn from(value: bool) -> Self {
-        if value {
-            Self::Closed
-        } else {
-            Self::None
-        }
-    }
-}
-
 #[derive(Debug, Default)]
 pub struct SidebarMetaEntry {
     pub details: Details,
@@ -310,25 +308,10 @@ impl From<SidebarEntry> for SidebarMetaEntry {
                 title,
                 code,
                 children,
+                details,
             }) => SidebarMetaEntry {
                 section: true,
-                details: Details::None,
-                code,
-                content: SidebarMetaEntryContent::Link { link, title },
-                children: if children.is_empty() {
-                    MetaChildren::None
-                } else {
-                    MetaChildren::Children(children.into_iter().map(Into::into).collect())
-                },
-            },
-            SidebarEntry::Details(BasicEntry {
-                link,
-                title,
-                code,
-                children,
-            }) => SidebarMetaEntry {
-                section: false,
-                details: Details::Closed,
+                details,
                 code,
                 content: SidebarMetaEntryContent::Link { link, title },
                 children: if children.is_empty() {
@@ -345,7 +328,7 @@ impl From<SidebarEntry> for SidebarMetaEntry {
                 path,
             }) => SidebarMetaEntry {
                 section: false,
-                details: details.into(),
+                details,
                 code: false,
                 content: SidebarMetaEntryContent::Link { link, title },
                 children: MetaChildren::ListSubPages(path, tags),
@@ -358,7 +341,7 @@ impl From<SidebarEntry> for SidebarMetaEntry {
                 path,
             }) => SidebarMetaEntry {
                 section: false,
-                details: details.into(),
+                details,
                 code: false,
                 content: SidebarMetaEntryContent::Link { link, title },
                 children: MetaChildren::ListSubPagesGrouped(path, tags),
@@ -368,12 +351,17 @@ impl From<SidebarEntry> for SidebarMetaEntry {
                 title,
                 code,
                 children,
+                details,
             }) => SidebarMetaEntry {
                 section: false,
-                details: Details::None,
+                details,
                 code,
                 content: SidebarMetaEntryContent::Link { link, title },
-                children: MetaChildren::Children(children.into_iter().map(Into::into).collect()),
+                children: if children.is_empty() {
+                    MetaChildren::None
+                } else {
+                    MetaChildren::Children(children.into_iter().map(Into::into).collect())
+                },
             },
             SidebarEntry::Link(link) => SidebarMetaEntry {
                 section: false,
@@ -469,7 +457,7 @@ impl SidebarMetaEntry {
                 }
             }
             MetaChildren::ListSubPages(url, page_types) => {
-                list_sub_pages_internal(out, url, locale, Some(1), false, None, page_types)?
+                list_sub_pages_internal(out, url, locale, Some(1), None, page_types)?
             }
             MetaChildren::ListSubPagesGrouped(url, page_types) => {
                 list_sub_pages_grouped_internal(out, url, locale, None, page_types)?
@@ -495,3 +483,15 @@ impl SidebarMetaEntry {
         Ok(())
     }
 }
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    #[test]
+    fn test_details_ser() {
+        let yaml_str = r#"details: closed"#;
+        let entry: BasicEntry = serde_yaml::from_str(yaml_str).unwrap();
+        assert_eq!(entry.details, Details::Closed);
+    }
+}

Diff for: crates/rari-doc/src/templ/templs/listsubpages.rs

@@ -15,19 +15,35 @@ pub fn list_sub_pages(
     reverse: Option<AnyArg>,
     ordered: Option<AnyArg>,
 ) -> Result<String, DocError> {
+    let depth = depth.map(|d| d.as_int() as usize).unwrap_or(1);
     let url = url.as_deref().filter(|s| !s.is_empty()).unwrap_or(env.url);
     let ordered = ordered.as_ref().map(AnyArg::as_bool).unwrap_or_default();
     let mut out = String::new();
     out.push_str(if ordered { "<ol>" } else { "<ul>" });
-    subpages::list_sub_pages_internal(
-        &mut out,
-        url,
-        env.locale,
-        Some(depth.map(|d| d.as_int() as usize).unwrap_or(1)),
-        reverse.map(|r| r.as_int() != 0).unwrap_or_default(), // Yes the old marco checks for == 0 not === 0.
-        Some(SubPagesSorter::SlugNatural),
-        &[],
-    )?;
+    if reverse.map(|r| r.as_int() != 0).unwrap_or_default() {
+        // Yes the old marco checks for == 0 not === 0.
+        if depth > 1 {
+            return Err(DocError::InvalidTempl(
+                "listsubpages with reverse set and depth != 1".to_string(),
+            ));
+        }
+        subpages::list_sub_pages_reverse_internal(
+            &mut out,
+            url,
+            env.locale,
+            Some(SubPagesSorter::SlugNatural),
+            &[],
+        )?;
+    } else {
+        subpages::list_sub_pages_internal(
+            &mut out,
+            url,
+            env.locale,
+            Some(depth),
+            Some(SubPagesSorter::SlugNatural),
+            &[],
+        )?;
+    }
     out.push_str(if ordered { "</ol>" } else { "</ul>" });
 
     Ok(out)

Diff for: crates/rari-doc/src/templ/templs/mod.rs

@@ -18,6 +18,7 @@ pub mod sidebars;
 pub mod specification;
 pub mod svginfo;
 pub mod web_ext_examples;
+pub mod xsltref;
 
 use rari_types::globals::deny_warnings;
 use rari_types::{Arg, RariEnv};
@@ -50,6 +51,12 @@ pub fn invoke(
             | "htmlsidebar"
             | "accessibilitysidebar"
             | "firefoxsidebar"
+            | "webassemblysidebar"
+            | "xsltsidebar"
+            | "mdnsidebar"
+            | "gamessidebar"
+            | "mathmlref"
+            | "pwasidebar"
     );
     let f = match name.as_str() {
         "compat" => compat::compat_any,
@@ -64,6 +71,7 @@ pub fn invoke(
         "firefox_for_developers" => firefox_for_developers::firefox_for_developers_any,
         "js_property_attributes" => js_property_attributes::js_property_attributes_any,
         "svginfo" => svginfo::svginfo_any,
+        "xsltref" => xsltref::xsltref_any,
 
         // hacky
         "glossarydisambiguation" => glossarydisambiguation::glossarydisambiguation_any,
@@ -130,6 +138,12 @@ pub fn invoke(
         "htmlsidebar" => sidebars::htmlsidebar_any,
         "accessibilitysidebar" => sidebars::accessibilitysidebar_any,
         "firefoxsidebar" => sidebars::firefoxsidebar_any,
+        "webassemblysidebar" => sidebars::webassemblysidebar_any,
+        "xsltsidebar" => sidebars::xsltsidebar_any,
+        "mdnsidebar" => sidebars::mdnsidebar_any,
+        "gamessidebar" => sidebars::gamessidebar_any,
+        "mathmlref" => sidebars::mathmlref_any,
+        "pwasidebar" => sidebars::pwasidebar_any,
 
         // unknown
         _ if deny_warnings() => return Err(DocError::UnknownMacro(ident.to_string())),

Diff for: crates/rari-doc/src/templ/templs/quick_links_with_subpages.rs

@@ -9,5 +9,13 @@ use crate::templ::legacy::fix_broken_legacy_url;
 #[rari_f]
 pub fn quick_links_with_subpages(url: Option<String>) -> Result<String, DocError> {
     let url = url.map(|s| fix_broken_legacy_url(&s, env.locale).to_string());
-    list_sub_pages(env, url, Some(AnyArg { value: Arg::Int(2) }), None, None)
+    list_sub_pages(
+        env,
+        url,
+        Some(AnyArg { value: Arg::Int(2) }),
+        None,
+        Some(AnyArg {
+            value: Arg::Bool(true),
+        }),
+    )
 }

Diff for: crates/rari-doc/src/templ/templs/sidebars.rs

@@ -68,3 +68,33 @@ pub fn accessibilitysidebar() -> Result<String, DocError> {
 pub fn firefoxsidebar() -> Result<String, DocError> {
     sidebar::render_sidebar("firefoxsidebar", env.slug, env.locale)
 }
+
+#[rari_f]
+pub fn webassemblysidebar() -> Result<String, DocError> {
+    sidebar::render_sidebar("webassemblysidebar", env.slug, env.locale)
+}
+
+#[rari_f]
+pub fn xsltsidebar() -> Result<String, DocError> {
+    sidebar::render_sidebar("xsltsidebar", env.slug, env.locale)
+}
+
+#[rari_f]
+pub fn mdnsidebar() -> Result<String, DocError> {
+    sidebar::render_sidebar("mdnsidebar", env.slug, env.locale)
+}
+
+#[rari_f]
+pub fn gamessidebar() -> Result<String, DocError> {
+    sidebar::render_sidebar("gamessidebar", env.slug, env.locale)
+}
+
+#[rari_f]
+pub fn mathmlref() -> Result<String, DocError> {
+    sidebar::render_sidebar("mathmlref", env.slug, env.locale)
+}
+
+#[rari_f]
+pub fn pwasidebar() -> Result<String, DocError> {
+    sidebar::render_sidebar("pwasidebar", env.slug, env.locale)
+}