1
0
mirror of https://github.com/postgres/postgres.git synced 2025-05-09 18:21:05 +03:00
Michael Paquier 292ae8af79 Improve documentation of pageinspect
This adds a section for heap-related functions.  These were previously
mixed with functions having a more general purpose, leading to
confusion.  While on it, add a query example for fsm_page_contents.

Backpatch down to 10, where b5e3942 introduced the subsections for
function types in pageinspect documentation.

Author: Masahiko Sawada
Discussion: https://postgr.es/m/CAD21AoDyM7E1+cK3-aWejxKTGC-wVVP2B+RnJhN6inXyeRmqzw@mail.gmail.com
Backpatch-through: 10
2019-08-23 20:41:06 +09:00
..
2018-07-16 10:48:05 +02:00
2017-10-20 19:26:10 -04:00
2019-07-05 08:34:54 +02:00
2018-10-11 11:43:56 -07:00
2018-06-20 16:01:18 +02:00
2019-07-14 14:30:27 +02:00
2018-06-20 16:06:03 +02:00
2019-08-13 08:40:17 +02:00
2019-06-09 11:25:56 +09:00
2019-07-01 12:50:55 -04:00
2017-10-17 15:10:33 -04:00
2017-10-17 15:10:33 -04:00
2019-07-05 08:34:54 +02:00
2019-04-08 22:32:46 +02:00
2018-07-16 10:48:05 +02:00
2019-04-03 17:40:29 -07:00
2017-10-17 15:10:33 -04:00
2017-10-17 15:10:33 -04:00
2018-07-16 10:48:05 +02:00
2018-10-03 12:48:37 -07:00
2019-01-02 12:44:25 -05:00
2019-03-29 08:26:33 +01:00
2018-07-16 10:48:05 +02:00
2017-10-17 15:10:33 -04:00
2018-08-28 21:33:32 +09:00
2019-04-08 22:32:46 +02:00
2019-07-14 14:30:27 +02:00
2017-10-17 15:10:33 -04:00
2019-08-13 08:40:17 +02:00
2019-03-29 13:36:24 +01:00
2019-07-01 12:50:55 -04:00
2019-07-01 12:50:55 -04:00
2019-02-17 20:23:10 +09:00
2017-11-23 09:44:28 -05:00
2019-08-13 08:40:17 +02:00
2019-08-13 08:40:17 +02:00
2017-08-15 14:37:44 -04:00
2019-03-27 23:10:23 +01:00
2019-03-27 23:10:23 +01:00
2019-03-30 08:15:57 +01:00
2019-07-14 14:30:27 +02:00
2018-08-28 21:42:45 +09:00
2018-07-16 10:48:05 +02:00
2019-07-05 08:34:54 +02:00

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

Linking within DocBook 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
----------

- For an internal link, if you want to supply text, use <link>, else
  <xref>.

- Specific nouns like GUC variables, SQL commands, and contrib modules
  usually have xreflabels.

- For an external link, use <ulink>, with or without link text.