diff options
| author |   Ulrich Müller <ulm@gentoo.org> | 2020-01-11 11:10:07 +0100 |
|---|---|---|
| committer | Ulrich Müller <ulm@gentoo.org> | 2020-01-15 22:28:45 +0100 |
| commit | d10a853abe03569b235f960693f47960c494fd9b (patch) | |
| tree | 6f2ca664e9844c4a46118434222a444965721312 /appendices | |
| parent | devbook-guide: Make codesamples agree with their rendering. (diff) | |
| download | devmanual-d10a853abe03569b235f960693f47960c494fd9b.tar.gz devmanual-d10a853abe03569b235f960693f47960c494fd9b.tar.bz2 devmanual-d10a853abe03569b235f960693f47960c494fd9b.zip | |
devbook-guide: Explain <codesample>.
Signed-off-by: Ulrich Müller <ulm@gentoo.org>
Diffstat (limited to 'appendices')
| -rw-r--r-- | appendices/devbook-guide/text.xml | 69 |
1 files changed, 65 insertions, 4 deletions
diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml index 5ae077b..0f0a3ad 100644 --- a/appendices/devbook-guide/text.xml +++ b/appendices/devbook-guide/text.xml @@ -262,10 +262,71 @@ prose more <e>punch</e>! <title>Code samples and colour-coding</title> <body> -<todo> -Fill this section with the information about the use of -<codesample/>. -</todo> +<p> +The <c><pre></c> tag does not support any syntax highlighting. When you +need syntax highlighting, use the <c><codesample></c> tag along with a +<c>lang</c> attribute <d/> usually you want this to be set to <c>"ebuild"</c> +to syntax highlight ebuild code snippets. Currently, the following languages +are supported: +</p> + +<ul> + <li>c</li> + <li>ebuild</li> + <li>make</li> + <li>m4</li> + <li>sgml</li> +</ul> + +<note> +Remember that all leading and trailing spaces, and line breaks in +<c><codesample></c> blocks will appear in the displayed html page. +</note> + +<p> +Sample <c><codesample lang="c"></c> block: +</p> + +<codesample lang="c"> +#include <stdio.h> + +main() +{ + /* This is a comment */ + printf("Hello, world!\n"); +} +</codesample> + +<p> +You can also specify <c>numbering="lines"</c> to enable line numbering, as in +the following example: +</p> + +<codesample lang="ebuild" numbering="lines"> +# Copyright 1999-2020 Gentoo Authors +# Distributed under the terms of the GNU General Public License v2 + +EAPI=7 + +DESCRIPTION="MicroGnuEmacs, a port from the BSDs" +HOMEPAGE="https://homepage.boetes.org/software/mg/" +SRC_URI="https://github.com/hboetes/${PN}/archive/${PV}.tar.gz -> ${P}.tar.gz" + +LICENSE="public-domain" +SLOT="0" +KEYWORDS="alpha amd64 arm hppa ppc ~ppc64 sparc x86" + +RDEPEND="sys-libs/ncurses:0= + >=dev-libs/libbsd-0.7.0" +DEPEND="${RDEPEND}" +BDEPEND="virtual/pkgconfig" + +src_install() { + dobin mg + doman mg.1 + dodoc README tutorial +} +</codesample> </body> </subsection> |