Makefile DTD

The content collection makefile DTD defines the format to which a makefile must conform.

<!-- 
	DTD for NXT 4 make files
	Version 4.0
	Copyright (c) 2005-2023, Rocket Software, Inc.
-->

<!-- 
The following parameter entities may be overridden in the make file's
internal DTD subset. For example, to change the default value for document
encodings from #IMPLIED (auto detect) to iso-8859-1, the internal
DTD subset in the make file would look like this (though the path to the
DTD may be different):

<!DOCTYPE makefile SYSTEM "file:///va:/production/dtd/makefile.dtd" [
	<!ENTITY % default-encoding '"iso-8859-1"'>
]>

-->
<!ENTITY % default-dse-id            "'file-system-dse'">
<!ENTITY % default-dse-id-metadata   "'file-system-dse'">
<!ENTITY % default-hidden            "'no'">
<!ENTITY % default-content-type      "#IMPLIED">
<!ENTITY % default-encoding          "#IMPLIED">
<!ENTITY % default-compression       "'none'">
<!ENTITY % default-indexsheet        "#IMPLIED">
<!ENTITY % fsysdse-class-id-ansi     "{023933C0-CFCF-11d1-B139-00C04F932EC0}">
<!ENTITY % fsysdse-class-id-unicode  "{DCFC3BDD-5125-4734-B422-81B65E50611A}">


<!-- Pre-defined DSE for easy use. -->
<!ENTITY fsysdse "<dse id='file-system-dse' class-id='%fsysdse-class-id-unicode;'/>">
<!ENTITY fsysdse-class-id "%fsysdse-class-id-unicode;">

<!ELEMENT makefile (dse+, (infobase|content-collection))>
<!ATTLIST makefile
	version	CDATA #FIXED "4.0">

<!ELEMENT dse (param*)>
<!ATTLIST dse
	id		ID #REQUIRED
	class-id	CDATA #REQUIRED
	chain		IDREF #IMPLIED>

<!ELEMENT param EMPTY>
<!ATTLIST param
	name	CDATA #REQUIRED
	value	CDATA #REQUIRED>	

<!ELEMENT content-collection ((field|field-def)*, indexsheet*, property*, document+)>
<!ATTLIST content-collection
	id			CDATA #REQUIRED
	title			CDATA #REQUIRED
	filename		CDATA #REQUIRED
	update-filename		CDATA "update.upd"
	encryption		(none|exportable|best) "none"
	password		CDATA #IMPLIED
	old-password		CDATA #IMPLIED
	stop-words		(yes|no) "no"
	index-headings		(yes|no) "no"
	lang-module		CDATA "NextPage US English Server Extension Module. Version 2.01">

<!-- infobase is deprecated in favor of content-collection -->
<!ELEMENT infobase ((field|field-def)*, indexsheet*, property*, document+)>
<!ATTLIST infobase
	id			CDATA #REQUIRED
	title			CDATA #REQUIRED
	filename		CDATA #REQUIRED
	update-filename		CDATA "update.upd"
	encryption		(none|exportable|best) "none"
	password		CDATA #IMPLIED
	old-password		CDATA #IMPLIED
	stop-words		(yes|no) "no"
	index-headings		(yes|no) "no"
	lang-module		CDATA "NextPage US English Server Extension Module. Version 2.01">

<!ELEMENT field EMPTY>
<!ATTLIST field
	name		CDATA #REQUIRED
	type		(text|long|double|date|time) "text"
	relevance	(normal|high|higher|highest) "normal"
	picture		CDATA #IMPLIED
	index		(yes|no) "yes"
	exclusive	(yes|no) "no"
	term-list	(yes|no) "no"
	phrase		(yes|no) "no"
	toc-section	(yes|no) "no"
	stop-words	(yes|no) "no"
	proximity	(yes|no) "yes"
	date-2000	(yes|no) "no">

<!-- field-def is deprecated in favor of field -->
<!ELEMENT field-def EMPTY>
<!ATTLIST field-def
	name		CDATA #REQUIRED
	type		(text|long|double|date|time) "text"
	relevance	(normal|high|higher|highest) "normal"
	picture		CDATA #IMPLIED
	index		(yes|no) "yes"
	exclusive	(yes|no) "no"
	term-list	(yes|no) "no"
	phrase		(yes|no) "no"
	toc-section	(yes|no) "no"
	stop-words	(yes|no) "no"
	proximity	(yes|no) "yes"
	date-2000	(yes|no) "no">

<!ELEMENT property EMPTY>
<!ATTLIST property
	name		CDATA #REQUIRED
	value		CDATA #REQUIRED>

<!-- compression best is deprecated in favor of fast -->
<!ELEMENT document (metadata?,(document)*)>
<!ATTLIST document
	id			CDATA #IMPLIED
	name			CDATA #REQUIRED
	title			CDATA #IMPLIED
	hidden			(yes|no) %default-hidden;
	index			(yes|no) "yes"
	location		CDATA #IMPLIED
	dse			IDREF %default-dse-id;
	content-type		CDATA %default-content-type;
	encoding		CDATA %default-encoding;
	compression		(none|fast|best) %default-compression;
	indexsheet		IDREF %default-indexsheet;
	first-child-content	(yes|no) "no">

<!ELEMENT metadata EMPTY>
<!ATTLIST metadata
	location		CDATA #IMPLIED
	dse			IDREF %default-dse-id-metadata;>

<!ELEMENT indexsheet EMPTY>
<!ATTLIST indexsheet
	id			ID #REQUIRED
	src			CDATA #REQUIRED
	default-for-content-type CDATA #IMPLIED>

Makefile Elements

The makefile can contain the following elements.

content-collection

Marks the beginning of the content within a content collection. This is the root content collection element.

The term infobase has been deprecated in favor of content-collection. Infobase is maintained for backwards compatibility.

Definition

<!ELEMENT content-collection 
     ((field | field-def*), indexsheet*, property*, document+)>
<!ATTLIST content-collection
     id                  CDATA #REQUIRED
     title               CDATA #REQUIRED
     filename            CDATA #REQUIRED
     update-filename     CDATA "update.upd"
     encryption          (none|exportable|best) "none"
     password            CDATA #IMPLIED
     old-password        CDATA #IMPLIED
     stop-words          (yes|no) no
     lang-module         CDATA "NextPage US English 
	                     Server Extension Module. Version 2.01"
>

Attributes

NXT 4 Language Modules

The [Server\LanguageModules] section of the Publish.ini file contains mappings between these names and the corresponding DLL file names.

Remarks

You can specify only one content collection in a makefile. In addition, only one language can be specified for each content collection.

Example

<?xml version="3.0"?>
<!DOCTYPE makefile SYSTEM 
"file:///v:/production/dtd/makefile.dtd" [
     <!ENTITY prjdir "c:\Project\data\government">
]>
<makefile>
&fsysdse;

<content-collection
   id="gov"
   title="Government: A Sampling of Documents"
   filename="&prjdir;\government.nfo"
   update-filename="&prjdir;\government.upd"
   compression="best">

<document location="&prjdir;\titlepage.html" 
    content-type="text/html"/>
<document location="&prjdir;\govtlogo.gif" 
    content-type="image/gif" hidden=yes index=no/>

<document name="Acts-Bills">
   <document location="&prjdir;\Acts-Bills\brady.html"  
       content-type="text/html"/>
   <document location="&prjdir;\Acts-Bills\civil91.html"  
   content-type="text/html"/>
</document>

<document name="Cases">
   <document location="&prjdir;\Cases\meinhold.html" 
   content-type="text/html"/>
</document>

</content-collection>
</makefile>

DOCTYPE

Specifies a file's document type. It also gives the path to the document type definition (DTD) specifying how to parse and validate the XML file.

Definition

<!DOCTYPE {file type} SYSTEM "file:///{path to makefile.dtd}">

or

<!DOCTYPE {file type} SYSTEM "file:///{path to makefile.dtd}"
[
   <!ENTITY {entity name} "{entity value}">
]>

Remarks

A DTD can have two parts: an external subset, stored in the file specified using the DOCTYPE tag, and an internal subset, declared inside of the DOCTYPE tag. Entities declared in the DTD's internal subset take precedence over entities declared in the external subset.

The syntax for specifying the DTD is:

protocol://host/path/file.ext

The following examples show the syntax in a modified format.host is dropped because host is assumed to be localhost. The resulting syntax is:

file:///c:/myfile.txt

Example

<!DOCTYPE makefile SYSTEM "file:///c:/Rocket/makefile.dtd">

<!DOCTYPE makefile SYSTEM "file:///c:/Rocket/makefile.dtd"
[      <!ENTITY prjdir "c:\Rocket\data\sports">       
       <!ENTITY % default-hidden"'no'"> ]>

document

Specifies the document or heading to store in a content collection.

Definition

<!ELEMENT document ((document)*,metadata?)>
<!ATTLIST document
   id             CDATA #IMPLIED
   name           CDATA #REQUIRED
   title          CDATA #IMPLIED
   hidden         (yes|no) %default-hidden;
   index          (yes|no) yes
   location       CDATA #IMPLIED
   dse            IDREF %default-dse-id;
   content-type   CDATA %default-content-type;
   encoding       CDATA %default-encoding;
   compression    (none|fast|best) %default-compression;
   indexsheet     IDREF %default-indexsheet;
   first-child-content  (yes|no) no
>

Attributes

Remarks

Establish headings in a content collection using document titles. Establish the order and hierarchy of a content collection through the order and hierarchy of documents listed in the makefile. Make one document the child of a second by nesting the first between the begin and end tags of the second.

Fields, levels, and HTML heading tags may be applied within a document to create sub-headings. You should not include subheadings in documents that have child documents. The resulting table of contents puts the subheadings below the child documents.

When documents reference secondary files for their content, such as with graphics, the secondary files may be stored within the same content collection or externally. An HTML path uses the document's name to specify the location of a document in a content collection. References from one document to another document in the same content collection should be relative URLs. For example, an HTML file could contain the following:

<IMG SRC="../images/myimage.gif">

As shown here, you may specify relative paths using the ".." and "/" characters commonly used in URLs. However, you may not specify a URL relative to the root by beginning the URL with "/". Instead you should use an absolute URL from the server by adding a replacement string as shown in the following example:

<IMG SRC="#!--#EXECUTIVE:HOME_PATH --#/images/myimage.gif">

This results in a reference that looks like:

<IMG SRC="http://localhost/NXT/gateway.dll/images/myimage.gif">

Example

<document name="Acts-Bills">
   <document location="&prjdir;\Acts-Bills\brady.html" 
      title="Brady Bill" content-type="text/html"/>
   <document location="&prjdir;\Acts-Bills\civil91.html" 
      title="Civil Rights Bill 191" content-type="text/html"/>
   <document location="&prjdir;\Acts-Bills\compfraud.html" 
      title="Compensation Fraud" 
	  content-type="text/html" 
	  encoding="UTF-8"/>
</document>

dse

Declares the Document Source Extension (DSE) to be used to import documents into a content collection.

Definition

<!ELEMENT dse (param*)>
<!ATTLIST dse
      id          ID #REQUIRED
      class-id    CDATA #REQUIRED
      chain       IDREF #IMPLIED>

Attributes

Remarks

DSEs must be defined between the makefile and content-collection elements.

Use the param argument to specify options for a DSE to use.

A DSE abstracts a source of documents to store in a content COLLECTION. ccBuild uses DSEs to read documents for storing in a content collection. DSEs may preprocess documents before handing them to ccBuild.

DSEs can be chained so that the output of one DSE is the input of another. In order to establish a chain, a DSE's chain attribute must be set to the ID of another DSE.

The NXT File System DSE does not support chaining.

The following table shows the entity the makefile.dtd defines for using the NXT DSE.

Before specifying the NXT DSE in a makefile, you must include its entity. You must declare a DSE before declaring another DSE chain that chains to it.

Both Unicode and ANSI DSEs are supported in NXT 4. ccBuild will try to use the Unicode interface first and then switches to the ANSI interface. Each set of DSEinterfacess has a different interface identifier or GUID to distinguish between Unicode and ANSI. Because of the differences in the DSE interfaces, chaining between the two interfaces is not recommended and in most situations will not work. A DSE can be written to handle the string translations itself, which would allow chaining between Unicode and ANSI DSEs but this does not occur automatically.

Example

The following example demonstrates defining and using a custom DSE called my-dse.

<?xml version="3.0"?>
<!DOCTYPE makefile SYSTEM 
"file:///c:/Program Files/Rocket/NXT 4/Builder/makefile.dtd">

<makefile>
<dse id='my-dse' 
class-id='{025933C0-CFCF-11d1-B139-00C04F932EC0}'/>
<content-collection
     id="fisha"
     title="Fish Almanac"
     filename="c:\Project\content collection\Almanac.nfo">

     <document   name="Trout Records"
                 location="c:\Project\data\trout.mtf"
                 dse="my-dse"
     content-type="text/html"
     />
</content-collection>

</makefile>

field

Defines a field for which to create an index.

Definition

<!ELEMENT field EMPTY>
<!ATTLIST field
   name          CDATA #REQUIRED
   type          (text|long|double|date|time) "text"
   relevance     (normal|high|higher|highest) "normal"
   picture       CDATA #IMPLIED
   index         (yes|no) yes
   exclusive     (yes|no) no
   term-list     (yes|no) no
   phrase        (yes|no} no
   toc-section   (yes|no) no
   stop-words    (yes|no) no
   proximity     (yes|no) yes
   date-2000     (yes|no) no
>

Attributes

Remarks

To apply a field, you must use the indexsheet element to define rules which specify indexing for the field. You must also specify that a document use the indexsheet.

Example

<field name="Birth" type="date" 
   picture="mm/dd/yy" index=yes
   term-list=no toc-section=no 
   stop-words=no date-2000=yes/>

indexsheet

Specifies an indexsheet which determines how the indexer should index data.

Definition

<!ELEMENT indexsheet ANY>
<!ATTLIST indexsheet
   id                        ID     #REQUIRED
   src                       CDATA  #IMPLIED
   default-for-content-type  CDATA  #IMPLIED>

Attributes

Remarks

To use an indexsheet for a document, specify the ID of the indexsheet in the document's indexsheet attribute. An indexsheet must be defined before it is used. To specify the default indexsheet to use for documents in a content collection, redefine the default-indexsheet entity in the internal portion of a Makefile's DTD.

See Indexsheet DTD for the format of indexsheets.

Example

<?xml version="3.0"?>
<!DOCTYPE makefile SYSTEM 
"file:///c:/Program Files/Rocket/NXT 4/Builder/makefile.dtd">
<makefile>
&fsysdse;

<content-collection title="my content" 
   filename="C:\Project\content collection\mycontent.nfo">

     <field-def name="Creator"/>

     <indexsheet id="my-index-rules"
      src="c:\Project\indexsheet\myindex.htm"/>
       <indexsheet id="index-html" 
	   src="c:\Project\indexsheet\default-html.htm" 
	   default-for-content-type "text/html" />
        <xsl:stylesheet>

           <xsl:template match='Creator'>
              <np:index field="Creator">
                 <xsl:process-children/>
              </np:index>
           </xsl:template>

           <xsl:template match='Editor'>
              <np:index field="Editor">
                 <xsl:process-children/>
              </np:index>
           </xsl:template>

        </xsl:stylesheet>
     </indexsheet>

     <document location="c:\Project\docs\mydoc1.html"
indexsheet="my-index-rules" 
content-type="text/html"/>

</content-collection>
</makefile>

makefile

Marks the beginning of makefile information. This is the root makefile element.

Definition

<!ELEMENT makefile (dse+, (infobase | content-collection))>
<!ATTLIST makefile version CDATA #FIXED "6.0">

Attributes

Remarks

A makefile can contain one or more dse elements and a single content-collection element.

Examples

<?xml version="3.0"?>
<!DOCTYPE makefile SYSTEM 
"file:///c:/Program Files/Rocket/NXT 4/Builder/makefile.dtd"
[
   <!ENTITY prjdir "c:\Project\Data\Government">
]>
<makefile>
&fsysdse;
<content-collection
     id="gov"
     title="Government: A Sampling of Documents"
     filename="&prjdir;\government.nfo">
     <document location="&prjdir;\titlepage.html"
     name="1"
     content-type="text/html"/>
</content-collection>
</makefile>

metadata

Specifies the metadata file to include in the content collection. Metadata is stored as a document property and describes the document.

Definition

<!ELEMENT metadata EMPTY>
<!ATTLIST metadata
   location	CDATA #IMPLIED
   dse	IDREF %default-dse-id-metadata;>

Attributes

Remarks

If the location of the metadata file is the same as the document being referenced, then the metadata DSE must be different from the document DSE. If both location and DSEs are identical, then NXT 4 will index the document again instead of indexing the metadata file.

In order to distinguish the separate metadata file, either a distinguishing location must be provided, or the DSE itself must contain instructions for locating the RDF based on the main document's location. For example, one DSE might contain instructions to create a file with the same name but with a different extension. That is, mydoc.htm might be tied to a metadata file entitled mydoc.rtf. Another DSE might simply append the extension: mydoc.htm that is tied to a metadata file entitled mydoc.htm.rtf

The default indexsheet for metadata is metadata.xil.

Example

<document location="&prjdir;\Acts-Bills\brady.html" 
   title="Brady Bill" content-type="text/html"/>
  <metadata location="bradymetadata.rdf"/>
</document>

param

Specifies a parameter argument (named value) to pass to a DSE. Use parameters to customize how a DSE operates.

Definition

<!ELEMENT param EMPTY>
<!ATTLIST param
     name    CDATA #REQUIRED
     value   CDATA #REQUIRED>

Attributes

Remarks

It is possible to specify one set of parameters for a DSE to use when parsing one group of files and another set of parameters for the DSE to use when parsing another group of files. To do so, define two dse elements for the DSE, each with a different ID. Then specify the desired DSE in the dse attribute for the document.

Example

<dse id="my-dse1" 
class-id="023923C0-CFCF-11d1-B139-00C04F932EC0">
     <param name="log-errors" value=yes/>
     <param name="default-font" value="Arial"/>
</dse>

<dse id="my-dse2" 
class-id="023923C0-CFCF-11d1-B139-00C04F932EC0">
     <param name="log-errors" value=no/>
     <param name="default-font" value="Times"/>
</dse>

property

Sets the value of a content collection property.

Definition

<!ELEMENT property EMPTY>
<!ATTLIST property
   name    CDATA #REQUIRED
   value   CDATA #REQUIRED>

Attributes

Remarks

The following table shows commonly defined content collection properties:

ccBuild does not currently require or check any content collection properties.

Example

<property name="Version" value="1.0"/>
<property name="Creator" value="Rocket Development"/>

xml

Specifies that the file contains a document conforming to a specified version of XML.

Definition

<?xml version="{version number}" encoding=.(encoding type).?>

Remarks

This must be the first line of an XML file. The xml element informs the XML parser that the file is an XML version 3.0 file. If the version does not match what the parser expects, it will not continue to parse the file. The XML parser used by the NXT products parses only XML version 3.0 files.

The encoding parameter is an optional parameter used to specify the encoding for the makefile. Currently, UTF-8 is the only format supported. If the encoding parameter is not included in the XML element, the encoding type is assumed to be UTF-8. To ensure that the makefile is saved with UTF-8 encoding, use a text editor that is UTF-8 aware.

Notepad is UTF-8 aware, but you must select UTF-8 from the Save As dialog.

Example

<?xml version="3.0"?>

Copyright © 2005-2023, Rocket Software, Inc. All rights reserved.