Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 711164 - Devmanual <note>, <important> and <warning> boxes should use the same colours as the wiki
Summary: Devmanual <note>, <important> and <warning> boxes should use the same colours...
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal normal
Assignee: Gentoo Devmanual Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2020-03-01 12:17 UTC by Ulrich Müller
Modified: 2020-03-06 16:30 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments
screenshot from https://devmanual.gentoo.org/appendices/devbook-guide/index.html#an-example-body (devbook.png,13.75 KB, image/png)
2020-03-01 12:18 UTC, Ulrich Müller
Details
screenshot from https://wiki.gentoo.org/wiki/Gentoo_Wiki:Guidelines#Block-level_layout_elements (wiki.png,127.06 KB, image/png)
2020-03-01 12:19 UTC, Ulrich Müller
Details
Screenshot of devmanual page after the proposed change (devbook.png,15.10 KB, image/png)
2020-03-03 15:01 UTC, Ulrich Müller
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Ulrich Müller gentoo-dev 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 3 Ulrich Müller gentoo-dev 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 gentoo-dev 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 <ulm@gentoo.org>
AuthorDate: 2020-02-29 22:56:58 +0000
Commit:     Ulrich Müller <ulm@gentoo.org>
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 <ulm@gentoo.org>

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