(httpd-site) branch main updated: De-duplicate content between docformat.md and the style guide.
[email protected] Mon, 22 Jun 2026 17:09:22 +0000
| Newsgroups | gmane.comp.apache.cvs |
|---|---|
| Message-ID | <178214816250.1861761.6074012190860255338@gitbox3-he-fi.apache.org> |
This is an automated email from the ASF dual-hosted git repository.
rbowen pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/httpd-site.git
The following commit(s) were added to refs/heads/main by this push:
new a654433 De-duplicate content between docformat.md and the style guide.
a654433 is described below
commit a654433fe63e18e1d3818e9741f94ad299b6628e
Author: Rich Bowen <[email protected]>
AuthorDate: Mon Jun 22 13:08:38 2026 -0400
De-duplicate content between docformat.md and the style guide.
---
content/docs-project/docsformat.md | 24 ++++--------------------
content/docs-project/style-guide.md | 2 +-
2 files changed, 5 insertions(+), 21 deletions(-)
diff --git a/content/docs-project/docsformat.md b/content/docs-project/docsformat.md
index b787463..eeb76e6 100644
--- a/content/docs-project/docsformat.md
+++ b/content/docs-project/docsformat.md
@@ -11,27 +11,11 @@ documentation and how to transform it into HTML for review.
The documentation is written in a custom XML format with its own DTD.
The DTD is in the
[style directory](https://httpd.apache.org/docs/current/style/) of the
-manual. For detailed markup conventions, see the
-[Documentation Style Guide](style-guide.html).
+manual.
-### Common Markup Elements
-
-| Element | Purpose |
-|---------|---------|
-| `<example> ... </example>` | Wraps a code example block |
-| `<highlight language="config"> ... </highlight>` | Configuration example with syntax highlighting |
-| `<highlight language="perl"> ... </highlight>` | Perl code with highlighting |
-| `<highlight language="lua"> ... </highlight>` | Lua code with highlighting |
-| `<highlight language="C"> ... </highlight>` | C code with highlighting |
-| `<directive module="...">Name</directive>` | Cross-reference to a directive |
-| `<module>mod_name</module>` | Cross-reference to a module |
-| `<program>name</program>` | Cross-reference to an httpd program |
-| `<var>placeholder</var>` | User-supplied value |
-| `<note> ... </note>` | Informational callout |
-| `<note type="warning"> ... </note>` | Warning callout |
-
-The full format is best learned by reading existing documentation files.
-Start with a simple page and the patterns will become clear quickly.
+For markup conventions, element usage, prose style rules, and
+typographic guidelines, see the
+[Documentation Style Guide](style-guide.html).
## Viewing Your Changes
diff --git a/content/docs-project/style-guide.md b/content/docs-project/style-guide.md
index ef59d51..43ccabe 100644
--- a/content/docs-project/style-guide.md
+++ b/content/docs-project/style-guide.md
@@ -225,7 +225,7 @@ Use `<example>` with a nested `<highlight language="...">` block:
</highlight>
</example>
-Valid language values: `config` (most common), `lua`, `c`, `perl`, `sh`, `html`.
+Valid language values: `config` (most common), `sh`, `python`, `lua`, `c`, `perl`, `html`.
Do **not** use bare `<example>` with `<br />` for line breaks. This is a
legacy pattern. Convert to `<highlight>` when editing such files.