jakarta-oro-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d..@apache.org
Subject cvs commit: jakarta-oro/xdocs/manual/guide chapter-preface.xml chapter-regex.xml
Date Mon, 09 Jul 2001 11:55:13 GMT
dfs         01/07/09 04:55:13

  Modified:    build    build.xml
  Added:       xdocs/manual Makefile guide.xml oro.dsl
               xdocs/manual/guide chapter-preface.xml chapter-regex.xml
  Log:
  Added a skeleton for the programmer's guide using DocBook.  Made sure to
  exclude it from the packaging at this point in build.xml and also excluded
  the manual tree from the anakia documentation generation rule.
  
  Revision  Changes    Path
  1.12      +6 -4      jakarta-oro/build/build.xml
  
  Index: build.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-oro/build/build.xml,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- build.xml	2001/05/23 03:19:21	1.11
  +++ build.xml	2001/07/09 11:55:08	1.12
  @@ -1,11 +1,11 @@
   <?xml version="1.0"?>
  -<!-- $Id: build.xml,v 1.11 2001/05/23 03:19:21 dfs Exp $ -->
  +<!-- $Id: build.xml,v 1.12 2001/07/09 11:55:08 dfs Exp $ -->
   
   <project name="Jakarta-ORO" default="jar" basedir=".">
   
     <property name="Name" value="Jakarta-ORO"/>
     <property name="year" value="2001"/>
  -  <property name="version" value="2.0.3"/>
  +  <property name="version" value="2.0.3-dev1"/>
     <property name="project" value="jakarta-oro"/>
     <property name="top.dir" value=".."/>
     <property name="code.src" value="${top.dir}/src"/>
  @@ -120,7 +120,7 @@
           <anakia basedir="${docs.src}" destdir="${docs.dest}/"
           extension=".html" style="./site.vsl"
           projectFile="stylesheets/project.xml"
  -        excludes="**/stylesheets/** empty.xml"
  +        excludes="**/stylesheets/** manual/** empty.xml"
           includes="**/*.xml"
           lastModifiedCheck="true"
           templatePath="${jakarta-site2.dir}/xdocs/stylesheets">
  @@ -156,7 +156,9 @@
               <fileset dir="${code.src}"/>
           </copy>
           <copy todir="${final.dir}/docs">
  -            <fileset dir="${docs.dest}"/>
  +            <fileset dir="${docs.dest}">
  +              <exclude name="manual/**"/>
  +	    </fileset>
           </copy>
           <copy todir="${final.dir}/build">
               <fileset dir="${top.dir}/build">
  
  
  
  1.1                  jakarta-oro/xdocs/manual/Makefile
  
  Index: Makefile
  ===================================================================
  #
  # $Id: Makefile,v 1.1 2001/07/09 11:55:10 dfs Exp $
  #
  # This Makefile requires the installation of at least OpenJade 1.3 and
  # Docbook-Utils 0.6.  Output types other than html and rtf may require
  # additional software such as jadetex and LaTeX.  Text output requires
  # the lynx web browser.
  #
  # This Makefile is an interim measure that will go away and be replaced
  # with Ant rules that are a part of the regular buid procedure before a
  # formal release.
  #
  
  LIB_SGML_DIR = .
  OUTPUT_DIR   = ../../docs/manual
  
  DSSSL     = $(LIB_SGML_DIR)/oro.dsl
  JADE      = openjade
  JW        = jw -f docbook
  LYNX      = lynx
  
  ARTICLES  := $(basename $(shell find . -name "*.xml" -maxdepth 1 -print))
  
  DVI_OBJ   := $(ARTICLES:%=%.dvi)
  PS_OBJ    := $(ARTICLES:%=%.ps)
  PDF_OBJ   := $(ARTICLES:%=%.pdf)
  RTF_OBJ   := $(ARTICLES:%=%.rtf)
  TXT_OBJ   := $(ARTICLES:%=%.txt)
  HTML_OBJ  := $(ARTICLES:%=%.html)
  
  OBJ = $(DVI_OBJ) $(PS_OBJ) $(PDF_OBJ) $(RTF_OBJ) $(TXT_OBJ) $(HTML_OBJ)
  
  .SUFFIXES:
  .SUFFIXES: .dvi .ps .pdf .rtf .txt .html .xml
  
  %.dvi: %.xml .%.ts $(DSSSL)
  	$(JW) -b dvi -d $(DSSSL)\#print $<
  
  %.ps: %.xml .%.ts $(DSSSL)
  	$(JW) -b ps -d $(DSSSL)\#print $<
  
  %.pdf: %.xml .%.ts $(DSSSL)
  	$(JW) -b pdf -d $(DSSSL)\#print $<
  
  %.rtf: %.xml .%.ts $(DSSSL)
  	$(JW) -b rtf -d $(DSSSL)\#print $<
  
  %.html: %.xml .%.ts $(DSSSL)
  	rm -f $@
  	$(JADE) -V nochunks -t xml -i html -d $(DSSSL)\#html $< > $@
  
  %.txt: %.html .%.ts $(DSSSL)
  	rm -f $@
  	$(LYNX) -force_html -dump -width=80 -nolist $< > $@
  
  .guide.ts: guide.xml guide/*.xml
  	touch $@
  
  all: $(OBJ) copy
  
  dvi: $(DVI_OBJ)
  
  ps: $(PS_OBJ)
  
  pdf: $(PDF_OBJ)
  
  rtf: $(RTF_OBJ)
  
  txt: $(TXT_OBJ)
  
  html: $(HTML_OBJ)
  
  copy:
  	-mkdir $(OUTPUT_DIR) > /dev/null 2>&1 /dev/null
  	-cp -f $(OBJ) $(OUTPUT_DIR) > /dev/null 2>&1
  
  clean:
  	/bin/rm -fr $(OBJ) .*.ts
  
  
  
  1.1                  jakarta-oro/xdocs/manual/guide.xml
  
  Index: guide.xml
  ===================================================================
  <? xml version="1.0" encoding='ISO-8859-1'?>
  <!-- $Id: guide.xml,v 1.1 2001/07/09 11:55:11 dfs Exp $ -->
  <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
  <!ENTITY chapter-preface SYSTEM "guide/chapter-preface.xml">
  <!ENTITY chapter-regex SYSTEM "guide/chapter-regex.xml">
  <!ENTITY package-awk "org.apache.text.awk">
  <!ENTITY package-perl "org.apache.text.perl">
  <!ENTITY package-regex "org.apache.text.regex">
  <!ENTITY package-text "org.apache.text">
  ]>
  
  <book id="Jakarta-ORO-Programmer-Guide" lang="en">
  
    <!-- Header -->
    <bookinfo>
      <title>Jakarta ORO Programmer's Guide</title>
  
      <authorgroup>
        <author>
  	<firstname>Daniel</firstname>
  	<othername>F.</othername>
  	<surname>Savarese</surname>
  	<affiliation>
  	  <orgname>
              <ulink url="http://jakarta.apache.org/">
               The Apache Jakarta Project
              </ulink>
            </orgname>
  	  <address><email>dfs at savarese.org</email></address>
  	</affiliation>
        </author>
      </authorgroup>
  
      <revhistory>
        <revision>
  	<revnumber>0.1</revnumber>
  	<date>July 8, 2001</date>
  	<authorinitials>dfs</authorinitials>
  	<revremark>First draft.</revremark>
        </revision>
      </revhistory>
  
      <copyright>
        <year>2001</year>
        <holder>
          <ulink url="http://www.apache.org/">
          Apache Software Foundation
          </ulink>
        </holder>
      </copyright>
    </bookinfo>
  
  &chapter-preface;
  &chapter-regex;
  
  </book>
  
  <!--
     Local variables:
      mode: sgml
     End:
  -->
  
  
  
  1.1                  jakarta-oro/xdocs/manual/oro.dsl
  
  Index: oro.dsl
  ===================================================================
  <!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [
  <!ENTITY % html "IGNORE">
  <![%html;[
  <!ENTITY % print "IGNORE">
  <!ENTITY docbook.dsl SYSTEM "/usr/share/sgml/docbook/dsssl-stylesheets-1.59/html/docbook.dsl"
CDATA dsssl>
  ]]>
  <!ENTITY % print "INCLUDE">
  <![%print;[
  <!ENTITY docbook.dsl SYSTEM "/usr/share/sgml/docbook/dsssl-stylesheets-1.59/print/docbook.dsl"
CDATA dsssl>
  ]]>
  ]>
  
  <style-sheet>
  
  <style-specification id="print" use="docbook">
  <style-specification-body> 
  
  ;; ==============================
  ;; customize the print stylesheet
  ;; ==============================
  
  (declare-characteristic preserve-sdata?
    ;; this is necessary because right now jadetex does not understand
    ;; symbolic entities, whereas things work well with numeric entities.
    "UNREGISTERED::James Clark//Characteristic::preserve-sdata?"
    #f)
  
  (define %generate-article-toc%
    ;; Should a Table of Contents be produced for Articles?
    #f)
  
  (define (toc-depth nd)
    3)
  
  (define %generate-article-titlepage-on-separate-page%
    ;; Should the article title page be on a separate page?
    #f)
  
  (define %section-autolabel%
    ;; Are sections enumerated?
    #t)
  
  (define %footnote-ulinks%
    ;; Generate footnotes for ULinks?
    #f)
  
  (define %bop-footnotes%
    ;; Make "bottom-of-page" footnotes?
    #f)
  
  (define %body-start-indent%
    ;; Default indent of body text
    0pi)
  
  (define %para-indent-firstpara%
    ;; First line start-indent for the first paragraph
    0pt)
  
  (define %para-indent%
    ;; First line start-indent for paragraphs (other than the first)
    0pt)
  
  (define %block-start-indent%
    ;; Extra start-indent for block-elements
    0pt)
  
  (define formal-object-float
    ;; Do formal objects float?
    #t)
  
  (define %hyphenation%
    ;; Allow automatic hyphenation?
    #t)
  
  (define %admon-graphics%
    ;; Use graphics in admonitions?
    #f)
  
  </style-specification-body>
  </style-specification>
  
  
  <!--
  ;; ===================================================
  ;; customize the html stylesheet; borrowed from Cygnus
  ;; at http://sourceware.cygnus.com/ (cygnus-both.dsl)
  ;; ===================================================
  -->
  
  <style-specification id="html" use="docbook">
  <style-specification-body> 
  
  (declare-characteristic preserve-sdata?
    ;; this is necessary because right now jadetex does not understand
    ;; symbolic entities, whereas things work well with numeric entities.
    "UNREGISTERED::James Clark//Characteristic::preserve-sdata?"
    #f)
  
  (define %generate-legalnotice-link%
    ;; put the legal notice in a separate file
    #f)
  
  (define %admon-graphics-path%
    ;; use graphics in admonitions, set their
    "../images/")
  
  (define %admon-graphics%
    #f)
  
  (define %funcsynopsis-decoration%
    ;; make funcsynopsis look pretty
    #t)
  
  (define %html-ext%
    ".html")
  
  (define %generate-article-toc% 
    ;; Should a Table of Contents be produced for Articles?
    ;; If true, a Table of Contents will be generated for each 'Article'.
    #t)
  
  (define %generate-part-toc%
    #t)
  
  (define %generate-article-titlepage%
    #t)
  
  (define (chunk-skip-first-element-list)
    ;; forces the Table of Contents on separate page
    '())
  
  (define %root-filename%
    ;; The filename of the root HTML document (e.g, "index").
    "index")
  
  (define %shade-verbatim%
    #t)
  
  (define %use-id-as-filename%
    ;; Use ID attributes as name for component HTML files?
    #t)
  
  (define %graphic-default-extension% 
    "gif")
  
  (define %section-autolabel%
    ;; For enumerated sections (1.1, 1.1.1, 1.2, etc.)
    #t)
  
  (define (toc-depth nd)
    ;; more depth, 3 levels, to toc, instead of flat hierarchy
    3)
  
  </style-specification-body>
  </style-specification>
  
  <external-specification id="docbook" document="docbook.dsl">
  
  </style-sheet>
  
  
  
  1.1                  jakarta-oro/xdocs/manual/guide/chapter-preface.xml
  
  Index: chapter-preface.xml
  ===================================================================
  <!-- $Id: chapter-preface.xml,v 1.1 2001/07/09 11:55:12 dfs Exp $ -->
  
  <chapter id="chapter-preface">
    <title>Preface</title>
  
    <para>This documentation is a work in progress.</para>
  
  </chapter>
  
  <!--
     Local variables:
      mode: sgml
     End:
  -->
  
  
  1.1                  jakarta-oro/xdocs/manual/guide/chapter-regex.xml
  
  Index: chapter-regex.xml
  ===================================================================
  <!-- $Id: chapter-regex.xml,v 1.1 2001/07/09 11:55:12 dfs Exp $ -->
  
  <chapter id="chapter-regex">
    <title>Using the &package-regex; Package</title>
  
    <para>The &package-regex; package is the core of the
    Jakarta-ORO project.  It defines a set of base interfaces for
    using regular expressions in Java programs.  It also provides a set
    of classes implementing these interfaces for Perl 5 regular
    expressions.</para>
  
    <section id="package-regex-syntax">
      <title>Syntax</title>
  
      <para>A paragraph</para>
  
      <section id="package-regex-syntax-whatis">
        <title>What is a regular expression?</title>
  
        <para>A paragraph</para>
      </section>
  
      <section id="package-regex-syntax-Perl5">
        <title>Perl 5 regular expressions</title>
  
        <para>A paragraph</para>
      </section>
    </section>
  
  
    <section id="package-regex-interfaces">
      <title>The Interfaces</title>
  
      <para>A paragraph</para>
  
      <section id="package-regex-interfaces-Pattern">
        <title>Pattern</title>
  
        <para>A paragraph</para>
      </section>
  
      <section id="package-regex-interfaces-PatternCompiler">
        <title>PatternCompiler</title>
  
        <para>A paragraph</para>
      </section>
  
      <section id="package-regex-interfaces-PatternMatcher">
        <title>PatternMatcher</title>
  
        <para>A paragraph</para>
      </section>
  
      <section id="package-regex-interfaces-MatchResult">
        <title>MatchResult</title>
  
        <para>A paragraph</para>
      </section>
    </section>
  
  
    <section id="package-regex-classes">
      <title>The Classes</title>
  
      <para>A paragraph</para>
  
      <section id="package-regex-classes-Perl5Pattern">
        <title>Perl5Pattern</title>
  
        <para>A paragraph</para>
      </section>
  
      <section id="package-regex-classes-Perl5Compiler">
        <title>Perl5Compiler</title>
  
        <para>A paragraph</para>
      </section>
  
      <section id="package-regex-classes-Perl5Matcher">
        <title>Perl5Matcher</title>
  
        <para>A paragraph</para>
      </section>
  
      <section id="package-regex-classes-PatternMatcherInput">
        <title>PatternMatcherInput</title>
  
        <para>A paragraph</para>
      </section>
  
      <section id="package-regex-classes-Util">
        <title>Util</title>
  
        <para>A paragraph</para>
      </section>
  
      <section id="package-regex-classes-Perl5Debug">
        <title>Perl5Debug</title>
  
        <para>A paragraph</para>
      </section>
    </section>
  
    <section id="package-regex-examples">
      <title>Example Programs</title>
      <para>A paragraph</para>
    </section>
  
    <section id="package-regex-performance">
      <title>Maximizing Performance</title>
      <para>A paragraph</para>
    </section>
  
  
    <section id="package-regex-FAQ">
      <title>Frequently Asked Questions</title>
      <para>A paragraph</para>
    </section>
  
  
  </chapter>
  
  <!--
     Local variables:
      mode: sgml
     End:
  -->
  
  

Mime
View raw message