Summary
| Mentor(s): | Dr. Mike Murphy |
|---|---|
| Project Type: | Software development |
| Technologies: | Python, HTML, Git |
| Undergraduate Credit: | CSCI 399, CSCI 490 |
| Graduate Credit: | Not available |
| Locality: | Main campus and/or remote |
Purpose
The TealSite static site generator creates index data for all HTML tags encountered in a document. An author can use the abbr tag to indicate an abbreviation or acronym. Setting the title attribute on this tag allows the acronym to be expanded whenever a user hovers over it in their browser.
When reading a lot of content spread over multiple pages, it is easy for a person to forget the meaning of an acronym. Ideally, the acronym expansion would be useful to have each time an acronym is used. However, it would be exceptionally tedious to use the abbr tag each time an acronym needs to be typed. Fortunately, TealSite maintains a word index in addition to the tag index, so acronym detection is already possible.
Scope of Work
Extend TealSite to detect and add the abbr tag for acronyms found in the text nodes of a document. Matching text nodes will need to be divided around the acronym, then the acronym text will need to be wrapped into a newly-inserted abbr tag.