diff --git a/docs/_parser.lua b/docs/_parser.lua
index a1ad5b8a..f222105d 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 1e9341c4..9e4cb6c6 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 181a7028..8f5e2f53 100644
--- a/docs/common/rules_index.ldoc
+++ b/docs/common/rules_index.ldoc
@@ -3,70 +3,70 @@
-- | Name |
-- Description |
--
--- | placement | The client default placement on the screen |
--- | honor\_padding | When applying the placement, honor the screen padding |
--- | honor\_workarea | When applying the placement, honor the screen work area |
--- | tag | The client default tag |
--- | tags | The client default tags |
--- | new\_tag | Create a new tag for this client |
--- | switch\_to\_tags | Unselect the current tags and select this client tags |
--- | focus | Define if the client should grab focus by default |
--- | titlebars\_enabled | Should this client have a titlebar by default |
--- | callback | A function to call when this client is ready |
--- | marked | If a client is marked or not |
--- | is\_fixed | Return if a client has a fixed size or not |
--- | immobilized\_horizontal | Is the client immobilized horizontally? |
--- | immobilized\_vertical | Is the client immobilized vertically? |
--- | floating | The client floating state |
--- | x | The x coordinates |
--- | y | The y coordinates |
--- | width | The width of the client |
--- | height | The height of the client |
--- | dockable | If the client is dockable |
--- | requests\_no\_titlebar | If the client requests not to be decorated with a titlebar |
--- | shape | Set the client shape |
--- | window | The X window id |
--- | name | The client title |
--- | skip\_taskbar | True if the client does not want to be in taskbar |
--- | type | The window type |
--- | class | The client class |
--- | instance | The client instance |
--- | pid | The client PID, if available |
--- | role | The window role, if available |
--- | machine | The machine client is running on |
--- | icon\_name | The client name when iconified |
--- | icon | The client icon as a surface |
--- | icon\_sizes | The available sizes of client icons |
--- | screen | Client screen |
--- | hidden | Define if the client must be hidden, i |
--- | minimized | Define it the client must be iconify, i |
--- | size\_hints\_honor | Honor size hints, e |
--- | border\_width | The client border width |
--- | border\_color | The client border color |
--- | urgent | The client urgent state |
--- | content | A cairo surface for the client window content |
--- | opacity | The client opacity |
--- | ontop | The client is on top of every other windows |
--- | above | The client is above normal windows |
--- | below | The client is below normal windows |
--- | fullscreen | The client is fullscreen or not |
--- | maximized | The client is maximized (horizontally and vertically) or not |
--- | maximized\_horizontal | The client is maximized horizontally or not |
--- | maximized\_vertical | The client is maximized vertically or not |
--- | transient\_for | The client the window is transient for |
--- | group\_window | Window identification unique to a group of windows |
--- | leader\_window | Identification unique to windows spawned by the same command |
--- | size\_hints | A table with size hints of the client |
--- | motif\_wm\_hints | The motif WM hints of the client |
--- | sticky | Set the client sticky, i |
--- | modal | Indicate if the client is modal |
--- | focusable | True if the client can receive the input focus |
--- | shape\_bounding | The client's bounding shape as set by awesome as a (native) cairo surface |
--- | shape\_clip | The client's clip shape as set by awesome as a (native) cairo surface |
--- | shape\_input | The client's input shape as set by awesome as a (native) cairo surface |
--- | client\_shape\_bounding | The client's bounding shape as set by the program as a (native) cairo surface |
--- | client\_shape\_clip | The client's clip shape as set by the program as a (native) cairo surface |
--- | startup\_id | The FreeDesktop StartId |
--- | valid | If the client that this object refers to is still managed by awesome |
--- | first\_tag | The first tag of the client |
+-- | placement | The client default placement on the screen |
+-- | honor\_padding | When applying the placement, honor the screen padding |
+-- | honor\_workarea | When applying the placement, honor the screen work area |
+-- | tag | The client default tag |
+-- | tags | The client default tags |
+-- | new\_tag | Create a new tag for this client |
+-- | switch\_to\_tags | Unselect the current tags and select this client tags |
+-- | focus | Define if the client should grab focus by default |
+-- | titlebars\_enabled | Should this client have a titlebar by default |
+-- | callback | A function to call when this client is ready |
+-- | marked | If a client is marked or not |
+-- | is\_fixed | Return if a client has a fixed size or not |
+-- | immobilized\_horizontal | Is the client immobilized horizontally? |
+-- | immobilized\_vertical | Is the client immobilized vertically? |
+-- | floating | The client floating state |
+-- | x | The x coordinates |
+-- | y | The y coordinates |
+-- | width | The width of the client |
+-- | height | The height of the client |
+-- | dockable | If the client is dockable |
+-- | requests\_no\_titlebar | If the client requests not to be decorated with a titlebar |
+-- | shape | Set the client shape |
+-- | window | The X window id |
+-- | name | The client title |
+-- | skip\_taskbar | True if the client does not want to be in taskbar |
+-- | type | The window type |
+-- | class | The client class |
+-- | instance | The client instance |
+-- | pid | The client PID, if available |
+-- | role | The window role, if available |
+-- | machine | The machine client is running on |
+-- | icon\_name | The client name when iconified |
+-- | icon | The client icon as a surface |
+-- | icon\_sizes | The available sizes of client icons |
+-- | screen | Client screen |
+-- | hidden | Define if the client must be hidden, i |
+-- | minimized | Define it the client must be iconify, i |
+-- | size\_hints\_honor | Honor size hints, e |
+-- | border\_width | The client border width |
+-- | border\_color | The client border color |
+-- | urgent | The client urgent state |
+-- | content | A cairo surface for the client window content |
+-- | opacity | The client opacity |
+-- | ontop | The client is on top of every other windows |
+-- | above | The client is above normal windows |
+-- | below | The client is below normal windows |
+-- | fullscreen | The client is fullscreen or not |
+-- | maximized | The client is maximized (horizontally and vertically) or not |
+-- | maximized\_horizontal | The client is maximized horizontally or not |
+-- | maximized\_vertical | The client is maximized vertically or not |
+-- | transient\_for | The client the window is transient for |
+-- | group\_window | Window identification unique to a group of windows |
+-- | leader\_window | Identification unique to windows spawned by the same command |
+-- | size\_hints | A table with size hints of the client |
+-- | motif\_wm\_hints | The motif WM hints of the client |
+-- | sticky | Set the client sticky, i |
+-- | modal | Indicate if the client is modal |
+-- | focusable | True if the client can receive the input focus |
+-- | shape\_bounding | The client's bounding shape as set by awesome as a (native) cairo surface |
+-- | shape\_clip | The client's clip shape as set by awesome as a (native) cairo surface |
+-- | shape\_input | The client's input shape as set by awesome as a (native) cairo surface |
+-- | client\_shape\_bounding | The client's bounding shape as set by the program as a (native) cairo surface |
+-- | client\_shape\_clip | The client's clip shape as set by the program as a (native) cairo surface |
+-- | startup\_id | The FreeDesktop StartId |
+-- | valid | If the client that this object refers to is still managed by awesome |
+-- | first\_tag | The first tag of the client |
--
diff --git a/docs/config.ld b/docs/config.ld
index ca66ae96..e97264a5 100644
--- a/docs/config.ld
+++ b/docs/config.ld
@@ -100,12 +100,12 @@ sort_modules=true
-- Add more project level (left side index) types.
new_type("widgetmod" , "Widgets" , true)
-new_type("containermod", "Widget containers", true)
-new_type("layoutmod" , "Widget layouts" , true)
-new_type("coreclassmod", "Core components" , true)
-new_type("popupmod" , "Popups and bars" , true)
-new_type("utillib" , "Utility libraries", true)
-new_type("themelib" , "Theme related libraries", true)
+new_type("containermod", "Widget_containers", true)
+new_type("layoutmod" , "Widget_layouts" , true)
+new_type("coreclassmod", "Core_components" , true)
+new_type("popupmod" , "Popups_and_bars" , true)
+new_type("utillib" , "Utility_libraries", true)
+new_type("themelib" , "Theme_related_libraries", true)
file = {
-- C parts of libraries
diff --git a/docs/ldoc.ltp b/docs/ldoc.ltp
index 7550bb78..ee8f6534 100644
--- a/docs/ldoc.ltp
+++ b/docs/ldoc.ltp
@@ -15,9 +15,9 @@
@@ -30,6 +30,7 @@
# local function M(txt,item) return ldoc.markup(txt,item,ldoc.plain) end
# local nowrap = ldoc.wrap and '' or 'nowrap'
# local html_space = function(s) return s:gsub(" ", "%%20") end
+# local no_underscores = function(s) return s:gsub("_", " ") end
@@ -68,7 +69,7 @@
# local this_mod = module and module.name
# for kind, mods, type in ldoc.kinds() do
# if ldoc.allowed_in_contents(type,module) then
-
$(kind)
+
$(no_underscores(kind))
