Added: BUILDING
URL: http://svncommunity.digium.com/view/asterisk-docs/BUILDING?rev=1&view=auto
==============================================================================
--- BUILDING (added)
+++ BUILDING Thu Apr 27 11:22:50 2006
@@ -1,0 +1,47 @@
+Author Peter Beckman
+Date April 27, 2006
+
+How to build AstDOCs.
+
+AstDOC was stolen, taken really, from the PHPDOC project. It uses the DocBook
+standard to encorporate all of the subtleties of what you are documenting into
+a standard, SGML/XML format. This language allows you to export your
+documentation into several formats quickly and easily, without rewriting your
+documentation.
+
+For the most part, to get up to speed, read this document:
+
+ http://doc.php.net/php/dochowto/index.php
+
+It talks about the PHPDOC project in detail, and will give you a good overview
+of what the Asterisk Docs should look like in time.
+
+I think it is best to stick with the conventions from the PHPDOC group until
+we can make and modify our own.
+
+HOW TO GENERATE THE ASTDOC WEB-BASED DOCUMENTATION
+
+You need to have autoconf on your box.
+
+ 1. Run autoconf (sometimes autoconf259 or similar)
+
+ 2. Run ./configure --with-lang=en
+
+ 3. Run make phpweb
+
+ This will generate all of your documentation into the "php" directory.
+ Currently this assumes that the php dir will be "manual/en" from a web
+ perspective.
+
+ 4. cp -rp php/*.php php/manual/en/
+
+ A simple way to use your checked-out svn trunk to view your work on the
+ web. Just set your DOCUMENT_ROOT to svnroot/php and things should
+ work.
+
+ 5. The include files for the php manual can be found in includes/phpweb
+ dir. Just copy this whole tree to your new php/ dir.
+
+That's it. Have fun.
+
+Beckman
Added: LICENSE
URL: http://svncommunity.digium.com/view/asterisk-docs/LICENSE?rev=1&view=auto
==============================================================================
--- LICENSE (added)
+++ LICENSE Thu Apr 27 11:22:50 2006
@@ -1,0 +1,30 @@
+Documentation content licensing:
+
+ Copyright (c) 1997 - 2006 by the PHP Documentation Group. This
+ material may be distributed only subject to the terms and
+ conditions set forth in the Open Publication License, v1.0 or
+ later. A copy of the Open Publication License is distributed
+ with this manual, the latest version is presently available
+ at http://www.opencontent.org/openpub/.
+
+ Distribution of substantively modified versions of this document
+ is prohibited without the explicit permission of the copyright holder.
+
+ Distribution of the work or derivative of the work in any
+ standard (paper) book form is prohibited unless prior permission
+ is obtained from the copyright holder.
+
+ In case you are interested in redistribution or republishing of
+ this document in whole or in part, either modified or unmodified,
+ and you have questions, please contact the copyright holders at
+ doc-license@lists.php.net. Note that this address is mapped to
+ a publicly archived mailing list.
+
+ The Chapter 46 section of the documentation is based on an
+ initial contribution by Zend Technologies.
+
+Documentation tools licensing:
+
+ Most of the custom scripts used to build the documentation are
+ under the PHP License. Please check the license headers in the
+ files for more details.
Added: Makefile.in
URL: http://svncommunity.digium.com/view/asterisk-docs/Makefile.in?rev=1&view=auto
==============================================================================
--- Makefile.in (added)
+++ Makefile.in Thu Apr 27 11:22:50 2006
@@ -1,0 +1,340 @@
+# +----------------------------------------------------------------------+
+# | PHP Version 4 |
+# +----------------------------------------------------------------------+
+# | Copyright (c) 1997-2006 The PHP Group |
+# +----------------------------------------------------------------------+
+# | This source file is subject to version 3.0 of the PHP license, |
+# | that is bundled with this package in the file LICENSE, and is |
+# | available through the world-wide-web at the following url: |
+# | http://www.php.net/license/3_0.txt. |
+# | If you did not receive a copy of the PHP license and are unable to |
+# | obtain it through the world-wide-web, please send a note to |
+# | license@php.net so we can mail you a copy immediately. |
+# +----------------------------------------------------------------------+
+# | Authors: Stig Bakken <ssb@fast.no> |
+# +----------------------------------------------------------------------+
+#
+
+#
+# $Id: Makefile.in,v 1.171 2006/01/01 15:07:19 goba Exp $
+#
+
+all: html
+
+# {{{ variables
+
+VPATH=@srcdir@
+
+srcdir=@srcdir@
+scriptdir=@srcdir@/scripts
+PHP_SOURCE=@PHP_SOURCE@
+PECL_SOURCE=@PECL_SOURCE@
+LANGCODE=@LANG@
+LANGDIR=@LANGDIR@
+LANG=@LANG@ -D .
+JADE=@SP_OPTIONS@ @JADE@ -D . -wno-idref
+NSGMLS=@SP_OPTIONS@ @NSGMLS@
+PHP=@PHP@
+XSLTPROC=@XSLTPROC@
+XMLLINT=@XMLLINT@
+
+CATALOG=@CATALOG@
+
+HTML_STYLESHEET=dsssl/html.dsl
+PHPWEB_STYLESHEET=dsssl/phpweb.dsl
+HOWTO_STYLESHEET=dsssl/howto.dsl
+HOWTOPHP_STYLESHEET=dsssl/howto-php.dsl
+PRINT_STYLESHEET=dsssl/print.dsl
+KDEVELOP_TOC_STYLESHEET=dsssl/kdevelop_toc.dsl
+XMLDCL=$(srcdir)/dtds/dbxml-4.1.2/phpdocxml.dcl
+
+CHM_XSL_SHEET=xsl/htmlhelp.xsl
+HOWTO_XSL_SHEET=xsl/howto.xsl
+QUICKREF_XSL_SHEET=xsl/quickref.xsl
+
+BIGHTML_DEPS=$(HTML_STYLESHEET) dsssl/html-common.dsl dsssl/html-locale.dsl.in dsssl/common.dsl.in
+HTML_DEPS=$(HTML_STYLESHEET) dsssl/html-common.dsl dsssl/html-locale.dsl.in dsssl/common.dsl.in
+HOWTO_DEPS=$(HOWTO_STYLESHEET) $(HOWTOPHP_STYLESHEET) dsssl/html-common.dsl dsssl/html-locale.dsl.in dsssl/common.dsl.in howto/howto.ent
+PRINT_DEPS=$(PRINT_STYLESHEET) dsssl/common.dsl.in dsssl/print.dsl.in
+PHPWEB_DEPS=$(PHPWEB_STYLESHEET) dsssl/html-common.dsl dsssl/common.dsl
+KDEVELOP_TOC_DEPS=dsssl/kdevelop_toc.dsl Makefile
+
+DIST_FILES=@MANUAL@.tar.gz @MANUAL@.html.gz
+MIRROR_TARGETS=php/index.php html/index.html $(DIST_FILES)
+#MIRROR_TARGETS=phpweb_xsl html/index.html $(DIST_FILES)
+
+
+PDF_FILES=@MANUAL@.pdf.bz2
+
+HACK_RTL_LANGS_PAGES=@HACK_RTL_LANGS_PAGES@
+HACK_RTL_LANGS_PHPWEB=@HACK_RTL_LANGS_PHPWEB@
+# }}}
+
+@AUTOGENERATED_RULES@
+
+entities: FORCE
+ $(PHP) -c $(scriptdir) -q $(scriptdir)/entities.php
+
+manual.xml: $(srcdir)/manual.xml.in .manual.xml
+ CONFIG_FILES=$@ CONFIG_HEADERS= ./config.status
+
+.manual.xml: $(DEPEND_FILES) entities/global.ent
+ touch .manual.xml
+
+html: html/index.html
+bightml: @MANUAL@.html
+phpweb: php/index.php
+rtf: @MANUAL@.rtf
+tex latex: @MANUAL@.tex
+dvi: @MANUAL@.dvi
+ps: @MANUAL@.ps
+pdf: @MANUAL@.pdf
+howto: howto/html/index.html
+howtophp: howto/php/index.php
+howtotgz: howto/howto.html.tar.gz
+funcindex: funcindex.xml
+revcheck: revcheck.html
+
+FORCE:
+
+funclist.txt: FORCE
+ @if test "$(PHP_SOURCE)" = "no"; then \
+ echo "WARNING: recreating the function list needs php sources" ;\
+ echo " which were not found by configure" ;\
+ echo " aborting " ;\
+ else \
+ $(PHP) -C -q $(scriptdir)/genfunclist.php $(PHP_SOURCE) > funclist.txt ;\
+ fi; \
+ if test "$(PECL_SOURCE)" = "no" -a ! "$(PHP_SOURCE)" = "no"; then \
+ echo "WARNING: pecl sources not found - pecl functions" ;\
+ echo " will not be present in funclist.txt" ;\
+ elif test ! "$(PHP_SOURCE)" = "no"; then \
+ echo "" >> funclist.txt ;\
+ echo "# --------- PECL Stuff --------- " >> funclist.txt ;\
+ $(PHP) -C -q $(scriptdir)/genfunclist.php $(PECL_SOURCE) >> funclist.txt ;\
+ fi
+
+funcsummary.txt: FORCE
+ $(PHP) -C -q $(scriptdir)/genfuncsummary.php $(PHP_SOURCE) > funcsummary.txt
+
+revcheck.html: FORCE
+ PHPDOCDIR=$(srcdir) $(PHP) -c $(scriptdir) -f $(scriptdir)/revcheck.php $(LANGDIR) > revcheck.html
+
+funcindex.xml: FORCE
+ @if test "$(PHP)" = "no"; then \
+ echo "WARNING: recreating the function index needs php" ;\
+ echo " which was not found by configure" ;\
+ echo " reusing old file" ;\
+ touch funcindex.xml ;\
+ else \
+ $(XSLTPROC) -o quickref-temp.txt $(QUICKREF_XSL_SHEET) manual.xml ;\
+ echo "$(PHP) -q $(scriptdir)/genfuncindex.php quickref-temp.txt > funcindex.xml" ;\
+ $(PHP) -q $(scriptdir)/genfuncindex.php quickref-temp.txt > funcindex.xml ;\
+ rm -f quickref-temp.txt ;\
+ fi
+
+mirror-files: $(MIRROR_TARGETS)
+#extra-mirror-files: $(PDF_FILES) isilo
+extra-mirror-files: isilo
+
+snapshot: manual-snapshot.tar.gz
+
+manual-snapshot.tar.gz: @MANUAL@.html html/index.html @MANUAL@.rtf @MANUAL@.txt
+ tar -cvzf $@ @MANUAL@.html html/*.html @MANUAL@.rtf @MANUAL@.txt
+
+status: ./funclist.txt
+ $(PHP) -q $(scriptdir)/checkdoc.php > status.txt
+ $(PHP) -q $(scriptdir)/checkdoc.php missing > missing.txt
+
+summary: ./funcsummary.txt
+
+quickref: quickref.txt
+quickref.txt: FORCE
+ @if test ! -f funcindex.xml; then touch funcindex.xml; fi
+ $(XSLTPROC) -o quickref.txt $(QUICKREF_XSL_SHEET) manual.xml
+
+kdevelop_toc: php.toc
+php.toc: manual.xml $(KDEVELOP_TOC_DEPS)
+ echo '<!DOCTYPE gideontoc>' > $@
+ $(JADE) $(CATALOG) -d $(KDEVELOP_TOC_STYLESHEET) -V nochunks -t sgml $(XMLDCL) manual.xml | sed -e's/\& /\& /g' >> $@
+
+scripts/makedoc: $(scriptdir)/makedoc.cc
+ mkdir -p scripts
+ g++ -o scripts/makedoc $(scriptdir)/makedoc.cc
+
+# intermediate file for name change
+.SECONDARY: @MANUAL@.xml
+
+@MANUAL@.xml: manual.xml
+ cp manual.xml $@
+
+@MANUAL@.html: @MANUAL@.xml $(BIGHTML_DEPS)
+
+html/index.html: manual.xml $(HTML_DEPS)
+ $(PHP) -q $(scriptdir)/rtlpatch/hackmanuallang.php $(LANGDIR)
+ $(JADE) $(CATALOG) -d $(HTML_STYLESHEET) -V use-output-dir -t sgml $(XMLDCL) manual.xml
+ $(PHP) -q $(scriptdir)/html_syntax.php html html/
+ $(PHP) -q $(scriptdir)/rtlpatch/hackmanuallang.php en
+ $(HACK_RTL_LANGS_PAGES)
+
+# still needs more tweaks!!
+html_xsl: manual.xml
+ ${XSLTPROC} xsl/html.xsl manual.xml
+
+bightml_xsl: manual.xml
+ ${XSLTPROC} -o @MANUAL@.html xsl/bightml.xsl manual.xml
+
+fo: manual.xml
+ ${XSLTPROC} -o manual.fo xsl/fo.xsl manual.xml
+
+howto_xsl:
+ rm -rf ./howto/html && mkdir ./howto/html
+ ${XSLTPROC} $(HOWTO_XSL_SHEET) ./howto/howto.xml
+
+chm_xsl: manual.xml
+ ${XSLTPROC} $(CHM_XSL_SHEET) manual.xml
+
+phpweb_xsl: manual.xml
+ ${XSLTPROC} $(srcdir)/xsl/phpweb.xsl manual.xml
+ $(PHP) -q $(scriptdir)/fixphpweb.php `pwd`/php
+
+php/index.php: manual.xml $(PHPWEB_DEPS)
+ $(PHP) -q $(scriptdir)/phpweb-entities.php `pwd` phpweb
+ $(PHP) -q $(scriptdir)/rtlpatch/hackmanuallang.php $(LANGDIR)
+ -$(JADE) $(CATALOG) -d $(PHPWEB_STYLESHEET) -V use-output-dir -t sgml $(XMLDCL) manual.xml
+ $(PHP) -q $(scriptdir)/html_syntax.php php php/
[... 314423 lines stripped ...]
_______________________________________________
--Bandwidth and Colocation provided by Easynews.com --
Posted: Fri Apr 28, 2006 12:13 am Post subject: [asterisk-doc] r1 - // /RFC/ /chm/ /dbxml/ /dbxml/ent/ /dsss
Hello.
El jue, 27-04-2006 a las 13:40 -0400, Peter Beckman escribió:
Quote:
Excellent!
I'm not 100% sure how the PHPDOC group handles translations, but it looks
like the main branch is for english, and all other translations are in
separate SVN trunks.
Yes, that's the way they do it, since they use CVS. Maybe with SVN we
can just make a LANGUAGE/ directory on the sources root.
Quote:
I assume you check out the main trunk, then the trunk for the translation,
then use the same build process, except ./configure --with-lang=es
If you can figure out some of the errors in make test, that'd be great!
I tried to figure out the url to checkout a copy of the tree, but didn't
work. what's the svn url?
It seems to me that we'll have to change the translation scripts from
cvs to svn too. I guess this is exciting, as the work needed to run the
online generation system for all languages.
Can't wait to see this framework fully operational :)
Regards,
--
Alejandro Ríos Peña - (alerios)
_______________________________________________
--Bandwidth and Colocation provided by Easynews.com --
You cannot post new topics in this forum You cannot reply to topics in this forum You cannot edit your posts in this forum You cannot delete your posts in this forum You cannot vote in polls in this forum