HybridDog/geany
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve Statusbar Template documentation

Browse Source 
Mainly listing the available placeholders instead of pointing the
poor user deep into Geany's code.
This commit is contained in:
Matthew Brush 2013-04-14 18:57:37 -07:00
parent d452d0b737
commit 4e03e466e7
2 changed files with 499 additions and 397 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

807
doc/geany.html
View File

File diff suppressed because it is too large Load Diff

55
doc/geany.txt
View File

@ -2489,9 +2489,9 @@ Rarely used preferences, explained in the table below. A few of them require
restart to take effect, and a few other will only affect newly opened or created
documents before restart.
================================ ========================================= ========== ===========
================================ =========================================== ========== ===========
Key Description Default Applies
================================ ========================================= ========== ===========
================================ =========================================== ========== ===========
**Editor related**
use_gtk_word_boundaries Whether to look for the end of a word true to new
when using word-boundary related documents
@ -2525,7 +2525,7 @@ compiler_tab_autoscroll Whether to automatically scroll to the tru
last line of the output in the Compiler
tab.
statusbar_template The status bar statistics line format. See below. immediately
(Search in src/ui_utils.c for details).
(See `Statusbar Templates`_ for details).
new_document_after_close Whether to open a new document after all false immediately
documents have been closed.
msgwin_status_visible Whether to show the Status tab in the true immediately
@ -2536,18 +2536,6 @@ msgwin_messages_visible Whether to show the Messages tab in the tru
Messages Window
msgwin_scribble_visible Whether to show the Scribble tab in the true immediately
Messages Window
================================ ========================================= ========== ===========
By default, statusbar_template is empty. This tells Geany to use its
internal default, which is currently:
``line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S``
Note that ``\t`` = tab.
================================ =========================================== ========== ===========
Key Description Default Applies
================================ =========================================== ========== ===========
**VTE related**
emulation Terminal emulation mode. Only change this xterm immediately
if you have VTE termcap files other than
@ -2609,6 +2597,43 @@ number_exec_menu_items The maximum number of menu items in the 2
The extract_filetype_regex has the default value GEANY_DEFAULT_FILETYPE_REGEX.
Statusbar Templates
```````````````````
The default statusbar template is (note ``\t`` = tab):
``line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S``
Settings the preference to an empty string will also cause Geany to use this
internal default.
The following format characters are available for the statusbar template:
============ ===========================================================
Placeholder Description
============ ===========================================================
``%l`` The current line number starting at 1
``%L`` The total number of lines
``%c`` The current column number starting at 0
``%C`` The current column number starting at 1
``%s`` The number of selected characters or if only whole lines
selected, the number of selected lines.
``%w`` Shows ``RO`` when the document is in read-only mode,
otherwise shows whether the editor is in overtype (OVR)
or insert (INS) mode.
``%t`` Shows the indentation mode, either tabs (TAB),
spaces (SP) or both (T/S).
``%m`` Shows whether the document is modified (MOD) or nothing.
``%M`` The name of the document's line-endings (ex. ``Unix (LF)``)
``%e`` The name of the document's encoding (ex. UTF-8).
``%f`` The filetype of the document (ex. None, Python, C, etc).
``%S`` The name of the scope where the caret is located.
``%p`` The caret position in the entire document starting at 0.
``%r`` Shows whether the document is read-only (RO) or nothing.
``%Y`` The Scintilla style number at the caret position. This is
useful if you're debugging color schemes or related code.
============ ===========================================================
Terminal (VTE) preferences
^^^^^^^^^^^^^^^^^^^^^^^^^^