forked frompostgres/postgres
- Notifications
You must be signed in to change notification settings - Fork6
Commit9081bdd
committed
Improve <xref> vs. <command> formatting in the documentation
SQL commands are generally marked up as <command>, except when a linkto a reference page is used using <xref>. But the latter doesn'tcreate monospace markup, so this looks strange especially when aparagraph contains a mix of links and non-links.We considered putting <command> in the <refentrytitle> on the targetside, but that creates some formatting side effects elsewhere.Generally, it seems safer to solve this on the link source side.We can't put the <xref> inside the <command>; the DTD doesn't allowthis. DocBook 5 would allow the <command> to have the linkendattribute itself, but we are not there yet.So to solve this for now, convert the <xref>s to <link> plus<command>. This gives the correct look and also gives some moreflexibility what we can put into the link text (e.g., subcommands orother clauses). In the future, these could then be converted toDocBook 5 style.I haven't converted absolutely all xrefs to SQL command referencepages, only those where we care about the appearance of the link textor where it was otherwise appropriate to make the appearance match abit better. Also in some cases, the links where repetitive, so inthose cases the links where just removed and replaced by a plain<command>. In cases where we just want the link and don'tspecifically care about the generated link text (typically phrased"for further information see <xref ...>") the xref is kept.Reported-by: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>Discussion:https://www.postgresql.org/message-id/flat/87o8pco34z.fsf@wibble.ilmari.org1 parent1a9388b commit9081bdd
File tree
92 files changed
+348
-346
lines changed- doc/src/sgml
- ref
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
92 files changed
+348
-346
lines changedLines changed: 4 additions & 4 deletions
Original file line number | Diff line number | Diff line change | |
---|---|---|---|
| |||
177 | 177 |
| |
178 | 178 |
| |
179 | 179 |
| |
180 |
| - | |
181 |
| - | |
| 180 | + | |
| 181 | + | |
182 | 182 |
| |
183 | 183 |
| |
184 | 184 |
| |
| |||
1594 | 1594 |
| |
1595 | 1595 |
| |
1596 | 1596 |
| |
1597 |
| - | |
| 1597 | + | |
1598 | 1598 |
| |
1599 | 1599 |
| |
1600 | 1600 |
| |
| |||
1607 | 1607 |
| |
1608 | 1608 |
| |
1609 | 1609 |
| |
1610 |
| - | |
| 1610 | + | |
1611 | 1611 |
| |
1612 | 1612 |
| |
1613 | 1613 |
| |
|
Lines changed: 49 additions & 49 deletions
Large diffs are not rendered by default.
Lines changed: 12 additions & 12 deletions
Original file line number | Diff line number | Diff line change | |
---|---|---|---|
| |||
189 | 189 |
| |
190 | 190 |
| |
191 | 191 |
| |
192 |
| - | |
| 192 | + | |
193 | 193 |
| |
194 | 194 |
| |
195 | 195 |
| |
| |||
221 | 221 |
| |
222 | 222 |
| |
223 | 223 |
| |
224 |
| - | |
| 224 | + | |
225 | 225 |
| |
226 | 226 |
| |
227 | 227 |
| |
| |||
231 | 231 |
| |
232 | 232 |
| |
233 | 233 |
| |
234 |
| - | |
| 234 | + | |
235 | 235 |
| |
236 | 236 |
| |
237 | 237 |
| |
238 | 238 |
| |
239 | 239 |
| |
240 | 240 |
| |
241 |
| - | |
| 241 | + | |
242 | 242 |
| |
243 | 243 |
| |
244 | 244 |
| |
| |||
262 | 262 |
| |
263 | 263 |
| |
264 | 264 |
| |
265 |
| - | |
| 265 | + | |
266 | 266 |
| |
267 | 267 |
| |
268 | 268 |
| |
269 | 269 |
| |
270 | 270 |
| |
271 | 271 |
| |
272 | 272 |
| |
273 |
| - | |
| 273 | + | |
274 | 274 |
| |
275 | 275 |
| |
276 | 276 |
| |
| |||
296 | 296 |
| |
297 | 297 |
| |
298 | 298 |
| |
299 |
| - | |
| 299 | + | |
300 | 300 |
| |
301 | 301 |
| |
302 | 302 |
| |
| |||
4608 | 4608 |
| |
4609 | 4609 |
| |
4610 | 4610 |
| |
4611 |
| - | |
| 4611 | + | |
4612 | 4612 |
| |
4613 | 4613 |
| |
4614 | 4614 |
| |
| |||
8095 | 8095 |
| |
8096 | 8096 |
| |
8097 | 8097 |
| |
8098 |
| - | |
| 8098 | + | |
8099 | 8099 |
| |
8100 | 8100 |
| |
8101 | 8101 |
| |
| |||
8781 | 8781 |
| |
8782 | 8782 |
| |
8783 | 8783 |
| |
8784 |
| - | |
| 8784 | + | |
8785 | 8785 |
| |
8786 | 8786 |
| |
8787 | 8787 |
| |
| |||
8832 | 8832 |
| |
8833 | 8833 |
| |
8834 | 8834 |
| |
8835 |
| - | |
| 8835 | + | |
8836 | 8836 |
| |
8837 | 8837 |
| |
8838 | 8838 |
| |
| |||
8874 | 8874 |
| |
8875 | 8875 |
| |
8876 | 8876 |
| |
8877 |
| - | |
| 8877 | + | |
8878 | 8878 |
| |
8879 | 8879 |
| |
8880 | 8880 |
| |
|
Lines changed: 11 additions & 11 deletions
Original file line number | Diff line number | Diff line change | |
---|---|---|---|
| |||
1675 | 1675 |
| |
1676 | 1676 |
| |
1677 | 1677 |
| |
1678 |
| - | |
| 1678 | + | |
1679 | 1679 |
| |
1680 | 1680 |
| |
1681 |
| - | |
| 1681 | + | |
1682 | 1682 |
| |
1683 |
| - | |
| 1683 | + | |
1684 | 1684 |
| |
1685 | 1685 |
| |
1686 | 1686 |
| |
| |||
1692 | 1692 |
| |
1693 | 1693 |
| |
1694 | 1694 |
| |
1695 |
| - | |
| 1695 | + | |
1696 | 1696 |
| |
1697 | 1697 |
| |
1698 | 1698 |
| |
1699 |
| - | |
| 1699 | + | |
1700 | 1700 |
| |
1701 | 1701 |
| |
1702 | 1702 |
| |
| |||
1705 | 1705 |
| |
1706 | 1706 |
| |
1707 | 1707 |
| |
1708 |
| - | |
| 1708 | + | |
1709 | 1709 |
| |
1710 | 1710 |
| |
1711 | 1711 |
| |
| |||
1727 | 1727 |
| |
1728 | 1728 |
| |
1729 | 1729 |
| |
1730 |
| - | |
| 1730 | + | |
1731 | 1731 |
| |
1732 | 1732 |
| |
1733 | 1733 |
| |
| |||
1739 | 1739 |
| |
1740 | 1740 |
| |
1741 | 1741 |
| |
1742 |
| - | |
| 1742 | + | |
1743 | 1743 |
| |
1744 | 1744 |
| |
1745 | 1745 |
| |
| |||
3370 | 3370 |
| |
3371 | 3371 |
| |
3372 | 3372 |
| |
3373 |
| - | |
| 3373 | + | |
3374 | 3374 |
| |
3375 | 3375 |
| |
3376 | 3376 |
| |
3377 |
| - | |
| 3377 | + | |
3378 | 3378 |
| |
3379 | 3379 |
| |
3380 | 3380 |
| |
| |||
3406 | 3406 |
| |
3407 | 3407 |
| |
3408 | 3408 |
| |
3409 |
| - | |
| 3409 | + | |
3410 | 3410 |
| |
3411 | 3411 |
| |
3412 | 3412 |
| |
|
Lines changed: 1 addition & 1 deletion
Original file line number | Diff line number | Diff line change | |
---|---|---|---|
| |||
245 | 245 |
| |
246 | 246 |
| |
247 | 247 |
| |
248 |
| - | |
| 248 | + | |
249 | 249 |
| |
250 | 250 |
| |
251 | 251 |
| |
|
Lines changed: 3 additions & 4 deletions
Original file line number | Diff line number | Diff line change | |
---|---|---|---|
| |||
479 | 479 |
| |
480 | 480 |
| |
481 | 481 |
| |
482 |
| - | |
483 |
| - | |
484 |
| - | |
485 |
| - | |
| 482 | + | |
| 483 | + | |
| 484 | + | |
486 | 485 |
| |
487 | 486 |
| |
488 | 487 |
| |
|
Lines changed: 5 additions & 5 deletions
Original file line number | Diff line number | Diff line change | |
---|---|---|---|
| |||
504 | 504 |
| |
505 | 505 |
| |
506 | 506 |
| |
507 |
| - | |
| 507 | + | |
508 | 508 |
| |
509 | 509 |
| |
510 | 510 |
| |
| |||
513 | 513 |
| |
514 | 514 |
| |
515 | 515 |
| |
516 |
| - | |
| 516 | + | |
517 | 517 |
| |
518 | 518 |
| |
519 | 519 |
| |
| |||
572 | 572 |
| |
573 | 573 |
| |
574 | 574 |
| |
575 |
| - | |
| 575 | + | |
576 | 576 |
| |
577 | 577 |
| |
578 | 578 |
| |
| |||
605 | 605 |
| |
606 | 606 |
| |
607 | 607 |
| |
608 |
| - | |
| 608 | + | |
609 | 609 |
| |
610 | 610 |
| |
611 | 611 |
| |
| |||
1373 | 1373 |
| |
1374 | 1374 |
| |
1375 | 1375 |
| |
1376 |
| - | |
| 1376 | + | |
1377 | 1377 |
| |
1378 | 1378 |
| |
1379 | 1379 |
| |
|
Lines changed: 6 additions & 6 deletions
Original file line number | Diff line number | Diff line change | |
---|---|---|---|
| |||
147 | 147 |
| |
148 | 148 |
| |
149 | 149 |
| |
150 |
| - | |
| 150 | + | |
151 | 151 |
| |
152 | 152 |
| |
153 | 153 |
| |
154 | 154 |
| |
155 | 155 |
| |
156 |
| - | |
| 156 | + | |
157 | 157 |
| |
158 | 158 |
| |
159 | 159 |
| |
| |||
207 | 207 |
| |
208 | 208 |
| |
209 | 209 |
| |
210 |
| - | |
| 210 | + | |
211 | 211 |
| |
212 |
| - | |
213 |
| - | |
| 212 | + | |
| 213 | + | |
214 | 214 |
| |
215 | 215 |
| |
216 | 216 |
| |
| |||
418 | 418 |
| |
419 | 419 |
| |
420 | 420 |
| |
421 |
| - | |
| 421 | + | |
422 | 422 |
| |
423 | 423 |
| |
424 | 424 |
| |
|
Lines changed: 5 additions & 5 deletions
Original file line number | Diff line number | Diff line change | |
---|---|---|---|
| |||
87 | 87 |
| |
88 | 88 |
| |
89 | 89 |
| |
90 |
| - | |
| 90 | + | |
91 | 91 |
| |
92 | 92 |
| |
93 | 93 |
| |
| |||
227 | 227 |
| |
228 | 228 |
| |
229 | 229 |
| |
230 |
| - | |
| 230 | + | |
231 | 231 |
| |
232 |
| - | |
| 232 | + | |
233 | 233 |
| |
234 | 234 |
| |
235 | 235 |
| |
| |||
242 | 242 |
| |
243 | 243 |
| |
244 | 244 |
| |
245 |
| - | |
| 245 | + | |
246 | 246 |
| |
247 | 247 |
| |
248 | 248 |
| |
| |||
269 | 269 |
| |
270 | 270 |
| |
271 | 271 |
| |
272 |
| - | |
| 272 | + | |
273 | 273 |
| |
274 | 274 |
| |
275 | 275 |
| |
|
Lines changed: 3 additions & 3 deletions
Original file line number | Diff line number | Diff line change | |
---|---|---|---|
| |||
27 | 27 |
| |
28 | 28 |
| |
29 | 29 |
| |
30 |
| - | |
| 30 | + | |
31 | 31 |
| |
32 | 32 |
| |
33 | 33 |
| |
| |||
5278 | 5278 |
| |
5279 | 5279 |
| |
5280 | 5280 |
| |
5281 |
| - | |
5282 |
| - | |
| 5281 | + | |
| 5282 | + | |
5283 | 5283 |
| |
5284 | 5284 |
| |
5285 | 5285 |
| |
|
0 commit comments
Comments
(0)