Removing dom ID requirement for margin/sidenotes (#10)

* Removing dom ID requirement for margin/sidenotes

Prior to this commit, when using the `marginnote` or `sidenote`
shortcodes, you would need to pass a domId parameter to the shortcode.

With this change you no longer need to pass a parameter, and any
parameter passed is ignored. The pre-amble creates a unique domID for
the shortcodes.

* Replacing convoluted Scratch with Ordinal

I was leveraging the Scratch function of Hugo, when I could instead
rely on `.Ordinal`
This commit is contained in:
Jeremy Friesen 2019-04-18 09:37:06 -07:00 committed by Shawn O'Hare
parent cfa6769e1c
commit 4299d3bfdb
3 changed files with 20 additions and 22 deletions

View file

@ -105,9 +105,8 @@ support all the features present in the
- `marginnote` - `marginnote`
- **Description**: Wrap text to produce a numberless margin note. - **Description**: Wrap text to produce a numberless margin note.
- Usage: Accepts a required positional argument that is the margin note id. - Usage: `{{% marginnote %}}...{{% /marginnote %}}`
`{{% marginnote "<margin note id>"" %}}...{{% /marginnote %}}` - **Example**: `{{% marginnote %}}Some marginnote{{% /marginnote%}}`
- **Example**: `{{% marginnote "mn-example" %}}Some marginnote{{% /marginnote%}}`
- `section` - `section`
- **Description**: This shortcode is provided as a work-around for wrapping - **Description**: This shortcode is provided as a work-around for wrapping
@ -123,10 +122,9 @@ support all the features present in the
- `sidenote` - `sidenote`
- **Description**: Wrap text to produce an automatically numbered sidenote. - **Description**: Wrap text to produce an automatically numbered sidenote.
- **Usage**: identical to `marginnote`. - **Usage**: identical to `marginnote`
Accepts a required positional argument that is the side note id. `{{% sidenote %}}...{{% /sidenote %}}`
`{{% sidenote "<side note id>"" %}}...{{% /sidenote %}}` - **Example**: `{{% sidenote %}}Some sidenote{{% /sidenote %}}`
- **Example**: `{{% sidenote "sn-example" %}}Some sidenote{{% /sidenote %}}`
## Templates ## Templates

View file

@ -1,3 +1,3 @@
<label for="{{ .Get 0 }}" class="margin-toggle">&#8853;</label> {{ $marginnoteDomIdSuffix := .Ordinal }}<label for="marginnote-{{.Page.UniqueID}}-{{ $marginnoteDomIdSuffix }}" class="margin-toggle">&#8853;</label>
<input type="checkbox" id="{{ .Get 0 }}" class="margin-toggle"/> <input type="checkbox" id="marginnote-{{.Page.UniqueID}}-{{ $marginnoteDomIdSuffix }}" class="margin-toggle"/>
<span class="marginnote">{{ .Inner }}</span> <span class="marginnote">{{ .Inner }}</span>

View file

@ -1,3 +1,3 @@
<label for="{{ .Get "id" }}" class="margin-toggle sidenote-number"></label> {{ $sidenoteDomIdSuffix := .Ordinal }}<label for="sidenote-{{.Page.UniqueID}}-{{ $sidenoteDomIdSuffix }}" class="margin-toggle sidenote-number"></label>
<input type="checkbox" id="{{ .Get "id" }}" class="margin-toggle"/> <input type="checkbox" id="sidenote-{{.Page.UniqueID}}-{{ $sidenoteDomIdSuffix }}" class="margin-toggle"/>
<span class="sidenote">{{ .Inner }}</span> <span class="sidenote">{{ .Inner }}</span>