User's Manual

This is the user's manual for the Fweet Search Engine page. It endeavours to methodically describe and exemplify each feature appearing on the page, in the order of their appearance, in an attempt to induce a soporific effect upon the hapless reader. It partly assumes that you have already been through the introductory tutorial. The examples given below each feature are sometimes theoretical and not necessarily taken as is from the Fweet elucidation collection. Wherever a string is shown within quotation marks, the quotation marks themselves are just delimiters and do not form part of the string exemplified. If you take exception to some feature and would like to see it modified, improved or deteriorated, please send a comment.


Search String

This is the text-box in which one types the text to search for. The text is used exactly as typed, with the exception that leading spaces (i.e. all spaces before the first character), trailing spaces (i.e. all spaces after the last character) and consecutive spaces (i.e. all spaces but one between words) are discarded. Except for the special keywords described below, there are no characters with special meaning. The search string is further affected by the search options listed below.

Actions

This row of buttons allows you to perform common operations related to the searching process, as described in the bullets below.

Keywords

Special keywords – individually described below – may be used within the search string to perform more complex searches. All keywords must be written entirely in uppercase letters and be preceded and followed by at least one space to be properly identified by the search engine. All keywords are binary operators — i.e. they take two operands, one preceding the keyword, one following it. With the exception of the NEAR keyword, one may have more than one keyword within the same search string, in which case they are always processed from left to right. Note that keyword operands are in no way restricted to being single words.

AND

AND is one of the keywords supported by the search engine. It takes the form: "<1st-operand> AND <2nd-operand>", where each operand is any string that may be searched for. The effects of AND are somewhat different when searching in Fweet elucidations and when searching in Finnegans Wake text. When searching in Fweet elucidations, it will find any elucidation that contains both operands within the same elucidation, regardless of order (i.e. <1st-operand> after <2nd-operand> or vice versa), and will highlight both operands, if highlighting is turned on. When searching in Finnegans Wake text, it will find any text that contains both operands within the same one to four lines (as determined by the Text Search Distance option) of Finnegans Wake, regardless of order (i.e. <1st-operand> after <2nd-operand> or vice versa), and will highlight both operands and all the text between them, if highlighting is turned on.

NEAR

NEAR is one of the keywords supported by the search engine, and currently the most powerful one. It takes the form: "<1st-operand> NEAR <2nd-operand>", where each operand is any string that may be searched for and may well include other keywords. Unlike other keywords, the NEAR keyword may appear only once in the search string, effectively splitting the string into two sub-strings. When a search string contains the NEAR keyword, the search engine searches for the <1st-operand> as if it was a complete independent search string (including the processing of any keywords it may contain) and keeps the results in an internal table, then does the same for the <2nd-operand>. It then scans the two tables and displays only those elucidations in one table that are within the same one to four lines (as determined by the NEAR Merge Distance option) of an elucidation in the other table (and vice versa). This technique is applied regardless of the searched scope and can thus be used to find terms that are "near" each other even if they are in different scopes (e.g. one in the text of an elucidation, the other in the text of Finnegans Wake).

NEXT is one of the keywords supported by the search engine. It takes the form: "<1st-operand> NEXT <2nd-operand>", where each operand is any string that may be searched for. The effects of NEXT are exactly the same as those of THEN, except that only non-alphanumeric characters (e.g. spaces, punctuation marks), if any, are allowed between the <1st-operand> and the <2nd-operand> for the match to qualify. This keyword is often useful for finding words that may or may not be hyphenated (e.g. 'bee-hive', 'bee hive' and 'beehive' all match 'bee NEXT hive').

OR

OR is one of the keywords supported by the search engine. It takes the form: "<1st-operand> OR <2nd-operand>", where each operand is any string that may be searched for. It will find any elucidation or line of text that contains either operand (or both), and will highlight both operands, if highlighting is turned on.

THEN

THEN is one of the keywords supported by the search engine. It takes the form: "<1st-operand> THEN <2nd-operand>", where each operand is any string that may be searched for. The effects of THEN are exactly the same as those of AND, except that the <1st-operand> must come before the <2nd-operand> for the match to qualify.

Ignore Case

When this check-box is checked, the search engine ignores the case of letters in both the search string and the searched scope (elucidations or Finnegans Wake text), treating lowercase and uppercase letters as identical.

Ignore Accent

When this check-box is checked, the search engine ignores the presence of diacritics, accents and ligatures in the searched scope (elucidations or Finnegans Wake text), treating accented and unaccented letters as identical. Fweet currently supports a relatively restricted range of diacritics, accents and ligatures; see the "Diacritics" brevity of shorthands for a complete list.

Whole Words

When this check-box is checked, the search engine only compares whole words against the search string to find matches. Technically speaking, it requires that the characters immediately preceding and following the search string (or, if using special keywords, each keyword operand) in the searched scope (elucidations or Finnegans Wake text) not be alphanumeric (i.e. 'a' to 'z' or '0' to '9').

Regular Expression

When this check-box is checked, the search engine treats the search string (or, if using special keywords, each keyword operand) as a Perl-style regular expression. It is well beyond the scope of this site to teach the use of regular expressions (a kind of computer language shorthand for searching text strings), so if you do not know what these are, you can blissfully ignore this option. Note that some shorthands turn on this option; as long as you use shorthands for searching, continue ignoring this option, but if you switch from using shorthands to manually entering search strings, you may want to turn off this option, if it is on, or simply just click the "Reset All" button (although the vast majority of searches will not be affected by leaving this option on).

Natural

When this check-box is checked, elucidations are displayed exactly as they appear in the Fweet collection, with no special processing – au naturel, so to speak. Since the Fweet elucidations are full of rather cryptic shorthands, this can be inconvenient (hence, the Beautified option). This option is mainly useful, if at all, for those interested in the inner workings of the collection, perhaps preparatory to submitting elucidations of their own. Both this and the "Beautified" option may be checked at the same time, resulting in two lines per elucidation, one natural, one beautified, but this is even less useful. When this check-box is unchecked, the "Beautified" check-box is automatically checked, if it is not already so.

Beautified

When this check-box is checked, elucidations are displayed with clearer longhand terms instead of the native cryptic shorthands (as displayed by the Natural option). Beautified terms can always be identified by their exclusive use of the italic font style. Both this and the "Natural" option may be checked at the same time, resulting in two lines per elucidation, one natural, one beautified. When this check-box is unchecked, the "Natural" check-box is automatically checked, if it is not already so.

Highlight Matches

When this check-box is checked, terms matching the search string are highlighted (in red and underlined) for easier identification. Despite its seeming simplicity, this feature involves some rather complex programming when it comes to highlighting beautified elucidations and multi-line Finnegans Wake text; if you come across any unsuitable highlighting (whether morally or otherwise), please send a comment.

Show FW Text

When this check-box is checked, a line of Finnegans Wake text is shown above the elucidations belonging to that line. The text is displayed over a darker background to allow for differentiation between cryptic Finnegans Wake text and cryptic Fweet elucidations. The text shown is based on the webified version of Finnegans Wake available on Tim Szeliga's and Donald Theall's Finnegans Web website, with numerous modifications, primarily intended to adjust the text to Fweet's line numbering scheme and to correct more than a hundred misprints in the "Finnegans Web" text. If you find an error in the displayed Finnegans Wake text, vis-à-vis the printed text, please send a comment (I will forward it to Tim Szeliga if it is also relevant for "Finnegans Web", but sadly he is currently unable to correct the text on his website). Please remember that this feature is intended as an optional aid to reading the elucidations; it is no substitute for referring to (and quoting from) your own paper-based original!

Hide Summary

When this check-box is checked, the search summary paragraph usually present at the top of the search results page is not displayed. This option, suggested by Gary Yuen, is primarily intended for those using Fweet on mobile phones and similar screensize-challenged devices.

Sort Alphabetically

When this check-box is checked, the results are sorted alphabetically by elucidation text, rather than by the default page-and-line order.

Sort Alphabetically from Search String

When this check-box is checked, the results are sorted alphabetically by elucidation text, rather than by the default page-and-line order, ignoring however any text preceding the search string within the elucidation.

Get Following

When this check-box is checked, for each elucidation found by the search engine as a match for the search string, the following elucidation within the collection, if it has the same page-dot-line location, is also retrieved and displayed.

Search in Fweet Elucidations

When this check-box is checked, the search string is searched within the text of the Fweet elucidations. All elucidations matching the search criteria are then displayed. Both this and the Search in Finnegans Wake Text option may be checked at the same time, resulting in the search being conducted simultaneously on both scopes. When this check-box is unchecked, the "Search in Finnegans Wake Text" check-box is automatically checked, if it is not already so.

Search in Finnegans Wake Text

When this check-box is checked, the search string is searched within the text of Finnegans Wake. All the lines of Finnegans Wake text matching the search criteria are internally marked; then, all elucidations for each of these lines are displayed. When you perform a search using this option, the text of Finnegans Wake is displayed alongside the elucidations, even if you forgot to check the Show FW Text check-box. Both this and the Search in Fweet Elucidations option may be checked at the same time, resulting in the search being conducted simultaneously on both scopes. When this check-box is unchecked, the "Search in Fweet Elucidations" check-box is automatically checked, if it is not already so.

Also Search Related Shorthands

When this check-box is checked, the search string (or, if using special keywords, each keyword operand), in addition to being searched within the elucidations, is searched through all the content shorthands and any that match it are then also searched within the text of the Fweet elucidations. All elucidations matching the search string or any of the located shorthands are then displayed. This option is only relevant if the Search in Fweet Elucidations option is also checked.

Text Search Distance

This selection-list determines the number of lines of text of Finnegans Wake that are searched, allowing for the match to extend over more than one line. This option only affects searches within the "Finnegans Wake Text" scope and not within the "Fweet Elucidations" scope.

NEAR Merge Distance

This selection-list determines the number of lines between elucidations belonging to the two sub-searches of a search involving the NEAR keyword in order for such elucidations to qualify as being near enough to form part of the final set of results. This option only affects the merging of sub-searches associated with the NEAR keyword; it does not affect either of the two sub-searches themselves.

Font Size

This selection-list determines the relative font size of the text on the search results page (and no other page). This option, suggested by Gary Yuen, is primarily intended for those using Fweet on mobile phones and similar screensize-challenged devices.

Sans Serif

When this check-box is checked, the font type used for all the text on the search results page (and no other page) will be sans serif, rather than the default serif. This option, like several others, was suggested by Gary Yuen.

Shorthands

A shorthand is an abbreviated form used within the Fweet collection. A collection of shorthands sharing a similar subject (e.g. Languages) is referred to as a brevity of shorthands, or just a brevity. If there are other shorthands you would like to see formed, please send a comment. The effect of selecting any of the shorthands, be they text-box-based or selection-list-based, is governed by the following radio buttons: Submit, Overwrite and Append.

Submit

This radio button governs the effect of selecting any of the shorthands on the page. If this radio button is marked (i.e. on), the selected shorthand overwrites the contents of the "Search String" text-box, some of the "Search Options" check-boxes are changed to match the optimal configuration for this shorthand, and the shorthand is automatically submitted to the search engine for execution. Please refer to the Overwrite and the Append options for other possible effects.

Overwrite

This radio button governs the effect of selecting any of the shorthands on the page. If this radio button is marked (i.e. on), the selected shorthand overwrites the contents of the "Search String" text-box, some of the "Search Options" check-boxes are changed to match the optimal configuration for this shorthand, but the shorthand is not automatically submitted to the search engine for execution. After selecting a shorthand with this button marked, the mark automatically shifts to the "Append" option (as the main reason for using "Overwrite" is to follow it by an "Append"). Please refer to the Submit and the Append options for other possible effects.

Append

This radio button governs the effect of selecting any of the shorthands on the page. If this radio button is marked (i.e. on), the selected shorthand is appended to the current contents of the "Search String" text-box, some of the "Search Options" check-boxes are changed to match the optimal configuration for this shorthand, but the shorthand is not automatically submitted to the search engine for execution. Please refer to the Submit and the Overwrite options for other possible effects.

Line

This pair of text-boxes allows you to search for elucidations for a single line of Finnegans Wake. To do so, type a 1-to-3-digit page number in the left-hand box, type a 1-to-2-digit line number in the right-hand box, and step out of the boxes (e.g. by pressing "Tab" (not "Enter") or by clicking on the page's brown background (not on the "Submit Query" action button)). When you use these text-boxes, one special link (marked "Random Line") appears near the top of the results page, to allow you to jump along a path of random lines of Finnegans Wake, should you wish to do so. When you search for lines in chapter II.2, the given line number is automatically matched against the main page text, the bottom footnotes, the left marginalia, and the right marginalia.

Page

This text-box allows you to search for elucidations for a single page of Finnegans Wake. To do so, type a 1-to-3-digit page number in the box and step out of the box (e.g. by pressing "Tab" (not "Enter") or by clicking on the page's brown background (not on the "Submit Query" action button)). When you use this text-box, three special links (marked "Previous Page", "Next Page" and "Random Page") appear near the top (and bottom) of the results page, to simplify the browsing of adjacent (and random) pages of Finnegans Wake.

Chapter

This selection-list allows you to search for elucidations for an entire chapter of Finnegans Wake (or a portion of a chapter, for longer chapters). It is intended primarily as a service for people wanting to print an entire chapter's-worth of elucidations for later use in an Internet-free environment (e.g. a classroom).

Range

This quadruplet of text-boxes allows you to search for elucidations for a range of pages and lines of Finnegans Wake (i.e. from a given page-dot-line to a later page-dot-line). To do so, type 1-to-3-digit page numbers in the first (from) and third (to) boxes, type 1-to-2-digit line numbers in the second (from) and fourth (to) boxes, and step out of the boxes (e.g. by pressing "Tab" (not "Enter") or by clicking on the page's brown background (not on the "Submit Query" action button)). When you search for a range including lines of chapter II.2, the given line numbers are automatically matched against the main page text, the bottom footnotes, the left marginalia, and the right marginalia (please let me know if this is inconvenient).

Bible

This brevity contains shorthands for books of the Bible: Old Testament (in a Jewish conventional order), New Testament (in a Christian conventional order) &c. All the books of both testaments are listed, including some for which no elucidations are present. It also contains collective shorthands for all the books of the Old Testament and for all the books of the New Testament.

Books

This brevity contains shorthands for books, magazines and articles (in alphabetical order of the author's name) Joyce is known to have used as sources for Finnegans Wake (although not necessarily the exact edition listed). This list is very far from being complete, both in that there are still books mentioned within the elucidations that are not on the list and in that there are sources as yet not appearing anywhere in the collection. Unless otherwise noted, references to the books within the elucidations are by page number.

Classics

This brevity contains shorthands for classical works (in the widest sense of the term and in alphabetical order of the author's name) quoted or referred to within Finnegans Wake. This list is obviously extremely far from being complete and will be added to with time.

Clusters

This brevity contains shorthands – as usual, still a very partial list – for large or small clusters of related terms found in a relatively large proportion over a relatively small span of the text of Finnegans Wake – a few lines, a paragraph, a couple of pages (or in extreme cases, a chapter or two).

Diacritics

This brevity contains shorthands for accented letters and ligatures. It is useful, if at all, primarily with the Append option to construct search strings containing accented letters. When using shorthands from this brevity, the Ignore Accent option should be turned off, otherwise no elucidations will be found; this is automatically done by the search engine interface as soon as such a shorthand is selected.

Editorials

This brevity contains shorthands for various unrelated editorial entities that may be of some interest:

Folk Culture

This brevity contains shorthands for several loosely-related categories, such as children's games, proverbs and songs.

Joyce

This brevity contains shorthands for James Joyce's works referred to within the elucidations.

Languages

This brevity, which is rather complete, perhaps too complete, contains shorthands for the many languages appearing in Finnegans Wake.

Motifs

This brevity contains shorthands – as usual, still a very partial list – for recurring motifs found throughout the text of Finnegans Wake.

Newspapers

This brevity contains shorthands for newspapers and periodicals (in alphabetical order) Joyce is known to have used as sources for Finnegans Wake. Like the "Books" brevity, this one is also very far from being complete.

Notebooks

This brevity contains shorthands for entries from Joyce's FW notebooks (in tentative chronological order), primarily based on the highly-recommended Deane–Ferrer–Lernout Brepols edition of the Buffalo notebooks (and the addendum articles published in the GJS). This brevity also offers shorthands to select notebook entries by crayon colour (indicated by a parenthesised single letter after the notebook entry location reference, where (b) stands for blue, (g) for green, (k) for black, (o) for orange, (p) for purple, (r) for red, (w) for brown, (y) for yellow, and ( ) for uncrayoned).

Registers

This brevity contains shorthands for linguistic varieties and registers (in the widest sense of the term), such as Slang, Dialect, Dublin or World War I. These shorthands often appear in combination with each other or with "Languages" and "Folk Culture" shorthands (e.g. Anglo-Irish phrase, Triestine Italian Dialect, Dublin Slang).

Shakespeare

This brevity contains shorthands for references to the works of Shakespeare. All the plays are listed, in alphabetical order, including some for which no elucidations are present.

Sigla

This brevity contains shorthands for Joyce's major sigla. Sigla are pictorial ideograms that were used by Joyce to represent the central characters and themes of Finnegans Wake and are similarly used within the Fweet collection. The use of sigla within the elucidations is currently partial and inconsistent at best.

Symbols

This brevity contains shorthands for miscellaneous symbols appearing in the elucidations and/or in the text of Finnegans Wake, none of them extremely useful.

Utilities

As the search engine page is the central page of the site, it is also burdened with controls allowing access to utilities remotely related to the searching process (mostly just fancy links to other pages) .



[Site Map] Last Update: Jan 29 2014