From 15046913c5a7061f47c8a186a06bddbd9f0f5e1e Mon Sep 17 00:00:00 2001 From: Rich Bowen Date: Mon, 20 Apr 2026 19:31:26 +0000 Subject: [PATCH] Use rather than embedding HTML in blocks (style guide) git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1933189 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/compliance.xml | 10 +++-- docs/manual/content-negotiation.xml | 68 ++++++++++++++++------------- docs/manual/custom-error.xml | 22 +++++----- docs/manual/dso.xml | 16 +++++-- docs/manual/install.xml | 26 ++++++----- 5 files changed, 84 insertions(+), 58 deletions(-) diff --git a/docs/manual/compliance.xml b/docs/manual/compliance.xml index 9dd1164ab91..143e1c1195a 100644 --- a/docs/manual/compliance.xml +++ b/docs/manual/compliance.xml @@ -268,10 +268,12 @@

Invalid content types might include:

- # invalid
- Content-Type: foo
- # blank
- Content-Type: + +# invalid +Content-Type: foo +# blank +Content-Type: +

The server administrator has the option to restrict the policy to one diff --git a/docs/manual/content-negotiation.xml b/docs/manual/content-negotiation.xml index b9878a251f1..514f2879e2a 100644 --- a/docs/manual/content-negotiation.xml +++ b/docs/manual/content-negotiation.xml @@ -67,8 +67,10 @@ last resort:

- Accept-Language: fr; q=1.0, en; q=0.5
- Accept: text/html; q=1.0, text/*; q=0.8, image/gif; q=0.6, image/jpeg; q=0.6, image/*; q=0.5, */*; q=0.1 + +Accept-Language: fr; q=1.0, en; q=0.5 +Accept: text/html; q=1.0, text/*; q=0.8, image/gif; q=0.6, image/jpeg; q=0.6, image/*; q=0.5, */*; q=0.1 +

httpd supports 'server driven' content negotiation, as @@ -147,15 +149,17 @@ AddHandler type-map .var the map file.

- URI: foo
-
- URI: foo.en.html
- Content-type: text/html
- Content-language: en
-
- URI: foo.fr.de.html
- Content-type: text/html;charset=iso-8859-2
- Content-language: fr, de
+ +URI: foo + +URI: foo.en.html +Content-type: text/html +Content-language: en + +URI: foo.fr.de.html +Content-type: text/html;charset=iso-8859-2 +Content-language: fr, de +

Note also that a typemap file will take precedence over the @@ -180,15 +184,17 @@ AddHandler type-map .var assigned its language in the type map without being renamed:

- URI: foo
-
- URI: foo.html
- Content-type: text/html
- Content-language: en
-
- URI: foo.fr.html
- Content-type: text/html
- Content-language: fr
+ +URI: foo + +URI: foo.html +Content-type: text/html +Content-language: en + +URI: foo.fr.html +Content-type: text/html +Content-language: fr +

If the variants have different source qualities, that may be @@ -196,16 +202,18 @@ AddHandler type-map .var picture (available as JPEG, GIF, or ASCII-art):

- URI: foo
-
- URI: foo.jpeg
- Content-type: image/jpeg; qs=0.8
-
- URI: foo.gif
- Content-type: image/gif; qs=0.5
-
- URI: foo.txt
- Content-type: text/plain; qs=0.01
+ +URI: foo + +URI: foo.jpeg +Content-type: image/jpeg; qs=0.8 + +URI: foo.gif +Content-type: image/gif; qs=0.5 + +URI: foo.txt +Content-type: text/plain; qs=0.01 +

qs values can vary in the range 0.000 to 1.000. Note that diff --git a/docs/manual/custom-error.xml b/docs/manual/custom-error.xml index 0f3c41ba3ee..f8ac3f466c2 100644 --- a/docs/manual/custom-error.xml +++ b/docs/manual/custom-error.xml @@ -100,16 +100,18 @@ ErrorDocument 401 /subscription/how_to_subscribe.html environment variables, the following.

- REDIRECT_HTTP_ACCEPT=*/*, image/gif, image/jpeg, image/png
- REDIRECT_HTTP_USER_AGENT=Mozilla/5.0 Fedora/3.5.8-1.fc12 Firefox/3.5.8
- REDIRECT_PATH=.:/bin:/usr/local/bin:/sbin
- REDIRECT_QUERY_STRING=
- REDIRECT_REMOTE_ADDR=121.345.78.123
- REDIRECT_REMOTE_HOST=client.example.com
- REDIRECT_SERVER_NAME=www.example.edu
- REDIRECT_SERVER_PORT=80
- REDIRECT_SERVER_SOFTWARE=Apache/2.2.15
- REDIRECT_URL=/cgi-bin/buggy.pl + +REDIRECT_HTTP_ACCEPT=*/*, image/gif, image/jpeg, image/png +REDIRECT_HTTP_USER_AGENT=Mozilla/5.0 Fedora/3.5.8-1.fc12 Firefox/3.5.8 +REDIRECT_PATH=.:/bin:/usr/local/bin:/sbin +REDIRECT_QUERY_STRING= +REDIRECT_REMOTE_ADDR=121.345.78.123 +REDIRECT_REMOTE_HOST=client.example.com +REDIRECT_SERVER_NAME=www.example.edu +REDIRECT_SERVER_PORT=80 +REDIRECT_SERVER_SOFTWARE=Apache/2.2.15 +REDIRECT_URL=/cgi-bin/buggy.pl +

REDIRECT_ environment variables are created from diff --git a/docs/manual/dso.xml b/docs/manual/dso.xml index a6e17fb289f..9412d9df607 100644 --- a/docs/manual/dso.xml +++ b/docs/manual/dso.xml @@ -95,8 +95,10 @@ mod_foo.so:

-$ ./configure --prefix=/path/to/install --enable-foo
+ +$ ./configure --prefix=/path/to/install --enable-foo $ make install + @@ -108,8 +110,10 @@ $ make install httpd.conf.

-$ ./configure --enable-mods-shared=all
+ +$ ./configure --enable-mods-shared=all $ make install + @@ -122,8 +126,10 @@ $ make install --enable-load-all-modules.

-$ ./configure --enable-mods-shared=reallyall --enable-load-all-modules
+ +$ ./configure --enable-mods-shared=reallyall --enable-load-all-modules $ make install + @@ -134,8 +140,10 @@ $ make install source tree using apxs: -$ cd /path/to/3rdparty
+ +$ cd /path/to/3rdparty $ apxs -cia mod_foo.c + diff --git a/docs/manual/install.xml b/docs/manual/install.xml index 94da8619be2..4ba063c08a5 100644 --- a/docs/manual/install.xml +++ b/docs/manual/install.xml @@ -244,8 +244,10 @@ sudo service apache2 start simple matter of uncompressing, and then untarring:

-$ gzip -d httpd-NN.tar.gz
+ +$ gzip -d httpd-NN.tar.gz $ tar xvf httpd-NN.tar +

This will create a new directory under the current directory @@ -312,10 +314,12 @@ $ tar xvf httpd-NN.tar mod_lua:

- $ CC="pgcc" CFLAGS="-O2" \
- ./configure --prefix=/sw/pkg/apache \
- --enable-ldap=shared \
- --enable-lua=shared + +$ CC="pgcc" CFLAGS="-O2" \ + ./configure --prefix=/sw/pkg/apache \ + --enable-ldap=shared \ + --enable-lua=shared +

When configure is run it will take several minutes to @@ -420,11 +424,13 @@ $ tar xvf httpd-NN.tar changes, and then run:

- $ ./config.nice
- $ make
- $ make install
- $ PREFIX/bin/apachectl -k graceful-stop
- $ PREFIX/bin/apachectl -k start
+ +$ ./config.nice +$ make +$ make install +$ PREFIX/bin/apachectl -k graceful-stop +$ PREFIX/bin/apachectl -k start + You should always test any new version in your -- 2.47.3