From 5e1f07c03c0fad5b9efad676e1442359c7f8f313 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Mon, 3 Oct 2022 00:24:37 +0200 Subject: [PATCH] theme: make HTML5 compliant #329 --- exampleSite/content/basics/customization/_index.en.md | 2 +- exampleSite/content/shortcodes/attachments.en.md | 8 ++++---- exampleSite/content/shortcodes/button.en.md | 6 +++--- exampleSite/content/shortcodes/children/_index.en.md | 2 +- exampleSite/content/shortcodes/mermaid.en.md | 4 ++-- exampleSite/content/shortcodes/notice.en.md | 6 +++--- exampleSite/content/shortcodes/tabs.en.md | 2 +- layouts/partials/header.html | 2 +- layouts/partials/menu.html | 4 ++-- 9 files changed, 18 insertions(+), 18 deletions(-) diff --git a/exampleSite/content/basics/customization/_index.en.md b/exampleSite/content/basics/customization/_index.en.md index 165b527906..12469716b1 100644 --- a/exampleSite/content/basics/customization/_index.en.md +++ b/exampleSite/content/basics/customization/_index.en.md @@ -46,7 +46,7 @@ If no favicon file is found, the theme will lookup the alternative filename `log If you need to change this default behavior, create a new file in `layouts/partials/` named `favicon.html`. Then write something like this: ```html - + ``` ## Change the colors {#theme-variant} diff --git a/exampleSite/content/shortcodes/attachments.en.md b/exampleSite/content/shortcodes/attachments.en.md index d175966c9b..0a9f0bee03 100644 --- a/exampleSite/content/shortcodes/attachments.en.md +++ b/exampleSite/content/shortcodes/attachments.en.md @@ -59,11 +59,11 @@ Be aware that if you use a multilingual website, you will need to have as many f | Name | Default | Notes | |:------------|:--------------|:------------| -| **style** | `transparent` | The color scheme used to highlight the box content.

- by severity: `info`, `note`, `tip`, `warning`- by color: `blue`, `green`, `grey`, `orange`, `red`
- by special color: `default`,t` | -| **title** | see notes | Arbitray text for the box title. Depending on the **style** there may be a default title. Any given value will overwault.

- for severity styles: the matching title for the severity
- for all other colors: `Attachments`

If you wa you have to set this parameter to `" "` (a non empty string filled with spaces) | -| **icon** | see notes | [Font Awesome icon name]({{%relref "cont/icons#finding-an-icon" %}}) set to the left of the title. Depending le** there may be a default icon. Any given value will overwrite the default.

- for severity styles: a nice matching iseverity
- for all other colors: `paperclip`

If you want no icon, you have to set this parameter to `" "` (a non empty d with spaces) | +| **style** | `transparent` | The color scheme used to highlight the box content.

- by severity: `info`, `note`, `tip`, `warning`- by color: `blue`, `green`, `grey`, `orange`, `red`
- by special color: `default`,t` | +| **title** | see notes | Arbitray text for the box title. Depending on the **style** there may be a default title. Any given value will overwault.

- for severity styles: the matching title for the severity
- for all other colors: `Attachments`

If you wa you have to set this parameter to `" "` (a non empty string filled with spaces) | +| **icon** | see notes | [Font Awesome icon name]({{%relref "cont/icons#finding-an-icon" %}}) set to the left of the title. Depending le** there may be a default icon. Any given value will overwrite the default.

- for severity styles: a nice matching iseverity
- for all other colors: `paperclip`

If you want no icon, you have to set this parameter to `" "` (a non empty d with spaces) | | **sort** | `asc` | Sorting the output in `asc`ending or `desc`ending order. | -| **pattern** | `.*` | A [regular expressions](https://en.wikipedia.org/wiki/Regular_expression), used to filter the attachments by file name. For example:

- to match a file suffix of 'jpg', use `.*jpg` (not `*.jpg`)
- to match file names ending in `jpg` or `png`, use `.*(jpg\|png)` | +| **pattern** | `.*` | A [regular expressions](https://en.wikipedia.org/wiki/Regular_expression), used to filter the attachments by file name. For example:

- to match a file suffix of 'jpg', use `.*jpg` (not `*.jpg`)
- to match file names ending in `jpg` or `png`, use `.*(jpg\|png)` | ## Examples diff --git a/exampleSite/content/shortcodes/button.en.md b/exampleSite/content/shortcodes/button.en.md index fdd42b1d69..23d362812f 100644 --- a/exampleSite/content/shortcodes/button.en.md +++ b/exampleSite/content/shortcodes/button.en.md @@ -48,10 +48,10 @@ Once the button is clicked, it opens another browser tab for the given URL. | Name | Default | Notes | |:----------------------|:----------------|:------------| | **href** | _<empty>_ | The destination URL for the button. If this parameter is not set, the button will do nothing but is still displayed as clickable. | -| **style** | `transparent` | The color scheme used to paint the button.

- by severity: `info`, `note`, `tip`, `warning`
- by brand color: `primary`, `secondary`
- by color: `blue`, `green`, `grey`, `orange`, `red`
- by special color: `default`, `transparent` | -| **icon** | see notes | [Font Awesome icon name]({{%relref "cont/icons#finding-an-icon" %}}) set to the left of the title. Depending on the **style** there may be a default icon. Any given value will overwrite the default.

- for severity styles: a nice matching icon for the severity
- for all other colors: _<empty>_

If you want no icon for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) | +| **style** | `transparent` | The color scheme used to paint the button.

- by severity: `info`, `note`, `tip`, `warning`
- by brand color: `primary`, `secondary`
- by color: `blue`, `green`, `grey`, `orange`, `red`
- by special color: `default`, `transparent` | +| **icon** | see notes | [Font Awesome icon name]({{%relref "cont/icons#finding-an-icon" %}}) set to the left of the title. Depending on the **style** there may be a default icon. Any given value will overwrite the default.

- for severity styles: a nice matching icon for the severity
- for all other colors: _<empty>_

If you want no icon for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) | | **iconposition** | `left` | Places the icon to the `left` or `right` of the title. | -| _**<content>**_ | see notes | Arbitray text for the button title. Depending on the **style** there may be a default title. Any given value will overwrite the default.

- for severity styles: the matching title for the severity
- for all other colors: _<empty>_

If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) | +| _**<content>**_ | see notes | Arbitray text for the button title. Depending on the **style** there may be a default title. Any given value will overwrite the default.

- for severity styles: the matching title for the severity
- for all other colors: _<empty>_

If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) | ## Examples diff --git a/exampleSite/content/shortcodes/children/_index.en.md b/exampleSite/content/shortcodes/children/_index.en.md index 1f03190b7b..8b3ec87dba 100644 --- a/exampleSite/content/shortcodes/children/_index.en.md +++ b/exampleSite/content/shortcodes/children/_index.en.md @@ -41,7 +41,7 @@ While the examples are using shortcodes with named parameter you are free to als | **showhidden** | `false` | When `true`, child pages hidden from the menu will be displayed aswell. | | **description** | `false` | When `true` shows a short text under each page in the list. When no description or summary exists for the page, the first 70 words of the content is taken - [read more info about summaries on gohugo.io](https://gohugo.io/content/summaries/). | | **depth** | `1` | The depth of descendants to display. For example, if the value is `2`, the shortcode will display two levels of child pages. To get all descendants, set this value to a high number eg. `999`. | -| **sort** | see notes | The sort order of the displayed list.

If not set it is sorted by the [`ordersectionsby`]({{% relref "basics/configuration#global-site-parameters" %}}) setting of the site and the pages frontmatter

- `weight`: to sort on menu order
- `title`: to sort alphabetically on menu label. | +| **sort** | see notes | The sort order of the displayed list.

If not set it is sorted by the [`ordersectionsby`]({{% relref "basics/configuration#global-site-parameters" %}}) setting of the site and the pages frontmatter

- `weight`: to sort on menu order
- `title`: to sort alphabetically on menu label. | ## Examples diff --git a/exampleSite/content/shortcodes/mermaid.en.md b/exampleSite/content/shortcodes/mermaid.en.md index 15117acb3e..485ddb3272 100644 --- a/exampleSite/content/shortcodes/mermaid.en.md +++ b/exampleSite/content/shortcodes/mermaid.en.md @@ -147,7 +147,7 @@ sequenceDiagram loop Healthcheck John->John: Fight against hypochondria end - Note right of John: Rational thoughts
prevail... + Note right of John: Rational thoughts
prevail... John-->Alice: Great! John->Bob: How about you? Bob-->John: Jolly good! @@ -162,7 +162,7 @@ sequenceDiagram loop Healthcheck John->John: Fight against hypochondria end - Note right of John: Rational thoughts
prevail... + Note right of John: Rational thoughts
prevail... John-->Alice: Great! John->Bob: How about you? Bob-->John: Jolly good! diff --git a/exampleSite/content/shortcodes/notice.en.md b/exampleSite/content/shortcodes/notice.en.md index 7cccd9e228..23ab79a93d 100644 --- a/exampleSite/content/shortcodes/notice.en.md +++ b/exampleSite/content/shortcodes/notice.en.md @@ -51,9 +51,9 @@ It is all about the boxes. | Name | Position | Default | Notes | |:----------|:---------|:----------|:------------| -| **style** | 1 | `default` | The color scheme used to highlight the box content.

- by severity: `info`, `note`, `tip`, `warning`
- by brand color: `primary`, `secondary`
- by color: `blue`, `green`, `grey`, `orange`, `red`
- by special color: `default`, `transparent` | -| **title** | 2 | see notes | Arbitray text for the box title. Depending on the **style** there may be a default title. Any given value will overwrite the default.

- for severity styles: the matching title for the severity
- for all other colors: _<empty>_

If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) | -| **icon** | 3 | see notes | [Font Awesome icon name]({{%relref "cont/icons#finding-an-icon" %}}) set to the left of the title. Depending on the **style** there may be a default icon. Any given value will overwrite the default.

- for severity styles: a nice matching icon for the severity
- for all other colors: _<empty>_

If you want no icon for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) | +| **style** | 1 | `default` | The color scheme used to highlight the box content.

- by severity: `info`, `note`, `tip`, `warning`
- by brand color: `primary`, `secondary`
- by color: `blue`, `green`, `grey`, `orange`, `red`
- by special color: `default`, `transparent` | +| **title** | 2 | see notes | Arbitray text for the box title. Depending on the **style** there may be a default title. Any given value will overwrite the default.

- for severity styles: the matching title for the severity
- for all other colors: _<empty>_

If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) | +| **icon** | 3 | see notes | [Font Awesome icon name]({{%relref "cont/icons#finding-an-icon" %}}) set to the left of the title. Depending on the **style** there may be a default icon. Any given value will overwrite the default.

- for severity styles: a nice matching icon for the severity
- for all other colors: _<empty>_

If you want no icon for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) | | _**<content>**_ | | _<empty>_ | Arbitray text to be displayed in box. | ## Examples diff --git a/exampleSite/content/shortcodes/tabs.en.md b/exampleSite/content/shortcodes/tabs.en.md index 877fde4114..b71f12b1bd 100644 --- a/exampleSite/content/shortcodes/tabs.en.md +++ b/exampleSite/content/shortcodes/tabs.en.md @@ -70,7 +70,7 @@ echo "Hello World!" | Name | Default | Notes | |:----------------------|:-----------------|:------------| -| **groupid** | `default` | Arbitrary name of the group the tab view belongs to.

Tab views with the same **groupid** sychronize their selected tab. This sychronization applies to the whole site! | +| **groupid** | `default` | Arbitrary name of the group the tab view belongs to.

Tab views with the same **groupid** sychronize their selected tab. This sychronization applies to the whole site! | | _**<content>**_ | _<empty>_ | Arbitrary number of tabs defined with the `tab` sub-shortcode. | {{% notice note %}} diff --git a/layouts/partials/header.html b/layouts/partials/header.html index 33e89b9342..284231b200 100644 --- a/layouts/partials/header.html +++ b/layouts/partials/header.html @@ -134,7 +134,7 @@ {{- $remaining = sub $remaining 1 }} {{- if $ispublished }} {{- $depth = add $depth 1 }} -
  • {{ if $remaining }}{{end}}{{ if $page.Title }}{{ $page.Title }}{{ else }}{{ $page.Site.Title }}{{ end }}{{ if $remaining }}{{ end }}
    • {{ if $remaining }} > {{ end }} +
  • {{ if $remaining }}{{end}}{{ if $page.Title }}{{ $page.Title }}{{ else }}{{ $page.Site.Title }}{{ end }}{{ if $remaining }}{{ end }}{{ if $remaining }} > {{ end }}
    • {{- end }} {{- end }} {{- end }} \ No newline at end of file diff --git a/layouts/partials/menu.html b/layouts/partials/menu.html index 5b1e7ae5b9..dbfe037df8 100644 --- a/layouts/partials/menu.html +++ b/layouts/partials/menu.html @@ -52,7 +52,7 @@ {{- $footer := partial "menu-footer.html" . }} {{- $showfooter := not (eq 0 (int (len ($footer | plainify)))) }}
    -
    +