+Tue Jul 10 16:48:43 CEST 2001 Daniel Veillard <Daniel.Veillard@imag.fr>
+
+ * FEATURES libxslt/xsltproc.c libxslt/transform.c
+ libxslt/xsltInternals.h: added Embedding Stylesheets
+ * tests/REC/Makefile.am tests/REC/stand-2.7-1.*: added the test
+ from the REC about it
+ * libxslt/transform.c libxslt/extra.[ch] libxslt/preproc.c:
+ tried to accomodate the various (and changing) proprietary
+ ways of implementing chunking.
+ * tests/docbook/result/xtchunk/html: now output is generated in
+ ISO-8859-1
+
Mon Jul 9 23:23:50 CEST 2001 Daniel Veillard <Daniel.Veillard@imag.fr>
* libxslt/xsltproc.c: small cleanup
YES Literal Result Element as Stylesheet
-NO Embedding Stylesheets
+YES Embedding Stylesheets
NO mediaType
XSLT_XALAN_NAMESPACE, xsltDocumentElem);
xsltRegisterExtElement(ctxt, (const xmlChar *) "document",
XSLT_XT_NAMESPACE, xsltDocumentElem);
+ xsltRegisterExtElement(ctxt, (const xmlChar *) "document",
+ XSLT_NAMESPACE, xsltDocumentElem);
+ xsltRegisterExtElement(ctxt, (const xmlChar *) "document",
+ XSLT_EXSLT_COMMON_NAMESPACE, xsltDocumentElem);
}
#define XSLT_XT_NAMESPACE ((xmlChar *) "http://www.jclark.com/xt")
/**
+ * XSLT_EXSLT_COMMON_NAMESPACE:
+ *
+ * This is EXSLT common namespace http://www.exslt.org/exsl/exsl.html
+ */
+#define XSLT_EXSLT_COMMON_NAMESPACE ((xmlChar *) "http://exslt.org/common")
+
+/**
* XSLT_XALAN_NAMESPACE:
*
* This is the Apache project XALAN processor namespace for extensions
}
}
if (!comp->has_filename) {
- xsltGenericError(xsltGenericErrorContext,
- "xsltDocumentComp: could not find the href\n");
- style->errors++;
goto error;
}
#include "preproc.h"
#ifdef WITH_XSLT_DEBUG
-#define WITH_XSLT_DEBUG_PROCESS
+#define WITH_XSLT_DEBUG_EXTRA
#endif
int xsltMaxDepth = 500;
const xmlChar *doctypeSystem;
const xmlChar *version;
- if ((ctxt == NULL) || (node == NULL) || (inst == NULL)
- || (comp == NULL))
+ if ((ctxt == NULL) || (node == NULL) || (inst == NULL) || (comp == NULL))
return;
if (comp->filename == NULL) {
URL = xsltEvalAttrValueTemplate(ctxt, inst,
(const xmlChar *) "file",
XSLT_SAXON_NAMESPACE);
+ if (URL == NULL)
+ URL = xsltEvalAttrValueTemplate(ctxt, inst,
+ (const xmlChar *) "href",
+ XSLT_SAXON_NAMESPACE);
} else if (xmlStrEqual(inst->name, (const xmlChar *) "write")) {
#ifdef WITH_XSLT_DEBUG_EXTRA
xsltGenericDebug(xsltGenericDebugContext,
(const xmlChar *)
"select",
XSLT_XALAN_NAMESPACE);
+ if (URL == NULL)
+ URL = xsltEvalAttrValueTemplate(ctxt, inst,
+ (const xmlChar *)
+ "file",
+ XSLT_XALAN_NAMESPACE);
+ if (URL == NULL)
+ URL = xsltEvalAttrValueTemplate(ctxt, inst,
+ (const xmlChar *)
+ "href",
+ XSLT_XALAN_NAMESPACE);
} else if (xmlStrEqual(inst->name, (const xmlChar *) "document")) {
URL = xsltEvalAttrValueTemplate(ctxt, inst,
(const xmlChar *) "href",
- XSLT_XT_NAMESPACE);
- if (URL == NULL) {
-#ifdef WITH_XSLT_DEBUG_EXTRA
- xsltGenericDebug(xsltGenericDebugContext,
- "Found xslt11:document construct\n");
-#endif
- URL = xsltEvalAttrValueTemplate(ctxt, inst,
- (const xmlChar *)
- "href",
- XSLT_NAMESPACE);
- comp->ver11 = 1;
- } else {
-#ifdef WITH_XSLT_DEBUG_EXTRA
- xsltGenericDebug(xsltGenericDebugContext,
- "Found xt:document extension\n");
-#endif
- comp->ver11 = 0;
- }
+ NULL);
}
} else {
* Version described in 1.1 draft allows full parametrization
* of the output.
*/
- if (comp->ver11) {
- prop = xsltEvalAttrValueTemplate(ctxt, inst,
- (const xmlChar *) "version",
- XSLT_NAMESPACE);
- if (prop != NULL) {
- if (style->version != NULL)
- xmlFree(style->version);
- style->version = prop;
- }
- prop = xsltEvalAttrValueTemplate(ctxt, inst,
- (const xmlChar *) "encoding",
- XSLT_NAMESPACE);
- if (prop != NULL) {
- if (style->encoding != NULL)
- xmlFree(style->encoding);
- style->encoding = prop;
- }
- prop = xsltEvalAttrValueTemplate(ctxt, inst,
- (const xmlChar *) "method",
- XSLT_NAMESPACE);
- if (prop != NULL) {
- const xmlChar *URI;
-
- if (style->method != NULL)
- xmlFree(style->method);
- style->method = NULL;
- if (style->methodURI != NULL)
- xmlFree(style->methodURI);
- style->methodURI = NULL;
-
- URI = xsltGetQNameURI(inst, &prop);
- if (prop == NULL) {
- style->errors++;
- } else if (URI == NULL) {
- if ((xmlStrEqual(prop, (const xmlChar *) "xml")) ||
- (xmlStrEqual(prop, (const xmlChar *) "html")) ||
- (xmlStrEqual(prop, (const xmlChar *) "text"))) {
- style->method = prop;
- } else {
- xsltGenericError(xsltGenericErrorContext,
- "invalid value for method: %s\n", prop);
- style->warnings++;
- }
- } else {
+ prop = xsltEvalAttrValueTemplate(ctxt, inst,
+ (const xmlChar *) "version",
+ NULL);
+ if (prop != NULL) {
+ if (style->version != NULL)
+ xmlFree(style->version);
+ style->version = prop;
+ }
+ prop = xsltEvalAttrValueTemplate(ctxt, inst,
+ (const xmlChar *) "encoding",
+ NULL);
+ if (prop != NULL) {
+ if (style->encoding != NULL)
+ xmlFree(style->encoding);
+ style->encoding = prop;
+ }
+ prop = xsltEvalAttrValueTemplate(ctxt, inst,
+ (const xmlChar *) "method",
+ NULL);
+ if (prop != NULL) {
+ const xmlChar *URI;
+
+ if (style->method != NULL)
+ xmlFree(style->method);
+ style->method = NULL;
+ if (style->methodURI != NULL)
+ xmlFree(style->methodURI);
+ style->methodURI = NULL;
+
+ URI = xsltGetQNameURI(inst, &prop);
+ if (prop == NULL) {
+ style->errors++;
+ } else if (URI == NULL) {
+ if ((xmlStrEqual(prop, (const xmlChar *) "xml")) ||
+ (xmlStrEqual(prop, (const xmlChar *) "html")) ||
+ (xmlStrEqual(prop, (const xmlChar *) "text"))) {
style->method = prop;
- style->methodURI = xmlStrdup(URI);
+ } else {
+ xsltGenericError(xsltGenericErrorContext,
+ "invalid value for method: %s\n", prop);
+ style->warnings++;
}
- }
- prop = xsltEvalAttrValueTemplate(ctxt, inst,
- (const xmlChar *)
- "doctype-system", XSLT_NAMESPACE);
- if (prop != NULL) {
- if (style->doctypeSystem != NULL)
- xmlFree(style->doctypeSystem);
- style->doctypeSystem = prop;
- }
- prop = xsltEvalAttrValueTemplate(ctxt, inst,
- (const xmlChar *)
- "doctype-public", XSLT_NAMESPACE);
- if (prop != NULL) {
- if (style->doctypePublic != NULL)
- xmlFree(style->doctypePublic);
- style->doctypePublic = prop;
- }
- prop = xsltEvalAttrValueTemplate(ctxt, inst,
- (const xmlChar *) "standalone",
- XSLT_NAMESPACE);
- if (prop != NULL) {
- if (xmlStrEqual(prop, (const xmlChar *) "yes")) {
- style->standalone = 1;
- } else if (xmlStrEqual(prop, (const xmlChar *) "no")) {
- style->standalone = 0;
- } else {
- xsltGenericError(xsltGenericErrorContext,
- "invalid value for standalone: %s\n",
- prop);
- style->warnings++;
- }
- xmlFree(prop);
- }
+ } else {
+ style->method = prop;
+ style->methodURI = xmlStrdup(URI);
+ }
+ }
+ prop = xsltEvalAttrValueTemplate(ctxt, inst,
+ (const xmlChar *)
+ "doctype-system", NULL);
+ if (prop != NULL) {
+ if (style->doctypeSystem != NULL)
+ xmlFree(style->doctypeSystem);
+ style->doctypeSystem = prop;
+ }
+ prop = xsltEvalAttrValueTemplate(ctxt, inst,
+ (const xmlChar *)
+ "doctype-public", NULL);
+ if (prop != NULL) {
+ if (style->doctypePublic != NULL)
+ xmlFree(style->doctypePublic);
+ style->doctypePublic = prop;
+ }
+ prop = xsltEvalAttrValueTemplate(ctxt, inst,
+ (const xmlChar *) "standalone",
+ NULL);
+ if (prop != NULL) {
+ if (xmlStrEqual(prop, (const xmlChar *) "yes")) {
+ style->standalone = 1;
+ } else if (xmlStrEqual(prop, (const xmlChar *) "no")) {
+ style->standalone = 0;
+ } else {
+ xsltGenericError(xsltGenericErrorContext,
+ "invalid value for standalone: %s\n",
+ prop);
+ style->warnings++;
+ }
+ xmlFree(prop);
+ }
- prop = xsltEvalAttrValueTemplate(ctxt, inst,
- (const xmlChar *) "indent",
- XSLT_NAMESPACE);
- if (prop != NULL) {
- if (xmlStrEqual(prop, (const xmlChar *) "yes")) {
- style->indent = 1;
- } else if (xmlStrEqual(prop, (const xmlChar *) "no")) {
- style->indent = 0;
- } else {
- xsltGenericError(xsltGenericErrorContext,
- "invalid value for indent: %s\n", prop);
- style->warnings++;
- }
- xmlFree(prop);
- }
+ prop = xsltEvalAttrValueTemplate(ctxt, inst,
+ (const xmlChar *) "indent",
+ NULL);
+ if (prop != NULL) {
+ if (xmlStrEqual(prop, (const xmlChar *) "yes")) {
+ style->indent = 1;
+ } else if (xmlStrEqual(prop, (const xmlChar *) "no")) {
+ style->indent = 0;
+ } else {
+ xsltGenericError(xsltGenericErrorContext,
+ "invalid value for indent: %s\n", prop);
+ style->warnings++;
+ }
+ xmlFree(prop);
+ }
- prop = xsltEvalAttrValueTemplate(ctxt, inst,
- (const xmlChar *)
- "omit-xml-declaration",
- XSLT_NAMESPACE);
- if (prop != NULL) {
- if (xmlStrEqual(prop, (const xmlChar *) "yes")) {
- style->omitXmlDeclaration = 1;
- } else if (xmlStrEqual(prop, (const xmlChar *) "no")) {
- style->omitXmlDeclaration = 0;
- } else {
- xsltGenericError(xsltGenericErrorContext,
- "invalid value for omit-xml-declaration: %s\n",
- prop);
- style->warnings++;
- }
- xmlFree(prop);
- }
+ prop = xsltEvalAttrValueTemplate(ctxt, inst,
+ (const xmlChar *)
+ "omit-xml-declaration",
+ NULL);
+ if (prop != NULL) {
+ if (xmlStrEqual(prop, (const xmlChar *) "yes")) {
+ style->omitXmlDeclaration = 1;
+ } else if (xmlStrEqual(prop, (const xmlChar *) "no")) {
+ style->omitXmlDeclaration = 0;
+ } else {
+ xsltGenericError(xsltGenericErrorContext,
+ "invalid value for omit-xml-declaration: %s\n",
+ prop);
+ style->warnings++;
+ }
+ xmlFree(prop);
+ }
- elements = xsltEvalAttrValueTemplate(ctxt, inst,
- (const xmlChar *)
- "cdata-section-elements",
- XSLT_NAMESPACE);
- if (elements != NULL) {
- if (style->stripSpaces == NULL)
- style->stripSpaces = xmlHashCreate(10);
- if (style->stripSpaces == NULL)
- return;
-
- element = elements;
- while (*element != 0) {
- while (IS_BLANK(*element))
- element++;
- if (*element == 0)
- break;
- end = element;
- while ((*end != 0) && (!IS_BLANK(*end)))
- end++;
- element = xmlStrndup(element, end - element);
- if (element) {
+ elements = xsltEvalAttrValueTemplate(ctxt, inst,
+ (const xmlChar *)
+ "cdata-section-elements",
+ NULL);
+ if (elements != NULL) {
+ if (style->stripSpaces == NULL)
+ style->stripSpaces = xmlHashCreate(10);
+ if (style->stripSpaces == NULL)
+ return;
+
+ element = elements;
+ while (*element != 0) {
+ while (IS_BLANK(*element))
+ element++;
+ if (*element == 0)
+ break;
+ end = element;
+ while ((*end != 0) && (!IS_BLANK(*end)))
+ end++;
+ element = xmlStrndup(element, end - element);
+ if (element) {
#ifdef WITH_XSLT_DEBUG_PARSING
- xsltGenericDebug(xsltGenericDebugContext,
- "add cdata section output element %s\n",
- element);
+ xsltGenericDebug(xsltGenericDebugContext,
+ "add cdata section output element %s\n",
+ element);
#endif
- xmlHashAddEntry(style->stripSpaces, element,
- (xmlChar *) "cdata");
- xmlFree(element);
- }
- element = end;
- }
- xmlFree(elements);
- }
- } else {
- xsltParseStylesheetOutput(style, inst);
+ xmlHashAddEntry(style->stripSpaces, element,
+ (xmlChar *) "cdata");
+ xmlFree(element);
+ }
+ element = end;
+ }
+ xmlFree(elements);
}
/*
#ifdef WITH_XSLT_DEBUG_EXTRA
} else {
xsltGenericDebug(xsltGenericDebugContext,
- "Wrote %d bytes to %s\n", ret,, filename);
+ "Wrote %d bytes to %s\n", ret, filename);
#endif
}
* xslt.c: Implemetation of an XSL Transformation 1.0 engine
*
* Reference:
+ * XSLT specification
* http://www.w3.org/TR/1999/REC-xslt-19991116
*
+ * Associating Style Sheets with XML documents
+ * http://www.w3.org/1999/06/REC-xml-stylesheet-19990629
+ *
* See Copyright for the status of this software.
*
* daniel@veillard.com
return(ret);
}
+/************************************************************************
+ * *
+ * Handling of Stylesheet PI *
+ * *
+ ************************************************************************/
+
+#define CUR (*cur)
+#define SKIP(val) cur += (val)
+#define NXT(val) cur[(val)]
+#define SKIP_BLANKS \
+ while (IS_BLANK(CUR)) NEXT
+#define NEXT ((*cur) ? cur++ : cur)
+
+/**
+ * xsltParseStylesheetPI:
+ * value: the value of the PI
+ *
+ * This function checks that the type is text/xml and extracts
+ * the URI-Reference for the stylesheet
+ *
+ * Returns the URI-Reference for the stylesheet or NULL (it need to
+ * be freed by the caller)
+ */
+static xmlChar *
+xsltParseStylesheetPI(const xmlChar *value) {
+ const xmlChar *cur;
+ const xmlChar *start;
+ xmlChar *val;
+ xmlChar tmp;
+ xmlChar *href = NULL;
+ int isXml = 0;
+
+ if (value == NULL)
+ return(NULL);
+
+ cur = value;
+ while (CUR != 0) {
+ SKIP_BLANKS;
+ if ((CUR == 't') && (NXT(1) == 'y') && (NXT(2) == 'p') &&
+ (NXT(3) == 'e')) {
+ SKIP(4);
+ SKIP_BLANKS;
+ if (CUR != '=')
+ continue;
+ NEXT;
+ if ((CUR != '\'') && (CUR != '"'))
+ continue;
+ tmp = CUR;
+ NEXT;
+ start = cur;
+ while ((CUR != 0) && (CUR != tmp))
+ NEXT;
+ if (CUR != tmp)
+ continue;
+ val = xmlStrndup(start, cur - start);
+ NEXT;
+ if (val == NULL)
+ return(NULL);
+ if ((xmlStrcasecmp(val, BAD_CAST "text/xml")) &&
+ (xmlStrcasecmp(val, BAD_CAST "text/xsl"))) {
+ xmlFree(val);
+ break;
+ }
+ isXml = 1;
+ xmlFree(val);
+ } else if ((CUR == 'h') && (NXT(1) == 'r') && (NXT(2) == 'e') &&
+ (NXT(3) == 'f')) {
+ SKIP(4);
+ SKIP_BLANKS;
+ if (CUR != '=')
+ continue;
+ NEXT;
+ if ((CUR != '\'') && (CUR != '"'))
+ continue;
+ tmp = CUR;
+ NEXT;
+ start = cur;
+ while ((CUR != 0) && (CUR != tmp))
+ NEXT;
+ if (CUR != tmp)
+ continue;
+ if (href == NULL)
+ href = xmlStrndup(start, cur - start);
+ NEXT;
+ } else {
+ while ((CUR != 0) && (!IS_BLANK(CUR)))
+ NEXT;
+ }
+
+ }
+
+ if (!isXml) {
+ if (href != NULL)
+ xmlFree(href);
+ href = NULL;
+ }
+ return(href);
+}
+
+/**
+ * xsltLoadStylesheetPI:
+ * doc: a document to process
+ *
+ * This function tries to locate the stylesheet PI in the given document
+ * If found, and if contained within the document, it will extract
+ * that subtree to build the stylesheet to process @doc (doc itself will
+ * be modified). If found but referencing an external document it will
+ * attempt to load it and generate a stylesheet from it. In both cases,
+ * the resulting stylesheet and the document need to be freed once the
+ * transformation is done.
+ *
+ * Returns a new XSLT stylesheet structure or NULL if not found.
+ */
+xsltStylesheetPtr
+xsltLoadStylesheetPI(xmlDocPtr doc) {
+ xmlNodePtr child;
+ xsltStylesheetPtr ret = NULL;
+ xmlChar *href = NULL;
+ xmlURIPtr URI;
+
+ if (doc == NULL)
+ return(NULL);
+
+ /*
+ * Find the text/xml stylesheet PI id any before the root
+ */
+ child = doc->children;
+ while ((child != NULL) && (child->type != XML_ELEMENT_NODE)) {
+ if ((child->type == XML_PI_NODE) &&
+ (xmlStrEqual(child->name, BAD_CAST "xml-stylesheet"))) {
+ href = xsltParseStylesheetPI(child->content);
+ if (href != NULL)
+ break;
+ }
+ child = child->next;
+ }
+
+ /*
+ * If found check the href to select processing
+ */
+ if (href != NULL) {
+#ifdef WITH_XSLT_DEBUG_PARSING
+ xsltGenericDebug(xsltGenericDebugContext,
+ "xsltLoadStylesheetPI : found PI href=%s\n", href);
+#endif
+ URI = xmlParseURI((const char *) href);
+ if (URI == NULL) {
+ xsltGenericError(xsltGenericErrorContext,
+ "xml-stylesheet : href %s is not valid\n", href);
+ xmlFree(href);
+ return(NULL);
+ }
+ if ((URI->fragment != NULL) && (URI->scheme == NULL) &&
+ (URI->opaque == NULL) && (URI->authority == NULL) &&
+ (URI->server == NULL) && (URI->user == NULL) &&
+ (URI->path == NULL) && (URI->query == NULL)) {
+ xmlAttrPtr ID;
+
+#ifdef WITH_XSLT_DEBUG_PARSING
+ xsltGenericDebug(xsltGenericDebugContext,
+ "xsltLoadStylesheetPI : Reference to ID %s\n", href);
+#endif
+ if (URI->fragment[0] == '#')
+ ID = xmlGetID(doc, (const xmlChar *) &(URI->fragment[1]));
+ else
+ ID = xmlGetID(doc, (const xmlChar *) URI->fragment);
+ if (ID == NULL) {
+ xsltGenericError(xsltGenericErrorContext,
+ "xml-stylesheet : no ID %s found\n", URI->fragment);
+ } else {
+ xmlDocPtr fake;
+ xmlNodePtr subtree;
+
+ /*
+ * move the subtree in a new document passed to
+ * the stylesheet analyzer
+ */
+ subtree = ID->parent;
+ fake = xmlNewDoc(NULL);
+ if (fake != NULL) {
+ xmlUnlinkNode(subtree);
+ xmlAddChild((xmlNodePtr) fake, subtree);
+ ret = xsltParseStylesheetDoc(fake);
+ if (ret == NULL)
+ xmlFreeDoc(fake);
+ }
+ }
+ } else {
+ xmlChar *URL;
+
+ /*
+ * Reference to an external stylesheet
+ */
+ URL = xmlBuildURI(href, xmlNodeGetBase(doc, (xmlNodePtr) doc));
+ if (URL != NULL) {
+#ifdef WITH_XSLT_DEBUG_PARSING
+ xsltGenericDebug(xsltGenericDebugContext,
+ "xsltLoadStylesheetPI : fetching %s\n", URL);
+#endif
+ ret = xsltParseStylesheetFile(URL);
+ xmlFree(URL);
+ } else {
+#ifdef WITH_XSLT_DEBUG_PARSING
+ xsltGenericDebug(xsltGenericDebugContext,
+ "xsltLoadStylesheetPI : fetching %s\n", href);
+#endif
+ ret = xsltParseStylesheetFile(href);
+ }
+ }
+ xmlFreeURI(URI);
+ xmlFree(href);
+ }
+ return(ret);
+}
+
void xsltParseStylesheetOutput(xsltStylesheetPtr style,
xmlNodePtr cur);
xsltStylesheetPtr xsltParseStylesheetDoc (xmlDocPtr doc);
+xsltStylesheetPtr xsltLoadStylesheetPI (xmlDocPtr doc);
void xsltNumberFormat (xsltTransformContextPtr ctxt,
xsltNumberDataPtr data,
xmlNodePtr node);
static int nonet;
static xmlExternalEntityLoader defaultLoader = NULL;
+static struct timeval begin, end;
+static const char *params[16 + 1];
+static int nbparams = 0;
+static const char *output = NULL;
+
static xmlParserInputPtr
xsltNoNetExternalEntityLoader(const char *URL, const char *ID,
xmlParserCtxtPtr ctxt) {
return(NULL);
}
+static void
+xsltProcess(xmlDocPtr doc, xsltStylesheetPtr cur, const char *filename) {
+ xmlDocPtr res;
+
+#ifdef LIBXML_XINCLUDE_ENABLED
+ if (xinclude) {
+ if (timing)
+ gettimeofday(&begin, NULL);
+ xmlXIncludeProcess(doc);
+ if (timing) {
+ long msec;
+
+ gettimeofday(&end, NULL);
+ msec = end.tv_sec - begin.tv_sec;
+ msec *= 1000;
+ msec += (end.tv_usec - begin.tv_usec) / 1000;
+ fprintf(stderr, "XInclude processing %s took %ld ms\n",
+ filename, msec);
+ }
+ }
+#endif
+ if (timing)
+ gettimeofday(&begin, NULL);
+ if (output == NULL) {
+ if (repeat) {
+ int j;
+
+ for (j = 1; j < repeat; j++) {
+ res = xsltApplyStylesheet(cur, doc, params);
+ xmlFreeDoc(res);
+ xmlFreeDoc(doc);
+#ifdef LIBXML_HTML_ENABLED
+ if (html)
+ doc = htmlParseFile(filename, NULL);
+ else
+#endif
+#ifdef LIBXML_DOCB_ENABLED
+ if (docbook)
+ doc = docbParseFile(filename, NULL);
+ else
+#endif
+ doc = xmlParseFile(filename);
+ }
+ }
+ if (profile) {
+ res = xsltProfileStylesheet(cur, doc, params, stderr);
+ } else {
+ res = xsltApplyStylesheet(cur, doc, params);
+ }
+ if (timing) {
+ long msec;
+
+ gettimeofday(&end, NULL);
+ msec = end.tv_sec - begin.tv_sec;
+ msec *= 1000;
+ msec += (end.tv_usec - begin.tv_usec) / 1000;
+ if (repeat)
+ fprintf(stderr,
+ "Applying stylesheet %d times took %ld ms\n",
+ repeat, msec);
+ else
+ fprintf(stderr,
+ "Applying stylesheet took %ld ms\n", msec);
+ }
+ xmlFreeDoc(doc);
+ if (res == NULL) {
+ fprintf(stderr, "no result for %s\n", filename);
+ return;
+ }
+ if (noout) {
+ xmlFreeDoc(res);
+ return;
+ }
+#ifdef LIBXML_DEBUG_ENABLED
+ if (debug)
+ xmlDebugDumpDocument(stdout, res);
+ else {
+#endif
+ if (cur->methodURI == NULL) {
+ if (timing)
+ gettimeofday(&begin, NULL);
+ xsltSaveResultToFile(stdout, res, cur);
+ if (timing) {
+ long msec;
+
+ gettimeofday(&end, NULL);
+ msec = end.tv_sec - begin.tv_sec;
+ msec *= 1000;
+ msec += (end.tv_usec - begin.tv_usec) / 1000;
+ fprintf(stderr, "Saving result took %ld ms\n",
+ msec);
+ }
+ } else {
+ if (xmlStrEqual
+ (cur->method, (const xmlChar *) "xhtml")) {
+ fprintf(stderr, "non standard output xhtml\n");
+ if (timing)
+ gettimeofday(&begin, NULL);
+ xsltSaveResultToFile(stdout, res, cur);
+ if (timing) {
+ long msec;
+
+ gettimeofday(&end, NULL);
+ msec = end.tv_sec - begin.tv_sec;
+ msec *= 1000;
+ msec +=
+ (end.tv_usec - begin.tv_usec) / 1000;
+ fprintf(stderr,
+ "Saving result took %ld ms\n",
+ msec);
+ }
+ } else {
+ fprintf(stderr,
+ "Unsupported non standard output %s\n",
+ cur->method);
+ }
+ }
+#ifdef LIBXML_DEBUG_ENABLED
+ }
+#endif
+
+ xmlFreeDoc(res);
+ } else {
+ xsltRunStylesheet(cur, doc, params, output, NULL, NULL);
+ if (timing) {
+ long msec;
+
+ gettimeofday(&end, NULL);
+ msec = end.tv_sec - begin.tv_sec;
+ msec *= 1000;
+ msec += (end.tv_usec - begin.tv_usec) / 1000;
+ fprintf(stderr,
+ "Running stylesheet and saving result took %ld ms\n",
+ msec);
+ }
+ xmlFreeDoc(doc);
+ }
+}
+
static void usage(const char *name) {
printf("Usage: %s [options] stylesheet file [file ...]\n", name);
printf(" Options:\n");
{
int i;
xsltStylesheetPtr cur = NULL;
- xmlDocPtr doc, res;
- struct timeval begin, end;
- const char *params[16 + 1];
- int nbparams = 0;
- const char *output = NULL;
+ xmlDocPtr doc, style;
if (argc <= 1) {
usage(argv[0]);
return (1);
}
+
xmlInitMemory();
- LIBXML_TEST_VERSION defaultLoader = xmlGetExternalEntityLoader();
+
+ LIBXML_TEST_VERSION
+
+ defaultLoader = xmlGetExternalEntityLoader();
+ if (novalid == 0) /* TODO XML_DETECT_IDS | XML_COMPLETE_ATTRS */
+ xmlLoadExtDtdDefaultValue = 6;
+ else
+ xmlLoadExtDtdDefaultValue = 0;
for (i = 1; i < argc; i++) {
if (!strcmp(argv[i], "-"))
break;
*/
xmlSubstituteEntitiesDefault(1);
- if (novalid == 0) /* TODO XML_DETECT_IDS | XML_COMPLETE_ATTRS */
- xmlLoadExtDtdDefaultValue = 6;
- else
- xmlLoadExtDtdDefaultValue = 0;
for (i = 1; i < argc; i++) {
if ((!strcmp(argv[i], "-maxdepth")) ||
(!strcmp(argv[i], "--maxdepth"))) {
if ((argv[i][0] != '-') || (strcmp(argv[i], "-") == 0)) {
if (timing)
gettimeofday(&begin, NULL);
- cur = xsltParseStylesheetFile((const xmlChar *) argv[i]);
+ style = xmlParseFile((const char *) argv[i]);
if (timing) {
long msec;
fprintf(stderr, "Parsing stylesheet %s took %ld ms\n",
argv[i], msec);
}
- if (cur != NULL) {
- if (cur->indent == 1)
- xmlIndentTreeOutput = 1;
- else
- xmlIndentTreeOutput = 0;
- i++;
- }
+ if (style == NULL) {
+ fprintf(stderr, "cannot parse %s\n", argv[i]);
+ cur = NULL;
+ } else {
+ cur = xsltLoadStylesheetPI(style);
+ if (cur != NULL) {
+ /* it is an embedded stylesheet */
+ xsltProcess(style, cur, argv[i]);
+ xsltFreeStylesheet(cur);
+ exit(0);
+ }
+ cur = xsltParseStylesheetDoc(style);
+ if (cur != NULL) {
+ if (cur->indent == 1)
+ xmlIndentTreeOutput = 1;
+ else
+ xmlIndentTreeOutput = 0;
+ i++;
+ }
+ }
break;
}
if ((cur != NULL) && (cur->errors == 0)) {
for (; i < argc; i++) {
+ doc = NULL;
if (timing)
gettimeofday(&begin, NULL);
#ifdef LIBXML_HTML_ENABLED
fprintf(stderr, "Parsing document %s took %ld ms\n",
argv[i], msec);
}
-#ifdef LIBXML_XINCLUDE_ENABLED
- if (xinclude) {
- if (timing)
- gettimeofday(&begin, NULL);
- xmlXIncludeProcess(doc);
- if (timing) {
- long msec;
-
- gettimeofday(&end, NULL);
- msec = end.tv_sec - begin.tv_sec;
- msec *= 1000;
- msec += (end.tv_usec - begin.tv_usec) / 1000;
- fprintf(stderr, "XInclude processing %s took %ld ms\n",
- argv[i], msec);
- }
- }
-#endif
- if (timing)
- gettimeofday(&begin, NULL);
- if (output == NULL) {
- if (repeat) {
- int j;
-
- for (j = 1; j < repeat; j++) {
- res = xsltApplyStylesheet(cur, doc, params);
- xmlFreeDoc(res);
- xmlFreeDoc(doc);
-#ifdef LIBXML_HTML_ENABLED
- if (html)
- doc = htmlParseFile(argv[i], NULL);
- else
-#endif
-#ifdef LIBXML_DOCB_ENABLED
- if (docbook)
- doc = docbParseFile(argv[i], NULL);
- else
-#endif
- doc = xmlParseFile(argv[i]);
- }
- }
- if (profile) {
- res = xsltProfileStylesheet(cur, doc, params, stderr);
- } else {
- res = xsltApplyStylesheet(cur, doc, params);
- }
- if (timing) {
- long msec;
-
- gettimeofday(&end, NULL);
- msec = end.tv_sec - begin.tv_sec;
- msec *= 1000;
- msec += (end.tv_usec - begin.tv_usec) / 1000;
- if (repeat)
- fprintf(stderr,
- "Applying stylesheet %d times took %ld ms\n",
- repeat, msec);
- else
- fprintf(stderr,
- "Applying stylesheet took %ld ms\n", msec);
- }
- xmlFreeDoc(doc);
- if (res == NULL) {
- fprintf(stderr, "no result for %s\n", argv[i]);
- continue;
- }
- if (noout) {
- xmlFreeDoc(res);
- continue;
- }
-#ifdef LIBXML_DEBUG_ENABLED
- if (debug)
- xmlDebugDumpDocument(stdout, res);
- else {
-#endif
- if (cur->methodURI == NULL) {
- if (timing)
- gettimeofday(&begin, NULL);
- xsltSaveResultToFile(stdout, res, cur);
- if (timing) {
- long msec;
-
- gettimeofday(&end, NULL);
- msec = end.tv_sec - begin.tv_sec;
- msec *= 1000;
- msec += (end.tv_usec - begin.tv_usec) / 1000;
- fprintf(stderr, "Saving result took %ld ms\n",
- msec);
- }
- } else {
- if (xmlStrEqual
- (cur->method, (const xmlChar *) "xhtml")) {
- fprintf(stderr, "non standard output xhtml\n");
- if (timing)
- gettimeofday(&begin, NULL);
- xsltSaveResultToFile(stdout, res, cur);
- if (timing) {
- long msec;
-
- gettimeofday(&end, NULL);
- msec = end.tv_sec - begin.tv_sec;
- msec *= 1000;
- msec +=
- (end.tv_usec - begin.tv_usec) / 1000;
- fprintf(stderr,
- "Saving result took %ld ms\n",
- msec);
- }
- } else {
- fprintf(stderr,
- "Unsupported non standard output %s\n",
- cur->method);
- }
- }
-#ifdef LIBXML_DEBUG_ENABLED
- }
-#endif
-
- xmlFreeDoc(res);
- } else {
- xsltRunStylesheet(cur, doc, params, output, NULL, NULL);
- if (timing) {
- long msec;
-
- gettimeofday(&end, NULL);
- msec = end.tv_sec - begin.tv_sec;
- msec *= 1000;
- msec += (end.tv_usec - begin.tv_usec) / 1000;
- fprintf(stderr,
- "Running stylesheet and saving result took %ld ms\n",
- msec);
- }
- xmlFreeDoc(doc);
- }
+ xsltProcess(doc, cur, argv[i]);
}
xsltFreeStylesheet(cur);
}
grep "MORY ALLO" .memdump | grep -v "MEMORY ALLOCATED : 0" || true;\
rm -f $$name.res ; \
done)
+ @(for i in $(srcdir)/stand*.xml ; do \
+ name=`basename $$i .xml` ; \
+ echo $$name.xml ; \
+ $(top_builddir)/libxslt/xsltproc $(srcdir)/$$name.xml > $$name.res;\
+ if [ ! -f $(srcdir)/$$name.stand.out ] ; then cp $$name.res $(srcdir)/$$name.stand.out ; \
+ else if [ ! -s $$name.res ] ; then echo "Fatal error, no $$name.res\n" ; \
+ else diff $(srcdir)/$$name.stand.out $$name.res ; fi ; fi; \
+ grep "MORY ALLO" .memdump | grep -v "MEMORY ALLOCATED : 0" || true;\
+ rm -f $$name.res ; \
+ done)
--- /dev/null
+<!ATTLIST xsl:stylesheet
+ id ID #IMPLIED>
+<!ATTLIST stylesheet
+ id ID #IMPLIED>
+<!ATTLIST para
+ id ID #IMPLIED>
--- /dev/null
+<?xml version="1.0"?>
+SUCCESS
+...
+
--- /dev/null
+<?xml version="1.0"?>
+SUCCESS
+
+
+
+
+
+<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" font-weight="bold">
+...
+</fo:block>
+
+
+
--- /dev/null
+<?xml-stylesheet type="text/xml" href="#style1"?>
+<!DOCTYPE doc SYSTEM "stand-2.7-1.dtd">
+<doc>
+<head>
+<xsl:stylesheet id="style1"
+ version="1.0"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ xmlns:fo="http://www.w3.org/1999/XSL/Format">
+<xsl:import href="stand-2.7-1.xsl"/>
+<xsl:template match="id('foo')">
+ <fo:block font-weight="bold"><xsl:apply-templates/></fo:block>
+</xsl:template>
+<xsl:template match="xsl:stylesheet">
+ <!-- ignore -->
+</xsl:template>
+</xsl:stylesheet>
+</head>
+<body>
+<para id="foo">
+...
+</para>
+</body>
+</doc>
--- /dev/null
+<xsl:stylesheet version="1.0"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+<xsl:strip-space elements="*"/>
+<xsl:template match="/">
+<xsl:text>SUCCESS</xsl:text>
+<xsl:apply-templates/>
+</xsl:template>
+</xsl:stylesheet>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>A. Document Templates</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">A. Document Templates</th></tr>
<tr>
<td width="20%" align="left">
-<a href="indexs15.html">Prev</a>Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="apas17.html">Next</a>
+<a href="indexs15.html">Prev</a> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="apas17.html">Next</a>
</td>
</tr>
</table>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="indexs15.html">Prev</a>Â </td>
+<a href="indexs15.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="apas17.html">Next</a>
+<td width="40%" align="right"> <a href="apas17.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">Resources </td>
+<td width="40%" align="left">Resources </td>
<td width="20%" align="center"><a href="index.html">Up</a></td>
-<td width="40%" align="right">Â Template 2: Applet Manual For GNOME 1.x</td>
+<td width="40%" align="right"> Template 2: Applet Manual For GNOME 1.x</td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>Template 2: Applet Manual For GNOME 1.x</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">Template 2: Applet Manual For GNOME 1.x</th></tr>
<tr>
<td width="20%" align="left">
-<a href="apa.html">Prev</a>Â </td>
+<a href="apa.html">Prev</a> </td>
<th width="60%" align="center">A. Document Templates</th>
-<td width="20%" align="right">
 <a href="apas18.html">Next</a>
+<td width="20%" align="right"> <a href="apas18.html">Next</a>
</td>
</tr>
</table>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="apa.html">Prev</a>Â </td>
+<a href="apa.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="apas18.html">Next</a>
+<td width="40%" align="right"> <a href="apas18.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">A. Document Templates </td>
+<td width="40%" align="left">A. Document Templates </td>
<td width="20%" align="center"><a href="apa.html">Up</a></td>
-<td width="40%" align="right">Â Template 2: Applet Manual For GNOME 2.x</td>
+<td width="40%" align="right"> Template 2: Applet Manual For GNOME 2.x</td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>Template 2: Applet Manual For GNOME 2.x</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">Template 2: Applet Manual For GNOME 2.x</th></tr>
<tr>
<td width="20%" align="left">
-<a href="apas17.html">Prev</a>Â </td>
+<a href="apas17.html">Prev</a> </td>
<th width="60%" align="center">A. Document Templates</th>
-<td width="20%" align="right">Â </td>
+<td width="20%" align="right"> </td>
</tr>
</table>
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="apas17.html">Prev</a>Â </td>
+<a href="apas17.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">Â </td>
+<td width="40%" align="right"> </td>
</tr>
<tr>
-<td width="40%" align="left">Template 2: Applet Manual For GNOME 1.x </td>
+<td width="40%" align="left">Template 2: Applet Manual For GNOME 1.x </td>
<td width="20%" align="center"><a href="apa.html">Up</a></td>
-<td width="40%" align="right">Â </td>
+<td width="40%" align="right"> </td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>The GNOME Handbook of Writing Software Documentation</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center">The GNOME Handbook of Writing Software Documentation</th></tr>
<tr>
-<td width="20%" align="left">Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="indexs02.html">Next</a>
+<td width="20%" align="left"> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="indexs02.html">Next</a>
</td>
</tr>
</table>
<div class="affiliation">
<span class="orgname">Red Hat, Inc.<br></span><div class="address">
<br>
-
            <tt><<a href="mailto:dcm@redhat.com">dcm@redhat.com</a>></tt><br>
-Â Â Â Â Â Â Â Â Â Â </div>
+
<tt><<a href="mailto:dcm@redhat.com">dcm@redhat.com</a>></tt><br>
+ </div>
</div>
<h3 class="author">Daniel Mueth</h3>
<div class="affiliation"><div class="address">
<br>
-
            <tt><<a href="mailto:d-mueth@uchicago.edu">d-mueth@uchicago.edu</a>></tt><br>
-Â Â Â Â Â Â Â Â Â Â </div></div>
+
<tt><<a href="mailto:d-mueth@uchicago.edu">d-mueth@uchicago.edu</a>></tt><br>
+ </div></div>
<h3 class="author">Alexander Kirillov</h3>
<div class="affiliation"><div class="address">
<br>
-
            <tt><<a href="mailto:kirillov@math.sunysb.edu">kirillov@math.sunysb.edu</a>></tt><br>
-Â Â Â Â Â Â Â Â Â Â </div></div>
+
<tt><<a href="mailto:kirillov@math.sunysb.edu">kirillov@math.sunysb.edu</a>></tt><br>
+ </div></div>
</div>
<div><p class="releaseinfo">
This is a pre-release!
</p></div>
-<div><p class="copyright">Copyright © 2000 Red Hat, Inc., Daniel Mueth, and Alexander Kirillov</p></div>
+<div><p class="copyright">Copyright © 2000 Red Hat, Inc., Daniel Mueth, and Alexander Kirillov</p></div>
<div><div class="legalnotice">
<p>
Permission is granted to copy, distribute and/or modify this
interested in joining the GDP team, you should join the
<a href="http://mail.gnome.org/mailman/listinfo/gnome-doc-list/" target="_top">
<i>gnome-doc-list mailing list</i> </a>.
- Read <a href="indexs02.html" title="Getting Started Writing GNOME Documentation">the section called “Getting Started Writing GNOME Documentation”</a>, for help selecting a
+ Read <a href="indexs02.html" title="Getting Started Writing GNOME Documentation">the section called “Getting Started Writing GNOME Documentation”</a>, for help selecting a
project to work on. Feel free to introduce yourself on the
gnome-doc-list mailing list and indicate which project you
intend to work on, or else ask for suggestions of important
<a name="notation"></a>Notation and Conventions</h3></div></div>
<p>
This Handbook uses the following notation:
- <div class="informaltable" id="id2781298">
-<a name="id278
1298"></a><table border="0">
+ <div class="informaltable" id="id2782069">
+<a name="id278
2069"></a><table border="0">
<colgroup>
<col>
<col>
<hr>
<table width="100%" summary="Navigation footer">
<tr>
-<td width="40%" align="left">Â </td>
-<td width="20%" align="center">Â </td>
-<td width="40%" align="right">
 <a href="indexs02.html">Next</a>
+<td width="40%" align="left"> </td>
+<td width="20%" align="center"> </td>
+<td width="40%" align="right"> <a href="indexs02.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">Â </td>
-<td width="20%" align="center">Â </td>
-<td width="40%" align="right">Â Getting Started Writing GNOME Documentation</td>
+<td width="40%" align="left"> </td>
+<td width="20%" align="center"> </td>
+<td width="40%" align="right"> Getting Started Writing GNOME Documentation</td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>Getting Started Writing GNOME Documentation</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">Getting Started Writing GNOME Documentation</th></tr>
<tr>
<td width="20%" align="left">
-<a href="index.html">Prev</a>Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="indexs03.html">Next</a>
+<a href="index.html">Prev</a> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="indexs03.html">Next</a>
</td>
</tr>
</table>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">
-<a name="id2775470"></a>Note</h3>
+<a name="id2780402"></a>Note</h3>
<p>
Note that the information in the
<i>DocTable</i> may not always be up-to-date
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">
-<a name="id2775555"></a>NOTE</h3>
+<a name="id2780490"></a>NOTE</h3>
<p>
To get started writing for the GDP you do not need to rush
out and learn DocBook - if you feel it is too much to handle
</p>
<div class="itemizedlist"><ul>
<li style="list-style-type: opencircle"><p>
-<a name="id2775940"></a>
+<a name="id2780864"></a>
Download <a href="http://www.labs.redhat.com/png/png-support.html" target="_top">the
GDP DocBook DTD for PNG support</a> and install it
where you keep your DTD's. (On Red Hat use <tt>/usr/lib/sgml/</tt>.) Note that
recommended that you use version 3.1
</p></li>
<li style="list-style-type: disc"><p>
-<a name="id2776108"></a>
+<a name="id2781032"></a>
Add the new DTD to your SGML CATALOG file. The location
of your SGML CATALOG file may vary depending upon your
distribution. (On Red Hat it is usually in
and effort in adding and closing tags. You will find the
psgml package in DocBook Tools, which is the standard set of
tools for the GDP. You may find out more about DocBook Tools
- in <a href="indexs02.html#installingdocbook" title="Installing DocBook">the section called “Installing DocBook”</a>.
+ in <a href="indexs02.html#installingdocbook" title="Installing DocBook">the section called “Installing DocBook”</a>.
</p>
</div>
<div class="sect3">
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">
-<a name="id2776014"></a>NOTE</h3>
+<a name="id2780938"></a>NOTE</h3>
<p>
The html files you get will not look quite the same as the
documentation distributed with GNOME unless you have the
custom stylesheets installed on your machine. DocBook
Tools' default stylesheets will produce a different look
to your docs. You can read more about the GDP stylesheets
- in <a href="indexs02.html#gdpstylesheets" title="GDP Stylesheets">the section called “GDP Stylesheets”</a>.
+ in <a href="indexs02.html#gdpstylesheets" title="GDP Stylesheets">the section called “GDP Stylesheets”</a>.
</p>
</div>
</div>
</p>
<div class="itemizedlist"><ul>
<li style="list-style-type: disc"><p>
-<a name="id2898255"></a>
+<a name="id2903185"></a>
<a href="http://www.docbook.org" target="_top">http://www.docbook.org</a> - Norman
Walsh's <i>DocBook: The Definitive
Guide</i>. Online O'Reilly book on using
too formal for a beginner.
</p></li>
<li style="list-style-type: disc"><p>
-<a name="id2898311"></a>
+<a name="id2903240"></a>
<a href="http://www.oswg.org/oswg-nightly/oswg/en_US.ISO_8859-1/articles/DocBook-Intro/docbook-intro/index.html" target="_top">A Practical Introduction to DocBook</a>
- The Open Source Writers Group's introduction to using
DocBook. This is an excellent HOW-TO type article on
getting started.
</p></li>
<li style="list-style-type: disc"><p>
-<a name="id2898351"></a>
+<a name="id2903281"></a>
<a href="http://nis-www.lanl.gov/~rosalia/mydocs/docbook-intro/docbook-intro.html" target="_top">Getting Going with DocBook: Notes for
Hackers</a> - Mark Galassi's introduction to DocBook
for hackers. This has to be one of the first
was.
</p></li>
<li style="list-style-type: disc"><p>
-<a name="id2898391"></a>
+<a name="id2903320"></a>
<a href="http://www.freebsd.org/tutorials/docproj-primer/" target="_top">
FreeBSD Documentation Project Primer for New
Contributors</a> - FreeBSD documentation project
documentation authors write correct and consistent DocBook:
</p>
<div class="itemizedlist"><ul><li style="list-style-type: disc"><p>
-<a name="id2898457"></a>
- <a href="indexs04.html" title="DocBook Basics ">the section called “DocBook Basics ”</a> - Descriptions of
+<a name="id2903387"></a>
+ <a href="indexs04.html" title="DocBook Basics ">the section called “DocBook Basics ”</a> - Descriptions of
commonly used DocBook tags.
</p></li></ul></div>
<p>
<p>
Most GNOME documents will have screenshots of the particular
applet, application, GNOME component, or widget being
- discussed. As discussed above in <a href="indexs02.html#gdpdtd" title="GDP DTD (PNG Image Support)">the section called “GDP DTD (PNG Image Support)”</a> you
+ discussed. As discussed above in <a href="indexs02.html#gdpdtd" title="GDP DTD (PNG Image Support)">the section called “GDP DTD (PNG Image Support)”</a> you
will need to install the special GDP DocBook DTD which
supports PNG images, the format used for all images in GNOME
documentation. For the basic DocBook structure used to insert
- images in a document, see <a href="indexs02.html#jadeimages" title="Images in DocBook Tools">the section called “Images in DocBook Tools”</a> above.
+ images in a document, see <a href="indexs02.html#jadeimages" title="Images in DocBook Tools">the section called “Images in DocBook Tools”</a> above.
</p>
<div class="sect3">
<a name="screenshotappearance"></a><div class="titlepage"><div><h4 class="title">
directory with your SGML file for applets, or should be
kept in a directory called "figs" for application and other
documentation. After you use <b>db2html</b> to
- convert your SGML file to HTML (see <a href="indexs02.html#make-output" title="Creating Something Useful with your Docs">the section called “Creating Something Useful with your Docs”</a>), you will need to copy your
+ convert your SGML file to HTML (see <a href="indexs02.html#make-output" title="Creating Something Useful with your Docs">the section called “Creating Something Useful with your Docs”</a>), you will need to copy your
screenshots (either the individual PNG files for applet
documentation, or the whole "figs" directory for other
documentation) into the newly created HTML directory. Note
directory is erased and rewritten, so do not store your only
copy of the screenshots in that directory. If you wish to
create PostScript or PDF output, you will need to manually
- convert the PNG images to EPS as described in <a href="indexs02.html#jadeimages" title="Images in DocBook Tools">the section called “Images in DocBook Tools”</a>, but will not need to copy these
+ convert the PNG images to EPS as described in <a href="indexs02.html#jadeimages" title="Images in DocBook Tools">the section called “Images in DocBook Tools”</a>, but will not need to copy these
images from their default location, as they are included
directly into the output(PostScript of PDF) file.
</p>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="index.html">Prev</a>Â </td>
+<a href="index.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="indexs03.html">Next</a>
+<td width="40%" align="right"> <a href="indexs03.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">The GNOME Handbook of Writing Software Documentation </td>
+<td width="40%" align="left">The GNOME Handbook of Writing Software Documentation </td>
<td width="20%" align="center"><a href="index.html">Up</a></td>
-<td width="40%" align="right">Â The GNOME Documentation System</td>
+<td width="40%" align="right"> The GNOME Documentation System</td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>The GNOME Documentation System</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">The GNOME Documentation System</th></tr>
<tr>
<td width="20%" align="left">
-<a href="indexs02.html">Prev</a>Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="indexs04.html">Next</a>
+<a href="indexs02.html">Prev</a> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="indexs04.html">Next</a>
</td>
</tr>
</table>
particular application which explains the various windows
and features of the application. Application Manuals
typically use screenshots (PNG format) for clarity. Writing
- application manuals is discussed in more detail in <a href="indexs06.html" title="Writing Application and Applet Manuals">the section called “Writing Application and Applet Manuals”</a> below.
+ application manuals is discussed in more detail in <a href="indexs06.html" title="Writing Application and Applet Manuals">the section called “Writing Application and Applet Manuals”</a> below.
</p>
</div>
<div class="sect3">
GNOME Help Browser. The help
browser should show either the first page of the application
manual, or else the relevant page thereof. Application help
- is described in more detail in <a href="indexs08.html" title="Application Help Buttons">the section called “Application Help Buttons”</a> below.
+ is described in more detail in <a href="indexs08.html" title="Application Help Buttons">the section called “Application Help Buttons”</a> below.
</p>
</div>
<div class="sect3">
clicking on an icon or by right clicking on the application
part and selecting "What's This" or whatever is decided on
at the time. Context sensitive help is described in more
- detail in <a href="indexs10.html" title="Writing Context Sensitive Help (coming in GNOME-2.0)">the section called “Writing Context Sensitive Help (coming in GNOME-2.0)”</a>
+ detail in <a href="indexs10.html" title="Writing Context Sensitive Help (coming in GNOME-2.0)">the section called “Writing Context Sensitive Help (coming in GNOME-2.0)”</a>
below.
</p>
</div>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="indexs02.html">Prev</a>Â </td>
+<a href="indexs02.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="indexs04.html">Next</a>
+<td width="40%" align="right"> <a href="indexs04.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">Getting Started Writing GNOME Documentation </td>
+<td width="40%" align="left">Getting Started Writing GNOME Documentation </td>
<td width="20%" align="center"><a href="index.html">Up</a></td>
-<td width="40%" align="right">Â DocBook Basics </td>
+<td width="40%" align="right"> DocBook Basics </td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>DocBook Basics </title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">DocBook Basics </th></tr>
<tr>
<td width="20%" align="left">
-<a href="indexs03.html">Prev</a>Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="indexs05.html">Next</a>
+<a href="indexs03.html">Prev</a> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="indexs05.html">Next</a>
</td>
</tr>
</table>
readable format, you need special tools. The GDP uses <i>DocBook
Tools</i>, a free package of utilities for working with DocBook
which includes <i>Jade</i>, which does the SGML/DSSL
- parsing. You can read more about DocBook Tools in <a href="indexs02.html#installingdocbook" title="Installing DocBook">the section called “Installing DocBook”</a>.
+ parsing. You can read more about DocBook Tools in <a href="indexs02.html#installingdocbook" title="Installing DocBook">the section called “Installing DocBook”</a>.
</p>
<p>
The final appearance of the output (e.g. PostScript or HTML)
numbering style, and much more. DocBook tools come with a
collection of stylesheets (Norman Walsh's modular
stylesheets); GNOME Document Project uses some customized
- version of this stylesheets -- see <a href="indexs02.html#gdpstylesheets" title="GDP Stylesheets">the section called “GDP Stylesheets”</a>.
+ version of this stylesheets -- see <a href="indexs02.html#gdpstylesheets" title="GDP Stylesheets">the section called “GDP Stylesheets”</a>.
</p>
<p>
The advantage of specifying the <i>structure</i>
</p>
<p>
As stated before, the GDP uses the DocBook DTD. For a list of
- introductory and reference resources on DocBook, see <a href="indexs15.html" title="Resources">the section called “Resources”</a>. The following sections also provide
+ introductory and reference resources on DocBook, see <a href="indexs15.html" title="Resources">the section called “Resources”</a>. The following sections also provide
convenient instructions on which markup tags to use in various
- circumstances. Be sure to read <a href="indexs05.html" title="GDP Documentation Conventions ">the section called “GDP Documentation Conventions ”</a>
+ circumstances. Be sure to read <a href="indexs05.html" title="GDP Documentation Conventions ">the section called “GDP Documentation Conventions ”</a>
for GDP documentation-specific guidelines.
</p>
</div>
</p>
<div class="variablelist"><dl>
<dt>
-<a name="id2900749"></a><span class="term"> <i>Minimization</i></span>
+<a name="id2905678"></a><span class="term"> <i>Minimization</i></span>
</dt>
<dd><p>
-<a name="id2900768"></a>
+<a name="id2905697"></a>
It is possible with some implementations of SGML to use
minimizations to close elements in a document by using
</>, for example:
Modify->Normalize.
</p></dd>
<dt>
-<a name="id2900851"></a><span class="term"> <i>Self-closing tags</i></span>
+<a name="id2905780"></a><span class="term"> <i>Self-closing tags</i></span>
</dt>
<dd><p>
-<a name="id2900870"></a>
+<a name="id2905799"></a>
Also, in SGML some tags are allowed not to have closing
tags. For example, it is legal for
<tt><xref></tt> not to have a closing tag:
slash!).
</p></dd>
<dt>
-<a name="id2900923"></a><span class="term"> <i>Case sensitive tags</i></span>
+<a name="id2905852"></a><span class="term"> <i>Case sensitive tags</i></span>
</dt>
<dd><p>
-<a name="id2900943"></a>
+<a name="id2905872"></a>
In XML, unlike SGML, tags are case-senstive
<tt><title></tt> and
<tt><TITLE></tt> are different tags!
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">
-<a name="id2901414"></a>NOTE</h3>
+<a name="id2906340"></a>NOTE</h3>
<p>
Notice in this example that the screenshot file name does
not include the file type extension -- to find out
- why, please read <a href="indexs02.html#jadeimages" title="Images in DocBook Tools">the section called “Images in DocBook Tools”</a>.
+ why, please read <a href="indexs02.html#jadeimages" title="Images in DocBook Tools">the section called “Images in DocBook Tools”</a>.
</p>
</div>
</div>
and commands entered by user.
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">
-<a name="id2901627"></a>NOTE</h3>
+<a name="id2906548"></a>NOTE</h3>
<p>
Note that both <tt><programlisting></tt>
and <tt><screen></tt> preserve linebreaks,
</p>
<div class="variablelist"><dl>
<dt>
-<a name="id2901746"></a><span class="term"> <tt><itemizedlist></tt></span>
+<a name="id2906667"></a><span class="term"> <tt><itemizedlist></tt></span>
</dt>
<dd>
<p>
-<a name="id2901765"></a>
+<a name="id2906687"></a>
This is the simplest unnumbered list, parallel to
<tt><ul></tt> in HTML. Here is an example:
<pre class="programlisting">
</p>
<div class="itemizedlist"><ul>
<li><p>
-<a name="id2901783"></a>
+<a name="id2906722"></a>
Show backup files --
This will show any backup file that might be on
your system.
</p></li>
<li><p>
-<a name="id2901846"></a>
+<a name="id2906776"></a>
Show hidden files --
This will show all "dot files" or files that
begin with a dot. This files typically include
configuration files and directories.
</p></li>
<li><p>
-<a name="id2901873"></a>
+<a name="id2906803"></a>
Mix files and directories
-- This option will display files and
directories in the order you sort them instead
</p></li>
</ul></div>
<p> Note the use of <tt>&mdash;</tt>
- for long dash (see <a href="indexs04.html#specsymb" title=" Special symbols ">the section called “ Special symbols ”</a>). Also,
+ for long dash (see <a href="indexs04.html#specsymb" title=" Special symbols ">the section called “ Special symbols ”</a>). Also,
please note that the result looks much nicer because the
terms being explained (Show backup
files, etc.) are set in a different font. In
</p>
</dd>
<dt>
-<a name="id2902039"></a><span class="term"> <tt><orderedlist></tt></span>
+<a name="id2906969"></a><span class="term"> <tt><orderedlist></tt></span>
</dt>
<dd><p>
-<a name="id2902057"></a>
+<a name="id2906987"></a>
This list is completely analogous to
<tt><itemizedlist></tt> and has the same
syntax, but it produces numbered list. By default,
<tt>lowerroman</tt>.
</p></dd>
<dt>
-<a name="id2902137"></a><span class="term"> <tt><variablelist></tt></span>
+<a name="id2907067"></a><span class="term"> <tt><variablelist></tt></span>
</dt>
<dd><p>
-<a name="id2902157"></a> This list is used when each entry is
+<a name="id2907087"></a> This list is used when each entry is
rather long, so it should be formatted as a block of text
with some subtitle, like a small subsection. The
<tt><variablelist></tt> is more complicated
<a name="gui"></a>GUI elements</h4></div></div>
<div class="itemizedlist"><ul>
<li><p>
-<a name="id2902315"></a>
+<a name="id2907253"></a>
<tt><guibutton></tt> -- used for
buttons, including checkbuttons and radio buttons
</p></li>
<li><p>
-<a name="id2902340"></a>
+<a name="id2907279"></a>
<tt><guimenu></tt>,
<tt><guisubmenu></tt> --used for
top-level menus and submenus
<guimenu>Main Menu</guimenu></tt>
</p></li>
<li><p>
-<a name="id2902384"></a>
+<a name="id2907323"></a>
<tt><guimenuitem></tt>--an entry in a
menu
</p></li>
<li><p>
-<a name="id2902410"></a>
+<a name="id2907349"></a>
<tt><guiicon></tt>--an icon
</p></li>
<li><p>
-<a name="id2902434"></a>
+<a name="id2907373"></a>
<tt><guilabel></tt>--for items which have
labels, like tabs, or bounding boxes.
</p></li>
<li><p>
-<a name="id2902459"></a>
+<a name="id2907398"></a>
<tt><interface></tt>-- for most everything
else... a window, a dialog box, the Panel, etc.
</p></li>
An example of a <link linkend="extip">tip</link> was given in
<xref linkend="notes" />.
</pre>
- which produces: An example of a <a href="indexs04.html#extip">tip</a> was given in <a href="indexs04.html#notes" title="Notes, Warnings, And Tips">the section called “Notes, Warnings, And Tips”</a>.
+ which produces: An example of a <a href="indexs04.html#extip">tip</a> was given in <a href="indexs04.html#notes" title="Notes, Warnings, And Tips">the section called “Notes, Warnings, And Tips”</a>.
</p>
<p>
Here <tt>notes</tt> and <tt>extip</tt>
- are the id attributes of <a href="indexs04.html#notes" title="Notes, Warnings, And Tips">the section called “Notes, Warnings, And Tips”</a> and of the
+ are the id attributes of <a href="indexs04.html#notes" title="Notes, Warnings, And Tips">the section called “Notes, Warnings, And Tips”</a> and of the
example of a tip in it.
</p>
<p> To produce a link to an external source, such as a
</p>
<div class="itemizedlist"><ul>
<li><p>
-<a name="id2902816"></a> <tt><filename></tt> -- used
+<a name="id2907747"></a> <tt><filename></tt> -- used
for filenames,
e.g.<tt><filename></tt>
foo.sgml
produces: <tt>foo.sgml</tt>.
</p></li>
<li><p>
-<a name="id2902866"></a> <tt><filename
+<a name="id2907796"></a> <tt><filename
class="directory"></tt> -- used for
directories, e.g.<tt><filename
class="directory"></tt>/usr/bin
produces: <tt>/usr/bin</tt>.
</p></li>
<li><p>
-<a name="id2902922"></a>
+<a name="id2907853"></a>
<tt><application></tt> -- used for
application names,
e.g. <tt><application></tt>Gnumeric
Gnumeric.
</p></li>
<li><p>
-<a name="id2902972"></a>
+<a name="id2907903"></a>
<tt><envar></tt> -- used for
environment variables, e.g.
<tt><envar></tt>PATH<tt></envar></tt>.
</p></li>
<li><p>
-<a name="id2903013"></a>
+<a name="id2907944"></a>
<tt><command></tt> -- used for
commands entered on command line, e.g.
<tt><command></tt>make install
<b>make install</b>.
</p></li>
<li><p>
-<a name="id2903063"></a>
+<a name="id2907993"></a>
<tt><replaceable></tt> -- used for
replaceable text, e.g.
<tt><command></tt>db2html<tt><replaceable></tt>
other tags for keys, too: <tt><keysym></tt>
and <tt><keycode></tt>. However you are
unlikely to need these for most documentation. For reference,
- <tt><keysym></tt> is for the ‘symbolic
- name’ of a key. <tt><keycode></tt> is
- for the ‘scan code’ of a key. These are not
+ <tt><keysym></tt> is for the ‘symbolic
+ name’ of a key. <tt><keycode></tt> is
+ for the ‘scan code’ of a key. These are not
terms commonly required in GNOME documentation,
although <tt><keysym></tt> is useful for marking
up control codes.
</p>
<div class="itemizedlist"><ul>
<li><p>
-<a name="id2903502"></a>
+<a name="id2908425"></a>
<tt>&amp;</tt> -- ampersend (&)
</p></li>
<li><p>
-<a name="id2903521"></a>
+<a name="id2908444"></a>
<tt>&lt;</tt> -- left angle bracket (<)
</p></li>
<li><p>
-<a name="id2903540"></a>
- <tt>&copy;</tt> -- copyright sign (©)
+<a name="id2908463"></a>
+ <tt>&copy;</tt> -- copyright sign (©)
</p></li>
<li><p>
-<a name="id2903559"></a>
+<a name="id2908482"></a>
<tt>&mdash;</tt> -- long dash (--)
</p></li>
<li><p>
-<a name="id2903578"></a>
+<a name="id2908501"></a>
<tt>&hellip;</tt> -- ellipsis (...)
</p></li>
</ul></div>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="indexs03.html">Prev</a>Â </td>
+<a href="indexs03.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="indexs05.html">Next</a>
+<td width="40%" align="right"> <a href="indexs05.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">The GNOME Documentation System </td>
+<td width="40%" align="left">The GNOME Documentation System </td>
<td width="20%" align="center"><a href="index.html">Up</a></td>
-<td width="40%" align="right">Â GDP Documentation Conventions </td>
+<td width="40%" align="right"> GDP Documentation Conventions </td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>GDP Documentation Conventions </title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">GDP Documentation Conventions </th></tr>
<tr>
<td width="20%" align="left">
-<a href="indexs04.html">Prev</a>Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="indexs06.html">Next</a>
+<a href="indexs04.html">Prev</a> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="indexs06.html">Next</a>
</td>
</tr>
</table>
<p>
All GNOME documentation should conform to XML syntax
requirements, which are stricter than SGML ones -- see
- <a href="indexs04.html#xml" title="XML and SGML">the section called “XML and SGML”</a> for more informaion.
+ <a href="indexs04.html#xml" title="XML and SGML">the section called “XML and SGML”</a> for more informaion.
</p>
</div>
<div class="sect3">
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="indexs04.html">Prev</a>Â </td>
+<a href="indexs04.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="indexs06.html">Next</a>
+<td width="40%" align="right"> <a href="indexs06.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">DocBook Basics  </td>
+<td width="40%" align="left">DocBook Basics </td>
<td width="20%" align="center"><a href="index.html">Up</a></td>
-<td width="40%" align="right">Â Writing Application and Applet Manuals</td>
+<td width="40%" align="right"> Writing Application and Applet Manuals</td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>Writing Application and Applet Manuals</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">Writing Application and Applet Manuals</th></tr>
<tr>
<td width="20%" align="left">
-<a href="indexs05.html">Prev</a>Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="indexs07.html">Next</a>
+<a href="indexs05.html">Prev</a> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="indexs07.html">Next</a>
</td>
</tr>
</table>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">
-<a name="id2904036"></a>Documentation Availability</h3>
+<a name="id2908956"></a>Documentation Availability</h3>
<p>
Applications and applets should not rely on documentation
which is only available on the internet. All manuals and
</p>
</div>
<p> Application manuals should be based on the template in
- <a href="apa.html#template1" title="Template 1: Application Manual">the section called “Template 1: Application Manual”</a>. Applet manuals should be based on
- the templates in <a href="apas17.html" title="Template 2: Applet Manual For GNOME 1.x">the section called “Template 2: Applet Manual For GNOME 1.x”</a> for GNOME
- versions 1.x and the templates in <a href="apas18.html" title="Template 2: Applet Manual For GNOME 2.x">the section called “Template 2: Applet Manual For GNOME 2.x”</a>
+ <a href="apa.html#template1" title="Template 1: Application Manual">the section called “Template 1: Application Manual”</a>. Applet manuals should be based on
+ the templates in <a href="apas17.html" title="Template 2: Applet Manual For GNOME 1.x">the section called “Template 2: Applet Manual For GNOME 1.x”</a> for GNOME
+ versions 1.x and the templates in <a href="apas18.html" title="Template 2: Applet Manual For GNOME 2.x">the section called “Template 2: Applet Manual For GNOME 2.x”</a>
for GNOME versions 2.x.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">
-<a name="id2904076"></a>Manuals For Large Applications</h3>
+<a name="id2908997"></a>Manuals For Large Applications</h3>
<p>
Manuals for very large applications, such as GNOME Workshop
components should be a <tt><book></tt> (and thus
</div>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">
-<a name="id2904192"></a>Applet Manuals in GNOME 2.0</h3>
+<a name="id2909112"></a>Applet Manuals in GNOME 2.0</h3>
<p>
Note that applet manuals in GNOME 2.0 are treated in a special
way. The manuals for all applets are merged into a single
Application manuals should be made available by having a
"Manual" entry in the Help pull-down menu
at the top of the
- application, as described in <a href="indexs07.html" title="Listing Documents in the Help Menu">the section called “Listing Documents in the Help Menu”</a>.
+ application, as described in <a href="indexs07.html" title="Listing Documents in the Help Menu">the section called “Listing Documents in the Help Menu”</a>.
Applets should make their manuals available by
right-clicking on the applet.
</p>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="indexs05.html">Prev</a>Â </td>
+<a href="indexs05.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="indexs07.html">Next</a>
+<td width="40%" align="right"> <a href="indexs07.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">GDP Documentation Conventions  </td>
+<td width="40%" align="left">GDP Documentation Conventions </td>
<td width="20%" align="center"><a href="index.html">Up</a></td>
-<td width="40%" align="right">Â Listing Documents in the Help Menu</td>
+<td width="40%" align="right"> Listing Documents in the Help Menu</td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>Listing Documents in the Help Menu</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">Listing Documents in the Help Menu</th></tr>
<tr>
<td width="20%" align="left">
-<a href="indexs06.html">Prev</a>Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="indexs08.html">Next</a>
+<a href="indexs06.html">Prev</a> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="indexs08.html">Next</a>
</td>
</tr>
</table>
<a name="listingdocsinhelpmenu"></a>Listing Documents in the Help Menu</h2></div></div>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">
-<a name="id2904310"></a>Developer Information</h3>
+<a name="id2909230"></a>Developer Information</h3>
<p>
This section is for developers. Documentation authors
generally do not need to know this material.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">
-<a name="id2904453"></a>Note</h3>
+<a name="id2909374"></a>Note</h3>
<p>
If the help files are not present in the correct directory, the
menu items will NOT appear when the program is run.
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="indexs06.html">Prev</a>Â </td>
+<a href="indexs06.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="indexs08.html">Next</a>
+<td width="40%" align="right"> <a href="indexs08.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">Writing Application and Applet Manuals </td>
+<td width="40%" align="left">Writing Application and Applet Manuals </td>
<td width="20%" align="center"><a href="index.html">Up</a></td>
-<td width="40%" align="right">Â Application Help Buttons</td>
+<td width="40%" align="right"> Application Help Buttons</td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>Application Help Buttons</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">Application Help Buttons</th></tr>
<tr>
<td width="20%" align="left">
-<a href="indexs07.html">Prev</a>Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="indexs09.html">Next</a>
+<a href="indexs07.html">Prev</a> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="indexs09.html">Next</a>
</td>
</tr>
</table>
<a name="applicationhelpbuttons"></a>Application Help Buttons</h2></div></div>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">
-<a name="id2904591"></a>Developer Information</h3>
+<a name="id2909511"></a>Developer Information</h3>
<p>
This section is for developers. Documentation authors
generally do not need to know this material.
</pre>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">
-<a name="id2904697"></a>NOTE</h3>
+<a name="id2909617"></a>NOTE</h3>
<p>
The example above is in the C language, please refer to other
documentation or forums for other GNOME language bindings.
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="indexs07.html">Prev</a>Â </td>
+<a href="indexs07.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="indexs09.html">Next</a>
+<td width="40%" align="right"> <a href="indexs09.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">Listing Documents in the Help Menu </td>
+<td width="40%" align="left">Listing Documents in the Help Menu </td>
<td width="20%" align="center"><a href="index.html">Up</a></td>
-<td width="40%" align="right">Â Packaging Applet Documentation</td>
+<td width="40%" align="right"> Packaging Applet Documentation</td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>Packaging Applet Documentation</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">Packaging Applet Documentation</th></tr>
<tr>
<td width="20%" align="left">
-<a href="indexs08.html">Prev</a>Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="indexs10.html">Next</a>
+<a href="indexs08.html">Prev</a> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="indexs10.html">Next</a>
</td>
</tr>
</table>
<a name="appletmenu"></a>Adding Documentation to an Applet Menu</h3></div></div>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">
-<a name="id2904938"></a>Developer Information</h3>
+<a name="id2909858"></a>Developer Information</h3>
<p>
This section is for developers. Documentation authors
generally do not need to know this material.
You will need to write a simple callback function to open the
help browser to the appropriate document. This is done using
the <tt>gnome_help_file_find_file</tt> function,
- as described in <a href="indexs08.html" title="Application Help Buttons">the section called “Application Help Buttons”</a>.
+ as described in <a href="indexs08.html" title="Application Help Buttons">the section called “Application Help Buttons”</a>.
</p>
<p>
You will also want to add an About menu
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="indexs08.html">Prev</a>Â </td>
+<a href="indexs08.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="indexs10.html">Next</a>
+<td width="40%" align="right"> <a href="indexs10.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">Application Help Buttons </td>
+<td width="40%" align="left">Application Help Buttons </td>
<td width="20%" align="center"><a href="index.html">Up</a></td>
-<td width="40%" align="right">Â Writing Context Sensitive Help (coming in GNOME-2.0)</td>
+<td width="40%" align="right"> Writing Context Sensitive Help (coming in GNOME-2.0)</td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>Writing Context Sensitive Help (coming in GNOME-2.0)</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">Writing Context Sensitive Help (coming in GNOME-2.0)</th></tr>
<tr>
<td width="20%" align="left">
-<a href="indexs09.html">Prev</a>Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="indexs11.html">Next</a>
+<a href="indexs09.html">Prev</a> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="indexs11.html">Next</a>
</td>
</tr>
</table>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="indexs09.html">Prev</a>Â </td>
+<a href="indexs09.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="indexs11.html">Next</a>
+<td width="40%" align="right"> <a href="indexs11.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">Packaging Applet Documentation </td>
+<td width="40%" align="left">Packaging Applet Documentation </td>
<td width="20%" align="center"><a href="index.html">Up</a></td>
-<td width="40%" align="right">Â Referring to Other GNOME Documentation (coming in
+<td width="40%" align="right"> Referring to Other GNOME Documentation (coming in
GNOME-2.0)</td>
</tr>
</table>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>Referring to Other GNOME Documentation (coming in
GNOME-2.0)</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
GNOME-2.0)</th></tr>
<tr>
<td width="20%" align="left">
-<a href="indexs10.html">Prev</a>Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="indexs12.html">Next</a>
+<a href="indexs10.html">Prev</a> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="indexs12.html">Next</a>
</td>
</tr>
</table>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="indexs10.html">Prev</a>Â </td>
+<a href="indexs10.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="indexs12.html">Next</a>
+<td width="40%" align="right"> <a href="indexs12.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">Writing Context Sensitive Help (coming in GNOME-2.0)Â </td>
+<td width="40%" align="left">Writing Context Sensitive Help (coming in GNOME-2.0) </td>
<td width="20%" align="center"><a href="index.html">Up</a></td>
-<td width="40%" align="right">Â Basics of Documentation Style</td>
+<td width="40%" align="right"> Basics of Documentation Style</td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>Basics of Documentation Style</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">Basics of Documentation Style</th></tr>
<tr>
<td width="20%" align="left">
-<a href="indexs11.html">Prev</a>Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="indexs13.html">Next</a>
+<a href="indexs11.html">Prev</a> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="indexs13.html">Next</a>
</td>
</tr>
</table>
you'll have to juggle a number of other extremes as you write:
<div class="itemizedlist"><ul>
<li><p>
-<a name="id2905458"></a>
+<a name="id2910378"></a>
Documents should be complete, yet concise. You should
describe every feature, but you'll have decide how much
detail is really necessary. It's not, for example,
items that are more complex.
</p></li>
<li><p>
-<a name="id2905486"></a>
+<a name="id2910406"></a>
Be engaging and friendly, yet professional. Games
documents may be less formal than productivity
application documents (people don't
allusions or puns.
</p></li>
<li><p>
-<a name="id2905525"></a>
+<a name="id2910445"></a>
Examples, tips, notes, and screenshots are useful to
break up long stretches of text, but too many can get in
the way, and make your documents too choppy to read.
tabs, it's not usually necessary to have one for each.
</p></li>
<li><p>
-<a name="id2905549"></a>
+<a name="id2910469"></a>
The GDP strives to have all of its documentation conform
to certain standards of style and content, but every
document (and every writer) is different. You will need
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="indexs11.html">Prev</a>Â </td>
+<a href="indexs11.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="indexs13.html">Next</a>
+<td width="40%" align="right"> <a href="indexs13.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left">Referring to Other GNOME Documentation (coming in
- GNOME-2.0)Â </td>
+ GNOME-2.0) </td>
<td width="20%" align="center"><a href="index.html">Up</a></td>
-<td width="40%" align="right">Â Teamwork</td>
+<td width="40%" align="right"> Teamwork</td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>Teamwork</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">Teamwork</th></tr>
<tr>
<td width="20%" align="left">
-<a href="indexs12.html">Prev</a>Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="indexs14.html">Next</a>
+<a href="indexs12.html">Prev</a> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="indexs14.html">Next</a>
</td>
</tr>
</table>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="indexs12.html">Prev</a>Â </td>
+<a href="indexs12.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="indexs14.html">Next</a>
+<td width="40%" align="right"> <a href="indexs14.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">Basics of Documentation Style </td>
+<td width="40%" align="left">Basics of Documentation Style </td>
<td width="20%" align="center"><a href="index.html">Up</a></td>
-<td width="40%" align="right">Â Finishing A Document</td>
+<td width="40%" align="right"> Finishing A Document</td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>Finishing A Document</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">Finishing A Document</th></tr>
<tr>
<td width="20%" align="left">
-<a href="indexs13.html">Prev</a>Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="indexs15.html">Next</a>
+<a href="indexs13.html">Prev</a> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="indexs15.html">Next</a>
</td>
</tr>
</table>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="indexs13.html">Prev</a>Â </td>
+<a href="indexs13.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="indexs15.html">Next</a>
+<td width="40%" align="right"> <a href="indexs15.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">Teamwork </td>
+<td width="40%" align="left">Teamwork </td>
<td width="20%" align="center"><a href="index.html">Up</a></td>
-<td width="40%" align="right">Â Resources</td>
+<td width="40%" align="right"> Resources</td>
</tr>
</table>
</div>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<title>Resources</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.40">
<link rel="home" href="index.html" title="The GNOME Handbook of Writing Software Documentation">
<tr><th colspan="3" align="center">Resources</th></tr>
<tr>
<td width="20%" align="left">
-<a href="indexs14.html">Prev</a>Â </td>
-<th width="60%" align="center">Â </th>
-<td width="20%" align="right">
 <a href="apa.html">Next</a>
+<a href="indexs14.html">Prev</a> </td>
+<th width="60%" align="center"> </th>
+<td width="20%" align="right"> <a href="apa.html">Next</a>
</td>
</tr>
</table>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
-<a href="indexs14.html">Prev</a>Â </td>
+<a href="indexs14.html">Prev</a> </td>
<td width="20%" align="center"><a href="index.html">Home</a></td>
-<td width="40%" align="right">
 <a href="apa.html">Next</a>
+<td width="40%" align="right"> <a href="apa.html">Next</a>
</td>
</tr>
<tr>
-<td width="40%" align="left">Finishing A Document </td>
+<td width="40%" align="left">Finishing A Document </td>
<td width="20%" align="center"><a href="index.html">Up</a></td>
-<td width="40%" align="right">Â A. Document Templates</td>
+<td width="40%" align="right"> A. Document Templates</td>
</tr>
</table>
</div>
projects / platform / upstream / libxslt.git / commitdiff