mirror of
https://github.com/pgbackrest/pgbackrest.git
synced 2024-12-14 10:13:05 +02:00
c51274d1b6
It would be better if the documentation could be generated on multiple operating systems all in one go, but the doc system currently does not allow vars to be changed once they are set. The solution is to run the docs for each required OS and stitch the documentation together. It's not pretty but it works and the automation in release.pl should at least make it easy to use.
117 lines
4.9 KiB
XML
117 lines
4.9 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE doc SYSTEM "manifest.dtd">
|
|
<doc>
|
|
<!-- System-wide variables -->
|
|
<variable-list>
|
|
<variable key="project">pgBackRest</variable>
|
|
<variable key="project-tagline">Reliable PostgreSQL Backup & Restore</variable>
|
|
<variable key="version" eval="y">use pgBackRest::Version; PROJECT_VERSION</variable>
|
|
<variable key="version-stable" eval="y">
|
|
use BackRestDoc::Custom::DocCustomRelease;
|
|
|
|
(new BackRestDoc::Custom::DocCustomRelease(
|
|
new BackRestDoc::Common::Doc("{[doc-path]}/xml/release.xml")))->currentStableVersion();
|
|
</variable>
|
|
<variable key="project-exe">pgbackrest</variable>
|
|
<variable key="project-url-root">/</variable>
|
|
<variable key="postgres">PostgreSQL</variable>
|
|
<variable key="dash">-</variable>
|
|
<variable key="project-logo">logo.png</variable>
|
|
<variable key="project-favicon">favicon.png</variable>
|
|
|
|
<!-- Is this a development or debug build of the docs? -->
|
|
<variable key="dev">n</variable>
|
|
<variable key="debug">n</variable>
|
|
|
|
<!-- Release date - static allows for reproducible builds -->
|
|
<variable key="release-date-static">n</variable>
|
|
<variable key="release-date" eval="y">
|
|
use Time::Local;
|
|
use BackRestDoc::Custom::DocCustomRelease;
|
|
|
|
my ($second, $minute , $hour, $mday, $month, $year) = localtime();
|
|
$year += 1900;
|
|
|
|
if ('{[release-date-static]}' eq 'y')
|
|
{
|
|
my $strDate = (new BackRestDoc::Custom::DocCustomRelease(
|
|
new BackRestDoc::Common::Doc("{[doc-path]}/xml/release.xml")))->releaseLast()->paramGet('date');
|
|
|
|
if ($strDate eq 'XXXX-XX-XX')
|
|
{
|
|
confess &log(ERROR, 'not possible to use static release dates on a dev build');
|
|
}
|
|
else
|
|
{
|
|
($year, $month, $mday) = split(/[\s.\-]+/, $strDate);
|
|
$month -= 1;
|
|
}
|
|
}
|
|
|
|
my @stryMonth = ('January', 'February', 'March', 'April', 'May', 'June',
|
|
'July', 'August', 'September', 'October', 'November', 'December');
|
|
|
|
$stryMonth[$month] . ' ' . $mday . ', ' . $year;
|
|
</variable>
|
|
|
|
<!-- HTML variables -->
|
|
<variable key="html-footer" eval='y'>
|
|
'Copyright &copy; 2015' . '-' . substr('{[release-date]}', length('{[release-date]}') - 4) .
|
|
', The PostgreSQL Global Development Group, <a href="{[github-url-license]}">MIT License</a>. Updated ' .
|
|
'{[release-date]}';
|
|
</variable>
|
|
<!-- <variable key="html-logo"><img src="{[project-logo]}"></variable> -->
|
|
|
|
<!-- PDF variables -->
|
|
<variable key="pdf-logo">{[doc-path]}/output/latex/logo</variable>
|
|
|
|
<variable key="pdf-title1">{[project]} User Guide</variable>
|
|
<variable key="pdf-title2">Open Source PostgreSQL Backup and Restore Utility</variable>
|
|
<variable key="pdf-title3">Version {[version]}</variable>
|
|
|
|
<variable key="pdf-organization">Crunchy Data Solutions, Inc.</variable>
|
|
<variable key="pdf-resource-logo">cds-logo.eps</variable>
|
|
|
|
<variable key='pdf-footer-left'>{[pdf-title1]}\\{[pdf-title3]}</variable>
|
|
<variable key='pdf-footer-center'>\ \\-\ \thepage\ -</variable>
|
|
<variable key='pdf-footer-right'>{[pdf-organization]}\\\today</variable>
|
|
|
|
<variable key="pdf-file">CrunchyBackRest-UserGuide-{[version]}</variable>
|
|
</variable-list>
|
|
|
|
<source-list>
|
|
<source key="index"/>
|
|
<source key="user-guide-index"/>
|
|
<source key="user-guide"/>
|
|
<source key="reference" type="custom"/>
|
|
<source key="release" type="custom"/>
|
|
<source key="metric"/>
|
|
<source key="coding"/>
|
|
<source key="documentation"/>
|
|
<source key="test"/>
|
|
</source-list>
|
|
|
|
<render-list>
|
|
<render type="html">
|
|
<render-source key="index" menu="Home"/>
|
|
<render-source key="user-guide-index" menu="User Guides"/>
|
|
<render-source key="user-guide"/>
|
|
<render-source key="release" menu="Releases"/>
|
|
<render-source key="configuration" source="reference" menu="Configuration"/>
|
|
<render-source key="command" source="reference" menu="Commands"/>
|
|
<render-source key="metric" menu="Metrics"/>
|
|
</render>
|
|
|
|
<render type="pdf" file="{[pdf-file]}">
|
|
<render-source key="user-guide"/>
|
|
</render>
|
|
|
|
<render type="markdown">
|
|
<render-source key="index" file="../../../README.md"/>
|
|
<render-source key="coding" file="../../../CODING.md"/>
|
|
<render-source key="test" file="../../../test/README.md"/>
|
|
<render-source key="documentation" file="../../README.md"/>
|
|
</render>
|
|
</render-list>
|
|
</doc>
|