1
0
mirror of https://github.com/postgres/postgres.git synced 2025-06-23 14:01:44 +03:00
Files
postgres/doc/src/sgml
Andrew Dunstan a7e3a390e1 Add new make targets world-bin and install-world-bin
These are the same as world and install-world respectively, but without
building or installing the documentation. There are many reasons for
wanting to be able to do this, including speed, lack of documentation
building tools, and wanting to build other formats of the documentation.
Plans for simplifying the buildfarm client code include using these
targets.

Backpatch to all live branches.

Discussion: https://postgr.es/m/6a421136-d462-b043-a8eb-e75b2861f3df@dunslane.net
2021-07-01 14:52:40 -04:00
..
2021-03-28 11:28:17 -04:00
2020-09-10 14:16:38 +02:00
2020-10-26 19:17:05 -04:00
2017-10-20 19:26:10 -04:00
2020-11-25 09:54:50 +01:00
2020-07-18 22:43:49 +09:00
2019-08-20 13:45:58 +09:00
2020-10-19 19:29:56 +03:00
2020-07-18 22:43:49 +09:00
2018-06-20 16:06:03 +02:00
2020-10-19 13:48:20 +02:00
2017-10-17 15:10:33 -04:00
2017-10-17 15:10:33 -04:00
2020-07-18 22:43:49 +09:00
2020-10-19 19:29:56 +03:00
2018-07-16 10:44:06 +02:00
2017-10-17 15:10:33 -04:00
2017-10-17 15:10:33 -04:00
2020-07-18 22:43:49 +09:00
2020-10-19 19:29:56 +03:00
2018-10-03 13:11:44 -07:00
2018-04-03 09:47:18 -04:00
2021-01-02 13:06:24 -05:00
2019-02-21 15:39:37 +01:00
2021-01-05 14:26:37 -05:00
2017-10-17 15:10:33 -04:00
2020-10-19 19:29:56 +03:00
2017-10-17 15:10:33 -04:00
2017-10-17 15:10:33 -04:00
2019-08-20 13:45:58 +09:00
2020-10-19 19:29:56 +03:00
2017-08-15 14:37:44 -04:00
2017-04-12 15:41:41 -04:00
2020-10-19 19:29:56 +03:00
2019-08-20 13:45:58 +09:00

<!-- doc/src/sgml/README.links -->

Linking within SGML documents can be confusing, so here is a summary:


Intra-document Linking
----------------------

<xref>
	use to get chapter/section number from the title of the target
	link, or xreflabel if defined at the target, or refentrytitle if target
        is a refentry;  has no close tag
	http://www.oasis-open.org/docbook/documentation/reference/html/xref.html

<link>
	use to supply text for the link, requires </link>
	http://www.oasis-open.org/docbook/documentation/reference/html/link.html

linkend=
	controls the target of the link/xref, required

endterm=
	for <xref>, allows the text of the link/xref to be taken from a
	different link target title


External Linking
----------------

<ulink>
	like <link>, but uses a URL (not a document target);  requires
	</ulink>; if no text is specified, the URL appears as the link
	text
	http://www.oasis-open.org/docbook/documentation/reference/html/ulink.html

url=
	used by <ulink> to specify the URL, required


Guidelines
----------

o  If you want to supply text, use <link>, else <xref>
o  Do not use text with <ulink> so the URL appears in printed output
o  Specific nouns like GUC variables, SQL commands, and contrib modules
   usually have xreflabels