From 9051b533459712afdd770992bc6935d09c7c0a6d Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Thu, 5 Mar 2009 09:48:55 +0100 Subject: #114: Added an ``abbr`` role to markup abbreviations and acronyms. --- doc/markup/inline.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'doc/markup/inline.rst') diff --git a/doc/markup/inline.rst b/doc/markup/inline.rst index 97b20da7..69721b32 100644 --- a/doc/markup/inline.rst +++ b/doc/markup/inline.rst @@ -278,6 +278,16 @@ Other semantic markup The following roles don't do anything special except formatting the text in a different style: +.. role:: abbr + + An abbreviation. If the role content contains a parenthesized explanation, + it will be treated specially: it will be shown in a tool-tip in HTML, and + output only once in LaTeX. + + Example: ``:abbr:`LIFO (last-in, first-out)```. + + .. versionadded:: 0.6 + .. role:: command The name of an OS-level command, such as ``rm``. -- cgit v1.2.1