summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Add support for stable doc URLs (#342)Wismill2023-05-141-0/+63
| | | | | | | | | | | | | | | | | | | | | | Doc URLs may change with time because they depend on Doxygen machinery. This is unfortunate because it is good practice to keep valid URLs (see: https://www.w3.org/Provider/Style/URI.html). I could not find a built-in solution in Doxygen, so the solution proposed here is to maintain a registry of all URLs and manage legacy URLs as redirections to their canonical page. This commit adds a registry of URLs that has three functions: - Check no previous URL is now invalid. - Add aliases for moved pages. - Generate redirection pages for aliases. The redirection works with a simple <meta http-equiv="refresh"> HTML tag. See: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta#http-equiv This commit also initialize the URLs registry with current pages and some redirections needed after recent documentation refactoring. Finally, the CI is updated to catch any change that invalidate previous URLs.
* Improve documentationPierre Le Marre2023-05-137-69/+450
| | | | | | - Add introduction to XKB - Embrace Doxygen features - More cross links
* Use consistent indentation for map and CSS filesRan Benita2023-05-041-5/+5
| | | | Signed-off-by: Ran Benita <ran@unusedvar.com>
* Improve the doc of the XKB keymap text format, V1 (#321)Wismill2023-04-302-90/+920
| | | | | | | | | | | - Add table of contents - Add terminology section - (WIP) Add Introduction to the format - Improve the keycode section - Improve the interpret section - Add guide to create and use modifiers - (WIP) Add actions documentation - Add cross-references - Add keysyms header to documentation
* ignore: remove no longer relevant gitignore filesRan Benita2021-05-221-2/+0
| | | | | | These were relevant for the autoconf build but now we're meson only. Signed-off-by: Ran Benita <ran@unusedvar.com>
* doc: fix user-configuration sample fileJouke Witteveen2021-04-111-1/+3
| | | | | | Support copy-pasting from the docs to get something functional. Signed-off-by: Jouke Witteveen <j.witteveen@gmail.com>
* doc: add keymap-format-text-v1.md to the HTML documentationRan Benita2021-02-271-3/+9
| | | | | | It's incomplete but might be helpful for someone. Signed-off-by: Ran Benita <ran@unusedvar.com>
* doc/keymap: some slight editingRan Benita2020-12-271-13/+11
| | | | Signed-off-by: Ran Benita <ran@unusedvar.com>
* doc/keymap: add documentation for xkb_symbols (#205)Simon Zeni2020-12-271-3/+103
|
* doc: add some disclaimer regarding user-specific key types and compat entriesPeter Hutterer2020-08-301-0/+9
| | | | | | | It's a niche use-case but basically the same as adding symbols, so let's go with a general handwavy explanation. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* Add /etc/xkb as extra lookup path for system data filesPeter Hutterer2020-08-302-0/+5
| | | | | | | | | | | | | | | This completes the usual triplet of configuration locations available for most processes: - vendor-provided data files in /usr/share/X11/xkb - system-specific data files in /etc/xkb - user-specific data files in $XDG_CONFIG_HOME/xkb The default lookup order user, system, vendor, just like everything else that uses these conventions. For include directives in rules files, the '%E' resolves to that path. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: ignore rxkb, RXBK prefixes in doxygenRan Benita2020-07-251-1/+3
| | | | Signed-off-by: Ran Benita <ran@unusedvar.com>
* Add libxkbregistry to query available RMLVOPeter Hutterer2020-07-061-0/+63
| | | | | | | | | | | | | | | | | | | | | This library is the replacement for clients parsing evdev.xml directly. Instead, they should use the API here so that in the future we may even be able to swap evdev.xml for a more suitable data format. The library parses through evdev.xml (using libxml2) and - if requested - through evdev.extras.xml as well. The merge approach is optimised for the default case where we have a system-installed rules XML and another file in $XDG_CONFIG_DIR that adds a few entries. We load the system file first, then append any custom ones to that. It's not possible to overwrite the MLVO list provided by the system files - if you want to do that, get the change upstream. XML validation is handled through the DTD itself which means we only need to check for a nonempty name, everything else the DTD validation should complain about. The logging system is effectively identical to xkbcommon. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* tools: move the remaining tools from test to herePeter Hutterer2020-06-251-3/+3
| | | | Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: correct the include path listPeter Hutterer2020-06-161-3/+3
| | | | | | | | XKB_CONFIG_ROOT (if defined) replaces the built-in system directories. Fixes 5fb2c6769b7259ba647781bc800d6a46d90cf1a9 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: add documentation for user configurationPeter Hutterer2020-06-151-0/+156
| | | | | | | Most of this is currently hidden in the commit message for ca033a29d2ca, let's make it a bit more public so we have a link to point users to. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: add the rules-format file (as markdown)Peter Hutterer2020-06-151-2/+8
| | | | | | | | | | | Useful to have this as part of the documentation. The rendering isn't great but at least not any worse than pure text. Markdown escapes % so explaining our use of %S and %H would require a double % - not idea. Let's just wrap it as a code block and done. Includes two typo fixes too, yay. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc/rules-format.txt: document include supportRan Benita2020-01-181-1/+15
| | | | Signed-off-by: Ran Benita <ran@unusedvar.com>
* build: make doxygen run from the source treeRan Benita2017-08-011-1/+3
| | | | | | I couldn't find any other way to make this work! Signed-off-by: Ran Benita <ran234@gmail.com>
* build: change doxygen target to be properly dependency-basedRan Benita2017-07-312-11/+2
| | | | | | | This hackery (thanks libinput) is clearer and more precise than the previous hackery. Signed-off-by: Ran Benita <ran234@gmail.com>
* doc/compat: correct the XKB protocol version from 1.1 to 1.0Ran Benita2017-04-291-1/+1
| | | | | | | | There is no XKB 1.1! Thanks to Oded Arbel for catching this. Signed-off-by: Ran Benita <ran234@gmail.com>
* doc/compat: (! MODIFIER) syntax is parsed but ignoredRan Benita2016-09-011-0/+1
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* doc/compat.md: xkbcomp ignores multiple-keysyms these daysRan Benita2016-09-011-2/+1
| | | | | | https://cgit.freedesktop.org/xorg/app/xkbcomp/commit/?id=e119cbec7e750ffc4d4bd08b577db2c697035a30 Signed-off-by: Ran Benita <ran234@gmail.com>
* doc: Also mention the wayland test client in the quick guideBryce Harrington2016-06-211-0/+2
| | | | Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: Declare keymap for wayland exampleBryce Harrington2016-06-211-0/+1
| | | | | | | keymap was defined in the X11 example, but also define it in the wayland example just to make it a bit more standalone Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: Fix ctx type in exampleBryce Harrington2016-06-211-1/+1
| | | | | | | xkb_context_new() returns a xkb_context pointer, so change the variable definition to be consistent. Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: Fix Doxygen include for srcdir != builddirDaniel Stone2016-03-151-9/+9
| | | | | | | | | | | | | | | Instead of giving Doxygen a series of absolute paths to the source files and a relative path to the output directory, run it from the source directory with purely relative paths to the source files, and give it an absolute path to the build directory. This fixes the parsing of README.md with a separate build directory, since the relative includes for doc/quick-guide.md and doc/compat.md don't resolve otherwise. Doxygen's INCLUDE_PATH turns out not to fix this either, since that's just a set of paths to open and parse, rather than an analogue to cpp's -I. Signed-off-by: Daniel Stone <daniels@collabora.com>
* doc: some notes about key names and aliasesRan Benita2016-01-201-0/+1
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* doc/keymap-format-text-v1: add title and introRan Benita2015-11-231-23/+32
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* doc/quick-guide: small improvementsRan Benita2015-11-211-13/+11
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* doc/keymap-format-text-v1: convert to markdownRan Benita2015-11-212-354/+359
| | | | | | Make it more readable for random browsing. Signed-off-by: Ran Benita <ran234@gmail.com>
* doc/keymap-format-text-v1: update info on preserveRan Benita2015-11-211-22/+17
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* doc/Doxyfile: explicitly set HTML_TIMESTAMP = NORan Benita2015-09-081-1/+1
| | | | | | | | | YES was the default in older version. Having a timestamp hurts reproducible builds, and serves no purpose, so remove it. https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=789071 Signed-off-by: Ran Benita <ran234@gmail.com>
* doc/Doxyfile: only keep non-default valuesRan Benita2015-09-081-2341/+0
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* doc/Doxyfile: sync with latest versionRan Benita2015-09-081-937/+1443
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* doc/compat.md: add compose incompatibilitiesRan Benita2014-10-181-0/+9
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* docs: make html output have a fixed width, hide footerRan Benita2014-10-182-1/+10
| | | | | | | | It's hard to read text which stretches indefinitely. The footer is not adding much. Signed-off-by: Ran Benita <ran234@gmail.com>
* doc/quick-guide: some improvementsRan Benita2014-10-181-5/+15
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* doc/compat.md: we don't support more groups or mods yetRan Benita2014-10-181-2/+2
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* README: move compatibility notes to their own pageRan Benita2014-10-182-0/+47
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* compose: add xkbcommon-compose - APIRan Benita2014-10-031-1/+2
| | | | | | | | | | | | | | | | xkbcommon-compose is a Compose implementation for xkbcommon. It mostly behaves like libX11's Compose, but the support is somewhat low-level and is not transparent like in libX11. The user must add some supporting code in order to utilize it. The intended audience are users who use xkbcommon but not a full-blown input method. With this they can add Compose support in a straightforward manner, so they have a fairly complete keyboard input for Latin-like languages at least. See the header documentation for details. Signed-off-by: Ran Benita <ran234@gmail.com>
* doc: disable alphabetical data structure indexRan Benita2014-09-221-1/+1
| | | | | | It is useless - we have very little data structures. Signed-off-by: Ran Benita <ran234@gmail.com>
* doc: disable BRIEF_MEMBER_DESCRan Benita2014-09-221-1/+1
| | | | | | | | It's easier to quickly go through the functions in a module this way. The names provide enough "brief description" to get someone to click for the full description. Signed-off-by: Ran Benita <ran234@gmail.com>
* doc: disable tree viewRan Benita2014-09-221-1/+1
| | | | | | It is redundant with the header navigation. Signed-off-by: Ran Benita <ran234@gmail.com>
* quick-guide: fix xkb_state_key_get_syms() exampleRan Benita2014-09-211-1/+1
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* quick-guide: fix Java-esque array syntaxRan Benita2014-09-211-1/+1
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* doc: order the modules betterRan Benita2014-09-181-3/+5
| | | | | | | Explicitly specify the files in INPUT so that "X11 Support" appears after the main modules. Signed-off-by: Ran Benita <ran234@gmail.com>
* doc: fix new doxygen version warningsRan Benita2014-04-252-14/+2
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* build: trim down generated doxygen docsRan Benita2014-03-271-1/+1
| | | | | | Remove the huge verbatim copies of the header files. Signed-off-by: Ran Benita <ran234@gmail.com>
* Reformat README markdownRan Benita2014-03-271-2/+2
| | | | | | So that github displays it as markdown, and correctly. Signed-off-by: Ran Benita <ran234@gmail.com>
View Lorry Controller Status