#ifndef HelpText_h #define HelpText_h /****************************************************************************** * * Copyright (C) 2002 Hugo PEREIRA * * This is free software; you can redistribute it and/or modify it under the * terms of the GNU General Public License as published by the Free Software * Foundation; either version 2 of the License, or (at your option) any later * version. * * This software is distributed in the hope that it will be useful, but WITHOUT * Any WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * for more details. * * You should have received a copy of the GNU General Public License along with * this program. If not, see . * *******************************************************************************/ #include //* help text static const QString helpText[] = { //_________________________________________________________ QObject::tr( "Introduction" ), QObject::tr( "

Introduction

QEdit is a Graphical text editor designed for text files and programming source files. it provides standard menus, dialogs, toolbars and shortcut to perform all actions related to text editing and offers contextual support for easier editing of various programming languages files, such as:

  • C/C++;
  • Makefiles and shell scripts;
  • Perl scripts;
  • HTML and XML;
  • diff files.

Each of the above is considered as a Document Class and associated to a set of syntax highlighting patterns, indentation rules, text edition macros, and parenthesis matching highlighting.

QEdit is highly customizable to fit a wide range of editing habits. Most of its features have been ported from existing text editors, such as Emacs or NEdit, although not all of the features of the previous two editors can be found. Some features have been originally designed for QEdit that cannot be easily found in the above two editors, such as:

  • an original interface to aspell for spell checking, either using a dialog or via syntax highlighting of the misspelled words;
    • " "
  • an independent thread to perform periodic backups of the edited files in the /tmp directory rather than in the working directory
    • " "
  • an independent thread to list and check the validity of previously opened files.
    • " "
  • an editable help system, that allows any user to add his own experience with the editor.
    • " "
  • vertically, horizontally or combined multiple view system that allow more efficient comparison between sections of files. Multiple views allow to display either duplicated (and synchronized) copy of the same file (as in NEdit), or different files, as in Emacs.
    • " "

QEdit is based on Qt and is nicely integrated in a KDE or Gnome environment by adopting the same look and feel appearance as the current desktop." ), //_________________________________________________________ QObject::tr( "Main Window" ), QObject::tr( "

Text Edition Main Window

This section describes the most useful features of the main edition window. More details are given elsewhere in the dedicated sections of this help.

Cut, Copy and Paste

Cut, Copy and Paste actions are available either from the toolbar, the Edit menu, the pop-up menu opened when right-clicking on the text, or the Ctrl+X Ctrl+C and Ctrl+V key accelerators, respectively. The Cut and Copy actions are enabled only if there is an active selection in the current editor. The paste action is enabled only if some text is available from the clipboard.

Undo and Redo

Undo and Redo actions are available either from the toolbar, the Edit menu, the pop-up menu opened when right-clicking on the text, or the Ctrl+Z and Shift+Ctrl+Z key accelerators, respectively. The undo/redo lists are kept synchronized between multiple views of the same files. The actions above are enabled only when undoing/redoing is available in the history.

Automatic indentation

Automatic indentation is available for document classes associated to some file types, such as c/c++ and Perl script files. It is configurable in the corresponding document classes input file loaded at start-up. When enabled, automatic indentation rules are applied on the current line by pressing the Tab character. It is also performed when the return key is pressed, to start a new line. Automatic indentation can be disabled either in the Default Configuration dialog, in which case it will be disabled for all the following edition sessions, or in the Settings menu, in which case it is disabled for the current session only.

Text selection

Normal selection starts when the left button of the mouse is pressed. It is modified (extended or reduced) by moving the mouse pointer with the left button still pressed. The selection ends and is copied to the selection clipboard when the button is released. A drag and drop system allows to move the selected text either in the same window or in a separated file.

Box selection is available provided that the font used for editing has a fixed width. Box selection starts when the left button of the mouse is pressed together with the Ctrl key, and modified by moving the mouse pointer with the above still pressed. The selection ends and is copied to the selection clipboard when either the left mouse button or the Control key is released. The cut, copy and paste actions, as well as the drag and drop ability are also available for box selection.

Automatic save

Automatic save of the file is performed at fixed interval of time when the text is modified. It is handled by a separate thread in order not to create any overhead. The auto saved files are located by default in the /tmp directory and recovered automatically in case the editing session ends abruptly.

Automatic spell checking

Automatic spell checking can be turned on in the Settings menu. It replaces (temporarily) any syntax highlighting patterns and identifies all words that are misspelled in the current text. Correctly spelled words can be selected and used as a replacement when right-clicking on a misspelled word. The dictionary language and document class associated to the spell-checker is modified in the Settings menu. Selected dictionaries and filter are stored together with the opened file history. When no values are found, default values are used, that can be modified in the Default Configuration dialog.

Printing

Printing is achieved via built-in Qt's printing support. Syntax highlighted patterns are also rendered to the output document.

" ), //_________________________________________________________ QObject::tr( "Main Menu" ), QObject::tr( "

Main Menu

The Main Menu is located at the top of the editor. It contains the following sub-menus:

File menu

The File menu provides basic file operations, such as New/Open/Save/Print and the corresponding key accelerators, as well as the management of multiple views in the current window. Pressing the Close button closes the current edition window. Pressing the Exit button closes all edition windows and exit QEdit. The following two features are also available:

  • the possibility to open an old file, based on an historic of all opened files. The size of the historic is set in the Default Configuration dialog. Only the most recently opened files are kept. Previously opened files that cannot be found on disk appear in grey in the corresponding sub-menu. They will be discarded from the historic at the next session. They can also be manually removed by pressing the Clean button at the top of the sub-menu.
    • " "
  • the possibility to manually assign the document class of the current file by selecting the class name in the corresponding sub-menu, in place of the default document class assigned based on either the file extension or its contents.
    • " "

Edit menu

the Edit menu provides basic edition operations, such as Undo/Redo, Cut/Copy and Paste of the current selection and conversion to upper/lower case, as well as the corresponding key accelerators.

Search menu

the Search menu provides text find/replace operations and the possibility to select a paragraph by its line number in the text, as well as the corresponding key accelerators.

Settings menu

The settings menu contains QEdit Default Configuration dialog and the Spell Check Configuration dialog that defines which language and file type is used for spell checking (this feature is available only if QEdit was compiled with aspell support). Several check boxes are also provided to control which features of the current document class should be enabled/disabled in the current session.

Tools menu

The Tools menu provides high-level text modification macros and edition utilities that are common to all document classes. Such macros apply to large portion of the text and perform actions such as text indentation, spell checking (via a pop-up dialog), diff of opened files, etc.

Macro menu

  • The Macro menu contains high level edition macros associated to the current document class. Such macros usually apply to large portion of the text and perform actions such as applying comments (as specified by the document class language), adding/removing tabulations, cleaning the end of line from empty spaces, etc. The Spell check button opens the spell checking dialog used to correct all misspelled words in the document (this feature is available only if QEdit was compiled with aspell support). Some of the macros are associated to key accelerators depending on the current document class configuration file;

    Window menu

    The Window menu provides information about the active edit file and fast access to all other edited files in the session.

    Help menu

    the Help menu provides access to this help, displays information on the version of QEdit that is being used, and the version of Qt against which it was compiled. It also has a debug sub-menu used for maintenance.

    " ), //_________________________________________________________ QObject::tr( "Toolbars" ), QObject::tr( "

    Toolbars

    Several toolbars are located (by default) at the top of the editor window to provide easy access to the most commonly used features. They are:

    • the File toolbar, used to create a new file, edit an existing file, save an edited file, and print the current file (either to postscript or to a printer). The same actions are available in the File menu.
      • " "
    • the Edition toolbar, used to cut, copy or paste the current text selection, and undo/redo the last actions. The same actions are available in the Edit menu.
    • the Tools toolbar, used to open the spell checking dialog and display information on the currently edited file.
      • " "
    • the Multiple views toolbar, used to clone the current file in the separate view, open a new file in a separate view, close the current view, or detach the current view to make it an independent window. The same actions are available in the File menu.

    By right-clicking on the toolbars a menu is opened that allows to show/hide the displayed toolbars. The toolbars can also be dragged and dropped around the editor window to change their location. The default visibility and location of the toolbars can be set in the configuration dialog, under the toolbars tab." ), //_________________________________________________________ QObject::tr( "Status bar" ), QObject::tr( "

    Status Bar

    The status bar is located at the bottom of the editor window and displays the full name of the current edited file, the position of the cursor in the text, as well as the current date and time. The file name can be selected by double clicking on it and copied to the clipboard for use in other applications.

    " ), //_________________________________________________________ QObject::tr( "Default Configuration" ), QObject::tr( "

    Default Configuration

    The default configuration dialog is accessible from the Settings menu. It consists of several tabs in which a large set of options can be modified by the user to suit his editing habits.

    Base

    the Base tab allows to modify the font used to display the widgets and the text; the application icon, the location where the toolbar icons are found (since the name of the toolbar icons match the one used for most of the desktop icon themes, this option allows to pick a set of icons that match the current desktop icon theme. Besides, it allows to try find additional icons that are foreseen in QEdit, but not included in the distribution); the appearance of the toolbar buttons, and the background color of the items displayed in lists.

    Document classes

    the Document classes tab allows to specify from which files the document classes used to define the set of actions associated to a specific file type are loaded. Such files are written in XML format and can be edited by hand. New files can be added and loaded in place of the default. Future versions of QEdit should have a Document class manager that allows for easier editing of these files.

    Display

    The Display tab allows which features of the document classes should be enabled by default. This includes the syntax highlighting, the matching parenthesis highlighting, the automatic indentation, tab emulation, etc. It also allows to configure some of the colors used for the highlighting.

    Multiple views

    The Multiple views tag allows to configure the default open mode of QEdit (either in a new window or as a new view in an existing window, as well as the default orientation (horizontal or vertical) of new views in a window. The corresponding buttons in the Multiple views toolbar allows to change this default behavior for the current session only.

    A different color can be used as a background for inactive views as opposed to the active view, to make the later more easily identifiable. This color is also configurable here.

    Toolbars

    The Toolbars tab allows to decide which toolbars should be visible/hidden by default in every new window, as well as the side of the window at which they should appear

    Misc

    the Misc (miscelaneous) tab allows to modify additional settings that don't enter the above categories such as: the backup and auto-save configurations, the default window size and the sorting of the previously opened files in the Open previous menu.

    " ), //_________________________________________________________ QObject::tr( "Document Classes" ), QObject::tr( "

    Document Classes

    \n" "

    Document classes consist of a set of recognition patterns associated to a different type of files and used to facilitate its editing. The different patterns cover: \n" "

      \n" "
    • syntax highlighting patterns;
      • \n" "
    • indentation rules;
      • \n" "
    • text edition macros;
      • \n" "
    • matching parenthesis highlighting
      • \n" "
    • and logical blocks markers.
      • \n" "
    \n" "

    The following type of files are supported by default:\n" "

      \n" "
    • C/C++;
    • Makefiles and shell scripts;
      • \n" "
    • Perl scripts;
      • <\n" "li>HTML and XML;
    • diff files.
      • \n" "
    \n" "

    Each document class is defined in an external XML file loaded at start-up and associated to the file being edited. By default, the association between a file and its document class is based on the file extension or the contents of its first lines. This association can be changed manually via the Set document class sub-menu in the File menu. The list of files that are loaded at start-up is configurable in the Default configuration dialog accessible from the Settings menu. " ), //_________________________________________________________ QObject::tr( "Logical block markers" ), QObject::tr( "

    Logical block markers

    \n" "\n" "

    For some document classes, blocks of text are well separated in logical structures. For instance, c/c++ logical structures are delimited by curly brackets, while LaTeX structures are delimited by begin and end tags.

    \n" "

    QEdit offers the possibility to identify these structures and represents them as vertical segments located at the left of the edition window. Such segments are called block delimiters. When available, these delimiters can be made visible by checking the corresponding option in the Settings menu, or in the Default configuration dialog.

    \n" "

    When visible, logical structures can be collapsed or expanded at will by clicking on the marker corresponding to the beginning of each block delimiter, or by selecting the corresponding action in the menu.

    \n" "

    When a logical block is collapsed, only its first line is displayed in the editor window, and an horizontal line is drawn to indicate that some text is hidden at this location. The first line is still editable. However, when one deletes this line, the full logical block gets erased.

    \n" "

    In the current implementation, the action of expanding or collapsing one or several logical blocks is included in the undo/redo history. This allows notably to easily recover from inconsiderate removal of collapsed blocks. As a side effect, such actions mark the file as modified even if its contents is actually unchanged. It is unfortunate, but harmless.

    \n" "" ), //_________________________________________________________ QObject::tr( "Spell Check Configuration" ), QObject::tr( "

    Spell Check Configuration

    The spell check configuration dialog is accessible from the Settings menu. It is divided in two boxes. The first box is dedicated to the general configuration of the spell checker and contains the following options:

    • the dictionary which defines the language used for spell checking
      • " "
    • the filter which defines the type of file that is being checked. For each file type, specific keywords (such as commands for a LaTeX file) are discarded from the spell checking;
      • " "
    • the aspell command (as typed from the command line in any terminal), which is used to retrieve the default list of dictionaries and filters.
      • " "

    The second box is dedicated to the automatic spell checking configuration and contains the following options:

    • the maximum number of suggestions displayed in the pop-up menu opened by right clicking on a misspelled word when automatic spell checking is enabled;
      • " "
    • the font color and format (bold, underline, italic, ...) used to highlight misspelled words when automatic spell checking is enabled;
      • " "

    Modifications to the settings available in the spell check configuration dialog apply to the current edition session and all later sessions. The filter and dictionary used for the current file can also be modified in the Settingsmenu directly. The modifications performed to these menus apply to the current file only.

    The spell checking of the current document is performed either using the interactive dialog accessible from the Macro menu, or by selecting the automatic spell check button in the Settings menu.

    " ), //_________________________________________________________ QObject::tr( "Automatic Spell Check" ), QObject::tr( "

    Automatic Spell Check

    The automatic spell check is turned on/off in the Settings menu. when enabled, the current syntax highlighting is turned off and misspelled words are (by default) shown in red and underlined. Right clicking on a misspelled word opens a menu where a list of correctly spelled suggestions is displayed that can be used to replace the current word. Alternatively, the misspelled word can be ignored, meaning that it will not appear red anymore, as long as this edition session is active, or added to the dictionary, meaning that it will be considered correctly spelled for this session and all the following (as well as for other applications using aspell).

    The dictionary used by the automatic spell check, the syntax highlighting pattern used for misspelled words as well as the document type (used to define a set of words to be ignored, such as commands in a LaTeX file), are selected in the Settings menu." ), //_________________________________________________________ QObject::tr( "Printing" ), QObject::tr( "

    Printing

    The print dialog is opened using the print button in either the toolbar or the File menu. Printing is achieved using built-in Qt's printing support. Syntax highlighting patterns are also rendered to the output document.

    " ), //_________________________________________________________ QObject::tr( "Tab Emulation" ), QObject::tr( "

    Tab Emulation

    Tab emulation is used to replace the standard tab character by a fixed amount of space characters. This is useful for portability of the edited document with respect to other applications, such as Emacs. By default tab emulation is on. Tab emulation is enabled/disabled in the Default configuration window. The number of space characters used as a replacement when emulation is on is also selected there.

    The automatic text indentation rules generally depend on the number of leading tab characters found in the previous paragraph. It uses the current tab emulation setup to determine the number of tab characters. So that indentation is only accurate for a document that uses the same convention for tab characters as the current setup of QEdit. In case of inconsistency, one can either

    • change the editor setting to match the edited file;
    • or use the replace in window command with the correct selection and replacement strings to modify the edited text so that it matches the current editor configuration

    Additionally, a text macro called Replace leading tabs is found in the tools menu, which replaces all true leading tab characters with the current emulated tabs." ), //_________________________________________________________ QObject::tr( "Regular Expressions" ), QObject::tr( "

    Regular Expressions

    Regular expressions provide an efficient way of looking for complicated patterns in a text, using a compact syntax which is interpreted by the Qt built-in regular expression engine. Regular expressions are used extensively to define the syntax highlighting patterns, indentation rules and matching parenthesis in the document class configuration files. In general QEdit users do not need to know about the syntax used by regular expressions unless they wish to modify the document classes configuration files or create a new one.

    Regular expressions can also be used in the editor find and replace dialogs to find text patterns more sophisticated than simple words.

    The syntax used for regular expression is documented elsewhere on the web and notably in the Qt on-line documentation page. " ), //_________________________________________________________ QObject::tr( "Multiple Views" ), QObject::tr( "

    Multiple Views

    Multiple views have two usage:

    • they allow to display different sections of the same file in a single editor window.
    • they allow to display different files in the same window.

    Multiple views of the same file are opened either via the clone button in the File menu, in which case the layout (vertical or horizontal) of the new view is controlled by the default orientation option from the default configuration dialog, or directly via the Multiple views toolbar.

    When multiple views are opened, the text appearing in the two view is automatically synchronized. Modifications performed to one of the view is immediately ported to the second. Matching parenthesis highlighting is also common to both views, which allows to check for closing parenthesis after large sections of text by looking for the matching parenthesis in the other window.

    Multiple views of different files are opened either from the usual open, open previous and new buttons in the File menu, provided that the default open mode in the default configuration dialog is set to open in new view, or via the Multiple views toolbar. When two different files are opened in the same window, they can be diffed (using the command-line diff command) to highlight conflict or added text blocks." ), //_________________________________________________________ QObject::tr( "Automatic Backup" ), QObject::tr( "

    Automatic Backup

    To prevent loss of information and enforce file recovery whenever the application is terminated abruptly, an automatic save of the files is performed on a regular basis in the /tmp directory.

    The backup file name is constructed based on the original file name and the user editing it. For instance, the file

    /home/hpereira/QEdit/src/HelpText.h

    edited by user hpereira is backed up at

    /tmp/hpereira_home_hpereira_src_QEdit_HelpText.h.

    The file can be later recovered either by hand or using QEdit directly, since QEdit always check at start-up if there a backup file with a later modification time than the one of the file being opened.

    The default backup time interval is 20 seconds and can be modified in the default configuration dialog. The default directory where the backup files are saved can also be modified from there.

    Backup are performed only when the file has actually been modified. They are handled in a separate thread so that they don't create any overload." ), //_________________________________________________________ QObject::tr( "Mouse Buttons" ), QObject::tr( "

    Mouse Buttons

    By default the mouse buttons are associated to the following actions:

    • Pressing the left button gives focus to a display, places the cursor at the mouse position, and clears any selection in the display. Moving the mouse while the left button is pressed selects the text following the cursor and copies it to the selection clipboard. The selection ends when the button is released. A double click with the left button selects the word pointed to by the mouse. A triple click selects the entire paragraph. A quadruple click selects the whole text.
      • " "
    • Pressing the middle button places the cursor at the mouse position and insert a copy of the currently selected text or the selection clipboard, if any. Moving the mouse with the Middle button pressed moves the cursor accordingly. The selection is copied to the display when the button is released, at the place where the cursor is.
      • " "
    • Pressing the right button opens a menu to perform basic edition actions, such as undo/redo, cut/copy/paste, etc. Moving the mouse with the right button pressed does nothing.
      • " "

    The action of the buttons may change when Meta keys, such as the Control key or the Alt key are pressed simultaneously. Currently, only one such modification is available:

    • pressing left Button + Ctrl starts a box selection from the place where the mouse pointer is. The selection is extended by moving the mouse pointer with both buttons pressed and it ends when one of the two buttons is released. The box selection is then copied to the selection clipboard and can be inserted anywhere else in the text
    " ), //_________________________________________________________ QObject::tr( "Accelerators" ), QObject::tr( "

    Accelerators

    Key accelerators provide shortcuts to the most commonly used actions by pressing a predefined sequence of keys. They are case insensitive.

    The following accelerators are available,

    • Ctrl+N create a new file;
    • Ctrl+O open an existing file;
    • Ctrl+W close current edition window;
    • Ctrl+S save current file;
    • Ctrl+P Print current document;
    • Ctrl+Q close all edition windows and exit QEdit;
    • Ctrl+Z undo last action;
    • Shift+Ctrl+Z redo last action;
    • Ctrl+X cut current selection;
    • Ctrl+C copy current selection;
    • Ctrl+V paste clipboard at the current cursor location;
    • Ctrl+A select all text;
    • Ctrl+U convert current selection to upper-case;
    • Shift+Ctrl+U convert current selection to lower-case;
    • Ctrl+F raise the text find dialog;
    • Ctrl+G find the next occurrence of the searched string in the forward direction;
    • Shift+Ctrl+G find the next occurrence of the searched string in the backward direction;
    • Ctrl+H find the next occurrence of the current selection in the forward direction;
    • Shift+Ctrl+H find the next occurrence of the current selection in the backward direction;
    • Ctrl+R raise the replace dialog;
    • Ctrl+T find the next occurrence of the searched string in the forward direction and replace with the current replacement text;
    • Shift+Ctrl+T find the next occurrence of the searched string in the backward direction and replace with the current replacement text;
    • Ctrl+L select a paragraph by its line number;

    Additional key accelerators are provided with the text edition macros provided by the current document class and are set in the corresponding document class configuration file." ), //_________________________________________________________ QObject::tr( "Command line" ), QObject::tr( "

    Command Line

    " "

    QEdit usage is the following:

    " "

    qedit [options] [file1] [file2] [...]

    " "

    With [options] being one or several of the following:

    " "
      " "
    • --help displays this help and exit
      • " "
    • --tabbed opens files in same window
      • " "
    • --diff opens files in same window and perform diff
      • " "
    • --autospell switch autospell on for all files
      • " "
    • --filter \"filter name\" select filter for autospell
      • " "
    • --dictionary \"dictionary name\" select dictionary for autospell
      • " "
    • --close close displays matching file names and exit
      • " "
    • --replace replace existing instance with new one.
      • " "
    • --no-server ignore server mode. runs new application instance.
      • " "
    • --abort exit existing instance.
      • " "
    " "

    and [file1] [file2] [...] the list of files to be opened.

    " "

    Remarks:

    " "
      " "
    • When no files are specified, a blank window is opened. " "
    • Unless the server mode is disabled, opening a file that was already oppened during the same session simply raises the corresponding window.
      • " "
    " ), 0 }; #endif