WWPGuide
Build Processes
There are (currently) two very different build processes and two validation processes used for the Guide. In all cases, the process is performed using the make command from some directory with some parameter. In order to make this easier, in all cases now if you go to the right directory (and you have to know or guess which is the right directory :-) ) and enter make alone, it spits out documentation about what the build or validation processes for that directory are and how to execute them.
process | directory | sample cmd |
---|---|---|
generate new schemas from ODD file, EMPB schema, and lists of keywords | .../encoding/guide/schema/ | make all |
validate existing XML | .../encoding/guide/xml/ | e.g., make relax-fast-good |
create a combined file in /tmp/ | .../encoding/guide/xml/ | make combined |
generate new HTML (from XML) | .../encoding/guide/html/ | make all |
validate existing HTML | .../encoding/guide/html/ | make valid |
Note: Schema generation will not work on machines other than golf, Syd's Mac, and maybe papa. If you want that capability on your system, we'd have to install roma the commandline tool and the TEI stylesheets, first.
Remaining gremlins to tackle
Locations of Formatting issues
- http://golf.services.brown.edu/WWP/encoding/guide/html/transcription_specialCharacters.html
I (Syd) looked at this page, and found the navigation left-hand column missing, and fixed that. (The <?HTTP-ssi #include file="navigation.xml" ?> was missing from the source XML.) However, I noticed some problems that I have tried to address:- a lot of what it says was not exactly true
- some phrase-level encoding was missing
- I tried encoding the characters being discussed as <quote><code>X</code></quote> (instead of just <quote>X</quote>) for readability; a bit of a hack, I admit.
You should take a look, as some of my wording may be clumsy. I think examples are in order, too.
- [1]
- What's wrong with the formatting? --- Syd
- I note, however, that it says "see note below" when it means "see #3, below". Not fixed yet.
- check back in on bullet points throughout
Pages that don't "exist"
http://golf.services.brown.edu/WWP/encoding/guide/html/strategy.html
footer.xml is empty
letters.collection.xml only has an example
http://golf.services.brown.edu/WWP/encoding/guide/html/text_headLabel.html
http://golf.services.brown.edu/WWP/encoding/guide/html/text_paragraph.html
http://golf.services.brown.edu/WWP/encoding/guide/html/text_scheherazade.html
http://golf.services.brown.edu/WWP/encoding/guide/html/text_structure.html
http://golf.services.brown.edu/WWP/encoding/guide/html/transcription_handwriting.html
Need P5 attention
transcription_wordLetter.xml
Need examples
text_closerTrailer.xml
text_postscript.xml
text_entries.xml
<head>Examples</head>
<div type="example">
<head>Example 1. Entries in a diary</head>
</div>
<div type="example">
<head>Example 2. Entries as subdivisions of a long letter</head>
phrase_author.xml
phrase_namesAbbreviations.xml
phrase_unknown.xml
phrase_time.xml
text_dedication.html
text_essay.html
text_frontispeice.
text_index
text_list.
text_listerrors
names of non-humans and things phrase_namesNonhuman
names: problems of nested reference phase_namesNesting
Names: problems of multiple reference phrase_namesMultiple.xml
Dates: simple encoding phrase_date...
Dates: dealing with calendars
Dates: format for the value attribute
Dates: date ranges
Dates: errors in
Dates: complex encoding
Time
Authors in Main text
Titles of other texts
Referencing Strings
Interaction of various emendation types
Syd
change xslt and CSS so that html does not show keywords in type="narrative"
done:
Other
- Need to check for duplicate xml:id= values. I just noticed that two entries have rn156. And two have rn230 also.
- Need to check for use of unexplained jargon. E.g., "each speaker needs a
separate role ID" occurs in drama_castListdetails.xml ... has the word "ID" been explained satisfactorily?
- http://golf.services.brown.edu/WWP/encoding/guide/html/phrase_overview.html does not process correctly and it does not have a corresponding xml file to correct (?) The HTML file is obsolete and should be deleted.
done, 2007-11-17:
- http://golf.services.brown.edu/WWP/encoding/guide/html/prose.html does not process correctly and it does not have a corresponding xml file to correct The HTML file is obsolete and should be deleted.
done, 2007-11-17:
- pointers and linking: need to include section about footnotes and endnotes