db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2024-12-14 10:13:05 +02:00
Code Issues Releases Activity
21db7f65ef
pgbackrest/doc/xml/dtd/doc.dtd

275 lines
10 KiB
DTD
Raw Normal View History

Move contributor list to the end of release.xml for convenience.
2017-08-12 00:43:21 +02:00
<!ELEMENT doc ((description, intro, release-list, contributor-list)|(config, operation)|
Allow containers to be defined in a document. The defined containers are built before the document build begins which allows them to be reused.
2018-07-23 13:49:15 +02:00
(description?, variable-list?, host-define*, block-define*, cleanup?, section+))>
Doc engine improvements. Bug Fixes: * Fixed and issue that suppressed exceptions in PDF builds. Features: * Allow a source to be included as a section so large documents can be broken up. * Added section link support to Markdown output. * Added list support to PDF output. * Added include option to explicitly build sources (complements the exclude option though both cannot be used in the same invocation). * Added keyword-add option to add keywords without overriding the default keyword. * Added debug option to doc.pl to easily add the debug keyword to documentation builds. * Added pre option to doc.pl to easily add the pre keyword to documentation builds. Refactoring: * Improvements to markdown rendering. * Remove code dependency on project variable, instead use title param.
2016-11-17 23:35:11 +02:00
<!ATTLIST doc title CDATA #REQUIRED>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST doc subtitle CDATA "">
<!ATTLIST doc toc CDATA "y">
Doc engine improvements. Bug Fixes: * Fixed missing variable replacements. * Removed hard-coded host names from configuration file paths. Documentation Features: * Allow command-line length to be configured using cmd-line-len param. * Added compact param to allow CSS to be embedded in HTML file. * Added pretty param to produce HTML with proper indenting. * Only generate HTML menu when required and don't require index page. * Assign numbers to sections by default. * VM mount points are now optional.
2016-11-07 17:06:35 +02:00
<!ATTLIST doc toc-number CDATA "y">
<!ATTLIST doc cmd-line-len CDATA "80">
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
Added SEO and sharing features to the website. Descriptions wordsmithed (for better or worse) by committer.
2016-05-16 23:01:48 +02:00
<!ELEMENT description (#PCDATA)>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
<!ELEMENT intro (text)>
Added SEO and sharing features to the website. Descriptions wordsmithed (for better or worse) by committer.
2016-05-16 23:01:48 +02:00
<!ELEMENT operation (description, text?, operation-general, command-list)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST operation title CDATA #REQUIRED>
More work on automated docs. Merging this to go back to some feature/bug work for a while.
2015-03-16 20:01:01 +02:00
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ELEMENT operation-general (option-list)>
<!ATTLIST operation-general title CDATA #REQUIRED>
More work on automated docs. Merging this to go back to some feature/bug work for a while.
2015-03-16 20:01:01 +02:00
<!ELEMENT command-list (text?, command+)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST command-list title CDATA #REQUIRED>
More work on automated docs. Merging this to go back to some feature/bug work for a while.
2015-03-16 20:01:01 +02:00
Implemented issue #132: Improved command-line help. Implemented issue #133: Dynamic module loading where possible.
2015-09-08 13:31:24 +02:00
<!ELEMENT command (summary, text, option-list?, command-example-list)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST command id CDATA #REQUIRED>
<!ATTLIST command name CDATA #REQUIRED>
More work on automated docs. Merging this to go back to some feature/bug work for a while.
2015-03-16 20:01:01 +02:00
<!ELEMENT command-example-list (text?, command-example+)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST command-example-list title CDATA "Examples">
More work on automated docs. Merging this to go back to some feature/bug work for a while.
2015-03-16 20:01:01 +02:00
<!ELEMENT command-example (text)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST command-example title CDATA "Example">
More work on automated docs. Merging this to go back to some feature/bug work for a while.
2015-03-16 20:01:01 +02:00
<!ELEMENT option-list (option+)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ELEMENT option (summary, text, example)>
<!ATTLIST option id CDATA #REQUIRED>
Partial multi-repository implementation. Multi-repository implementations for the archive-push, check, info, stanza-create, stanza-upgrade, and stanza-delete commands. Multi-repo configuration is disabled so there should be no behavioral changes between these commands and their current single-repo implementations. Multi-repo documentation and integration tests are still in the multi-repo development branch. All unit tests work as multi-repo since they are able to bypass the configuration restrictions.
2021-01-21 22:21:50 +02:00
<!ATTLIST option section CDATA "">
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST option name CDATA #REQUIRED>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
Added SEO and sharing features to the website. Descriptions wordsmithed (for better or worse) by committer.
2016-05-16 23:01:48 +02:00
<!ELEMENT config (description, text, config-section-list)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST config title CDATA #REQUIRED>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
<!ELEMENT config-example (text)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST config-example title CDATA #REQUIRED>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
<!ELEMENT config-section-list (text?, config-section+)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST config-section-list title CDATA #REQUIRED>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
<!ELEMENT config-section (text, config-key-list?)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST config-section id CDATA #REQUIRED>
<!ATTLIST config-section name CDATA #REQUIRED>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
<!ELEMENT config-key-list (config-key+)>
Implemented issue #132: Improved command-line help. Implemented issue #133: Dynamic module loading where possible.
2015-09-08 13:31:24 +02:00
<!ELEMENT config-key (summary, text, default?, allow?, example)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST config-key id CDATA #REQUIRED>
<!ATTLIST config-key name CDATA #REQUIRED>
<!ELEMENT execute-list (title, execute+)>
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ATTLIST execute-list host CDATA #REQUIRED>
Replace keywords with more flexible if statements. Keywords were extremely limited and prevented us from generating multi-version documentation and other improvements. Replace keywords with an if statement that can evaluate a Perl expression with variable replacement. Since keywords were used to generate cache keys, add a --key-var parameter to identify which variables should make up the key.
2018-12-01 19:40:01 +02:00
<!ATTLIST execute-list if CDATA "">
Use a prebuilt s3 server container for documentation and tests.
2018-06-12 19:43:15 +02:00
<!ATTLIST execute-list show CDATA "">
Add cmd-extra field. Allow hidden options to be added to a command. This allows certain commands (like apt-get) to be forced during the build without making that a part of the documentation.
2016-06-04 02:07:28 +02:00
<!ELEMENT execute (exe-cmd, exe-cmd-extra?, exe-user?, exe-var?, exe-retry?, exe-output?, (exe-highlight-type?, exe-highlight)?,
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
exe-err-expect?, exe-err-suppress?, exe-err-suppress-stderr?)>
Replace keywords with more flexible if statements. Keywords were extremely limited and prevented us from generating multi-version documentation and other improvements. Replace keywords with an if statement that can evaluate a Perl expression with variable replacement. Since keywords were used to generate cache keys, add a --key-var parameter to identify which variables should make up the key.
2018-12-01 19:40:01 +02:00
<!ATTLIST execute if CDATA "">
Pre-build containers for any execute elements marked pre. This allows the documentation to be built more quickly and offline during development when --pre is specified on the command line. Each host gets a pre-built container with all the execute elements marked pre. As long as the pre elements do not change the container will not need to be rebuilt. The feature should not be used for CI builds as it may hide errors in the documentation.
2018-11-29 21:45:15 +02:00
<!ATTLIST execute pre CDATA "">
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ATTLIST execute user CDATA "">
<!ATTLIST execute filter CDATA "">
<!ATTLIST execute filter-context CDATA "">
Document generator improvements. * Build containers from scratch for more accurate testing. * Allow environment load to be skipped. * Allow bash wrapping to be skipped. * Allow forcing a command to run as a user without sudo.
2018-06-10 20:13:56 +02:00
<!ATTLIST execute user-force CDATA "">
<!ATTLIST execute bash-wrap CDATA "">
<!ATTLIST execute load-env CDATA "">
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ATTLIST execute skip CDATA "">
<!ATTLIST execute show CDATA "">
<!ATTLIST execute output CDATA "">
<!ATTLIST execute err-suppress CDATA "">
<!ATTLIST execute err-expect CDATA "">
<!ATTLIST execute retry CDATA "">
<!ATTLIST execute variable-key CDATA "">
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ELEMENT exe-cmd (#PCDATA)>
Add cmd-extra field. Allow hidden options to be added to a command. This allows certain commands (like apt-get) to be forced during the build without making that a part of the documentation.
2016-06-04 02:07:28 +02:00
<!ELEMENT exe-cmd-extra (#PCDATA)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ELEMENT exe-highlight (#PCDATA)>
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ELEMENT exe-highlight-type (#PCDATA)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ELEMENT cleanup (execute+)>
<!ELEMENT variable-list (variable+)>
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ELEMENT variable (#PCDATA)>
<!ATTLIST variable key CDATA #REQUIRED>
Replace keywords with more flexible if statements. Keywords were extremely limited and prevented us from generating multi-version documentation and other improvements. Replace keywords with an if statement that can evaluate a Perl expression with variable replacement. Since keywords were used to generate cache keys, add a --key-var parameter to identify which variables should make up the key.
2018-12-01 19:40:01 +02:00
<!ATTLIST variable if CDATA "default">
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ATTLIST variable eval CDATA "n">
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ELEMENT backrest-config (title, backrest-config-option+)>
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ATTLIST backrest-config host CDATA #REQUIRED>
<!ATTLIST backrest-config owner CDATA "">
<!ATTLIST backrest-config show CDATA "">
Replace keywords with more flexible if statements. Keywords were extremely limited and prevented us from generating multi-version documentation and other improvements. Replace keywords with an if statement that can evaluate a Perl expression with variable replacement. Since keywords were used to generate cache keys, add a --key-var parameter to identify which variables should make up the key.
2018-12-01 19:40:01 +02:00
<!ATTLIST backrest-config if CDATA "">
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ATTLIST backrest-config reset CDATA "">
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST backrest-config file CDATA #REQUIRED>
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ELEMENT backrest-config-option (#PCDATA)>
Replace keywords with more flexible if statements. Keywords were extremely limited and prevented us from generating multi-version documentation and other improvements. Replace keywords with an if statement that can evaluate a Perl expression with variable replacement. Since keywords were used to generate cache keys, add a --key-var parameter to identify which variables should make up the key.
2018-12-01 19:40:01 +02:00
<!ATTLIST backrest-config-option if CDATA "">
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ATTLIST backrest-config-option section CDATA #REQUIRED>
<!ATTLIST backrest-config-option key CDATA #REQUIRED>
<!ATTLIST backrest-config-option remove CDATA "n">
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ELEMENT postgres-config (title, postgres-config-option+)>
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ATTLIST postgres-config host CDATA #REQUIRED>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST postgres-config file CDATA #REQUIRED>
Replace keywords with more flexible if statements. Keywords were extremely limited and prevented us from generating multi-version documentation and other improvements. Replace keywords with an if statement that can evaluate a Perl expression with variable replacement. Since keywords were used to generate cache keys, add a --key-var parameter to identify which variables should make up the key.
2018-12-01 19:40:01 +02:00
<!ATTLIST postgres-config if CDATA "">
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ATTLIST postgres-config show CDATA "">
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ELEMENT postgres-config-option (#PCDATA)>
Replace keywords with more flexible if statements. Keywords were extremely limited and prevented us from generating multi-version documentation and other improvements. Replace keywords with an if statement that can evaluate a Perl expression with variable replacement. Since keywords were used to generate cache keys, add a --key-var parameter to identify which variables should make up the key.
2018-12-01 19:40:01 +02:00
<!ATTLIST postgres-config-option if CDATA "">
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST postgres-config-option key CDATA #REQUIRED>
<!ELEMENT option-description EMPTY>
<!ATTLIST option-description key CDATA #REQUIRED>
Add cmd-description tag. Allow command summaries to be inserted anywhere in the documentation to avoid duplication.
2016-06-12 15:01:56 +02:00
<!ELEMENT cmd-description EMPTY>
<!ATTLIST cmd-description key CDATA #REQUIRED>
Doc engine improvements. Bug Fixes: * Fixed and issue that suppressed exceptions in PDF builds. Features: * Allow a source to be included as a section so large documents can be broken up. * Added section link support to Markdown output. * Added list support to PDF output. * Added include option to explicitly build sources (complements the exclude option though both cannot be used in the same invocation). * Added keyword-add option to add keywords without overriding the default keyword. * Added debug option to doc.pl to easily add the debug keyword to documentation builds. * Added pre option to doc.pl to easily add the pre keyword to documentation builds. Refactoring: * Improvements to markdown rendering. * Remove code dependency on project variable, instead use title param.
2016-11-17 23:35:11 +02:00
<!ELEMENT section (title?,
Add cmd-description tag. Allow command summaries to be inserted anywhere in the documentation to avoid duplication.
2016-06-12 15:01:56 +02:00
((p|list|table|host-add|execute-list|backrest-config|postgres-config|cmd-description|
Add admonitions to documentation renderers. Admonitions call out places where the user should take special care. Support added for HTML, PDF, Markdown and help text renderers. XML files have been updated accordingly. Contributed by Cynthia Shang.
2018-12-30 16:40:20 +02:00
option-description|code-block|block|section|admonition)*))>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST section id CDATA #REQUIRED>
Replace keywords with more flexible if statements. Keywords were extremely limited and prevented us from generating multi-version documentation and other improvements. Replace keywords with an if statement that can evaluate a Perl expression with variable replacement. Since keywords were used to generate cache keys, add a --key-var parameter to identify which variables should make up the key.
2018-12-01 19:40:01 +02:00
<!ATTLIST section if CDATA "">
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ATTLIST section depend CDATA "">
Doc engine improvements. Bug Fixes: * Fixed and issue that suppressed exceptions in PDF builds. Features: * Allow a source to be included as a section so large documents can be broken up. * Added section link support to Markdown output. * Added list support to PDF output. * Added include option to explicitly build sources (complements the exclude option though both cannot be used in the same invocation). * Added keyword-add option to add keywords without overriding the default keyword. * Added debug option to doc.pl to easily add the debug keyword to documentation builds. * Added pre option to doc.pl to easily add the pre keyword to documentation builds. Refactoring: * Improvements to markdown rendering. * Remove code dependency on project variable, instead use title param.
2016-11-17 23:35:11 +02:00
<!ATTLIST section source CDATA "">
Allow sections to be excluded from table of contents in PDF output.
2018-02-21 22:26:30 +02:00
<!ATTLIST section toc CDATA "">
Doc engine improvements. Bug Fixes: * Fixed missing variable replacements. * Removed hard-coded host names from configuration file paths. Documentation Features: * Allow command-line length to be configured using cmd-line-len param. * Added compact param to allow CSS to be embedded in HTML file. * Added pretty param to produce HTML with proper indenting. * Only generate HTML menu when required and don't require index page. * Assign numbers to sections by default. * VM mount points are now optional.
2016-11-07 17:06:35 +02:00
<!ELEMENT title (#PCDATA|quote|b|i|bi|ul|ol|id|code|host|file|path|cmd|setting|exe|backrest|postgres|br-option|br-setting|
Improvements to documentation engine: * Documentation can now be built with reusable blocks to reduce duplication. * Added ability to pass options to containers within the documentation. * Add proper tag to slightly emphasize proper nouns.
2017-02-10 17:22:05 +02:00
pg-option|pg-setting|link|user|proper)*>
<!ELEMENT block-define (
((p|list|table|host-add|execute-list|backrest-config|postgres-config|cmd-description|
Build all docs with S3 using --var=s3-all=y Force repo-type=s3 for all tests. This is not currently the default for any OS builds.
2019-05-29 14:38:45 +02:00
option-description|code-block|block|admonition)+|
Improvements to documentation engine: * Documentation can now be built with reusable blocks to reduce duplication. * Added ability to pass options to containers within the documentation. * Add proper tag to slightly emphasize proper nouns.
2017-02-10 17:22:05 +02:00
((p|list)*, section+)|(p|list)*))>
<!ATTLIST block-define id CDATA #REQUIRED>
Documentation may be built with user-specified packages. By default the documentation builds pgBackRest from source, but the documentation is also a good way to smoke-test packages. Allow a package file to be specified by passing --var=package=/path/to/package.ext. This works for Debian and CentOS 6 builds.
2018-12-04 20:17:55 +02:00
<!ATTLIST block-define if CDATA "">
Improvements to documentation engine: * Documentation can now be built with reusable blocks to reduce duplication. * Added ability to pass options to containers within the documentation. * Add proper tag to slightly emphasize proper nouns.
2017-02-10 17:22:05 +02:00
Build all docs with S3 using --var=s3-all=y Force repo-type=s3 for all tests. This is not currently the default for any OS builds.
2019-05-29 14:38:45 +02:00
<!ELEMENT block (block-variable-replace*)>
Improvements to documentation engine: * Documentation can now be built with reusable blocks to reduce duplication. * Added ability to pass options to containers within the documentation. * Add proper tag to slightly emphasize proper nouns.
2017-02-10 17:22:05 +02:00
<!ATTLIST block id CDATA #REQUIRED>
Build all docs with S3 using --var=s3-all=y Force repo-type=s3 for all tests. This is not currently the default for any OS builds.
2019-05-29 14:38:45 +02:00
<!ATTLIST block if CDATA "">
Improvements to documentation engine: * Documentation can now be built with reusable blocks to reduce duplication. * Added ability to pass options to containers within the documentation. * Add proper tag to slightly emphasize proper nouns.
2017-02-10 17:22:05 +02:00
<!ELEMENT block-variable-replace (#PCDATA)>
<!ATTLIST block-variable-replace key CDATA #REQUIRED>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
<!ELEMENT default (#PCDATA)>
<!ELEMENT allow (#PCDATA)>
<!ELEMENT example (#PCDATA)>
More detailed release notes. Release notes are now broken into sections so that bugs, features, and refactors are clearly delineated. An "Additional Notes" section has been added for changes to documentation and the test suite that do not affect the core code.
2016-05-26 16:34:10 +02:00
<!ELEMENT contributor-list (contributor+)>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
More detailed release notes. Release notes are now broken into sections so that bugs, features, and refactors are clearly delineated. An "Additional Notes" section has been added for changes to documentation and the test suite that do not affect the core code.
2016-05-26 16:34:10 +02:00
<!ELEMENT contributor (contributor-name-display, contributor-id*)>
<!ATTLIST contributor id CDATA #REQUIRED>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
More detailed release notes. Release notes are now broken into sections so that bugs, features, and refactors are clearly delineated. An "Additional Notes" section has been added for changes to documentation and the test suite that do not affect the core code.
2016-05-26 16:34:10 +02:00
<!ELEMENT contributor-name-display (#PCDATA)>
<!ELEMENT contributor-id (#PCDATA)>
<!ATTLIST contributor-id type CDATA #REQUIRED>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
More detailed release notes. Release notes are now broken into sections so that bugs, features, and refactors are clearly delineated. An "Additional Notes" section has been added for changes to documentation and the test suite that do not affect the core code.
2016-05-26 16:34:10 +02:00
<!ELEMENT release-list (release+)>
<!ELEMENT release (release-core-list?, release-doc-list?, release-test-list?)>
<!ATTLIST release date CDATA #REQUIRED>
<!ATTLIST release version CDATA #REQUIRED>
<!ATTLIST release title CDATA #REQUIRED>
Split "refactor" sections into "improvements" and "development" in the release notes. Many development notes are not relevant to users and simply clutter the release notes, so they are no longer shown on the website.
2017-11-26 03:32:35 +02:00
<!ELEMENT release-core-list (p?, release-bug-list?, release-feature-list?, release-improvement-list?, release-development-list?)>
<!ELEMENT release-test-list (p?, release-feature-list?, release-improvement-list?, release-development-list?)>
<!ELEMENT release-doc-list (p?, release-bug-list?, release-feature-list?, release-improvement-list?, release-development-list?)>
More detailed release notes. Release notes are now broken into sections so that bugs, features, and refactors are clearly delineated. An "Additional Notes" section has been added for changes to documentation and the test suite that do not affect the core code.
2016-05-26 16:34:10 +02:00
<!ELEMENT release-bug-list (release-item+)>
<!ELEMENT release-feature-list (release-item+)>
Split "refactor" sections into "improvements" and "development" in the release notes. Many development notes are not relevant to users and simply clutter the release notes, so they are no longer shown on the website.
2017-11-26 03:32:35 +02:00
<!ELEMENT release-improvement-list (release-item+)>
<!ELEMENT release-development-list (release-item+)>
More detailed release notes. Release notes are now broken into sections so that bugs, features, and refactors are clearly delineated. An "Additional Notes" section has been added for changes to documentation and the test suite that do not affect the core code.
2016-05-26 16:34:10 +02:00
Use the git log to ease release note management. The release notes are generally a direct reflection of the git log. So, ease the burden of maintaining the release notes by using the git log to determine what needs to be added. Currently only non-dev items are required to be matched to a git commit but the goal is to account for all commits. The git history cache is generated from the git log but can be modified to correct typos and match the release notes as they evolve. The commit hash is used to identify commits that have already been added to the cache. There's plenty more to do here. For instance, links to the commits for each release item should be added to the release notes.
2019-05-23 00:54:49 +02:00
<!ELEMENT release-item (commit*, release-item-contributor-list?, p+)>
More detailed release notes. Release notes are now broken into sections so that bugs, features, and refactors are clearly delineated. An "Additional Notes" section has been added for changes to documentation and the test suite that do not affect the core code.
2016-05-26 16:34:10 +02:00
<!ELEMENT release-item-contributor-list (release-item-ideator*, release-item-contributor*, release-item-reviewer*)>
<!ELEMENT release-item-ideator (#PCDATA)>
<!ATTLIST release-item-ideator id CDATA #REQUIRED>
<!ELEMENT release-item-contributor (#PCDATA)>
<!ATTLIST release-item-contributor id CDATA #REQUIRED>
<!ELEMENT release-item-reviewer (#PCDATA)>
<!ATTLIST release-item-reviewer id CDATA #REQUIRED>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
Use the git log to ease release note management. The release notes are generally a direct reflection of the git log. So, ease the burden of maintaining the release notes by using the git log to determine what needs to be added. Currently only non-dev items are required to be matched to a git commit but the goal is to account for all commits. The git history cache is generated from the git log but can be modified to correct typos and match the release notes as they evolve. The commit hash is used to identify commits that have already been added to the cache. There's plenty more to do here. For instance, links to the commits for each release item should be added to the release notes.
2019-05-23 00:54:49 +02:00
<!ELEMENT commit EMPTY>
<!ATTLIST commit type CDATA "">
<!ATTLIST commit id CDATA "">
<!ATTLIST commit subject CDATA #REQUIRED>
Split most of README.md out into CHANGELOG.md and USERGUIDE.md. Added release dates to change log.
2015-08-07 20:43:53 +02:00
<!ELEMENT contribute (text)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST contribute title CDATA #REQUIRED>
Split most of README.md out into CHANGELOG.md and USERGUIDE.md. Added release dates to change log.
2015-08-07 20:43:53 +02:00
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
<!ELEMENT recognition (text)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST recognition title CDATA #REQUIRED>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
Split most of README.md out into CHANGELOG.md and USERGUIDE.md. Added release dates to change log.
2015-08-07 20:43:53 +02:00
<!ELEMENT support (text)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ATTLIST support title CDATA #REQUIRED>
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!-- Host elements -->
Allow containers to be defined in a document. The defined containers are built before the document build begins which allows them to be reused.
2018-07-23 13:49:15 +02:00
<!ELEMENT host-define (#PCDATA)>
Replace keywords with more flexible if statements. Keywords were extremely limited and prevented us from generating multi-version documentation and other improvements. Replace keywords with an if statement that can evaluate a Perl expression with variable replacement. Since keywords were used to generate cache keys, add a --key-var parameter to identify which variables should make up the key.
2018-12-01 19:40:01 +02:00
<!ATTLIST host-define if CDATA "">
Allow containers to be defined in a document. The defined containers are built before the document build begins which allows them to be reused.
2018-07-23 13:49:15 +02:00
<!ATTLIST host-define image CDATA #REQUIRED>
<!ATTLIST host-define from CDATA #REQUIRED>
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ELEMENT host-add (execute*)>
Use minio as local S3 emulator in documentation. The documentation was relying on a ScalityS3 container built for testing which wasn't very transparent. Instead, use the stock minio container and configure it in the documentation. Also, install certificates and CA so that TLS verification can be enabled.
2019-05-27 13:37:20 +02:00
<!ATTLIST host-add if CDATA "">
Add id param for hosts created with host-add. The host-*-ip variable is created from the id param so the name param can be changed without affecting the host-*-ip variable. If id is not specified then it is copied from name.
2018-02-22 01:10:53 +02:00
<!ATTLIST host-add id CDATA "">
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ATTLIST host-add name CDATA #REQUIRED>
<!ATTLIST host-add user CDATA #REQUIRED>
<!ATTLIST host-add image CDATA #REQUIRED>
Improvements to documentation engine: * Documentation can now be built with reusable blocks to reduce duplication. * Added ability to pass options to containers within the documentation. * Add proper tag to slightly emphasize proper nouns.
2017-02-10 17:22:05 +02:00
<!ATTLIST host-add option CDATA "">
Document generator improvements. * Allow parameters to be passed when a container is created. * Allow /etc/hosts update to be skipped (for containers without bash).
2018-05-25 19:42:09 +02:00
<!ATTLIST host-add update-hosts CDATA "">
<!ATTLIST host-add param CDATA "">
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ATTLIST host-add os CDATA "">
<!ATTLIST host-add mount CDATA "">
<!-- Table elements -->
Add HTML table rendering and update PDF/Markdown renderers to support header-less tables. Contributed by Cynthia Shang.
2018-12-18 21:56:39 +02:00
<!ELEMENT table (title?, table-header?, table-data)>
Add optional table captions. All renderers now support table captions, when requested. Contributed by Cynthia Shang.
2018-12-20 23:20:54 +02:00
<!ATTLIST title label CDATA "">
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ELEMENT table-header (table-column+)>
<!ATTLIST table-header width CDATA "">
Moved change log to website. The change log was the last piece of documentation to be rendered in Markdown only. Wrote a converter so the document can be output by the standard renderers. The change log will now be located on the website and has been renamed to "Releases".
2016-05-26 15:20:55 +02:00
<!ELEMENT table-column (#PCDATA|quote|b|i|id|code|host|file|path|cmd|setting|exe|backrest|postgres|br-option|
Improvements to documentation engine: * Documentation can now be built with reusable blocks to reduce duplication. * Added ability to pass options to containers within the documentation. * Add proper tag to slightly emphasize proper nouns.
2017-02-10 17:22:05 +02:00
br-setting|pg-option|pg-setting|link|user|proper)*>
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ATTLIST table-column align CDATA "">
<!ATTLIST table-column fill CDATA "">
<!ELEMENT table-data (table-row+)>
<!ELEMENT table-row (table-cell+)>
Moved change log to website. The change log was the last piece of documentation to be rendered in Markdown only. Wrote a converter so the document can be output by the standard renderers. The change log will now be located on the website and has been renamed to "Releases".
2016-05-26 15:20:55 +02:00
<!ELEMENT table-cell (#PCDATA|quote|b|i|ul|ol|id|code|code-block|host|file|path|cmd|setting|exe|backrest|postgres|br-option|
Improvements to documentation engine: * Documentation can now be built with reusable blocks to reduce duplication. * Added ability to pass options to containers within the documentation. * Add proper tag to slightly emphasize proper nouns.
2017-02-10 17:22:05 +02:00
br-setting|pg-option|pg-setting|link|user|proper)*>
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!-- Formatted elements -->
Fix comment typos. This includes some variable names in tests which don't seem important enough for their own commits. Contributed by Josh Soref.
2019-08-26 18:05:36 +02:00
<!-- admonition type can be note, important, warning, caution and tip -->
Add admonitions to documentation renderers. Admonitions call out places where the user should take special care. Support added for HTML, PDF, Markdown and help text renderers. XML files have been updated accordingly. Contributed by Cynthia Shang.
2018-12-30 16:40:20 +02:00
<!ELEMENT admonition ANY>
<!ATTLIST admonition type CDATA #REQUIRED>
Moved change log to website. The change log was the last piece of documentation to be rendered in Markdown only. Wrote a converter so the document can be output by the standard renderers. The change log will now be located on the website and has been renamed to "Releases".
2016-05-26 15:20:55 +02:00
<!ELEMENT summary (#PCDATA|quote|b|i|ul|ol|id|code|code-block|host|file|path|cmd|setting|exe|backrest|postgres|br-option|
Improvements to documentation engine: * Documentation can now be built with reusable blocks to reduce duplication. * Added ability to pass options to containers within the documentation. * Add proper tag to slightly emphasize proper nouns.
2017-02-10 17:22:05 +02:00
br-setting|pg-option|pg-setting|link|user|proper)*>
Modify general document elements to allow any child element. This allows for nesting of elements such as <b> and <i>. Contributed by Cynthia Shang.
2018-12-31 09:19:38 +02:00
<!ELEMENT p ANY>
Replace keywords with more flexible if statements. Keywords were extremely limited and prevented us from generating multi-version documentation and other improvements. Replace keywords with an if statement that can evaluate a Perl expression with variable replacement. Since keywords were used to generate cache keys, add a --key-var parameter to identify which variables should make up the key.
2018-12-01 19:40:01 +02:00
<!ATTLIST p if CDATA "">
Modify general document elements to allow any child element. This allows for nesting of elements such as <b> and <i>. Contributed by Cynthia Shang.
2018-12-31 09:19:38 +02:00
<!ELEMENT text ANY>
<!ELEMENT i ANY>
<!ELEMENT b ANY>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
<!ELEMENT ul (li+)>
<!ELEMENT ol (li+)>
Modify general document elements to allow any child element. This allows for nesting of elements such as <b> and <i>. Contributed by Cynthia Shang.
2018-12-31 09:19:38 +02:00
<!ELEMENT li ANY>
Lists can now be used outside of p and text tags. This allows for more flexible document structuring.
2016-05-26 15:34:03 +02:00
<!ELEMENT list (list-item+)>
Allow if condition in documentation lists and list items.
2019-01-24 16:45:28 +02:00
<!ATTLIST list if CDATA "">
Modify general document elements to allow any child element. This allows for nesting of elements such as <b> and <i>. Contributed by Cynthia Shang.
2018-12-31 09:19:38 +02:00
<!ELEMENT list-item ANY>
Allow if condition in documentation lists and list items.
2019-01-24 16:45:28 +02:00
<!ATTLIST list-item if CDATA "">
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
<!ELEMENT id (#PCDATA)>
<!ELEMENT code (#PCDATA)>
Renamed pg_backrest.pl to pg_backrest in the docs.
2015-07-06 23:59:44 +02:00
<!ELEMENT code-block (#PCDATA|exe)*>
Doc engine improvements. Bug Fixes: * Fixed and issue that suppressed exceptions in PDF builds. Features: * Allow a source to be included as a section so large documents can be broken up. * Added section link support to Markdown output. * Added list support to PDF output. * Added include option to explicitly build sources (complements the exclude option though both cannot be used in the same invocation). * Added keyword-add option to add keywords without overriding the default keyword. * Added debug option to doc.pl to easily add the debug keyword to documentation builds. * Added pre option to doc.pl to easily add the pre keyword to documentation builds. Refactoring: * Improvements to markdown rendering. * Remove code dependency on project variable, instead use title param.
2016-11-17 23:35:11 +02:00
<!ATTLIST code-block title CDATA "">
Allow code blocks to have a type. Currently this is only rendered in Markdown.
2018-02-16 21:46:02 +02:00
<!ATTLIST code-block type CDATA "">
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ELEMENT host (#PCDATA)>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
<!ELEMENT file (#PCDATA)>
<!ELEMENT path (#PCDATA)>
<!ELEMENT cmd (#PCDATA)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ELEMENT user (#PCDATA)>
Added documentation in the user guide for delta restores, expiration, dedicated backup hosts, starting and stopping pgBackRest, and replication.
2015-11-22 23:44:01 +02:00
<!ELEMENT quote (#PCDATA)>
Improvements to documentation engine: * Documentation can now be built with reusable blocks to reduce duplication. * Added ability to pass options to containers within the documentation. * Add proper tag to slightly emphasize proper nouns.
2017-02-10 17:22:05 +02:00
<!ELEMENT proper (#PCDATA)>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
<!ELEMENT setting (#PCDATA)>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ELEMENT br-option (#PCDATA)>
<!ELEMENT br-setting (#PCDATA)>
<!ELEMENT pg-option (#PCDATA)>
<!ELEMENT pg-setting (#PCDATA)>
Renamed pg_backrest.pl to pg_backrest in the docs.
2015-07-06 23:59:44 +02:00
<!ELEMENT exe EMPTY>
First pass at building automated docs for markdown/html. This works pretty well, but the config sections of doc.xml still require too much maintenance. With the new Config code, it should be possible to generate those sections automatically.
2015-03-08 20:05:41 +02:00
<!ELEMENT backrest EMPTY>
More work on automated docs. Merging this to go back to some feature/bug work for a while.
2015-03-16 20:01:01 +02:00
<!ELEMENT postgres EMPTY>
Implemented issue #148: Website with basic user guide.
2015-10-28 11:10:36 +02:00
<!ELEMENT link (#PCDATA)>
<!ATTLIST link url CDATA "">
<!ATTLIST link page CDATA "">
A number of doc improvements: 1) Started on a general markdown renderer 2) Internal links now work in PDF 3) Improvements to PDF styling 4) Some comment and formatting fixes 5) User guide edits.
2015-12-23 18:04:26 +02:00
<!ATTLIST link section CDATA "">
Reference in New Issue Copy Permalink