Menu
▾
▴
[phpBT-dev] CVS: phpbt/docs/sgml dependencies.sgml,NONE,1.1 docs.dsl,NONE,1.1 phpbt.sgml,NONE,1.1 template.sgml,NONE,1.1 devstandards.sgml,1.4,1.5
|
From: Benjamin C. <bc...@us...> - 2001-09-27 13:40:24
|
Update of /cvsroot/phpbt/phpbt/docs/sgml
In directory usw-pr-cvs1:/tmp/cvs-serv18455/sgml
Modified Files:
devstandards.sgml
Added Files:
dependencies.sgml docs.dsl phpbt.sgml template.sgml
Log Message:
Starting the documentation book
--- NEW FILE: dependencies.sgml ---
<!-- -*- sgml -*- -->
<sect1 id="dependencies">
<title>Dependencies</title>
<abstract>
<para>&phpbt; requires one external package, PHPlib, and can optionally use JpGraph.</para>
</abstract>
<sect2 id="dep-phplib">
<title>PHPlib</title>
<para>PHPlib can be found at <ulink url="http://phplib.sourceforge.net/">http://phplib.sourceforge.net</ulink>. It provides the database abstraction layer, html templates, and session and authentication management.</para>
</sect2>
</sect1>
<!-- Local Variables: -->
<!-- sgml-indent-step: 2 -->
<!-- sgml-indent-data: 2 -->
<!-- sgml-parent-document: "phpbt.sgml" -->
<!-- End: -->
--- NEW FILE: docs.dsl ---
<!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style
Sheet//EN" [
<!ENTITY docbook.dsl PUBLIC "-//Norman Walsh//DOCUMENT DocBook HTML
Stylesheet//EN" CDATA dsssl>
]>
<style-sheet>
<style-specification use="docbook">
<style-specification-body>
;; Copyright (c) 2001 Jesse Goerz, NewbieDoc project.
;; http://sourceforge.net/projects/newbiedoc
;; Permission is granted to copy, distribute and/or modify this
;; document under the terms of the GNU Free Documentation License,
;; Version 1.1 or any later version published by the Free Software
;; Foundation; with no Invariant Sections, with no Front-Cover
;; Texts, and with no Back-Cover Texts. A copy of the license can
;; be found at http://www.fsf.org/copyleft/fdl.html.
;;
;; $Log: docs.dsl,v $
;; Revision 1.1 2001/09/27 13:40:20 bcurtis
;; Starting the documentation book
;;
;; Revision 1.1 2001/05/05 08:37:08 jgoerz
;; stable: stylesheet for single html file
;;
;; Revision 1.2 2001/05/04 04:24:02 jesse
;; Added callouts, changed bgcolor for body and
;; verbatim environments.
;;
;; Revision 1.1 2001/04/24 09:09:54 jesse
;; Initial revision
;;
(define %generate-article-toc%
;; Should a Table of Contents be produced for Articles?
#t)
(define (toc-depth nd)
(if (string=? (gi nd) (normalize "book"))
;;
;; Docbook default is 1 level deep
;; I don't understand "normalize book" but
;; it doesn't seem to affect if we use
;; articles. I changed it to 2 deep.
;;
3
2))
(define %generate-article-titlepage%
;; Should an article title page be produced?
#t)
(define %titlepage-in-info-order%
;; Place elements on title page in document order?
#f)
(define %admon-graphics%
;; Use graphics in admonitions?
#t)
(define %admon-graphics-path%
;; Path to admonition graphics
;; Sets the path, probably relative to the directory
;; where the HTML files are created, to the admonition
;; graphics.
;;
;; This needs to be "./images/" for tar distributed articles
;; This needs to be "../images/" for tar distributed Newbiedoc book
;; This needs to be "../images/" for individual articles on our website
"../images/")
(define %callout-graphics%
;; If true, callouts are presented with graphics (e.g., reverse-video
;; circled numbers instead of "(1)", "(2)", etc.).
;; Default graphics are provided in the distribution.
#t)
(define %callout-graphics-path%
;; Sets the path, probably relative to the directory where the HTML
;; files are created, to the callout graphics.
"../images/callouts/")
(define %callout-graphics-number-limit%
;; If '%callout-graphics%' is true, graphics are used to represent
;; callout numbers. The value of '%callout-graphics-number-limit%' is
;; the largest number for which a graphic exists. If the callout number
;; exceeds this limit, the default presentation "(nnn)" will always
;; be used.
10)
(define ($admon-graphic$ #!optional (nd (current-node)))
;; Admonition graphic file
;; Given an admonition node, returns the name of the
;; graphic that should be used for that admonition.
(cond ((equal? (gi nd) (normalize "tip"))
(string-append %admon-graphics-path% "tip.gif"))
((equal? (gi nd) (normalize "note"))
(string-append %admon-graphics-path% "note.gif"))
((equal? (gi nd) (normalize "important"))
(string-append %admon-graphics-path% "important.gif"))
((equal? (gi nd) (normalize "caution"))
(string-append %admon-graphics-path% "caution.gif"))
((equal? (gi nd) (normalize "warning"))
(string-append %admon-graphics-path% "warning.gif"))
(else (error (string-append (gi nd) " is not an admonition.")))))
(define ($admon-graphic-width$ #!optional (nd (current-node)))
"25")
(define %number-programlisting-lines%
;; Enumerate lines in a 'ProgramListing'?
#f)
(define %linenumber-length%
;; Width of line numbers in enumerated environments
;; Line numbers will be padded to %linenumber-length% characters.
0)
(define %linenumber-mod%
;; Controls line-number frequency in enumerated environments.
;; Every %linenumber-mod% line will be enumerated.
1)
(define %linenumber-padchar%
;; Pad character in line numbers
;; Line numbers will be padded (on the left) with %linenumber-padchar%
" ")
(define %shade-verbatim%
;; Should verbatim environments be shaded?
#t)
(define ($shade-verbatim-attr$)
;; Attributes used to create a shaded verbatim environment.
(list
(list "BORDER" "0")
(list "BGCOLOR" "#EEEEEE")
(list "WIDTH" ($table-width$))))
(define %section-autolabel%
;; Are sections enumerated?
#t)
(define %body-attr%
;; What attributes should be hung off of BODY?
(list
(list "BGCOLOR" "#FFFFFF")
(list "TEXT" "#000000")
(list "LINK" "#0000FF")
(list "VLINK" "#800080")
(list "ALINK" "#FF0000")))
(define %stylesheet%
;; Name of the stylesheet to use
"docs.css")
(define %stylesheet-type%
;; The type of the stylesheet to use
"text/css")
(define %html40%
;; Generate HTML 4.0
#t)
(define %use-id-as-filename%
;; Use ID attributes as name for component HTML files?
#t)
;;Default extension for filenames?
(define %html-ext%
".html")
</style-specification-body>
</style-specification>
<external-specification id="docbook" document="docbook.dsl">
</style-sheet>
--- NEW FILE: phpbt.sgml ---
<!-- -*- sgml -*- -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
[
<!-- Shortcuts -->
<!ENTITY phpbt "phpBugTracker">
<!-- Developer's Guide -->
<!ENTITY devstandards SYSTEM "devstandards.sgml">
<!ENTITY dependencies SYSTEM "dependencies.sgml">
]>
<book id="index">
<bookinfo>
<title>&phpbt;</title>
<abstract>
<para>&phpbt; is a web-based bug reporting and tracking system. It allows development teams to manage the testing and debugging segments of the development cycle.</para>
</abstract>
</bookinfo>
<chapter id="userguide">
<title>User's Guide</title>
<abstract>
<para>Currently all interactions with &phpbt; are done via the web interface. Users can submit bugs, communicate with developers and testers about bugs, and search through the bug database.</para>
</abstract>
</chapter>
<chapter id="adminguide">
<title>Administrator's Guide</title>
<abstract>
<para>One of the main design goals of &phpbt; is to make installation and administration easy. In fact, the difficulty of installing bugzilla was a key motivator for &phpbt;'s existence.</para>
</abstract>
</chapter>
<chapter id="devguide">
<title>Developer's Guide</title>
<abstract>
<para>Adding on to or extending &phpbt; should be easy for those with a knowledge of PHP and SQL. New developers are always welcome to join the project at <ulink url="http://www.sourceforge.net/projects/phpbt/">http://www.sourceforge.net/projects/phpbt</ulink>, or to simply submit patches, bug reports, or feature requests.</para>
</abstract>
&devstandards;
&dependencies;
</chapter>
</book>
<!-- Local Variables: -->
<!-- sgml-indent-step: 2 -->
<!-- sgml-indent-data: 2 -->
<!-- End: -->
--- NEW FILE: template.sgml ---
<!-- -*- sgml -*- -->
<sect1 id="uniquesectionid">
<title>Example Documentation Section</title>
<abstract>
<para>Summary of what this section is about.</para>
</abstract>
<sect2 id="subsectid">
<title>Subsection title</title>
<para>Subsection content</para>
<para>More content</para>
</sect2>
</sect1>
<!-- Local Variables: -->
<!-- sgml-indent-step: 2 -->
<!-- sgml-indent-data: 2 -->
<!-- sgml-parent-document: "phpbt.sgml" -->
<!-- End: -->
Index: devstandards.sgml
===================================================================
RCS file: /cvsroot/phpbt/phpbt/docs/sgml/devstandards.sgml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- devstandards.sgml 2001/09/25 04:13:10 1.4
+++ devstandards.sgml 2001/09/27 13:40:20 1.5
@@ -1,31 +1,24 @@
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
-
-[
-<!ENTITY phpbt "phpBugTracker">
-]>
-
-<article id="index" xreflabel="Development Standards">
- <articleinfo>
- <title>Development Standards</title>
- <abstract>
- <para>
- This document will contain the coding and process standards to be
- followed by the developers working on &phpbt;.
- </para>
- </abstract>
- </articleinfo>
+<!-- -*- sgml -*- -->
+<sect1 id="devstandards">
+ <title>Development Standards</title>
+ <abstract>
+ <para>
+ This section details the coding and process standards to be
+ followed by the developers working on &phpbt;.
+ </para>
+ </abstract>
- <sect1 id="devstandards-code" xreflabel="Coding Standards">
+ <sect2 id="devstandards-code" xreflabel="Coding Standards">
<title>Coding Standards</title>
- <sect2 id="devstandards-indenting" xreflabel="Indenting">
+ <sect3 id="devstandards-indenting" xreflabel="Indenting">
<title>Indenting</title>
<para>
Use an indent of one tab per indent.
</para>
- </sect2>
+ </sect3>
- <sect2 id="devstandards-control" xreflabel="Control Structures">
+ <sect3 id="devstandards-control" xreflabel="Control Structures">
<title>Control Structures</title>
<para>
These include if, for, while, switch, etc. Here is an example if
@@ -53,9 +46,9 @@
readability and decreases the likelihood of logic errors being
introduced when new lines are added.
</para>
- </sect2>
+ </sect3>
- <sect2 id="devstandards-funccalls" xreflabel="Function Calls">
+ <sect3 id="devstandards-funccalls" xreflabel="Function Calls">
<title>Function Calls</title>
<para>
Functions should be called with no spaces between the function name,
@@ -72,9 +65,9 @@
As displayed above, there should be one space on either side of an
equals sign used to assign the return value of a function to a variable.
</para>
- </sect2>
+ </sect3>
- <sect2 id="devstandards-funcdefs" xreflabel="Function Definitions">
+ <sect3 id="devstandards-funcdefs" xreflabel="Function Definitions">
<title>Function Definitions</title>
<para>
Function definitions follow the format of function calls, with the
@@ -120,9 +113,9 @@
}
</programlisting>
- </sect2>
+ </sect3>
- <sect2 id="devstandards-comments" xreflabel="Comments">
+ <sect3 id="devstandards-comments" xreflabel="Comments">
<title>Comments</title>
<para>
Non-documentation comments are strongly encouraged. A general rule of
@@ -130,9 +123,9 @@
want to try and describe that", you need to comment it before you
forget how it works.
</para>
- </sect2>
+ </sect3>
- <sect2 id="devstandards-including" xreflabel="Including Code">
+ <sect3 id="devstandards-including" xreflabel="Including Code">
<title>Including Code</title>
<para>
Anywhere you are unconditionally including a class file, use
@@ -146,31 +139,31 @@
with <function>require_once()</function> will not be included again by
<function>include_once()</function>.
</para>
- </sect2>
+ </sect3>
- <sect2 id="devstandards-phptags" xreflabel="PHP Tags">
+ <sect3 id="devstandards-phptags" xreflabel="PHP Tags">
<title>PHP Tags</title>
<para>
Always use <computeroutput><?php ?></computeroutput>
to delimit PHP code, not the <computeroutput><? ?></computeroutput>
shorthand.
</para>
- </sect2>
+ </sect3>
- <sect2 id="devstandards-constants" xreflabel="Naming Constants">
+ <sect3 id="devstandards-constants" xreflabel="Naming Constants">
<title>Naming Constants</title>
<para>
Constants should always be uppercase, with underscores to separate
words.
</para>
- </sect2>
+ </sect3>
- </sect1>
+ </sect2>
- <sect1 id="otherconventions" xreflabel="Other Conventions">
+ <sect2 id="otherconventions" xreflabel="Other Conventions">
<title>Other Conventions</title>
- <sect2 id="devstandards-filenaming" xreflabel="File Naming">
+ <sect3 id="devstandards-filenaming" xreflabel="File Naming">
<title>File Naming</title>
<para>
File names should be all lowercase and contain no spaces. HTML files
@@ -179,13 +172,19 @@
template files should match the name of the PHP file that will be using
it, e. g., <filename>index.html</filename> would be the template file
for <filename>index.php</filename>. Where one PHP file uses more than one
- templates, the templates should be similarly named:
+ template, the templates should be similarly named:
<filename>user.php</filename> could use
<filename>userlist.html</filename> and <filename>userform.html</filename>
for a list of users and editing a user, respectively.
</para>
- </sect2>
+ </sect3>
+
+ </sect2>
- </sect1>
+</sect1>
-</article>
+<!-- Local Variables: -->
+<!-- sgml-indent-step: 2 -->
+<!-- sgml-indent-data: 2 -->
+<!-- sgml-parent-document: "phpbt.sgml" -->
+<!-- End: -->
|
