diff --git a/rendered/css/style.css b/rendered/css/style.css index bb2e6e3c8..1f0b0c067 100644 --- a/rendered/css/style.css +++ b/rendered/css/style.css @@ -122,6 +122,10 @@ background-color: #6060e0; color: #ffffff; } + div.note-cont + p { + background-color: #6060e0; + color: #ffffff; + } aside.note::before { background-color: #3030e0; } @@ -138,6 +142,11 @@ color: #ffffff; font-weight: 700; } + div.warning-cont + p { + background-color: #e08060; + color: #ffffff; + font-weight: 700; + } aside.warning::before { background-color: #e05030; font-weight: 800; @@ -152,9 +161,15 @@ div.note + p > a, a:visited { color: #50e7f4; } + div.note-cont + p > a, a:visited { + color: #50e7f4; + } div.warning + p > a, a:visited { color: #50e7f4; } + div.warning-cont + p > a, a:visited { + color: #50e7f4; + } aside > p > a:hover { color: #90ffff; } @@ -181,16 +196,32 @@ aside { } div.note + p { padding-top: 4.4rem; - padding-left: 0.15rem; - padding-right: 0.15rem; + padding-left: 1rem; + padding-right: 1rem; + padding-bottom: 1.4rem; + margin-top: -2.25rem; + margin-bottom: 1.5rem; +} +div.note-cont + p { + padding-top: 1rem; + padding-left: 1rem; + padding-right: 1rem; padding-bottom: 1.4rem; margin-top: -2.25rem; margin-bottom: 1.5rem; } div.warning + p { padding-top: 4.4rem; - padding-left: 0.15rem; - padding-right: 0.15rem; + padding-left: 1rem; + padding-right: 1rem; + padding-bottom: 1.4rem; + margin-top: -2.25rem; + margin-bottom: 1.5rem; +} +div.warning-cont + p { + padding-top: 1rem; + padding-left: 1rem; + padding-right: 1rem; padding-bottom: 1.4rem; margin-top: -2.25rem; margin-bottom: 1.5rem; @@ -245,14 +276,6 @@ aside > p { padding-left: 1rem; padding-right: 1rem; } -div.note + p { - padding-left: 1rem; - padding-right: 1rem; -} -div.warning + p { - padding-left: 1rem; - padding-right: 1rem; -} @font-face { font-family: robotolight; diff --git a/rendered/zip-0325.html b/rendered/zip-0325.html index 88d0b3dfe..a5aa555e0 100644 --- a/rendered/zip-0325.html +++ b/rendered/zip-0325.html @@ -202,13 +202,16 @@

Private-use metad
  • Return \(\mathsf{CKDreg}(K, \mathtt{0x7FFFFFFF}, \mathsf{PrivateUseSubject})\)
  • -
    +

    It is the responsibility of wallet developers to ensure that they do not use colliding \(\mathsf{PrivateUseSubject}\) values, and to analyse their private use for any security risks related to potential cross-protocol attacks (in the event that -two wallet developers happen to select a colliding \(\mathsf{PrivateUseSubject}\)). -Wallet developers that are unwilling to accept these risks SHOULD propose new +two wallet developers happen to select a colliding \(\mathsf{PrivateUseSubject}\)).

    + +
    + +

    Wallet developers that are unwilling to accept these risks SHOULD propose new standardised metadata protocols instead, to benefit from ecosystem coordination and review.

    diff --git a/rendered/zip-guide-markdown.html b/rendered/zip-guide-markdown.html index 4c6799b60..ccc6e1956 100644 --- a/rendered/zip-guide-markdown.html +++ b/rendered/zip-guide-markdown.html @@ -168,21 +168,29 @@

    Notes and warnings -

    .. note::” in reStructuredText or “<div class="note"></div>” in Markdown -(followed by a blank line in either case), can be used for an aside from the main -text. The rendering of notes is colourful and may be distracting, so they should +

    .. note::” in reStructuredText, or “<div class="note"></div>” followed by a +blank line in Markdown, can be used for an aside from the main text.

    + +
    + +

    The rendering of notes is colourful and may be distracting, so they should only be used for important points.

    -

    .. warning::” in reStructuredText or “<div class="warning"></div>” in -Markdown (followed by a blank line in either case), can be used for warnings. -Warnings should be used very sparingly — for example to signal that a +

    .. warning::” in reStructuredText, or “<div class="warning"></div>” followed +by a blank line in Markdown, can be used for warnings.

    + +
    + +

    Warnings should be used very sparingly — for example to signal that a entire specification, or part of it, may be inapplicable or could cause significant interoperability or security problems. In most cases, a “MUST” or “SHOULD” conformance requirement is more appropriate.

    -

    In Markdown, notes and warnings can currently only be a single paragraph.

    +

    In Markdown, notes and warnings can be extended across multiple paragraphs by +using “<div class="note-cont"></div>” or “<div class="warning-cont"></div>” +(preceded and followed by a blank line) between paragraphs.

    Valid markup

    @@ -219,9 +227,9 @@

    Citations and refe
    .. [#snark] `The Hunting of the Snark <https://www.gutenberg.org/files/29888/29888-h/29888-h.htm>_. Lewis Carroll, with illustrations by Henry Holiday. MacMillan and Co. London. March 29, 1876.
     
    -

    or like this in Markdown::

    +

    or like this in Markdown:

    -
    [^snark] [The Hunting of the Snark](https://www.gutenberg.org/files/29888/29888-h/29888-h.htm). Lewis Carroll, with illustrations by Henry Holiday. MacMillan and Co. London. March 29, 1876.
    +
    [^snark]: [The Hunting of the Snark](https://www.gutenberg.org/files/29888/29888-h/29888-h.htm). Lewis Carroll, with illustrations by Henry Holiday. MacMillan and Co. London. March 29, 1876.
     

    Note that each entry must be on a single line regardless of how long that makes the diff --git a/rendered/zip-guide.html b/rendered/zip-guide.html index 2abf294cd..172a4ff5c 100644 --- a/rendered/zip-guide.html +++ b/rendered/zip-guide.html @@ -91,14 +91,14 @@

    Notes and warnings

    -

    In Markdown, notes and warnings can currently only be a single paragraph.

    +

    In Markdown, notes and warnings can be extended across multiple paragraphs by using "<div class="note-cont"></div>" or "<div class="warning-cont"></div>" (preceded and followed by a blank line) between paragraphs.

    Valid markup

    This is optional before publishing a PR, but to check whether a document is valid reStructuredText or Markdown, first install docutils and rst2html5, and build MultiMarkdown-6. E.g. on Debian-based distros:

    @@ -119,7 +119,7 @@

    The corresponding entry in the References section should look like this in reStructuredText:

    .. [#snark] `The Hunting of the Snark <https://www.gutenberg.org/files/29888/29888-h/29888-h.htm>`_. Lewis Carroll, with illustrations by Henry Holiday. MacMillan and Co. London. March 29, 1876.

    or like this in Markdown:

    -
    [^snark] [The Hunting of the Snark](https://www.gutenberg.org/files/29888/29888-h/29888-h.htm). Lewis Carroll, with illustrations by Henry Holiday. MacMillan and Co. London. March 29, 1876.
    +
    [^snark]: [The Hunting of the Snark](https://www.gutenberg.org/files/29888/29888-h/29888-h.htm). Lewis Carroll, with illustrations by Henry Holiday. MacMillan and Co. London. March 29, 1876.

    Note that each entry must be on a single line regardless of how long that makes the line. In Markdown there must be a blank line between entries.

    The current rendering of a Markdown ZIP reorders the references according to their first use; the rendering of a reStructuredText ZIP keeps them in the same order as in the References section.

    To link to another section of the same ZIP, use "`Section title`_" in reStructuredText, or "[Section title]" in Markdown.

    diff --git a/zips/zip-0325.md b/zips/zip-0325.md index 4c114b1da..3b1de117a 100644 --- a/zips/zip-0325.md +++ b/zips/zip-0325.md @@ -171,12 +171,15 @@ valid hardened child index) within its key tree for this purpose. most 252 bytes that identifies the desired private-use context. - Return $\mathsf{CKDreg}(K, \mathtt{0x7FFFFFFF}, \mathsf{PrivateUseSubject})$ -
    +
    It is the responsibility of wallet developers to ensure that they do not use colliding $\mathsf{PrivateUseSubject}$ values, and to analyse their private use for any security risks related to potential cross-protocol attacks (in the event that two wallet developers happen to select a colliding $\mathsf{PrivateUseSubject}$). + +
    + Wallet developers that are unwilling to accept these risks SHOULD propose new standardised metadata protocols instead, to benefit from ecosystem coordination and review. diff --git a/zips/zip-guide-markdown.md b/zips/zip-guide-markdown.md index 8a8a425e6..bccfe0558 100644 --- a/zips/zip-guide-markdown.md +++ b/zips/zip-guide-markdown.md @@ -158,21 +158,29 @@ ZIP editors will catch any inconsistencies in review.
    -"`.. note::`" in reStructuredText or "`
    `" in Markdown -(followed by a blank line in either case), can be used for an aside from the main -text. The rendering of notes is colourful and may be distracting, so they should +"`.. note::`" in reStructuredText, or "`
    `" followed by a +blank line in Markdown, can be used for an aside from the main text. + +
    + +The rendering of notes is colourful and may be distracting, so they should only be used for important points.
    -"`.. warning::`" in reStructuredText or "`
    `" in -Markdown (followed by a blank line in either case), can be used for warnings. +"`.. warning::`" in reStructuredText, or "`
    `" followed +by a blank line in Markdown, can be used for warnings. + +
    + Warnings should be used very sparingly — for example to signal that a entire specification, or part of it, may be inapplicable or could cause significant interoperability or security problems. In most cases, a "MUST" or "SHOULD" conformance requirement is more appropriate. -In Markdown, notes and warnings can currently only be a single paragraph. +In Markdown, notes and warnings can be extended across multiple paragraphs by +using "`
    `" or "`
    `" +(preceded and followed by a blank line) between paragraphs. ## Valid markup @@ -207,9 +215,9 @@ reStructuredText: .. [#snark] `The Hunting of the Snark _. Lewis Carroll, with illustrations by Henry Holiday. MacMillan and Co. London. March 29, 1876. ``` -or like this in Markdown:: +or like this in Markdown: ```markdown -[^snark] [The Hunting of the Snark](https://www.gutenberg.org/files/29888/29888-h/29888-h.htm). Lewis Carroll, with illustrations by Henry Holiday. MacMillan and Co. London. March 29, 1876. +[^snark]: [The Hunting of the Snark](https://www.gutenberg.org/files/29888/29888-h/29888-h.htm). Lewis Carroll, with illustrations by Henry Holiday. MacMillan and Co. London. March 29, 1876. ``` Note that each entry must be on a single line regardless of how long that makes the diff --git a/zips/zip-guide.rst b/zips/zip-guide.rst index 43df16760..95bb4dd4c 100644 --- a/zips/zip-guide.rst +++ b/zips/zip-guide.rst @@ -167,23 +167,24 @@ Notes and warnings ------------------ .. note:: - "``.. note::``" in reStructuredText or "``
    ``" in - Markdown (followed by a blank line in either case), can be used for an aside - from the main text. + "``.. note::``" in reStructuredText, or "``
    ``" followed + by a blank line in Markdown, can be used for an aside from the main text. The rendering of notes is colourful and may be distracting, so they should only be used for important points. .. warning:: "``.. warning::``" in reStructuredText, or "``
    ``" - in Markdown (followed by a blank line in either case), can be used for warnings. + followed by a blank line in Markdown, can be used for warnings. Warnings should be used very sparingly — for example to signal that a entire specification, or part of it, may be inapplicable or could cause significant interoperability or security problems. In most cases, a "MUST" or "SHOULD" conformance requirement is more appropriate. -In Markdown, notes and warnings can currently only be a single paragraph. +In Markdown, notes and warnings can be extended across multiple paragraphs by +using "``
    ``" or "``
    ``" +(preceded and followed by a blank line) between paragraphs. Valid markup ------------ @@ -221,7 +222,7 @@ reStructuredText:: or like this in Markdown:: - [^snark] [The Hunting of the Snark](https://www.gutenberg.org/files/29888/29888-h/29888-h.htm). Lewis Carroll, with illustrations by Henry Holiday. MacMillan and Co. London. March 29, 1876. + [^snark]: [The Hunting of the Snark](https://www.gutenberg.org/files/29888/29888-h/29888-h.htm). Lewis Carroll, with illustrations by Henry Holiday. MacMillan and Co. London. March 29, 1876. Note that each entry must be on a single line regardless of how long that makes the line. In Markdown there must be a blank line between entries.