Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit c99d5d1

Browse files
peterepetere
committed
doc: Fix <synopsis> in <term> markup
Although the DTD technically allows this, the resulting HTML is invalid because it puts block elements inside inline elements. DocBook 5.0 also doesn't allow it anymore, so it's fair to assume that this was never really intended to work. Replace <synopsis> with <literal>, which is the markup used elsewhere in the documentation in similar cases.
1 parent 734fbbd commit c99d5d1

File tree

1 file changed

+19
-51
lines changed

1 file changed

+19
-51
lines changed

‎doc/src/sgml/textsearch.sgml

Lines changed: 19 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -859,10 +859,7 @@ SELECT plainto_tsquery('english', 'The Fat &amp; Rats:C');
859859
</indexterm>
860860

861861
<term>
862-
<synopsis>
863-
ts_rank(<optional> <replaceable class="PARAMETER">weights</replaceable> <type>float4[]</>, </optional> <replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>,
864-
<replaceable class="PARAMETER">query</replaceable> <type>tsquery</> <optional>, <replaceable class="PARAMETER">normalization</replaceable> <type>integer</> </optional>) returns <type>float4</>
865-
</synopsis>
862+
<literal>ts_rank(<optional> <replaceable class="PARAMETER">weights</replaceable> <type>float4[]</>, </optional> <replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>, <replaceable class="PARAMETER">query</replaceable> <type>tsquery</> <optional>, <replaceable class="PARAMETER">normalization</replaceable> <type>integer</> </optional>) returns <type>float4</></literal>
866863
</term>
867864

868865
<listitem>
@@ -879,10 +876,7 @@ ts_rank(<optional> <replaceable class="PARAMETER">weights</replaceable> <type>fl
879876
</indexterm>
880877

881878
<term>
882-
<synopsis>
883-
ts_rank_cd(<optional> <replaceable class="PARAMETER">weights</replaceable> <type>float4[]</>, </optional> <replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>,
884-
<replaceable class="PARAMETER">query</replaceable> <type>tsquery</> <optional>, <replaceable class="PARAMETER">normalization</replaceable> <type>integer</> </optional>) returns <type>float4</>
885-
</synopsis>
879+
<literal>ts_rank_cd(<optional> <replaceable class="PARAMETER">weights</replaceable> <type>float4[]</>, </optional> <replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>, <replaceable class="PARAMETER">query</replaceable> <type>tsquery</> <optional>, <replaceable class="PARAMETER">normalization</replaceable> <type>integer</> </optional>) returns <type>float4</></literal>
886880
</term>
887881

888882
<listitem>
@@ -1226,9 +1220,7 @@ FROM (SELECT id, body, q, ts_rank_cd(ti, q) AS rank
12261220
</indexterm>
12271221

12281222
<term>
1229-
<synopsis>
1230-
<type>tsvector</> || <type>tsvector</>
1231-
</synopsis>
1223+
<literal><type>tsvector</> || <type>tsvector</></literal>
12321224
</term>
12331225

12341226
<listitem>
@@ -1267,9 +1259,7 @@ FROM (SELECT id, body, q, ts_rank_cd(ti, q) AS rank
12671259
</indexterm>
12681260

12691261
<term>
1270-
<synopsis>
1271-
setweight(<replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>, <replaceable class="PARAMETER">weight</replaceable> <type>"char"</>) returns <type>tsvector</>
1272-
</synopsis>
1262+
<literal>setweight(<replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>, <replaceable class="PARAMETER">weight</replaceable> <type>"char"</>) returns <type>tsvector</></literal>
12731263
</term>
12741264

12751265
<listitem>
@@ -1297,9 +1287,7 @@ setweight(<replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>,
12971287
</indexterm>
12981288

12991289
<term>
1300-
<synopsis>
1301-
length(<replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>) returns <type>integer</>
1302-
</synopsis>
1290+
<literal>length(<replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>) returns <type>integer</></literal>
13031291
</term>
13041292

13051293
<listitem>
@@ -1316,9 +1304,7 @@ length(<replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>) re
13161304
</indexterm>
13171305

13181306
<term>
1319-
<synopsis>
1320-
strip(<replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>) returns <type>tsvector</>
1321-
</synopsis>
1307+
<literal>strip(<replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>) returns <type>tsvector</></literal>
13221308
</term>
13231309

13241310
<listitem>
@@ -1352,9 +1338,7 @@ strip(<replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>) ret
13521338
<varlistentry>
13531339

13541340
<term>
1355-
<synopsis>
1356-
<type>tsquery</> &amp;&amp; <type>tsquery</>
1357-
</synopsis>
1341+
<literal><type>tsquery</> &amp;&amp; <type>tsquery</></literal>
13581342
</term>
13591343

13601344
<listitem>
@@ -1368,9 +1352,7 @@ strip(<replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>) ret
13681352
<varlistentry>
13691353

13701354
<term>
1371-
<synopsis>
1372-
<type>tsquery</> || <type>tsquery</>
1373-
</synopsis>
1355+
<literal><type>tsquery</> || <type>tsquery</></literal>
13741356
</term>
13751357

13761358
<listitem>
@@ -1384,9 +1366,7 @@ strip(<replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>) ret
13841366
<varlistentry>
13851367

13861368
<term>
1387-
<synopsis>
1388-
!! <type>tsquery</>
1389-
</synopsis>
1369+
<literal>!! <type>tsquery</></literal>
13901370
</term>
13911371

13921372
<listitem>
@@ -1404,9 +1384,7 @@ strip(<replaceable class="PARAMETER">vector</replaceable> <type>tsvector</>) ret
14041384
</indexterm>
14051385

14061386
<term>
1407-
<synopsis>
1408-
numnode(<replaceable class="PARAMETER">query</replaceable> <type>tsquery</>) returns <type>integer</>
1409-
</synopsis>
1387+
<literal>numnode(<replaceable class="PARAMETER">query</replaceable> <type>tsquery</>) returns <type>integer</></literal>
14101388
</term>
14111389

14121390
<listitem>
@@ -1440,9 +1418,7 @@ SELECT numnode('foo &amp; bar'::tsquery);
14401418
</indexterm>
14411419

14421420
<term>
1443-
<synopsis>
1444-
querytree(<replaceable class="PARAMETER">query</replaceable> <type>tsquery</>) returns <type>text</>
1445-
</synopsis>
1421+
<literal>querytree(<replaceable class="PARAMETER">query</replaceable> <type>tsquery</>) returns <type>text</></literal>
14461422
</term>
14471423

14481424
<listitem>
@@ -1495,9 +1471,7 @@ SELECT querytree(to_tsquery('!defined'));
14951471
<varlistentry>
14961472

14971473
<term>
1498-
<synopsis>
1499-
ts_rewrite (<replaceable class="PARAMETER">query</replaceable> <type>tsquery</>, <replaceable class="PARAMETER">target</replaceable> <type>tsquery</>, <replaceable class="PARAMETER">substitute</replaceable> <type>tsquery</>) returns <type>tsquery</>
1500-
</synopsis>
1474+
<literal>ts_rewrite (<replaceable class="PARAMETER">query</replaceable> <type>tsquery</>, <replaceable class="PARAMETER">target</replaceable> <type>tsquery</>, <replaceable class="PARAMETER">substitute</replaceable> <type>tsquery</>) returns <type>tsquery</></literal>
15011475
</term>
15021476

15031477
<listitem>
@@ -1521,9 +1495,7 @@ SELECT ts_rewrite('a &amp; b'::tsquery, 'a'::tsquery, 'c'::tsquery);
15211495
<varlistentry>
15221496

15231497
<term>
1524-
<synopsis>
1525-
ts_rewrite (<replaceable class="PARAMETER">query</> <type>tsquery</>, <replaceable class="PARAMETER">select</> <type>text</>) returns <type>tsquery</>
1526-
</synopsis>
1498+
<literal>ts_rewrite (<replaceable class="PARAMETER">query</> <type>tsquery</>, <replaceable class="PARAMETER">select</> <type>text</>) returns <type>tsquery</></literal>
15271499
</term>
15281500

15291501
<listitem>
@@ -3239,9 +3211,7 @@ SELECT plainto_tsquery('supernovae stars');
32393211
</indexterm>
32403212

32413213
<term>
3242-
<synopsis>
3243-
CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable> USING gist(<replaceable>column</replaceable>);
3244-
</synopsis>
3214+
<literal>CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable> USING gist(<replaceable>column</replaceable>);</literal>
32453215
</term>
32463216

32473217
<listitem>
@@ -3262,9 +3232,7 @@ CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable>
32623232
</indexterm>
32633233

32643234
<term>
3265-
<synopsis>
3266-
CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable> USING gin(<replaceable>column</replaceable>);
3267-
</synopsis>
3235+
<literal>CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable> USING gin(<replaceable>column</replaceable>);</literal>
32683236
</term>
32693237

32703238
<listitem>
@@ -3414,7 +3382,7 @@ CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable>
34143382

34153383
<variablelist>
34163384
<varlistentry>
3417-
<term><synopsis>\dF<optional>+</optional> <optional>PATTERN</optional></synopsis></term>
3385+
<term><literal>\dF<optional>+</optional> <optional>PATTERN</optional></literal></term>
34183386
<listitem>
34193387
<para>
34203388
List text search configurations (add <literal>+</> for more detail).
@@ -3455,7 +3423,7 @@ Parser: "pg_catalog.default"
34553423
</varlistentry>
34563424

34573425
<varlistentry>
3458-
<term><synopsis>\dFd<optional>+</optional> <optional>PATTERN</optional></synopsis></term>
3426+
<term><literal>\dFd<optional>+</optional> <optional>PATTERN</optional></literal></term>
34593427
<listitem>
34603428
<para>
34613429
List text search dictionaries (add <literal>+</> for more detail).
@@ -3486,7 +3454,7 @@ Parser: "pg_catalog.default"
34863454
</varlistentry>
34873455

34883456
<varlistentry>
3489-
<term><synopsis>\dFp<optional>+</optional> <optional>PATTERN</optional></synopsis></term>
3457+
<term><literal>\dFp<optional>+</optional> <optional>PATTERN</optional></literal></term>
34903458
<listitem>
34913459
<para>
34923460
List text search parsers (add <literal>+</> for more detail).
@@ -3539,7 +3507,7 @@ Parser: "pg_catalog.default"
35393507
</varlistentry>
35403508

35413509
<varlistentry>
3542-
<term><synopsis>\dFt<optional>+</optional> <optional>PATTERN</optional></synopsis></term>
3510+
<term><literal>\dFt<optional>+</optional> <optional>PATTERN</optional></literal></term>
35433511
<listitem>
35443512
<para>
35453513
List text search templates (add <literal>+</> for more detail).

0 commit comments

Comments
 (0)