rnhmjoj/qutebrowser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Change config descriptions to be asciidoc

Browse Source
This commit is contained in:
Florian Bruhin 2014-05-28 21:45:37 +02:00
parent c5d923f92e
commit a687388819
1 changed files with 53 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

105
qutebrowser/config/configdata.py
View File

@ -77,35 +77,35 @@ SECTION_DESC = {
"The searchengine named DEFAULT is used when general.auto-search "
"is true and something else than a URL was entered to be opened. "
"Other search engines can be used via the bang-syntax, e.g. "
'"qutebrowser !google". The string "{}" will be replaced by the '
'search term, use "{{" and "}}" for literal {/} signs.'),
"+:open qutebrowser !google+. The string +{}+ will be replaced by the "
"search term, use +{{+ and +}}+ for literal +{+/+}+ signs."),
'keybind': (
"Bindings from a key(chain) to a command.\n"
"For special keys (can't be part of a keychain), enclose them in "
"<...>. For modifiers, you can use either - or + as delimiters, and "
"these names:\n"
" Control: Control, Ctrl\n"
" Meta: Meta, Windows, Mod4\n"
" Alt: Alt, Mod1\n"
" Shift: Shift\n"
"For simple keys (no <>-signs), a capital letter means the key is "
"pressed with Shift. For special keys (with <>-signs), you need "
'to explicitely add "Shift-" to match a key pressed with shift. '
'You can bind multiple commands by separating them with ";;".'),
"+<+_..._+>+. For modifiers, you can use either +-+ or +++ as "
"delimiters, and these names:\n\n"
" * Control: +Control+, +Ctrl+\n"
" * Meta: +Meta+, +Windows+, +Mod4+\n"
" * Alt: +Alt+, +Mod1+\n"
" * Shift: +Shift+\n\n"
"For simple keys (no +<>+-signs), a capital letter means the key is "
"pressed with Shift. For special keys (with +<>+-signs), you need "
"to explicitely add +Shift-+ to match a key pressed with shift. "
"You can bind multiple commands by separating them with +;;+."),
'keybind.insert': (
"Keybindings for insert mode.\n"
"Since normal keypresses are passed through, only special keys are "
"supported in this mode.\n"
"Useful hidden commands to map in this section:\n"
" open-editor: Open a texteditor with the focused field.\n"
" leave-mode: Leave the command mode."),
"Useful hidden commands to map in this section:\n\n"
" * +open-editor+: Open a texteditor with the focused field.\n"
" * +leave-mode+: Leave the command mode."),
'keybind.hint': (
"Keybindings for hint mode.\n"
"Since normal keypresses are passed through, only special keys are "
"supported in this mode.\n"
"Useful hidden commands to map in this section:\n"
" follow-hint: Follow the currently selected hint.\n"
" leave-mode: Leave the command mode."),
"Useful hidden commands to map in this section:\n\n"
" * +follow-hint+: Follow the currently selected hint.\n"
" * +leave-mode+: Leave the command mode."),
'keybind.passthrough': (
"Keybindings for passthrough mode.\n"
"Since normal keypresses are passed through, only special keys are "
@ -115,53 +115,54 @@ SECTION_DESC = {
"Keybindings for command mode.\n"
"Since normal keypresses are passed through, only special keys are "
"supported in this mode.\n"
"Useful hidden commands to map in this section:\n"
" command-history-prev: Switch to previous command in history.\n"
" command-history-next: Switch to next command in history.\n"
" completion-item-prev: Select previous item in completion.\n"
" completion-item-next: Select next item in completion.\n"
" command-accept: Execute the command currently in the commandline.\n"
" leave-mode: Leave the command mode."),
"Useful hidden commands to map in this section:\n\n"
" * +command-history-prev+: Switch to previous command in history.\n"
" * +command-history-next+: Switch to next command in history.\n"
" * +completion-item-prev+: Select previous item in completion.\n"
" * +completion-item-next+: Select next item in completion.\n"
" * +command-accept+: Execute the command currently in the "
"commandline.\n"
" * +leave-mode+: Leave the command mode."),
'keybind.prompt': (
"Keybindings for prompts in the status line.\n"
"You can bind normal keys in this mode, but they will be only active "
"when a yes/no-prompt is asked. For other prompt modes, you can only "
"bind special keys.\n"
"Useful hidden commands to map in this section:\n"
" prompt-accept: Confirm the entered value.\n"
" prompt-yes: Answer yes to a yes/no question.\n"
" prompt-no: Answer no to a yes/no question.\n"
" leave-mode: Leave the prompt mode."),
"Useful hidden commands to map in this section:\n\n"
" * +prompt-accept+: Confirm the entered value.\n"
" * +prompt-yes+: Answer yes to a yes/no question.\n"
" * +prompt-no+: Answer no to a yes/no question.\n"
" * +leave-mode+: Leave the prompt mode."),
'aliases': (
"Aliases for commands.\n"
"By default, no aliases are defined. Example which adds a new command "
":qtb to open qutebrowsers website:\n"
" qtb = open http://www.qutebrowser.org/"),
"+:qtb+ to open qutebrowsers website:\n\n"
"+qtb = open http://www.qutebrowser.org/+"),
'colors': (
"Colors used in the UI.\n"
"A value can be in one of the following format:\n"
" - #RGB/#RRGGBB/#RRRGGGBBB/#RRRRGGGGBBBB\n"
" - A SVG color name as specified in [1].\n"
" - transparent (no color)\n"
" - rgb(r, g, b) / rgba(r, g, b, a) (values 0-255 or "
"A value can be in one of the following format:\n\n"
" * +#RGB+/+#RRGGBB+/+#RRRGGGBBB+/+#RRRRGGGGBBBB+\n"
" * A SVG color name as specified in http://www.w3.org/TR/SVG/"
"types.html#ColorKeywords[the W3C specification].\n"
" * transparent (no color)\n"
" * +rgb(r, g, b)+ / +rgba(r, g, b, a)+ (values 0-255 or "
"percentages)\n"
" - hsv(h, s, v) / hsva(h, s, v, a) (values 0-255, hue 0-359)\n"
' - A gradient as explained at [2] under "Gradient"\n'
" [1] http://www.w3.org/TR/SVG/types.html#ColorKeywords\n"
" [2] http://qt-project.org/doc/qt-4.8/stylesheet-reference.html"
"#list-of-property-types\n"
'The "hints.*" values are a special case as they\'re real CSS '
" * +hsv(h, s, v)+ / +hsva(h, s, v, a)+ (values 0-255, hue 0-359)\n"
" * A gradient as explained in http://qt-project.org/doc/qt-4.8/"
"stylesheet-reference.html#list-of-property-types[the Qt "
"documentation] under ``Gradient''.\n\n"
"The +hints.*+ values are a special case as they're real CSS "
"colors, not Qt-CSS colors. There, for a gradient, you need to use "
"-webkit-gradient, see [3].\n"
" [3] https://www.webkit.org/blog/175/introducing-css-gradients/"),
"+-webkit-gradient+, see https://www.webkit.org/blog/175/introducing-"
"css-gradients/[the WebKit documentation].\n"),
'fonts': (
"Fonts used for the UI, with optional style/weight/size.\n"
" Style: normal/italic/oblique\n"
" Weight: normal, bold, 100..900\n"
" Size: Number + px/pt\n"
"Fonts used for the UI, with optional style/weight/size.\n\n"
" * Style: +normal+/+italic+/+oblique+\n"
" * Weight: +normal+, +bold+, 100..900\n"
" * Size: Number + +px+/+pt+\n"
"Note: The font for hints is a true CSS font, not a Qt-CSS one, "
'because of that, a general "Monospace" family is enough and we '
'don\'t use "${_monospace}" there.'),
"because of that, a general ``Monospace'' family is enough and we "
"don't use +${_monospace}+ there."),
}
@ -200,7 +201,7 @@ DATA = OrderedDict([
('editor',
SettingValue(types.ShellCommand(placeholder=True), 'gvim -f "{}"'),
"The editor (and arguments) to use for the open-editor binding. "
"Use {} for the filename. Gets split via shutils."),
"Use +{}+ for the filename. Gets split via shutils."),
('private-browsing',
SettingValue(types.Bool(), 'false'),