Convert usage of HTML to markdown.

Signed-off-by: Julian Wollrath <jwollrath@web.de>
This commit is contained in:
Julian Wollrath 2015-02-20 15:41:19 +01:00 committed by Daniel Hahler
parent 4d76967397
commit 668055479e
3 changed files with 33 additions and 34 deletions

View File

@ -54,16 +54,15 @@ end
-- to the top of the stack. -- to the top of the stack.
-- --
-- The callback function receives three arguments: -- The callback function receives three arguments:
-- <ul>
-- <li>a table containing modifiers keys</li>
-- <li>a string with the pressed key</li>
-- <li>a string with either "press" or "release" to indicate the event type</li>
-- </ul>
-- --
-- A callback can return <code>false</code> to pass the events to the next -- * a table containing modifiers keys
-- * a string with the pressed key
-- * a string with either "press" or "release" to indicate the event type
--
-- A callback can return `false` to pass the events to the next
-- keygrabber in the stack. -- keygrabber in the stack.
-- @param g The key grabber callback that will get the key events until it will be deleted or a new grabber is added. -- @param g The key grabber callback that will get the key events until it will be deleted or a new grabber is added.
-- @return the given callback <code>g</code>. -- @return the given callback `g`.
-- @usage -- @usage
-- -- The following function can be bound to a key, and be used to resize a -- -- The following function can be bound to a key, and be used to resize a
-- -- client using the keyboard. -- -- client using the keyboard.

View File

@ -588,18 +588,18 @@ end
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
--- Create a menu popup. --- Create a menu popup.
-- @param args Table containing the menu informations.<br/> -- @param args Table containing the menu informations.
-- <ul> --
-- <li> Key items: Table containing the displayed items. Each element is a table by default (when element 'new' is awful.menu.entry) containing: item name, triggered action, submenu table or function, item icon (optional). </li> -- * Key items: Table containing the displayed items. Each element is a table by default (when element 'new' is awful.menu.entry) containing: item name, triggered action, submenu table or function, item icon (optional).
-- <li> Keys theme.[fg|bg]_[focus|normal], theme.border_color, theme.border_width, theme.submenu_icon, theme.height and theme.width override the default display for your menu and/or of your menu entry, each of them are optional. </li> -- * Keys theme.[fg|bg]_[focus|normal], theme.border_color, theme.border_width, theme.submenu_icon, theme.height and theme.width override the default display for your menu and/or of your menu entry, each of them are optional.
-- <li> Key auto_expand controls the submenu auto expand behaviour by setting it to true (default) or false. </li> -- * Key auto_expand controls the submenu auto expand behaviour by setting it to true (default) or false.
-- </ul> --
-- @param parent Specify the parent menu if we want to open a submenu, this value should never be set by the user. -- @param parent Specify the parent menu if we want to open a submenu, this value should never be set by the user.
-- @usage -- The following function builds and shows a menu of clients that match -- @usage -- The following function builds and shows a menu of clients that match
-- -- a particular rule. -- -- a particular rule.
-- -- Bound to a key, it can be used to select from dozens of terminals open on -- -- Bound to a key, it can be used to select from dozens of terminals open on
-- -- several tags. -- -- several tags.
-- -- When using @{awful.rules.match_any} instead of @{awful.rules.match}, -- -- When using @{rules.match_any} instead of @{rules.match},
-- -- a menu of clients with different classes could be build. -- -- a menu of clients with different classes could be build.
-- --
-- function terminal_menu () -- function terminal_menu ()

View File

@ -158,32 +158,32 @@ local function prompt_text_with_cursor(args)
end end
--- Run a prompt in a box. --- Run a prompt in a box.
-- <p>The following readline keyboard shortcuts are implemented as expected:</p> --
-- The following readline keyboard shortcuts are implemented as expected:
-- <kbd>CTRL+A</kbd>, <kbd>CTRL+B</kbd>, <kbd>CTRL+C</kbd>, <kbd>CTRL+D</kbd>, -- <kbd>CTRL+A</kbd>, <kbd>CTRL+B</kbd>, <kbd>CTRL+C</kbd>, <kbd>CTRL+D</kbd>,
-- <kbd>CTRL+E</kbd>, <kbd>CTRL+J</kbd>, <kbd>CTRL+M</kbd>, <kbd>CTRL+F</kbd>, -- <kbd>CTRL+E</kbd>, <kbd>CTRL+J</kbd>, <kbd>CTRL+M</kbd>, <kbd>CTRL+F</kbd>,
-- <kbd>CTRL+H</kbd>, <kbd>CTRL+K</kbd>, <kbd>CTRL+U</kbd>, <kbd>CTRL+W</kbd>, -- <kbd>CTRL+H</kbd>, <kbd>CTRL+K</kbd>, <kbd>CTRL+U</kbd>, <kbd>CTRL+W</kbd>,
-- <kbd>CTRL+BACKSPACE</kbd>, <kbd>SHIFT+INSERT</kbd>, <kbd>HOME</kbd>, -- <kbd>CTRL+BACKSPACE</kbd>, <kbd>SHIFT+INSERT</kbd>, <kbd>HOME</kbd>,
-- <kbd>END</kbd> and arrow keys. -- <kbd>END</kbd> and arrow keys.
-- <p>The following shortcuts implement additional history manipulation commands --
-- The following shortcuts implement additional history manipulation commands
-- where the search term is defined as the substring of the command from first -- where the search term is defined as the substring of the command from first
-- character to cursor position.</p> -- character to cursor position.
-- <ul> --
-- <li><code>CTRL+R</code>: reverse history search, matches any history entry -- * <kbd>CTRL+R</kbd>: reverse history search, matches any history entry
-- containing search term.</li> -- containing search term.
-- <li><code>CTRL+S</code>: forward history search, matches any history entry -- * <kbd>CTRL+S</kbd>: forward history search, matches any history entry
-- containing search term.</li> -- containing search term.
-- <li><code>CTRL+UP</code>: ZSH up line or search, matches any history entry -- * <kbd>CTRL+UP</kbd>: ZSH up line or search, matches any history entry
-- starting with search term.</li> -- starting with search term.
-- <li><code>CTRL+DOWN</code>: ZSH down line or search, matches any history -- * <kbd>CTRL+DOWN</kbd>: ZSH down line or search, matches any history
-- entry starting with search term.</li> -- entry starting with search term.
-- <li><code>CTRL+DELETE</code>: delete the currently visible history entry from -- * <kbd>CTRL+DELETE</kbd>: delete the currently visible history entry from
-- history file. -- history file. This does not delete new commands or history entries under
-- This does not delete new commands or history entries under user editing.</li> -- user editing.
-- </ul> --
-- @param args A table with optional arguments: <code>fg_cursor</code>, -- @tparam table args A table with optional arguments: `fg_cursor`, `bg_cursor`,
-- <code>bg_cursor</code>, <code>ul_cursor</code>, <code>prompt</code>, -- `ul_cursor`, `prompt`, `text`, `selectall`, `font`, `autoexec`.
-- <code>text</code>, <code>selectall</code>, <code>font</code>,
-- <code>autoexec</code>.
-- @param textbox The textbox to use for the prompt. -- @param textbox The textbox to use for the prompt.
-- @param exe_callback The callback function to call with command as argument -- @param exe_callback The callback function to call with command as argument
-- when finished. -- when finished.