From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 44B1F138350 for ; Wed, 15 Jan 2020 21:30:21 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 83797E0863; Wed, 15 Jan 2020 21:30:20 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 66426E0863 for ; Wed, 15 Jan 2020 21:30:20 +0000 (UTC) Received: from oystercatcher.gentoo.org (unknown [IPv6:2a01:4f8:202:4333:225:90ff:fed9:fc84]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 18C4D34E0BB for ; Wed, 15 Jan 2020 21:30:03 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id CEE6AB1 for ; Wed, 15 Jan 2020 21:29:59 +0000 (UTC) From: "Ulrich Müller" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Ulrich Müller" Message-ID: <1579123726.eda9eff6a5393887b56679df3ff9c4107e1e4674.ulm@gentoo> Subject: [gentoo-commits] proj/devmanual:master commit in: appendices/devbook-guide/ X-VCS-Repository: proj/devmanual X-VCS-Files: appendices/devbook-guide/text.xml X-VCS-Directories: appendices/devbook-guide/ X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Müller X-VCS-Revision: eda9eff6a5393887b56679df3ff9c4107e1e4674 X-VCS-Branch: master Date: Wed, 15 Jan 2020 21:29:59 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: 192308c8-0939-4bdf-9011-a5de79d4b556 X-Archives-Hash: 71d40af31d804aa9bb8b2de13910da7b commit: eda9eff6a5393887b56679df3ff9c4107e1e4674 Author: Ulrich Müller gentoo org> AuthorDate: Sat Jan 11 19:44:54 2020 +0000 Commit: Ulrich Müller gentoo org> CommitDate: Wed Jan 15 21:28:46 2020 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=eda9eff6 devbook-guide: Update section on intra-document references. Signed-off-by: Ulrich Müller gentoo.org> appendices/devbook-guide/text.xml | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml index 0f0a3ad..3b583f2 100644 --- a/appendices/devbook-guide/text.xml +++ b/appendices/devbook-guide/text.xml @@ -469,14 +469,23 @@ admonitions. A definition list comprises:

GuideXML makes it really easy to reference other parts of the document using -hyperlinks. You can create a link pointing to Chapter -One by typing <uri link="#doc_chap1">Chapter -One</uri>. To point to section two of -Chapter One, type <uri link="#doc_chap1_sect2">section two of -Chapter One</uri>. To refer to figure 3 in chapter 1, type -<uri link="#doc_chap1_fig3">figure 1.3</uri>. Or, to refer -to code listing 2 in chapter 2, type -<uri link="#doc_chap2_pre2">code listing 2.2</uri>. +hyperlinks. You can create a link pointing to another chapter, like +Ebuild File Format, by typing +<uri link="::ebuild-writing/file-format/">Ebuild File +Format</uri>, i.e., two colons followed by the relative path from +the root node. To refer to a section in another chapter, like +First Ebuild, type +<uri link="::quickstart/#First Ebuild">First Ebuild</uri>. +

+ +

+If the link target's chapter (or section etc.) title is to be used as the link +text, an empty <uri> element can be used. As a matter of fact, +I could have written the two examples above in more compact form: +<uri link="::ebuild-writing/file-format/"/> and +<uri link="::quickstart/#First Ebuild"/> render as + and +, respectively.