From b34cc6b896075cb2ecd6036a197faa006f833ec6 Mon Sep 17 00:00:00 2001 From: Emmanuel Lepage Vallee Date: Tue, 9 Jul 2019 17:17:34 -0400 Subject: [PATCH] doc: Fix autogenerated table links. Update for the new URL scheme. --- docs/_parser.lua | 27 +++---- docs/build_rules_index.lua | 2 +- docs/common/rules_index.ldoc | 132 +++++++++++++++++------------------ 3 files changed, 78 insertions(+), 83 deletions(-) diff --git a/docs/_parser.lua b/docs/_parser.lua index a1ad5b8a7..f222105dc 100644 --- a/docs/_parser.lua +++ b/docs/_parser.lua @@ -69,19 +69,19 @@ local function path_to_module(path) end local modtypes = { - classmod = true, - widgetmod = true, - containermod = true, - layoutmod = true, - coreclassmod = true, - popupmod = true, + classmod = "classes", + widgetmod = "widgets", + containermod = "widget_containers", + layoutmod = "widget_layouts", + coreclassmod = "core_components", + popupmod = "popups_and_bars", + module = "libraries", + submodule = "libraries", + utillib = "utility_libraries", + themelib = "theme_related_libraries", } local libtypes = { - module = true, - submodule = true, - utillib = true, - themelib = true, } function module.path_to_html(path) @@ -95,12 +95,7 @@ function module.path_to_html(path) if modtypes[tag] then f:close() - return "../classes/".. mod ..".html#" - end - - if libtypes[tag] then - f:close() - return "../libraries/".. mod ..".html#" + return "../"..modtypes[tag].."/".. mod ..".html#" end end f:close() diff --git a/docs/build_rules_index.lua b/docs/build_rules_index.lua index 1e9341c4e..9e4cb6c6f 100644 --- a/docs/build_rules_index.lua +++ b/docs/build_rules_index.lua @@ -9,7 +9,7 @@ local matcher, matcher2 = "(.*)", ".*" -- merged into one documentation page (aka, awful.client doesn't have content -- anymore). This override the path so the parser doesn't have to be aware of it function parser.path_to_html() - return "../classes/client.html#client." + return "../core_components/client.html#" end local clientruleproperty = parser.parse_files(files, "clientruleproperty", matcher, matcher2) diff --git a/docs/common/rules_index.ldoc b/docs/common/rules_index.ldoc index 181a7028a..8f5e2f538 100644 --- a/docs/common/rules_index.ldoc +++ b/docs/common/rules_index.ldoc @@ -3,70 +3,70 @@ -- Name -- Description -- --- placementThe client default placement on the screen --- honor\_paddingWhen applying the placement, honor the screen padding --- honor\_workareaWhen applying the placement, honor the screen work area --- tagThe client default tag --- tagsThe client default tags --- new\_tagCreate a new tag for this client --- switch\_to\_tagsUnselect the current tags and select this client tags --- focusDefine if the client should grab focus by default --- titlebars\_enabledShould this client have a titlebar by default --- callbackA function to call when this client is ready --- markedIf a client is marked or not --- is\_fixedReturn if a client has a fixed size or not --- immobilized\_horizontalIs the client immobilized horizontally? --- immobilized\_verticalIs the client immobilized vertically? --- floatingThe client floating state --- xThe x coordinates --- yThe y coordinates --- widthThe width of the client --- heightThe height of the client --- dockableIf the client is dockable --- requests\_no\_titlebarIf the client requests not to be decorated with a titlebar --- shapeSet the client shape --- windowThe X window id --- nameThe client title --- skip\_taskbarTrue if the client does not want to be in taskbar --- typeThe window type --- classThe client class --- instanceThe client instance --- pidThe client PID, if available --- roleThe window role, if available --- machineThe machine client is running on --- icon\_nameThe client name when iconified --- iconThe client icon as a surface --- icon\_sizesThe available sizes of client icons --- screenClient screen --- hiddenDefine if the client must be hidden, i --- minimizedDefine it the client must be iconify, i --- size\_hints\_honorHonor size hints, e --- border\_widthThe client border width --- border\_colorThe client border color --- urgentThe client urgent state --- contentA cairo surface for the client window content --- opacityThe client opacity --- ontopThe client is on top of every other windows --- aboveThe client is above normal windows --- belowThe client is below normal windows --- fullscreenThe client is fullscreen or not --- maximizedThe client is maximized (horizontally and vertically) or not --- maximized\_horizontalThe client is maximized horizontally or not --- maximized\_verticalThe client is maximized vertically or not --- transient\_forThe client the window is transient for --- group\_windowWindow identification unique to a group of windows --- leader\_windowIdentification unique to windows spawned by the same command --- size\_hintsA table with size hints of the client --- motif\_wm\_hintsThe motif WM hints of the client --- stickySet the client sticky, i --- modalIndicate if the client is modal --- focusableTrue if the client can receive the input focus --- shape\_boundingThe client's bounding shape as set by awesome as a (native) cairo surface --- shape\_clipThe client's clip shape as set by awesome as a (native) cairo surface --- shape\_inputThe client's input shape as set by awesome as a (native) cairo surface --- client\_shape\_boundingThe client's bounding shape as set by the program as a (native) cairo surface --- client\_shape\_clipThe client's clip shape as set by the program as a (native) cairo surface --- startup\_idThe FreeDesktop StartId --- validIf the client that this object refers to is still managed by awesome --- first\_tagThe first tag of the client +-- placementThe client default placement on the screen +-- honor\_paddingWhen applying the placement, honor the screen padding +-- honor\_workareaWhen applying the placement, honor the screen work area +-- tagThe client default tag +-- tagsThe client default tags +-- new\_tagCreate a new tag for this client +-- switch\_to\_tagsUnselect the current tags and select this client tags +-- focusDefine if the client should grab focus by default +-- titlebars\_enabledShould this client have a titlebar by default +-- callbackA function to call when this client is ready +-- markedIf a client is marked or not +-- is\_fixedReturn if a client has a fixed size or not +-- immobilized\_horizontalIs the client immobilized horizontally? +-- immobilized\_verticalIs the client immobilized vertically? +-- floatingThe client floating state +-- xThe x coordinates +-- yThe y coordinates +-- widthThe width of the client +-- heightThe height of the client +-- dockableIf the client is dockable +-- requests\_no\_titlebarIf the client requests not to be decorated with a titlebar +-- shapeSet the client shape +-- windowThe X window id +-- nameThe client title +-- skip\_taskbarTrue if the client does not want to be in taskbar +-- typeThe window type +-- classThe client class +-- instanceThe client instance +-- pidThe client PID, if available +-- roleThe window role, if available +-- machineThe machine client is running on +-- icon\_nameThe client name when iconified +-- iconThe client icon as a surface +-- icon\_sizesThe available sizes of client icons +-- screenClient screen +-- hiddenDefine if the client must be hidden, i +-- minimizedDefine it the client must be iconify, i +-- size\_hints\_honorHonor size hints, e +-- border\_widthThe client border width +-- border\_colorThe client border color +-- urgentThe client urgent state +-- contentA cairo surface for the client window content +-- opacityThe client opacity +-- ontopThe client is on top of every other windows +-- aboveThe client is above normal windows +-- belowThe client is below normal windows +-- fullscreenThe client is fullscreen or not +-- maximizedThe client is maximized (horizontally and vertically) or not +-- maximized\_horizontalThe client is maximized horizontally or not +-- maximized\_verticalThe client is maximized vertically or not +-- transient\_forThe client the window is transient for +-- group\_windowWindow identification unique to a group of windows +-- leader\_windowIdentification unique to windows spawned by the same command +-- size\_hintsA table with size hints of the client +-- motif\_wm\_hintsThe motif WM hints of the client +-- stickySet the client sticky, i +-- modalIndicate if the client is modal +-- focusableTrue if the client can receive the input focus +-- shape\_boundingThe client's bounding shape as set by awesome as a (native) cairo surface +-- shape\_clipThe client's clip shape as set by awesome as a (native) cairo surface +-- shape\_inputThe client's input shape as set by awesome as a (native) cairo surface +-- client\_shape\_boundingThe client's bounding shape as set by the program as a (native) cairo surface +-- client\_shape\_clipThe client's clip shape as set by the program as a (native) cairo surface +-- startup\_idThe FreeDesktop StartId +-- validIf the client that this object refers to is still managed by awesome +-- first\_tagThe first tag of the client --