The valid keywords are as follows (with significant characters shown in capital letters):
TYPE OF CODEBOOK TO CREATE
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
TYPE= HTML [create HTML files] PRINT2SIDE
TAGGED1SIDE [for MS Word,
1-sided printing]
TAGGED2SIDE [for MS Word,
2-sided printing]
PRINT1SIDE [Plain text for
1-sided printing]
PRINT2SIDE [Plain text for
2-sided printing]
SOURCE OF THE DATA
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
(Only one of the following two keywords can be used in the same run.)
STudy= path(s) of dataset directories Look for variables only
(can be repeated) in current directory
(or in a DDL file)
DDL= name of DDL file Look for an SDA dataset
VARIABLE LIST AND TEMPLATES
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
VARlist= filename of list of variables All variables in
(vars can be specified with alphabetical order
temporary recodes or (for an SDA study)
collapses) or in the order found
(in a DDL file)
GROUPsfile= name of file with group names No extra variable groups
and variables in each group
(HTML output only)
TEmplate= filename containing Default template used
template(s)
OUTPUT LOCATIONS
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
SAvefile= directory/prefix for output (if HTML:) hcbk
(all ignored for DDL input)
SYSMDlabel= Label for system missing-data (No Data)
(ignored for DDL input)
(overrides the "SYSMIS_LABEL"
string in the Language File)
SOURCE OF SUPPLEMENTARY, INTRODUCTORY, AND APPENDIX TEXT
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
DOCLink= filename(heading) No supplementary
for supplementary material documents
in HTML codebooks only
(can be repeated)
INTro= filename(heading) No introduction
for intro material
(can be repeated)
Appendix= filename(heading) No appendix
for appendix
(can be repeated)
CBTEXT= directory in which to find SDA study directory
the /CBTEXT subdirectory (for SDA input)
(for supplementary text) or current directory
(for DDL input)
TItle= filename of title page Default title page
FILTER AND WEIGHT VARIABLES
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
FILTer= names and codes of filter No selection filter
variables; for example:
filter=gender(1),age(18-50)
(can be repeated)
(ignored for DDL input)
Weight= name of weight variable No weighting for
(ignored for DDL input) frequencies or stats
VARIABLE FOR A STRATIFIED CODEBOOK
(Stratified codebooks are only available in HTML format.)
(Only one of the following two keywords can be used in the same run.)
ROWVAR= name of stratifying variable No row stratifier
COLUMNVAR= name of stratifying variable No column stratifier
(If 'all' is given after the name of the stratifying variable, then
all categories of the stratifying variable are shown. Otherwise,
the categories with missing data are excluded.
For example: 'rowvar=year all'.)
PROCESSING INSTRUCTIONS
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
LANGfile= name of file with non-English English labels on
labels and messages output
MAXCat= max number of categories SDA input: 40 rows
to display or 20 columns
DDL input:
all with labels
PCt= EXCLUDE [missing data in pcts] EXCLUDE [missing data]
INCLUDE [missing data]
BOTH [kinds of percents]
NOPCT [no percentages]
NONUM [no frequencies
or percentages]
(all ignored for DDL input)
SYSMDlabel= Label for system missing-data (No Data)
(ignored for DDL input)
(overrides the "SYSMIS_LABEL"
string in the Language File)
OPTIONS FOR HTML OUTPUT ONLY
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
HLINK= filename with external links
HSIZE= maximum file size 100
(in 1000's of bytes)
HEADER= name of file for header No logo or link put at
text or for logo TOP of title page and
main index pages
FOOTER= name of file for footer No logo or link put at
text or for logo BOTTOM of title page
and main index pages
FRAMes= YES (Create codebook Codebook created without
using HTML frames) HTML frames
FORMATING FOR A PLAIN TEXT FILE (ignored for tagged and HTML)
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
LINelength= number of characters in a line 72
(not counting left margin)
MARgin= number of spaces for 6
left margin
PAgelength= maximum page length (lines) 60
Multiple input studies are specified either by repeating the 'study=' keyword, or by including two or more study addresses (separated by blanks or a comma) after a 'study=' keyword.
If one or more SDA studies are specified without a matching
varlist, all variables in the studies will be included in the
codebook, in alphabetical order. If a DDL file is specified
without a matching varlist, all variables in the DDL file will be
included in the codebook, in the order in which they are found in
the DDL file.
Repetition of the `study=' keyword is allowed, as described above; however, `study=' and `ddl=' specifications cannot be mixed for the same codebook.
Multiple filter variables can be specified either by including more than one on the line after `filter=' or by using multiple `filter=' lines. (Filter specifications are ignored for DDL input.)
If other keywords are repeated, an error message will result.
type = tagged2side study = natlrace varlist = rvarlist savefile = rcodebk.txt template = template.cb title = titlefile intro = introfile # Both appendix headings will go into the table of contents # The second heading will also go into the body of the codebook # as a heading for that appendix (because of the '**'). appendix = appA(Sample Description) appendix = appB(**Description of Weighting Procedures) # Shows codes as `.' that were blank in the original data file. # Label them 'Blank - Does Not Apply'. SYSMDlabel = Blank - Does Not Apply
type = tagged2side DDL = nrace.ddl varlist = rvarlist savefile = rcodebk.txt # Note that any template references to `statistics' or # `date' (date of creation of SDA variable) will be ignored. template = template.cb title = titlefile intro = introfile appendix = appA(Sample Description) appendix = appB(**Description of Weighting Procedures)
type = tagged2side study = natlrace varlist = rvarlist savefile = rcodebk.txt template = template.cb weight = casewt filter = race(1-5) gender(1) title = titlefile intro = introfile appendix = appA(Sample Description) appendix = appB(Description of Weighting Procedures)
study = natlrace varlist = rvarlist rowvar=year savefile = race template = template.cb title = titlefile intro = general(General Introduction to the Study) intro = sponsors(Organization and Funding of the Study) appendix = note1(Codes for States and Countries) appendix = note2(Codes for Religious Denominations) # The following headings go in the body of the codebook # as well as in the index (because of the '**'). appendix = appA(**Sample Description) appendix = appB(**Description of Weighting Procedures) appendix = appC(**Outcome of Fieldwork)
| xcodebk | Full XCODEBK documentation |
| xcodebk formatting | Summary of formatting instructions for XCODEBK |