PPTools/Guiguts/Guiguts Manual/Help Menu

GUIGUTS VERSION 1.5.0 MANUAL

Guiguts HELP Menu: Online and Built-in Help

Most of the topics on the HELP menu link to online resources at DP. The ones ending with [www] use your Browser to display pages at DP. In addition, when most Dialog boxes are on-screen and have the Focus, F1 (the standard HELP key) is context-sensitive, and takes you directly to the relevant topic in this Manual (when you have Internet access to DP).

• Manual -- (you're reading it now)
• Guiguts Help on DP Forum -- the "Help with: Guiguts" thread. Ask questions, get answers, review past discussions.
• Keyboard Shortcuts -- This lists every shortcut key recognized by Guiguts. The list is the file "hotkeys.txt" in the Guiguts folder of your computer. A copy of the list as it existed when this page was written is shown below.
• Regex Quick Reference -- This lists a summary of regular expression notation as used by Guiguts, some of which are extensions of the normal ones used elsewhere. The list is the file "regref.txt" in the Guiguts folder of your computer. A copy of the list as it existed when this page was written is shown below.
• Compose Sequences -- displays a list of keyboard sequences that can be used to select and insert many Unicode characters by using the Compose Key. The first few lines of that list may look something like this:
  
  • The above list shows that pressing and releasing the Compose key (defaults to the right-hand Alt key, or Alt-Gr or Control+M on a Mac) and typing into the dialog that pops up, either two spaces, or space-asterisk or asterisk-space will insert a non-breaking space; compose key followed by two exclamation marks inserts an inverted exclamation mark; to insert a cent symbol, use the compose key followed by C or c and the slash character, etc. There are hundreds of sequences pre-defined. With the exception of composing Greek, the order of the keys usually does not matter, and the keys have been chosen to hint at the character to be inserted in order to make them memorable.
    • For details and examples of using the Compose key, see Compose Key on the Tools->Character Tools sub-menu.
    • If the default Compose key (right-hand Alt key, or Alt-Gr or Ctrl-M on a Mac) conflicts with another use you already have for it, you can choose a different key or key sequence by using the Preferences>Processing>Set Compose Key. The existence of such a conflict might show as the first keystroke being lost when you start typing a Compose sequence.
      
  • List of Main Compose Sequences (there are many more than these):

Characters to type	Result
character and ` or \	character with grave accent
character and ' or /	character with acute accent
character and ^	character with circumflex
character and " or :	character with diaeresis/umlaut
character and ~, o, -	character with tilde, ring, bar
+ and accent character	Combining accent for when precomposed version not available
= and letter	plain Greek letter
=, accent character(s) and letter	accented Greek - use ( or ) first for breathing, | just before letter for iota subscript
- and space, or double -	endash or emdash
^ and 1, 2 or 3	superscript for squared & cubed
* and character	special/transformed character, e.g. *o for degree, *p for pilcrow, *. for middle dot
digit/digit	fraction
<', >' or <", >"	curly quotes
double space, or * and space	non-breaking space

• Message Log -- Displays a list of recent messages that may be useful to you or to the Developer.
• GG PP Process Checklist -- an outline of the post-processing steps.
• About Guiguts -- displays a brief statement about the purpose, licensing (GNU GPL) and partial history of Guiguts. For a more thorough list of the talented people who have developed Guiguts over the years, see one of the "Thanks" files in the Guiguts folder on your computer.
• Software Versions -- displays the identifications of the components of Guiguts you are using.
• Check for Updates -- Checks to see if a newer version is available and lets you decide what to do now and in the future:

You are up-to-date

Update available

 

• Report Bug or Suggest Enhancement -- opens a page at DP's website where you can report bugs and suggest enhancements. At that page, you either can describe the bug/enhancement, or click a link to GitHub (a website where our software developers store their programs and keep track of their activities) and describe the bug/enhancement there.

 

Keyboard Shortcuts

A printable summary of most of these keyboard shortcuts is HERE.

MAIN WINDOW

<ctrl>+x -- cut or column cut
<ctrl>+c -- copy or column copy
<ctrl>+v -- paste
<ctrl>+a -- select all
<ctrl>+o -- open file
<ctrl>+s -- save file
<ctrl>+<shift>+s -- save as
<ctrl>+<alt>+r -- open regex quick reference
<ctrl>+<alt>+v -- alternative paste method to avoid bug with Unicode characters

<shift>+mouse drag -- column select
F1 -- column copy
F2 -- column cut
F3 -- column paste

F5 -- open Word Frequency
F6 -- run Bookloupe
F7 -- spell check selection (or document, if no selection made)
F8 -- open Stealth Scannos search

<ctrl>+z -- undo
<ctrl>+y, <ctrl>+<shift>+z -- redo

<ctrl>+u -- Convert case of selection to upper case
<ctrl>+l -- Convert case of selection to lower case
<ctrl>+t -- Convert case of selection to title case

<ctrl>+d -- delete character after cursor (Delete)
<ctrl>+h -- delete character to the left of the cursor (Backspace)
<ctrl>+k -- delete from cursor to end of line
<ctrl>+<backspace> -- delete word backwards
<ctrl>+<delete> -- delete word forwards

<ctrl>+f -- open Search & Replace popup
<ctrl>+g -- continue search
<ctrl>+<shift>+g -- continue search in opposite direction
<ctrl>+b -- count number of matches
<ctrl>+<shift>+b -- quick-count number of matches to highlighted word(s)

<ctrl>+i -- view current image (as See Img button)
<ctrl>+j -- go to line
<ctrl>+p -- go to page
<ctrl>+<shift>+p -- go to page label

<ctrl>+w -- rewrap selection
<ctrl>+<shift>+w -- block rewrap selection
<ctrl>+m (or) <alt>+right arrow -- indent +1 / move column selection right
<ctrl>+<shift>+m (or) <alt>+left arrow -- indent -1 / move column selection left
<ctrl>+<alt>+m -- indent +4
<ctrl>+<alt>+<shift>+m -- indent -4
<ctrl>+e -- flood fill (if popup is open, otherwise open it)
<ctrl>+r -- surround text (if popup is open, otherwise open it)

<ctrl>+Home -- move cursor to the start of the text
<ctrl>+End -- move cursor to end of the text
<ctrl>+right arrow -- move to the start of the next word
<ctrl>+left arrow -- move to the start of the previous word
<ctrl>+up arrow -- move to the start of the current paragraph
<ctrl>+down arrow -- move to the start of the next paragraph
<ctrl>+PgUp -- scroll left one screen
<ctrl>+PgDn -- scroll right one screen

<shift>+Home -- adjust selection to beginning of current line
<shift>+End -- adjust selection to end of current line
<shift>+up arrow -- adjust selection up one line
<shift>+down arrow -- adjust selection down one line
<shift>+left arrow -- adjust selection left one character
<shift>+right arrow -- adjust selection right one character

<shift>+<ctrl>+Home -- adjust selection to the start of the text
<shift>+<ctrl>+End -- adjust selection to end of the text
<shift>+<ctrl>+left arrow -- adjust selection to the start of the previous word
<shift>+<ctrl>+right arrow -- adjust selection to the start of the next word
<shift>+<ctrl>+up arrow -- adjust selection to the start of the current paragraph
<shift>+<ctrl>+down arrow -- adjust selection to the start of the next paragraph

<ctrl>+, -- highlight all apostrophes in selection
<ctrl>+. -- highlight all double quotes in selection
<ctrl>+<alt>+h -- highlight arbitrary characters in selection
<ctrl>+; -- toggle highlighting of quotes and brackets
<ctrl>+<shift>+a -- toggle highlighting of vertical column at cursor
<ctrl>+0 -- remove all highlights

<ctrl>+1,2,3,4,5 -- go to bookmark 1,2,3,4,5
<ctrl>+<shift>+1,2,3,4,5 -- set bookmark 1,2,3,4,5

<Insert> -- Toggle insert / overstrike mode

Double-click left mouse button -- select word
Triple-click left mouse button -- select line

<shift>+click left mouse button -- adjust selection to click point
<shift>+double-click left mouse button -- adjust selection to include word clicked on
<shift>+triple-click left mouse button -- adjust selection to include line clicked on

Single click right mouse button -- pop up shortcut to menu bar

Right Alt / AltGr key -- compose character with keystrokes (<ctrl>+m on Mac)

<command>+q - quit Guiguts (Mac only)


MENUS (non-Mac)

Hold Alt to activate the menu bar, select an item by typing its underlined symbol.


POPUP DIALOGS

F1 -- Display the relevant manual page in a browser window 


SEARCH POPUP

<Enter> -- Search
<shift>+<Enter> -- Replace
<ctrl>+<Enter> -- Replace & Search
<ctrl>+<shift>+<Enter> -- Replace All


PAGE SEPARATOR POPUP

j -- Join Lines - join lines, remove all blank lines, spaces, asterisks and hyphens
k -- Join, Keep Hyphen - join lines, remove all blank lines, spaces and asterisks, keep hyphen
l -- Blank Line - leave one blank line. Close up any other whitespace (paragraph break)
t -- New Section - leave two blank lines. Close up any other whitespace (section break)
h -- New Chapter - leave four blank lines. Close up any other whitespace (chapter break)
d -- Delete - delete the page separator. Make no other edits
r -- Refresh - search for, highlight and re-center the next page separator
u -- Undo - undo the last edit
e -- Redo - redo the last undo
v -- View - view the current page in the image viewer
a -- Auto - cycle through the automatic modes (No Auto, Auto Advance, 80% Auto, 99% Auto)
? -- Help - show Page Separator Fixup help


SPELL CHECK POPUP

<ctrl>+s -- Skip word
<ctrl>+i -- Skip all/ignore word
<ctrl>+a -- Add word to Aspell dictionary
<ctrl>+p -- Add word to project dictionary 


ADJUST PAGE MARKERS POPUP

PgDn/PgUp -- move to next/previous page marker
Up/Down/Left/Right arrows -- move current page marker up/down/left/right

Regular Expression Quick Reference

For the most part, guiguts uses a standard perl regex
engine for searching. It does differ from standard for
replacement assertions however.


LEGAL REGEX SEARCH ASSERTIONS

   \       Escapes the character immediately following it
   .       Matches any single character except a newline
   ^       Matches at the beginning of the string
   $       Matches at the end of the string
   *       Matches the preceding element 0 or more times
   +       Matches the preceding element 1 or more times
   ?       Matches the preceding element 0 or 1 times
   {...}   Specifies a range of occurrences for the element preceding it
   [...]   Matches any one of the characters contained within the brackets
   (...)   Groups subexpressions for capturing to $1, $2...
   (?:...) Groups subexpressions without capturing (cluster)
   |       Matches either the subexpression preceding or following it
   \1, \2 ...  The text from the Nth group


ESCAPE SEQUENCES

These work as in normal strings.

   \f       Formfeed
   \n       Newline
   \r       Carriage return
   \t       Tab
   \0__     Any octal ASCII value
   \x__     Any hexadecimal ASCII value
   \x{263a} A wide hexadecimal value
   \c_      Control-_
   \N{name} A named character


CHARACTER CLASSES

   [amy]    Match 'a', 'm' or 'y'
   [f-j]    Dash specifies "range". Match 'f','g','h','i', or 'j'
   [f-j-]   Dash escaped or at start or end means 'dash'. Match 'f','g','h','i', 'j' or '-'
   [^f-j]   Initial caret indicates "match any character _except_ these"

The following sequences work within or without a character class. The first six are
locale aware, all are Unicode aware. The default character class equivalent are given.

   \d      A digit                     [0-9]
   \D      A nondigit                  [^0-9]
   \w      A word character            [a-zA-Z0-9_]
   \W      A non-word character        [^a-zA-Z0-9_]
   \s      A whitespace character      [ \t\n\r\f]
   \S      A non-whitespace character  [^ \t\n\r\f]

   \C      Match a byte (with Unicode, '.' matches a character)
   \pP     Match P-named (Unicode) property
   \p{...} Match Unicode property with long name
   \PP     Match non-P
   \P{...} Match lack of Unicode property with long name
   \X      Match extended unicode sequence


POSIX character classes and their Unicode and Perl equivalents:

   alnum   IsAlnum              Alphanumeric
   alpha   IsAlpha              Alphabetic
   ascii   IsASCII              Any ASCII char
   blank   IsSpace  [ \t]       Horizontal whitespace (GNU extension)
   cntrl   IsCntrl              Control characters
   digit   IsDigit  \d          Digits
   graph   IsGraph              Alphanumeric and punctuation
   lower   IsLower              Lowercase chars (locale and Unicode aware)
   print   IsPrint              Alphanumeric, punct, and space
   punct   IsPunct              Punctuation
   space   IsSpace  [\s\ck]     Whitespace
           IsSpacePerl   \s     Perl's whitespace definition
   upper   IsUpper              Uppercase chars (locale and Unicode aware)
   word    IsWord   \w          Alphanumeric plus _ (Perl extension)
   xdigit  IsXDigit [0-9A-Fa-f] Hexadecimal digit

Within a character class:

    POSIX       traditional   Unicode
    [:digit:]       \d        \p{IsDigit}
    [:^digit:]      \D        \P{IsDigit}


ANCHORS

All are zero-width assertions.

   ^  Match string start
   $  Match string end
   \b Match word boundary (between \w and \W)
   \B Match except at word boundary (between \w and \w or \W and \W)


QUANTIFIERS

Quantifiers are greedy by default -- match the longest leftmost.

   Maximal Minimal Allowed range
   ------- ------- -------------
   {n,m}   {n,m}?  Must occur at least n times but no more than m times
   {n,}    {n,}?   Must occur at least n times
   {n}     {n}?    Must occur exactly n times
   *       *?      0 or more times (same as {0,})
   +       +?      1 or more times (same as {1,})
   ?       ??      0 or 1 time (same as {0,1})

There is no quantifier {,n} -- that gets understood as a literal string.


EXTENDED CONSTRUCTS

   (?=...)          Zero-width positive lookahead assertion
   (?!...)          Zero-width negative lookahead assertion
   (?<=...)         Zero-width positive lookbehind assertion
   (?<!...)         Zero-width negative lookbehind assertion
   (?>...)          Grab what we can, prohibit backtracking


LEGAL REPLACEMENT TERM ASSERTIONS

   \$   Literal dollar sign (only necessary when it procedes a digit - \$1.00)
   \n   New line
   \t   Tab character
   \A   Make named anchor from text until \E
   \R   Convert to Roman numeral until \E
   \C   Evaluate as code until \E
   \G   Convert from transliterated Greek to Unicode until \E
   \L   Lowercase until \E
   \U   Uppercase until \E
   \T   Title case until \E
   \E   End assertion
   \IP  Insert current page number (or 999999 if none)
   $1, $2 ...  hold the Xth captured expr (Up to 8)

\*..\E constructs cannot be nested