summaryrefslogtreecommitdiffstats
path: root/doc/global/macros.qdocconf
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Add macro for embedding YouTube videosTopi Reinio2017-03-061-0/+14
| | | | | | | | | | | | | | | | | | This macro adds a \youtube <ID> command that embeds a YouTube link into the documentation. The video container scales to a specified percentage of the available horizontal area. It assumes a source aspect ratio of 16:9, but looks acceptable with other ratios. For backends that do not support <iframe> (e.g. QTextBrowser), shows a clickable video thumbnail that open the YouTube link in an external browser window. Unfortunately, QTextBrowser cannot load images from a remote URL, so we need to store a thumbnail image in the .qch file. Change-Id: I3a3a0c5a20dd90e5cec6357ba70a23ee47dbe825 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Add a custom \borderedimage macroTopi Reinio2016-09-231-0/+1
| | | | | | | | | This macro is used similarly to the \image command; it wraps the image in a div with class attribute 'border' that allows additional styling in CSS. Change-Id: I94271074378d79f0e52f1f5a4715a1f84e0254dc Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Doc: Change instances of '(Mac) OS X' to 'macOS'Topi Reinio2016-08-121-0/+1
| | | | | | | | | | | | | | | As of version 10.12 (Sierra), the name of Apple's desktop operating system will be macOS. Change the occurrences where the Mac platform is discussed to use a macro \macos, which expands to 'macOS'. This helps with adapting to future renaming. Update the instructions on mac-specific Q_OS_* macro usage. Add a \target for the old 'Qt for OS X' topic to keep links working for other documentation modules that try to link with the old name. Change-Id: Id33fb0cd985df702a4ae4efb4c5fd428e77d9b85 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* qdoc: Fix output of \br commandTopi Reinio2014-08-261-2/+1
| | | | | | | | | | | | | | | | Since the \br was promoted from a macro to a QDoc command, its output has been enclosed in extra paragraph end/start tags, adding to the visible vertical space. This change fixes the issue by not closing the paragraph when QDoc encounters a \br command. Also removes the now-obsolete \br and \hr macros, as they are both proper commands. \BR and \HR substitute macros are kept. Task-number: QTBUG-37361 Change-Id: Iabbefb6e79268419792ccba42386f6342ccd175d Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Reintroduce \beginqdoc and \endqdoc macrosTopi Reinio2013-09-101-0/+2
| | | | | | | | | These macros were previously defined for QDoc manual. This change adds them to global macros.qdocconf so they can be used everywhere. Change-Id: I4fdf5a103ecfb356719951a7d0c6fbd35c887744 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Adding base macros and other QDoc definitionsJerome Pasion2012-10-261-0/+37
The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>