Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DocBook 5.0 validation nits #3

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

DocBook 5.0 validation nits #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
193256f
validation fix: <bookinfo/> becomes <info/>
martin-a-brown Mar 4, 2016
dd2be11
validation fix: <figure/> attr is floatstyle
martin-a-brown Mar 4, 2016
b85d48f
<listitem/> children cannot be CDATA, <para/>
martin-a-brown Mar 4, 2016
ced5963
change <programlisting/> to linenumbering
martin-a-brown Mar 4, 2016
45a7449
validation fix: <sect2/> becomes <section/>
martin-a-brown Mar 4, 2016
f490fbd
removing unknown attribute, tag="block"
martin-a-brown Mar 4, 2016
d8e0648
Merge branch 'master' of https://github.com/opentelecoms-org/RTCQuick…
martin-a-brown Mar 30, 2016
b7e75c0
symlink RTCQuickstartGuide.xml (TLDP convention)
martin-a-brown Mar 30, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions RTCQuickstartGuide.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
book.xml
4 changes: 2 additions & 2 deletions bookinfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<bookinfo xmlns="http://docbook.org/ns/docbook"
<info xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<author>
<personname><link xlink:href="http://danielpocock.com">Daniel Pocock</link></personname>
Expand All @@ -10,4 +10,4 @@
<year>2013</year><year>2014</year><year>2015</year>
<holder>Daniel Pocock</holder>
</copyright>
</bookinfo>
</info>
8 changes: 4 additions & 4 deletions debuild.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,26 @@

<example xml:id="debuild-install-debuild">
<title>Installing the <code>debuild</code> command</title>
<programlisting format="linespecific">$ sudo apt-get install devscripts
<programlisting linenumbering="numbered">$ sudo apt-get install devscripts
</programlisting>
</example>

<example xml:id="debuild-install-build-deps">
<title>Installing the compiler and dependencies</title>
<programlisting format="linespecific">$ sudo apt-get build-dep resiprocate</programlisting>
<programlisting linenumbering="numbered">$ sudo apt-get build-dep resiprocate</programlisting>
</example>

<example xml:id="debuild-create-deb">
<title>Running the <code>debuild</code> command</title>
<programlisting format="linespecific">$ wget http://.../resiprocate-1.9.8.tar.gz
<programlisting linenumbering="numbered">$ wget http://.../resiprocate-1.9.8.tar.gz
$ tar xzf resiprocate-1.9.8.tar.gz
$ cd resiprocate-1.9.8
$ debuild -rfakeroot -i -us -uc -b --no-lintian</programlisting>
</example>

<example xml:id="debuild-github">
<title>Running the <code>debuild</code> command using code from Git</title>
<programlisting format="linespecific">$ git clone https://github.com/resiprocate/resiprocate
<programlisting linenumbering="numbered">$ git clone https://github.com/resiprocate/resiprocate
$ cd resiprocate
$ git checkout 1.9.8
$ debuild -rfakeroot -i -us -uc -b --no-lintian</programlisting>
Expand Down
4 changes: 2 additions & 2 deletions dns.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@

<example xml:id="dns-bind-example-zone">
<title>ISC Bind zone file entries</title>
<programlisting format="linespecific">; the server where everything will run
<programlisting linenumbering="numbered">; the server where everything will run
server1 IN A 198.51.100.19
server1 IN AAAA 2001:DB8:1000:2000::19

Expand Down Expand Up @@ -186,7 +186,7 @@ _xmpp-server._tcp IN SRV 5 0 5269 xmpp-gw.example.org.</programlisting>

<example xml:id="dns-dig-example">
<title>Inspecting DNS entries with <code>dig</code></title>
<programlisting format="linespecific">$ dig -t naptr +short example.org
<programlisting linenumbering="numbered">$ dig -t naptr +short example.org
10 0 "s" "SIPS+D2T" "" _sips._tcp.example.org.

$ dig -t srv +short _sips._tcp.example.org.
Expand Down
12 changes: 6 additions & 6 deletions enum.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@

<example xml:id="enum-query-dig">
<title>Using <code>dig</code> to perform ENUM queries</title>
<programlisting format="linespecific">$ dig -t naptr 4.4.2.2.3.3.5.6.8.1.4.4.e164.arpa
<programlisting linenumbering="numbered">$ dig -t naptr 4.4.2.2.3.3.5.6.8.1.4.4.e164.arpa

; > DiG 9.8.4-rpz2+rl005.12-P1 > -t naptr 4.4.2.2.3.3.5.6.8.1.4.4.e164.arpa
;; global options: +cmd
Expand Down Expand Up @@ -162,12 +162,12 @@

<example xml:id="dlzldapenum-install-debian">
<title>Installing <code>dlz-ldap-enum</code> on Debian/Ubuntu</title>
<programlisting format="linespecific">$ sudo apt-get install dlz-ldap-enum</programlisting>
<programlisting linenumbering="numbered">$ sudo apt-get install dlz-ldap-enum</programlisting>
</example>

<example xml:id="dlzldapenum-install-redhat">
<title>Install <code>dlz-ldap-enum</code> on Fedora/RHEL/CentOS</title>
<programlisting format="linespecific">$ sudo yum install dlz-ldap-enum</programlisting>
<programlisting linenumbering="numbered">$ sudo yum install dlz-ldap-enum</programlisting>
</example>
</sect3>

Expand All @@ -186,7 +186,7 @@

<example xml:id="dlzldapenum-config-sample">
<title>Sample <code>dlz_ldap_enum.conf</code></title>
<programlisting format="linespecific">dlz "example" {
<programlisting linenumbering="numbered">dlz "example" {
database "dlopen /usr/lib/dlz-ldap-enum/dlz_ldap_enum.so 2
v3 simple {cn=admin,dc=example,dc=org} {secret} {127.0.0.1}
e164-addr.example.org
Expand All @@ -207,12 +207,12 @@

<example xml:id="dlzldapenum-named-config-sample-debian">
<title>Additions to <code>named.conf</code> for Debian/Ubuntu</title>
<programlisting format="linespecific">include "/etc/bind/dlz_ldap_enum.conf";</programlisting>
<programlisting linenumbering="numbered">include "/etc/bind/dlz_ldap_enum.conf";</programlisting>
</example>

<example xml:id="dlzldapenum-named-config-sample-redhat">
<title>Additions to <code>named.conf</code> for Fedora/RHEL/CentOS</title>
<programlisting format="linespecific">include "/etc/named/dlz_ldap_enum.conf";</programlisting>
<programlisting linenumbering="numbered">include "/etc/named/dlz_ldap_enum.conf";</programlisting>
</example>

</sect3>
Expand Down
8 changes: 4 additions & 4 deletions faq.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
xml:id="faq">
<title>Frequently Asked Questions</title>

<sect2>
<section>
<title>Can I use a virtual server for SIP or XMPP?</title>

<para>For small installations (less than 30 concurrent phone calls) a
Expand All @@ -14,16 +14,16 @@
processes (such as the TURN server or a soft PBX like Asterisk or
FreeSWITCH) be on dedicated servers while it may still be possible for
the SIP proxy or XMPP server to be on a virtual server.</para>
</sect2>
</section>

<sect2>
<section>
<title>Do I really need to use TLS encryption and certificates?</title>

<para><emphasis>Yes</emphasis>. Even if you don't care too much about
security or privacy, TLS helps to reduce the risk of nuisance calls from
spammers and the risk of impersonation and it also eliminates a range of
problems caused by SIP-aware routers that try to modify SIP messages to
help them through NAT.</para>
</sect2>
</section>

</chapter>
2 changes: 1 addition & 1 deletion firewall.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@

<example xml:id="firewall-setup-iptables-example">
<title>Firewall setup with <code>iptables</code></title>
<programlisting format="linespecific">iptables -I INPUT -p udp -d 198.51.100.19 --dport 3478 -j ACCEPT
<programlisting linenumbering="numbered">iptables -I INPUT -p udp -d 198.51.100.19 --dport 3478 -j ACCEPT
iptables -I INPUT -p udp -d 198.51.100.20 --dport 3478 -j ACCEPT
iptables -I INPUT -p udp -d 198.51.100.19 \
--dport 49152:65535 -j ACCEPT
Expand Down
14 changes: 7 additions & 7 deletions nagios.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

<example xml:id="nagios-plugin-stun-configuration">
<title>Sample <code>/etc/nagios-plugins/config/stun.cfg</code></title>
<programlisting format="linespecific"># can be used to check STUN and TURN servers
<programlisting linenumbering="numbered"># can be used to check STUN and TURN servers
# uses script from http://karlsbakk.net/asterisk/scripts/check_stun
define command {
command_name check_stun
Expand All @@ -33,7 +33,7 @@ define command {

<example xml:id="nagios-plugin-sip-tls-configuration">
<title>Sample <code>/etc/nagios-plugins/config/sip.cfg</code></title>
<programlisting format="linespecific"># uses script from https://github.com/ibc/nagios-sip-plugin
<programlisting linenumbering="numbered"># uses script from https://github.com/ibc/nagios-sip-plugin
define command {
command_name check_sip_tls
command_line /usr/local/lib/nagios/plugins/check_sip2 -t tls -p $ARG2$ -T 5 -s $ARG1$
Expand All @@ -42,7 +42,7 @@ define command {

<example xml:id="nagios-plugin-xmpp-configuration">
<title>Sample <code>/etc/nagios-plugins/config/xmpp.cfg</code></title>
<programlisting format="linespecific"># uses script from https://exchange.icinga.org/jandd/check_xmppng
<programlisting linenumbering="numbered"># uses script from https://exchange.icinga.org/jandd/check_xmppng
# Debian/Ubuntu: apt-get install nagios-check-xmppng
define command {
command_name check_xmpp
Expand All @@ -61,7 +61,7 @@ define command {

<example xml:id="nagios-check-stun-configuration">
<title>Sample service check for STUN/TURN</title>
<programlisting format="linespecific">define service{
<programlisting linenumbering="numbered">define service{
use generic-service
host_name turn-server.example.org
service_description STUN/TURN
Expand All @@ -73,7 +73,7 @@ define command {

<example xml:id="nagios-check-sip-tls-configuration">
<title>Sample service check for SIP over TLS</title>
<programlisting format="linespecific">define service{
<programlisting linenumbering="numbered">define service{
use generic-service
host_name server1
service_description SIPS
Expand All @@ -83,7 +83,7 @@ define command {

<example xml:id="nagios-check-sip-tls-configuration-443">
<title>Sample service check for SIP over TLS (port 443)</title>
<programlisting format="linespecific">define service{
<programlisting linenumbering="numbered">define service{
use generic-service
host_name server1
service_description SIPS 443
Expand All @@ -95,7 +95,7 @@ define command {

<example xml:id="nagios-check-xmpp-configuration">
<title>Sample service check for XMPP</title>
<programlisting format="linespecific">define service{
<programlisting linenumbering="numbered">define service{
use generic-service
host_name server1
service_description XMPP
Expand Down
2 changes: 1 addition & 1 deletion optimal-connectivity.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
of the system (n<superscript>2</superscript>), demonstrated in
<xref linkend="metcalfe-quadratic"/>.</para>

<figure float="none" xml:id="metcalfe-quadratic">
<figure floatstyle="none" xml:id="metcalfe-quadratic">
<title>Metcalfe's law</title>

<mediaobject>
Expand Down
4 changes: 2 additions & 2 deletions pbx.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@

<example xml:id="pbx-aterisk-with-repro-sip.conf">
<title>Asterisk <literal>sip.conf</literal></title>
<programlisting format="linespecific">; should match the realm used by the proxy
<programlisting linenumbering="numbered">; should match the realm used by the proxy
realm=sip-proxy.example.org
domain=sip-proxy.example.org
fromdomain=sip-proxy.example.org
Expand All @@ -282,7 +282,7 @@ nat=yes</programlisting>

<example xml:id="pbx-aterisk-with-repro-extensions.conf">
<title>Asterisk <literal>extensions.conf</literal></title>
<programlisting format="linespecific">exten => _8XXX,n,Dial(SIP/${EXTEN}@sip-proxy.example.org,45)</programlisting>
<programlisting linenumbering="numbered">exten => _8XXX,n,Dial(SIP/${EXTEN}@sip-proxy.example.org,45)</programlisting>
</example>
</sect1>
</chapter>
24 changes: 12 additions & 12 deletions preface.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,40 @@
xml:id="preface">
<title>Preface</title>

<sect2>
<section>
<title>Mission</title>

<para>This book aims to provide practical strategies for deploying
RTC with the technology available today.</para>
</sect2>
</section>

<sect2>
<section>
<title>Vision</title>

<para>A world where open standards and free software are the foundation
of personal and business communications, enabling genuine innovation
and the emergence of more disruptive technologies.</para>
</sect2>
</section>

<sect2>
<section>
<title>Who is this document for?</title>

<para>IT managers, system administrators, developers, web designers,
product managers and IT users who want best-practice
Real-Time Communications (RTC) technology for business or
private use.</para>
</sect2>
</section>

<sect2>
<section>
<title>What is Free RTC?</title>

<para>Running your own, independent, federated and peer-to-peer RTC
solutions, including instant messaging (IM), voice-over-IP (VoIP),
video/webcam, social networking and WebRTC, using open standards and,
in many cases, free, open source software.</para>
</sect2>
</section>

<sect2>
<section>
<title>Why?</title>

<para>There are many reasons organizations and individuals need to
Expand Down Expand Up @@ -66,9 +66,9 @@
software allow individuals and businesses of any size to engage
in genuine innovation, creating new and original services that run
across the network.</para>
</sect2>
</section>

<sect2>
<section>
<title>How?</title>

<para>This documentation aims to help you choose strong, best of breed,
Expand All @@ -83,7 +83,7 @@
Fedora and Red Hat/RHEL/CentOS), most IT professionals will be able
to set this up in less than one day, the most experienced reader
will find that it can be set up in less than an hour.</para>
</sect2>
</section>

</preface>

2 changes: 1 addition & 1 deletion pstn.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@

<example xml:id="pstn-asterisk-set-caller-id">
<title>Asterisk <literal>extensions.conf</literal> for specifying caller ID</title>
<programlisting format="linespecific">exten => _X.,1,Set(CALLERID(name)=00442071358378)
<programlisting linenumbering="numbered">exten => _X.,1,Set(CALLERID(name)=00442071358378)
exten => _X.,2,Set(CALLERID(number)=00442071358378)</programlisting>
</example>

Expand Down
8 changes: 4 additions & 4 deletions rpmbuild.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@

<example xml:id="rpmbuild-install-rpmbuild">
<title>Installing the <code>rpmbuild</code> command</title>
<programlisting format="linespecific">$ sudo yum install rpm-build</programlisting>
<programlisting linenumbering="numbered">$ sudo yum install rpm-build</programlisting>
</example>

<example xml:id="rpmbuild-install-build-deps">
<title>Installing the compiler and dependencies</title>
<programlisting format="linespecific">$ sudo yum install gcc-c++ libtool automake autoconf \
<programlisting linenumbering="numbered">$ sudo yum install gcc-c++ libtool automake autoconf \
asio-devel boost-devel cajun-jsonapi-devel c-ares-devel \
cppunit-devel gperf db4-cxx-devel db4-devel openssl-devel \
mysql-devel pcre-devel perl popt-devel python-devel \
Expand All @@ -25,7 +25,7 @@

<example xml:id="rpmbuild-setup">
<title>Creating the <code>rpmbuild</code> directories</title>
<programlisting format="linespecific">$ mkdir ~/rpms
<programlisting linenumbering="numbered">$ mkdir ~/rpms
$ cd ~/rpms
$ mkdir BUILD BUILDROOT \
RPMS/i386 RPMS/noarch RPMS/x86_64 \
Expand All @@ -39,7 +39,7 @@ $ </programlisting>

<example xml:id="rpmbuild-create-rpms">
<title>Running the <code>rpmbuild</code> command</title>
<programlisting format="linespecific">$ wget http://.../resiprocate-1.9.8.tar.gz
<programlisting linenumbering="numbered">$ wget http://.../resiprocate-1.9.8.tar.gz
$ rpmbuild -tb resiprocate-1.9.8.tar.gz</programlisting>
</example>

Expand Down
Loading