Bug 711164 – Devmanual <note>, <important> and <warning> boxes should use the same colours as the wiki

• Product: Documentation
• Status: RESOLVED FIXED

[Description Ulrich Müller 2020-03-01 12:17:12 UTC]

The <note>, <important>, and <warning> boxes in the devmanual, e.g.:
https://devmanual.gentoo.org/appendices/devbook-guide/index.html#an-example-body
are using a different colour scheme than the corresponding ones in the wiki:
https://wiki.gentoo.org/wiki/Gentoo_Wiki:Guidelines#Block-level_layout_elements

I suggest to update them to use blue, yellow, and red background, respectively. This would also be closer to the previous rendering in https://web.archive.org/web/20150314192204/http://www.gentoo.org/doc/en/xml-guide.xml#doc_chap2_sect3 which also used yellow for important and red for warning.

[Comment 1 Ulrich Müller 2020-03-01 12:18:52 UTC]

Created attachment 616710 [details]
screenshot from https://devmanual.gentoo.org/appendices/devbook-guide/index.html#an-example-body

[Comment 2 Ulrich Müller 2020-03-01 12:19:27 UTC]

Created attachment 616712 [details]
screenshot from https://wiki.gentoo.org/wiki/Gentoo_Wiki:Guidelines#Block-level_layout_elements

[Comment 3 Ulrich Müller 2020-03-03 15:01:04 UTC]

Created attachment 616996 [details]
Screenshot of devmanual page after the proposed change

[Comment 4 Larry the Git Cow 2020-03-06 16:30:51 UTC]

The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6fb169cf04e84a0b91708630e832ac0c5c1ecd8d

commit 6fb169cf04e84a0b91708630e832ac0c5c1ecd8d
Author:     Ulrich Müller <[e-mail]>
AuthorDate: 2020-02-29 22:56:58 +0000
Commit:     Ulrich Müller <[e-mail]>
CommitDate: 2020-03-06 16:27:03 +0000

    devbook.xsl: Bring admonitions in line with the wiki.
    
    Use alert-info, alert-warning, and alert-danger for note, important,
    and warning, respectively. This is also the scheme used in the wiki:
    https://wiki.gentoo.org/wiki/Gentoo_Wiki:Guidelines#Block-level_layout_elements
    
    Yellow background for important and red for warning also agrees with
    the colours formerly used with GuideXML:
    https://web.archive.org/web/20150314192204/http://www.gentoo.org/doc/en/xml-guide.xml#doc_chap2_sect3
    
    Closes: https://bugs.gentoo.org/711164
    Signed-off-by: Ulrich Müller <[e-mail]>

 devbook.xsl | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)