1
0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-09-16 09:06:18 +02:00

Simplify table of contents on command page by only listing commands.

Suggested by Stephen Frost.
This commit is contained in:
David Steele
2018-03-14 11:10:46 -04:00
parent 4b6cd92a4c
commit e7fd94ee23
2 changed files with 12 additions and 2 deletions

View File

@@ -708,7 +708,8 @@ sub helpCommandDocGet
# Iterate sections
foreach my $strCategory (sort(keys(%{$oCategory})))
{
my $oOptionListElement = $oSectionElement->nodeAdd('section', undef, {id => "category-${strCategory}"});
my $oOptionListElement = $oSectionElement->nodeAdd(
'section', undef, {id => "category-${strCategory}", toc => 'n'});
$oOptionListElement->
nodeAdd('title')->textSet(ucfirst($strCategory) . ' Options');
@@ -781,7 +782,8 @@ sub helpOptionGet
my $oOptionHash = shift;
# Create the option section
my $oOptionElement = $oParentElement->nodeAdd('section', undef, {id => "option-${strOption}"});
my $oOptionElement = $oParentElement->nodeAdd(
'section', undef, {id => "option-${strOption}", toc => defined($strCommand) ? 'n' : 'y'});
# Set the option section title
$oOptionElement->

View File

@@ -111,6 +111,14 @@
<p>Show index in examples for indexed options, i.e. <id>repo-*</id>, <id>pg-*</id>.</p>
</release-item>
<release-item>
<release-item-contributor-list>
<release-item-ideator id="frost.stephen"/>
</release-item-contributor-list>
<p>Simplify table of contents on command page by only listing commands.</p>
</release-item>
<release-item>
<p>Remove references to the C library being optional.</p>
</release-item>