2016-03-24 Fred Gleason <fredg@paravelsystems.com>

* Ported 'docs/cae.sxw' to DocBook-XML5 in 'docs/docbook/cae.xml'.
	* Ported 'docs/web_api.odt' to DocBook-XML5 in
	'docs/dockbook/web_api.xml'.
This commit is contained in:
Fred Gleason 2016-03-24 14:25:41 -04:00
parent 03cfa9d614
commit 539d23d359
11 changed files with 4959 additions and 6 deletions

View File

@ -15011,3 +15011,7 @@
scheduler codes in a case-insensitve manner. scheduler codes in a case-insensitve manner.
* Modified the return of the 'EditCut' web method to provide a full * Modified the return of the 'EditCut' web method to provide a full
<cutList> record in 'web/rdxport/carts.cpp'. <cutList> record in 'web/rdxport/carts.cpp'.
2016-03-24 Fred Gleason <fredg@paravelsystems.com>
* Ported 'docs/cae.sxw' to DocBook-XML5 in 'docs/docbook/cae.xml'.
* Ported 'docs/web_api.odt' to DocBook-XML5 in
'docs/dockbook/web_api.xml'.

21
INSTALL
View File

@ -98,6 +98,27 @@ TwoLAME - MPEG Layer 2 Encoder Library. Needed for MPEG Layer 2 exporting and
capture. Available at http://www.twolame.org/. capture. Available at http://www.twolame.org/.
DOCUMENTATION
-------------
The larger pieces of the Rivendell documentation are written in XML-DocBook5.
Pre-generated docs are included in the source tarball, so special tools will
not normally be required to view or install them. However, if you need to
rebuild them (either because you've modified the DocBook sources or are
installing from the primary GitHub repository), then you will need the
following:
XML-DocBook5 Stylesheets. Available at
http://sourceforge.net/projects/docbook/. You will also need to create a
$DOCBOOK_STYLESHEETS variable in your environment that points to the top
of the stylesheet tree. More information can be found at
http://www.docbook.org/tdg5/en/html/appa.html#s.stylesheetinstall. On
RHEL-ish systems, they are also available in the 'docbook5-style-xsl'
package.
xsltproc. Command line XSLT processor. Available at
http://xmlsoft.org/XSLT/xsltproc2.html
INSTALLATION INSTALLATION
There are three major steps to getting a Rivendell system up and There are three major steps to getting a Rivendell system up and
running. They are: running. They are:

View File

@ -31,6 +31,7 @@ endif
if ALSA_RD_AM if ALSA_RD_AM
ALSACONFIG_RD_OPT = rdalsaconfig ALSACONFIG_RD_OPT = rdalsaconfig
endif endif
SUBDIRS = icons\ SUBDIRS = icons\
helpers\ helpers\
lib\ lib\

View File

@ -66,6 +66,8 @@ AC_ARG_ENABLE(jack,[ --disable-jack disable JACK sound support],
[JACK_DISABLED=yes],[]) [JACK_DISABLED=yes],[])
AC_ARG_ENABLE(alsa,[ --disable-alsa disable direct ALSA sound support], AC_ARG_ENABLE(alsa,[ --disable-alsa disable direct ALSA sound support],
[ALSA_DISABLED=yes],[]) [ALSA_DISABLED=yes],[])
AC_ARG_ENABLE(docbook,[ --disable-docbook disable building of documentation],[DOCBOOK_DISABLED=yes],[])
AC_ARG_ENABLE(gpio,[ --disable-gpio disable General Purpose Input/Output GPIO support], AC_ARG_ENABLE(gpio,[ --disable-gpio disable General Purpose Input/Output GPIO support],
[GPIO_DISABLED=yes],[]) [GPIO_DISABLED=yes],[])
AC_ARG_ENABLE(pam,[ --disable-pam disable Rivendell PAM pam_rd.so support], AC_ARG_ENABLE(pam,[ --disable-pam disable Rivendell PAM pam_rd.so support],
@ -223,6 +225,14 @@ if test -z $MP4V2_DISABLED ; then
fi fi
fi fi
#
# Build DocBook Items?
#
if test -z $DOCBOOK_DISABLED ; then
USING_DOCBOOK=yes
fi
AM_CONDITIONAL([DOCBOOK_AM], [test "$USING_DOCBOOK" = yes])
# #
# Set Hard Library Dependencies # Set Hard Library Dependencies
# #
@ -466,6 +476,7 @@ AC_CONFIG_FILES([rivendell.spec \
web/tests/Makefile \ web/tests/Makefile \
conf/Makefile \ conf/Makefile \
docs/Makefile \ docs/Makefile \
docs/docbook/Makefile \
docs/examples/Makefile \ docs/examples/Makefile \
docs/man/Makefile \ docs/man/Makefile \
docs/tables/Makefile \ docs/tables/Makefile \

View File

@ -2,7 +2,7 @@
## ##
## docs/automake.am for Rivendell ## docs/automake.am for Rivendell
## ##
## (C) Copyright 2002-2006 Fred Gleason <fredg@paravelsystems.com> ## (C) Copyright 2002-2016 Fred Gleason <fredg@paravelsystems.com>
## ##
## This program is free software; you can redistribute it and/or modify ## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License version 2 as ## it under the terms of the GNU General Public License version 2 as
@ -19,14 +19,17 @@
## ##
## Use automake to process this into a Makefile.in ## Use automake to process this into a Makefile.in
SUBDIRS = examples\ if DOCBOOK_AM
DOCBOOK_AM_OPT = docbook
endif
SUBDIRS = $(DOCBOOK_AM_OPT) examples\
man\ man\
tables tables
EXTRA_DIST = ALSA.txt\ EXTRA_DIST = ALSA.txt\
ando_interface.odt\ ando_interface.odt\
asound.conf-sample\ asound.conf-sample\
cae.sxw\
catchd.txt\ catchd.txt\
colors\ colors\
copy_split_format.odt\ copy_split_format.odt\
@ -49,7 +52,6 @@ EXTRA_DIST = ALSA.txt\
SAGE_ENDEC.txt\ SAGE_ENDEC.txt\
scheduler_formats.ods\ scheduler_formats.ods\
SWITCHERS.txt\ SWITCHERS.txt\
web_api.odt\
WIN32.txt\ WIN32.txt\
WINGS_FILTER.txt WINGS_FILTER.txt

Binary file not shown.

54
docs/docbook/Makefile.am Normal file
View File

@ -0,0 +1,54 @@
## automake.am
##
## docs/docbook/automake.am for Rivendell
##
## (C) Copyright 2015 Fred Gleason <fredg@paravelsystems.com>
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License version 2 as
## published by the Free Software Foundation.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public
## License along with this program; if not, write to the Free Software
## Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
##
## Use automake to process this into a Makefile.in
##
## Build Dependencies
##
%.html: %.xml
xsltproc -o $@ $(DOCBOOK_STYLESHEETS)/xhtml/docbook.xsl $<
%.pdf: %.xml
xsltproc $(DOCBOOK_STYLESHEETS)/fo/docbook.xsl $< | fop - -pdf $@
%.1: %.xml
xsltproc $(DOCBOOK_STYLESHEETS)/manpages/docbook.xsl $<
%.8: %.xml
xsltproc $(DOCBOOK_STYLESHEETS)/manpages/docbook.xsl $<
all-local: cae.html\
cae.pdf\
web_api.html\
web_api.pdf
EXTRA_DIST = cae.html\
cae.pdf\
cae.xml\
web_api.html\
web_api.pdf\
web_api.xml
CLEANFILES = *~
MAINTAINERCLEANFILES = *~\
*.1\
*.8\
*.html\
*.pdf\
aclocal.m4\
configure\
Makefile.in

1755
docs/docbook/cae.xml Normal file

File diff suppressed because it is too large Load Diff

3105
docs/docbook/web_api.xml Normal file

File diff suppressed because it is too large Load Diff

Binary file not shown.

View File

@ -297,7 +297,6 @@ rm -rf $RPM_BUILD_ROOT
%doc conf/rd.conf-sample %doc conf/rd.conf-sample
%doc conf/my.cnf-master %doc conf/my.cnf-master
%doc conf/my.cnf-standby %doc conf/my.cnf-standby
%doc docs/cae.sxw
%doc docs/catchd.txt %doc docs/catchd.txt
%doc docs/colors %doc docs/colors
%doc docs/GPIO.txt %doc docs/GPIO.txt
@ -308,6 +307,8 @@ rm -rf $RPM_BUILD_ROOT
%doc docs/pam_rd.txt %doc docs/pam_rd.txt
%doc docs/rml.sxw %doc docs/rml.sxw
%doc docs/MESSAGE_BOX.txt %doc docs/MESSAGE_BOX.txt
%doc docs/docbook/cae.pdf
%doc docs/docbook/web_api.pdf
%doc docs/tables/audio_perms.txt %doc docs/tables/audio_perms.txt
%doc docs/tables/audio_ports.txt %doc docs/tables/audio_ports.txt
%doc docs/tables/cart.txt %doc docs/tables/cart.txt
@ -333,7 +334,6 @@ rm -rf $RPM_BUILD_ROOT
%doc docs/tables/users.txt %doc docs/tables/users.txt
%doc docs/tables/version.txt %doc docs/tables/version.txt
%doc docs/asound.conf-sample %doc docs/asound.conf-sample
%doc docs/web_api.odt
%doc conf/rlm_serial.conf %doc conf/rlm_serial.conf
%doc conf/rlm_udp.conf %doc conf/rlm_udp.conf
%doc conf/rlm_twitter.conf %doc conf/rlm_twitter.conf