Index page
Using Carthtml
txt\using.txt
using|right||Using CARTHTML
Here we will try to explain, step by step, how to use CARTHTML.
For a start there should be a file:
README.TXT
that explains how to install the the software and run it for the
first time. Unless you are reading this over the internet you
have already gotten that far, including preparing thes
demonstration pages.
Now you want to create some pages of your own.
There are two steps in this process.
First you need some data.
Second you need to prepare a configuration file.
These tasks are best tackled together or at least with a good
understanding of both but you probably have data that you
prepared before you stumbled on CARTHTML.
So we'll tackle that probability first.
We'll start with the data.
As was mentioned in the
Overview
The only thing that matters is the file name
so spend a few moments thinking about how you might name your files.
The trend seems to be away from the concise naming schemes that were forced
on us by the old 8.3 format dictated by DOS. However there was something
to e said for that standard, namely that it
was
a standard. It forced a consistancy that is no longer the norm but if you
did
develop your file naming habits in that environment this is going to be
easy.
The simplest data set that CARTHTML considers is the single article,
composed mostly of text and images with the occasional table or database.
All it takes to prepare such an article in the format presented in the
Demo Article
included in this set is to have all these files start with the same
characters and to tell the software what those characters are.
In the example above the string "art" was chosen so all the files had to
start with "art".
Thats all there is to it!
The files are sorted before they are assembled so you can tune things a
bit by selecting your file names so that they sort in the order you want
them presented but other than some
Formatting and Linking
options there is really nothing more you can do. If you examine the
files and file names
along with the
Demo Article
that was created from them it won't take long to figure out what is going
on.
However there are a couple of problems.
1. You probably did not prepare your paper with an ASCII editor.
and
2. You probably have it all in one big file, whereas CARTHTML does a better (or at least more complete) job with more but smaller files.
The easiest way to deal with both of these issues is to bring up the
document in whatever software you used to create it, then cut and paste the
text into an ASCII editor such as "EDIT" or "NOTEPAD" and save it using an
appropriate file name.
Easy!
To make it even easier you might want to add the CARTHTML formatting codes
to the text while it is still in the word processor. This you do by going
to the beginning of some text you want enhanced
(Bolded for instance)
(or a font change)
and press "Enter" so that it begins on a new line. Then type in "{B}"
or "{-1}" in front of it and another "Enter" at the end of the string.
There should be enough
formating options
available to satisfy those authors who actually have material to present.
The "Medium before the Message" crowd will want to look elsewhere.
This done you should chop your document into its logical groups and add
some linkages.
Start with the
images
as these require only the name change and perhaps some adjustments as to
size and format.
Name them with your starting string plus numbers so that they will be
preseneted in the order you want [string]001.gif [string].002.jpg etc.
Other support files such as
database tables and comma delimited files
are handled in the same way.
@@To be continued
and then there are the configuration files
There are two ways to create these, the easiest is to open one of the
sample files with a text editor such as "EDIT" or "NOTEPAD" and
modify it to suite. The other is to give a new name when you are
asked for a configuration file and enter the modifications as
prompted. You can get a feel for how this works by entering
"article" at the prompt (this will prepare the demoarticle as a
seperate document set).
Unfortunatly the editor for the multi page config files (.ch2)
does not yet work so for such data sets you are stuck with the
former option.
Another option is in the works in the form of a GUI
Configuration Editor
The use of this tool will be self-evident as long as you know what belongs
in the different fields so take a look at the annotated examples
configuration file .CH1
and
configuration file .CH2
and at the current configuration files
ARTICLE.CH1
,
DEMO.CH1
and
DEMO.CH2
txt\using.lst
txt\using-a1.lst
-
Annotations for Configuration File .CH1
The actual entries are bolded with the description below.
-
//////////////////// CARTHTML configuration file = demo.ch1
This section defines the set of HTML pages
-
Debug=2
Debug values currently range from 0 to 5
-
Project=demo
The value for Project is the common string with which all file names in the set start or the name of the .CH2 file that specifies these strings in the case of the multi document DataModel.
-
DataModel=
Current options include "article" and anything else.
The demo pages themselves are the later. There is a demo article among the sample documents and a stand-alone article can be created from the "demo-a" configuration file.
-
AbsoluteURL=
Not fully implemented this value will eventually insert the full URL instead of the relative URLs that are the default.
-
WebMaster=cart@nickerson.icomos.org
This becomes the mailto: at the bottom of each page and should be a valid email address of someone who knows the material.
-
////////////////////////////////////// Meta Data
This section defines the Meta Data that the search engines will use to index your material. The categories are loosly based on the Dublin Core set and will, no doubt, change as the standards stabalize.
// Dublin Core categories
// TITLE name given by the CREATOR or PUBLISHER.
// CREATOR person primarily responsible for creating the content
// SUBJECT The topic of the resource typically expressed as keywords
// DESCRIPTION A textual description of the content of the resource
// PUBLISHER Those responsible for making the resource available
// CONTRIBUTOR A person or organization not specified as a CREATOR
// DATE date made available in its present form YYYY-MM-DD
// TYPE category such as home page, novel, poem, working paper,
// FORMAT The data format of the resource
// IDENTIFIER String or number used to uniquely identify the resource
// SOURCE uniquely identify the work from which this resource was derived
// LANGUAGE Language(s) of the intellectual content
// RELATION The relationship of this resource to other resources
// COVERAGE The spatial and/or temporal characteristics of the resource
// RIGHTS copyright
-
Title=Local Publisher Demo
This is the title of the whole page set. It will appear a the top of the browser as well as at the head of the index.
-
Author=Steve Nickerson
-
KeyWords=
-
Description=
-
Publisher=
-
Contributer=
-
Classification=
-
Type=
-
Format=
-
Identifier=
-
Source=
-
Relation=
-
Rights=
-
LatLong=
-
Locality=
-
LanguageList=
If this value contains a single, 2 character, language code it will be used to identify the language of the set. If it contains a list of more than one language it will attempt to build parallel pages in each language.
-
////////////////////////////////////// Directories
This section deals with the directories the software needs to know about.
-
SourceDir=c:/carthtml/demodata
The location of your source material, everything in this directory and below will be considered for processing into the HTML set.
-
DestinDir=c:/carthtml/www/demo
The location at which to create the HTML files.
-
SkipDirs=REF
Sub-Directories under SourceDir to be ignored
-
CartDir=c:/carthtml
The location of the CARTHTML software.
-
////////////////////////////////////// Files
This section allows customization of the HTML pages
-
IndexImage=c:/carthtml/carthtml.gif
This image will appear at the top of the index of a multi page set
-
BackGImage=
This image will become the background of all right frame pages
-
IndexHeader=
In this file you can add the HTML code for colour, font, etc. that will define your index (left frame)
-
PageHeader=
In this file you can add the HTML code for colour, font, etc. that will define your right frame pages.
-
PageFooter=
In this file you can define a custom footer for all pages (left and right frames).
-
////////////////////////////////////// File Handling
This section tells the software how to deal with each file type.
-
NoHtml=ZIP,TMP,BAK,BK!
These files will be ignored unless they are mentioned in the "HtmlOrder" list below.
-
HtmlOrder=TXT,EN,FR,NUM,LST,HTM,DBF,DWF,JPG,GIF,TIF,BMP,ASR
This list defines the order in which the files will be assembled if their names are otherwise the same.
-
FootOrder=FTN,REF
Files with these extensions will always be at the end of the document in the order listed.
-
HtmlList=TXT,EN,FR,REF
Files in this list will be processed into HTML and formated as text.
-
CsvList=XLS,MDB
Files in this list require a .CSV equivalent to e turned into a table.
-
TxtList=WP5,DOC
Files in this list will be checked against the HtmlList and you will be reminded if the later are older than the former.
-
ImageList=GIF,JPG,TIF,BMP,ASR
Files in this list are treated as images. Thumbnails are created for all images and files other than .GIF and .JPG are converted to .GIFs.
-
DbfLinkList=/,HTM,GIF,JPG
When processing a database the value of each record is tested against files of these types and embedded links created if they are found. This dramatically extends processing time and should be used sparingly until time to produce the final set.
-
DbfIntList=XLS
Files of these types will become tables in the page itself (intended for short tables).
-
DbfExtList=DBF,MDB
Files of these types will become a separate set of html pages of 100 records each.
-
OrderedList=LST
Files in this list will become bullet lists in the HTML page.
-
NumberedList=NUM
Files in this list will become numbered lists in the HTML page.
-
FootnoteList=FTN
Files in this list will be treated as foot notes and placed either in the left frame or at the end of the document.
-
CaptionExt=CAP
Files with this extension will be used as the captions for images of the same name.
-
CadViewer=WHIP
This value determines which viewer to use for .DWF files. See the section on CAD files.
-
///////////// End of CARTHTML configuration file = demo.ch1
using-a1.lst
-
Annotations for Configuration File .CH1
The actual entries are bolded with the description below.
-
//////////////////// CARTHTML configuration file = demo.ch1
This section defines the set of HTML pages
-
Debug=2
Debug values currently range from 0 to 5
-
Project=demo
The value for Project is the common string with which all file names in the set start or the name of the .CH2 file that specifies these strings in the case of the multi document DataModel.
-
DataModel=
Current options include "article" and anything else.
The demo pages themselves are the later. There is a demo article among the sample documents and a stand-alone article can be created from the "demo-a" configuration file.
-
AbsoluteURL=
Not fully implemented this value will eventually insert the full URL instead of the relative URLs that are the default.
-
WebMaster=cart@nickerson.icomos.org
This becomes the mailto: at the bottom of each page and should be a valid email address of someone who knows the material.
-
////////////////////////////////////// Meta Data
This section defines the Meta Data that the search engines will use to index your material. The categories are loosly based on the Dublin Core set and will, no doubt, change as the standards stabalize.
// Dublin Core categories
// TITLE name given by the CREATOR or PUBLISHER.
// CREATOR person primarily responsible for creating the content
// SUBJECT The topic of the resource typically expressed as keywords
// DESCRIPTION A textual description of the content of the resource
// PUBLISHER Those responsible for making the resource available
// CONTRIBUTOR A person or organization not specified as a CREATOR
// DATE date made available in its present form YYYY-MM-DD
// TYPE category such as home page, novel, poem, working paper,
// FORMAT The data format of the resource
// IDENTIFIER String or number used to uniquely identify the resource
// SOURCE uniquely identify the work from which this resource was derived
// LANGUAGE Language(s) of the intellectual content
// RELATION The relationship of this resource to other resources
// COVERAGE The spatial and/or temporal characteristics of the resource
// RIGHTS copyright
-
Title=Local Publisher Demo
This is the title of the whole page set. It will appear a the top of the browser as well as at the head of the index.
-
Author=Steve Nickerson
-
KeyWords=
-
Description=
-
Publisher=
-
Contributer=
-
Classification=
-
Type=
-
Format=
-
Identifier=
-
Source=
-
Relation=
-
Rights=
-
LatLong=
-
Locality=
-
LanguageList=
If this value contains a single, 2 character, language code it will be used to identify the language of the set. If it contains a list of more than one language it will attempt to build parallel pages in each language.
-
////////////////////////////////////// Directories
This section deals with the directories the software needs to know about.
-
SourceDir=c:/carthtml/demodata
The location of your source material, everything in this directory and below will be considered for processing into the HTML set.
-
DestinDir=c:/carthtml/www/demo
The location at which to create the HTML files.
-
SkipDirs=REF
Sub-Directories under SourceDir to be ignored
-
CartDir=c:/carthtml
The location of the CARTHTML software.
-
////////////////////////////////////// Files
This section allows customization of the HTML pages
-
IndexImage=c:/carthtml/carthtml.gif
This image will appear at the top of the index of a multi page set
-
BackGImage=
This image will become the background of all right frame pages
-
IndexHeader=
In this file you can add the HTML code for colour, font, etc. that will define your index (left frame)
-
PageHeader=
In this file you can add the HTML code for colour, font, etc. that will define your right frame pages.
-
PageFooter=
In this file you can define a custom footer for all pages (left and right frames).
-
////////////////////////////////////// File Handling
This section tells the software how to deal with each file type.
-
NoHtml=ZIP,TMP,BAK,BK!
These files will be ignored unless they are mentioned in the "HtmlOrder" list below.
-
HtmlOrder=TXT,EN,FR,NUM,LST,HTM,DBF,DWF,JPG,GIF,TIF,BMP,ASR
This list defines the order in which the files will be assembled if their names are otherwise the same.
-
FootOrder=FTN,REF
Files with these extensions will always be at the end of the document in the order listed.
-
HtmlList=TXT,EN,FR,REF
Files in this list will be processed into HTML and formated as text.
-
CsvList=XLS,MDB
Files in this list require a .CSV equivalent to e turned into a table.
-
TxtList=WP5,DOC
Files in this list will be checked against the HtmlList and you will be reminded if the later are older than the former.
-
ImageList=GIF,JPG,TIF,BMP,ASR
Files in this list are treated as images. Thumbnails are created for all images and files other than .GIF and .JPG are converted to .GIFs.
-
DbfLinkList=/,HTM,GIF,JPG
When processing a database the value of each record is tested against files of these types and embedded links created if they are found. This dramatically extends processing time and should be used sparingly until time to produce the final set.
-
DbfIntList=XLS
Files of these types will become tables in the page itself (intended for short tables).
-
DbfExtList=DBF,MDB
Files of these types will become a separate set of html pages of 100 records each.
-
OrderedList=LST
Files in this list will become bullet lists in the HTML page.
-
NumberedList=NUM
Files in this list will become numbered lists in the HTML page.
-
FootnoteList=FTN
Files in this list will be treated as foot notes and placed either in the left frame or at the end of the document.
-
CaptionExt=CAP
Files with this extension will be used as the captions for images of the same name.
-
CadViewer=WHIP
This value determines which viewer to use for .DWF files. See the section on CAD files.
-
///////////// End of CARTHTML configuration file = demo.ch1
txt\using-a2.lst
using-a2.lst
using0.lst
-
DEMO-A.CH1 config file
-
//////////////////// CARTHTML configuration file = article.ch1
-
Debug=2
-
Project=article
-
DataModel=article
-
AbsoluteURL=
-
WebMaster=cart@nickerson.icomos.org
-
////////////////////////////////////// Meta Data
-
Title=Article Demo (local)
-
Author=Steve Nickerson
-
KeyWords=
-
Description=
-
Publisher=
-
Contributer=
-
Classification=
-
Type=
-
Format=
-
Identifier=
-
Source=
-
Relation=
-
Rights=
-
LatLong=
-
Locality=
-
LanguageList=
-
////////////////////////////////////// Directories
-
SourceDir=c:\carthtml\demodata\article
-
DestinDir=c:\carthtml\www\article
-
ReferenceDirs=REF
-
CartDir=c:\carthtml
-
////////////////////////////////////// Files
-
IndexImage=c:\carthtml\demodata\article\cartloga.gif
-
BackGImage=
-
IndexHeader=c:\carthtml\index.hdr
-
PageHeader=c:\carthtml\page.hdr
-
PageFooter=c:\carthtml\page.ftr
-
////////////////////////////////////// File Handling
-
NoHtml=XLS,BAK,TMP,CDF,HDF,CAP,ZIP,WP5,BK!
-
HtmlOrder=HTM,TXT,EN,FR,NUM,LST,DBF,DWF,JPG,GIF,TIF,BMP,ASR
-
FootOrder=FTN,REF
-
HtmlList=TXT
-
CdfList=DBF
-
CsvList=XLS,MDB
-
TxtList=WP5,DOC
-
ImageList=GIF,JPG,TIF,BMP,ASR
-
DbfLinkList=/,HTM,GIF,JPG
-
DbfIntList=DBF
-
DbfExtList=CSV
-
OrderedList=LST
-
NumberedList=NUM
-
FootnoteList=FTN
-
CaptionExt=CAP
-
CadViewer=whip
-
///////////// End of CARTHTML configuration file = article.ch1
using1.lst
-
DEMO.CH1 config file
-
////////////////////CARTHTML configuration file = demo.ch1
-
Project=demo
-
DebugMode=3
-
Language=
-
LatLong=
-
Title=CARTHTML Publisher Demo
-
Keywords=HTML,automatic,bulk publisher";
-
Author=Steve Nickerson
-
IndexFile=DEMO.ch2
-
////////////////////Meta Data
-
Language=
-
Description=An automatic HTML publisher for large, structured data sets
-
Classification=
-
Publisher=CART Computer Aided Recording Tools
-
Contributer=
-
Type=
-
Format=
-
Identifier=
-
Source=
-
Relation=
-
Locality=
-
Rights=135479 Canada Limited
-
////////////////////Directories
-
SourceDir=c:\carthtml\demodata
-
DestinDir=c:\carthtml\www\demo
-
SkipDirs=ignore
-
WebMaster=cart@nickerson.icomos.org
-
AbsoluteURL=http://nickerson.icomos.org/carthtml/www/demo
-
////////////////////Files
-
IndexImage=c:\carthtml\carthtml.gif
-
BackGImage=
-
IndexHeader=
-
IndexFooter=
-
PageHeader=
-
PageFooter=
-
////////////////////DBF Files
-
DbfLinkList=/,HTM,GIF,JPG
-
DbfIntList=XLS
-
DbfExtList=DBF,MDB
-
CsvList=XLS,MDB
-
DbfDir=
-
////////////////////HTML Files
-
HtmlOrder=TXT,EN,FR,NUM,LST,HTM,DBF,DWF,JPG,GIF,TIF,BMP,ASR
-
FootOrder=FTN,REF
-
NoHtml=ZIP,TMP,BAK,BK!
-
HtmlList=TXT,EN,FR,REF
-
TxtList=WP5,DOC
-
LanguageList=
-
////////////////////Special Files
-
CadViewer=WHIP!
-
OrderedList=LST
-
NumberedList=NUM
-
FootnoteList=FTN
-
CaptionExt=CAP
-
ImageList=GIF,JPG,TIF,BMP,ASR
using2.lst
-
DEMO.CH2 config file
-
cover|Cover||DEMO Cover Page
-
over|Right||{I}Overview
-
usin|right||Using CARTHTML
-
conf|article||Configuration Editor
-
|||{I}Text Handling
-
text|right||Text Files
-
form|right||Text Formatting
-
/*empty.jpg*empty|Right||No image or files available
-
/*c:\carthtml\cartlogw.gif*|Right||No code, valid image
-
/*c:\carthtml\cartlogw.gif*full|Right||Image available but no files
-
*c:\carthtml\cartlogw.gif*imag|right|imag.htm|Image Files
-
dbf|right||Database Tables
-
dwf|right||CAD Files
-
htm|right||HTML files
-
ftp|right||Download
-
art|article||Demo Article
-
file|right||Files & File Names
-
error|right||Error Conditions
-
|right|http://nickerson.icomos.org/steve/|{I}About the Author
using3.lst
-
DEMO-A.CH1 config file
-
// Build 931983782L
-
//////////////////// CARTHTML configuration file: demo-a.ch1
-
//////////////////// Thu Jul 15 19:28:05 1999
-
DebugMode=5
-
AutoStart=1
-
Project=article
-
IndexFile=Article
-
Title=Article Demo (local)
-
Keywords=
-
Author=Steve Nickerson
-
AbsoluteURL=
-
WebMaster=cart@nickerson.icomos.org
-
LatLong=
-
LanguageList=
-
//////////////////// Meta Data
-
Language=
-
KeyWords=
-
Description=
-
Publisher=
-
Contributer=
-
Classification=
-
Type=
-
Format=
-
Identifier=
-
Source=
-
Relation=
-
Rights=
-
LatLong=
-
Locality=
-
LanguageList=
-
//////////////////// Directories
-
SourceDir=c:\carthtml\demodata\article
-
DestinDir=c:\carthtml\www\article
-
SkipDirs=
-
//////////////////// Files
-
IndexImage=c:\carthtml\carthtml.gif
-
BackGImage=C:\carthtml\demodata\ARTICLE\art_1001.gif
-
IndexHeader=C:\carthtml\index.hdr
-
PageHeader=C:\carthtml\page.hdr
-
PageFooter=C:\carthtml\page.ftr
-
//////////////////// File Handling
-
NoHtml=ZIP,TMP,BAK,BK!
-
HtmlOrder=TXT,EN,FR,NUM,LST,HTM,DBF,DWF,JPG,GIF,TIF,BMP,ASR
-
FootOrder=FTN,REF
-
HtmlList=TXT,EN,FR,REF
-
CsvList=XLS,MDB
-
TxtList=WP5,DOC
-
ImageList=GIF,JPG,TIF,BMP,ASR
-
DbfLinkList=/,HTM,GIF,JPG
-
DbfIntList=XLS
-
DbfExtList=DBF,MDB
-
OrderedList=LST
-
NumberedList=NUM
-
FootnoteList=FTN
-
CaptionExt=CAP
-
CadViewer=WHIP!
-
//////////////////// End of CARTHTML configuration file
using4.lst
-
DEMO-C.CH1 config file
-
// Build 931382858L
-
//////////////////// CARTHTML configuration file: demo-c.ch1
-
//////////////////// Wed Jul 07 21:49:16 1999
-
DebugMode=2
-
AutoStart=1
-
Project=demo
-
IndexFile=demo-c.ch2
-
Title=Local Publisher Demo
-
Keywords=
-
Author=Steve Nickerson
-
AbsoluteURL=
-
WebMaster=cart@nickerson.icomos.org
-
LatLong=
-
LanguageList=
-
//////////////////// Meta Data
-
Language=
-
Description=
-
Publisher=
-
Contributer=
-
Classification=
-
Type=
-
Format=
-
Identifier=
-
Source=
-
Relation=
-
Rights=
-
LatLong=
-
Locality=
-
LanguageList=
-
//////////////////// Directories
-
SourceDir=N:
-
DestinDir=N:
-
SkipDirs=RECYCLED,THUMBDIR
-
//////////////////// Files
-
IndexImage=N:\cart_dev\GIF\Achair-1.gif
-
BackGImage=N:\cart_dev\GIF\Humsheet.gif
-
IndexHeader=C:\carthtml\Index.hdr
-
PageHeader=C:\carthtml\Page.hdr
-
PageFooter=
-
//////////////////// File Handling
-
NoHtml=*,
-
HtmlOrder=GIF
-
FootOrder=
-
HtmlList=TXT,EN,FR,REF
-
CsvList=
-
TxtList=
-
ImageList=GIF,asr,jpg
-
DbfLinkList=/,HTM,GIF,JPG
-
DbfIntList=
-
DbfExtList=
-
OrderedList=
-
NumberedList=
-
FootnoteList=
-
CaptionExt=
-
CadViewer=
-
//////////////////// End of CARTHTML configuration file
using5.lst
-
DEMO-C.CH2 config file
-
x-x-x|cover||GIF Test
-
a|left||A*.gif
-
b|left||B*.gif
-
c|left||C*.gif
-
d|left||D*.gif
-
e|left||E*.gif
-
f|left||F*.gif
-
g|left||G*.gif
-
h|left||H*.gif
-
i|left||I*.gif
-
j|left||J*.gif
-
k|left||K*.gif
-
l|left||L*.gif
-
m|left||M*.gif
-
n|left||N*.gif
-
o|left||O*.gif
-
p|left||P*.gif
-
q|left||Q*.gif
-
r|left||R*.gif
-
s|left||S*.gif
-
t|left||T*.gif
-
u|left||U*.gif
-
v|left||V*.gif
-
w|left||W*.gif
-
x|left||X*.gif
-
y|left||Y*.gif
-
z|left||Z*.gif
Files Referenced for usin
c:\carthtml\demodata\TXT\USING.TXT
c:\carthtml\demodata\TXT\USING.LST
c:\carthtml\demodata\TXT\USING-A1.LST
c:\carthtml\demodata\using-a1.lst
c:\carthtml\demodata\TXT\USING-A2.LST
c:\carthtml\demodata\using-a2.lst
c:\carthtml\demodata\USING0.LST
c:\carthtml\demodata\USING1.LST
c:\carthtml\demodata\USING2.LST
c:\carthtml\demodata\USING3.LST
c:\carthtml\demodata\USING4.LST
c:\carthtml\demodata\USING5.LST
Up
Index
Cover
Inquiries to:
cart@nickerson.icomos.org
Generated Tue Nov 09 08:54:04 1999
by: CART
[Compiled: Tue Nov 09 08:43:43 1999(vC++)]