Commit Graph

252 Commits

Author SHA1 Message Date
Daniel Hahler aae9b25457 ldoc.ltp: improve HTML title 2019-01-04 22:39:28 +01:00
Daniel Hahler 6792415cef ldoc: prepare for custom ldoc.ltp
ldoc.ltp is copied from ldoc (ldoc/html/ldoc_ltp.lua).
2019-01-04 22:39:28 +01:00
actionless d121780366 doc(readme): add receipts for installing current git master 2019-01-01 18:43:43 +01:00
mergify[bot] 98be7e88ef
Merge pull request #2483 from actionless/questions-readme
doc(readme): add questions section; split issues and contributing; fix apidoc link (in ldoc)
2018-12-17 14:24:24 +00:00
actionless 29b2b7138d doc(readme): add section about IRC 2018-11-19 22:09:46 +01:00
actionless 86084690b2 doc(readme): add questions section; split issues and contributing; fix apidoc link (in ldoc) 2018-11-19 22:01:37 +01:00
Sergey Vlasov f0878941ab doc: Fix c.requests_no_titlebar example
Signed-off-by: Sergey Vlasov <sigprof@gmail.com>
2018-11-12 11:48:59 +03:00
Daniel Hahler da585439ff docs: update URL for vicious (#2446)
It has been turned into an organization [1].

1: https://github.com/vicious-widgets/vicious/issues/60

[ci skip]
2018-10-20 15:15:01 -04:00
Emmanuel Lepage Vallee bb357dd33e doc: Restore the example width limit to fit in 1024x768.
The old stylesheet did this and it forced the examples to be smaller.

This commit restore this limit.
2018-10-12 14:19:25 -04:00
Emmanuel Lepage Vallee cd6979618f doc: Update the CSS to support our custom table class
Other change:

 * Use GitHub style <code> border
 * Add support for HTML <kbd> tags
2018-10-12 14:19:25 -04:00
Emmanuel Lepage Vallee b49f7e22dd doc: Add an index of valid properties to awful.spawn and awful.rules. 2018-10-12 14:19:25 -04:00
Emmanuel Lepage Vallee 62c95d5fe6 build: Move the meta file parser to an helper module
The commit also re-work the build target so if the file are deleted,
then they are created again. Using `file(COPY ...)` and
`file(MAKE_DIRECTORY ...)` as done previously caused some file to be out
of date or not being regenerated at all.

This commit also fixes some broken target that depended on `file(` and
`configure_file` CMake command not being part of any target.

Fix #2342
2018-10-12 14:18:32 -04:00
Emmanuel Lepage Vallee 90b17bdc09 awful.rules: Add proper documentation to the extra client properties.
Until now there wasn't much documentation available about how to use
these properties. With the new work on `awful.spawn` that rely more and
more on `awful.rules` integration, it is worth fixing.

This commit add a new documentation section and a future commit will
aggregate them to generate an index.
2018-10-10 01:58:18 -04:00
Emmanuel Lepage Vallée 768184d152
Merge pull request #2368 from psychon/motif_hints
Add c.requests_no_titlebar based on motif hints
2018-10-06 22:00:03 -04:00
Emmanuel Lepage Vallee 3fe5798a97 ldoc: Add a @sourcefunction section.
It will be used by features introduced in the next commit.
2018-08-27 00:03:22 -04:00
Uli Schlachter 45430daf7f rc.lua: Move Motif hints example to generated docs
Signed-off-by: Uli Schlachter <psychon@znc.in>
2018-08-26 19:26:19 +02:00
Emmanuel Lepage Vallee 3792a17c2f ldoc: Add a "filter" section for the taglist and tasklist 2018-08-18 15:49:05 -04:00
Emmanuel Lepage Vallee f11c0b47b9 doc: Remove capi.keygrabber from the official doc
`awful.keygrabber` should be the only one used directly.
2018-08-06 19:03:25 -04:00
Daniel Hahler 3876b18240 doc: Add missing C-object documentation and fix some papercuts.
Ref: https://github.com/awesomeWM/awesome/issues/1373
2018-07-25 18:26:11 -04:00
Yauhen Kirylau 4bd5b1940d feat(themes; beautiful): add partial support for GTK+3 themes (#2129) 2018-06-26 10:43:20 -04:00
Emmanuel Lepage Vallee f234dcabf6 doc: Add `[deprecated]` after some function names.
It use a little XSS-ish HTML tag injection, but it works
2018-05-28 14:11:41 -04:00
Emmanuel Lepage Vallee 0a2b05dfbb doc: Use the newer LDoc ability to use special handler for objects types
The `@signal` and `@property` are now correctly rendered. The need for
the extra `.` in front of the signal is no longer needed.
2018-05-28 14:11:41 -04:00
Joseph Herlant d9cc56538f build: man pages: use asciidoctor instead of asciidoc (#2234) 2018-04-04 11:28:50 +02:00
actionless 98e59225d7 chore(ldoc: css): return bullets style for unordered list items 2018-03-20 17:50:39 +00:00
actionless bdbc11e7df style(ldoc: css): apply some manual code formatting 2018-03-20 17:50:39 +00:00
actionless d5d46a4373 fixup! chore(ldoc: css): new style for the tables 2018-03-20 17:50:39 +00:00
actionless 8762588082 fixup! chore(ldoc: css): new style for the tables 2018-03-20 17:50:39 +00:00
actionless 0a6f3aa3da fixup! chore(ldoc: css): new style for the tables 2018-03-20 17:50:39 +00:00
actionless dafbd48375 chore(ldoc: css): new style for the tables 2018-03-20 17:50:39 +00:00
Emmanuel Lepage Vallée 356d730b7d
Merge pull request #2216 from psychon/deprecate-get_dir
Deprecate gears.filesystem.get_dir
2018-03-12 22:55:33 -04:00
README Bot 34f6cfccd8 Add CodeTriage badge to awesomewm/awesome (#2209)
Adds a badge showing the number of people helping this repo on CodeTriage.

[![Open Source Helpers](https://www.codetriage.com/awesomewm/awesome/badges/users.svg)](https://www.codetriage.com/awesomewm/awesome)

## What is CodeTriage?

CodeTriage is an Open Source app that is designed to make contributing to Open Source projects easier. It works by sending subscribers a few open issues in their inbox. If subscribers get busy, there is an algorithm that backs off issue load so they do not get overwhelmed

[Read more about the CodeTriage project](https://www.codetriage.com/what).

## Why am I getting this PR?

Your project was picked by the human, @schneems. They selected it from the projects submitted to https://www.codetriage.com and hand edited the PR. How did your project get added to [CodeTriage](https://www.codetriage.com/what)? Roughly over 1 year ago, [cameronjacobson](https://github.com/cameronjacobson) added this project to CodeTriage in order to start contributing. Since then, 8 people have subscribed to help this repo.

## What does adding a badge accomplish?

Adding a badge invites people to help contribute to your project. It also lets developers know that others are invested in the longterm success and maintainability of the project.

You can see an example of a CodeTriage badge on these popular OSS READMEs:

- [![Email clients like GMAIL do not render SVG images](https://www.codetriage.com/rails/rails/badges/users.svg)](https://www.codetriage.com/rails/rails) https://github.com/rails/rails
- [![Email clients like GMAIL do not render SVG images](https://www.codetriage.com/crystal-lang/crystal/badges/users.svg)](https://www.codetriage.com/crystal-lang/crystal) https://github.com/crystal-lang/crystal

## Have a question or comment?

While I am a bot, this PR was manually reviewed and monitored by a human - @schneems. My job is writing commit messages and handling PR logistics.

If you have any questions, you can reply back to this PR and they will be answered by @schneems. If you do not want a badge right now, no worries, close the PR, you will not hear from me again.

Thanks for making your project Open Source! Any feedback is greatly appreciated.
2018-03-12 22:52:43 -04:00
Uli Schlachter 3e7ab86fae sample_theme: Use get_configuration_dir()
Signed-off-by: Uli Schlachter <psychon@znc.in>
2018-03-11 16:08:07 +01:00
Uli Schlachter 128c1ec32f Fix the reference to the default config in my-first-awesome
The line in the default config changed at some point.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2018-03-11 16:08:07 +01:00
Emmanuel Lepage Vallee 74508098de rules: Add a rule building chain of responsability
Before this commit, there was a conflict between the spawn and
awful.rules rules.

Also, modules such as Tryannical monkey-patched this function to
add their own rules to the mix. This commit introduce a proper
API to add handlers.

The order is crutial for this to work, so a dependency system is
also added.

Fix #1482
2018-03-04 01:34:33 -05:00
Emmanuel Lepage Vallée fb0ccc3220
doc: Add a common problem section 2018-02-25 17:21:32 -05:00
Emmanuel Lepage Vallee d99504775b doc: Mutualize the wibar and wibox constructor documentation.
Do it now since the future awful.popup and notification widget
also uses it.

The `load_ldoc.cmake` changes allow to include `.ldoc` blocks in
existing ldoc comments. Previously, it added some extra newlines
and an autogenerated comments saying the content below was imported.
The problem is that this prevented the system to be used for shared
function arguments.

This commit also renames the `wibar` argument table from `arg` to
`args` as the name has to be the same in the `wibox` and `wibar`
constructor for this to work.
2017-11-27 00:22:11 -05:00
Emmanuel Lepage Vallee 4e54aea6a9 wibox: Add an input_passthrough property.
Allows, for example, to have semi translucent wibars on top of
the fullscreens clients without having issues with inputs.
2017-11-27 00:20:42 -05:00
Emmanuel Lepage Vallee fccd35b45c doc: Remove entries for modules that have been moved for a year or more.
To make the index looks smaller.
2017-11-19 00:46:06 -05:00
Emmanuel Lepage Vallee 9f7a365447 doc: Cleanup useless index entries
Entries such as the empty `objects.client` or `awful.hotkeys_popup.keys`
are no longer in the main index.
2017-11-19 00:46:06 -05:00
Daniel Hahler fb93003cc5 docs/ldoc.css: just use system fonts 2017-10-28 00:08:31 +02:00
Daniel Hahler 5c9bc988bb navigation: less margin to the left 2017-10-28 00:08:31 +02:00
Daniel Hahler 102e1046b9 add our logo 2017-10-28 00:08:31 +02:00
Daniel Hahler b291880fa1 add css
Source: https://github.com/stevedonovan/LDoc/pull/287
https://raw.githubusercontent.com/hishamhm/LDoc/7214818f0ff580e5607a4de764340aa7e3b55d1a/ldoc/html/ldoc_new_css.lua
2017-10-28 00:08:28 +02:00
Reiner Herrmann cce65aa6d3 Sort list of files used in generated table 2017-10-07 13:58:35 +02:00
Uli Schlachter 43e268373d Mention minimum ldoc version in the readme (#2027)
See commit 2c741f8e1d which introduced this dependency.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-09-09 05:14:41 +02:00
Luke Bonham 4fc3108e0f Fix doc typos and optimised PNGs (#2000) 2017-08-16 20:07:08 +02:00
Nick Diego Yamane bfe58d65f1 docs: fix some typos/leftovers (#1989)
Signed-off-by: Nick Yamane <nick.diego@gmail.com>
2017-08-14 16:06:44 +02:00
Uli Schlachter eb7ee7072c Fix an old todo in the docs (#1981)
This new paragraph might not be great and it certainly is less
informative than what the wiki said here (it suggested to use some
library for widgets and explained how to use it). However, this new
paragraph is definitely better than the todo that was here for far too
long.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-08-13 22:26:07 +02:00
Daniel Hahler 0f5c7b3270 NEWS: fix typos/grammar (#1918)
[ci skip]
2017-07-15 20:19:36 +02:00
Emmanuel Lepage Vallee 9724850fb8 release: Update the NEWS 2017-07-15 15:53:13 +02:00
Uli Schlachter b8956090d9 Fix cyclic build dependency for 06-appearance.md.lua
Previously this code checked the generated documentation to decide if
something is a class or a module. Now, it parses the source file and
looks for the @classmod, @module and @submodule tags to make the same
decision.

Fixes: https://github.com/awesomeWM/awesome/issues/1255
Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-06-14 14:49:51 +02:00
Uli Schlachter 61229500a2 docs/06-appearance.md.lua: Add vim modeline
Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-06-14 14:29:20 +02:00
Emmanuel Lepage Vallee 5d6d8043ec quality: Remove trailing white spaces
Fix #1129
2017-06-11 00:11:48 -04:00
Uli Schlachter 84080c64c5 spawn: Use CLOEXEC for pipes (#1811)
Fixes: https://github.com/awesomeWM/awesome/issues/1193#issuecomment-305705724
Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-06-02 10:13:26 +02:00
Emmanuel Lepage Vallée 5544d11405 Merge pull request #1802 from awesomeWM/move-widget-drawing
Move gears.surface.widget_to_svg to wibox.widget.draw_to_svg_file (and widget_to_surface to draw_to_image_surface)
2017-06-01 06:05:21 -04:00
Åsmund Ervik c172af947e Updated porting tips with new section on how to obtain clean 3.5.9 and 4.0 rc.lua versions to diff existing config with / port into. Fixes issue #1576 2017-05-31 08:51:53 +02:00
Uli Schlachter 6de6419180 Add functions to draw widgets to a cairo surface
These are supposed to eventually replace the already-existing functions
in gears.surface which have a similar signature

Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-05-30 11:22:07 +02:00
Uli Schlachter 0707f52ebf Get rid of broken hint in the readme (#1801)
luaL_dostring(L, s) is a macro that expands to
luaL_loadstring(L,s)||lua_pcall(L,0,LUA_MULTRET,0). Then,
lua_pcall(L,n,r,f) sometimes (since Lua 5.3?) is a macro that expands to
lua_pcallk(L,n,r,f,0,NULL), but can sometimes also just be a function.

Explaining all the above would make this section more complicated and
apparently no one uses this hint anyway, because no one told us yet that
this hint does not work.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-05-30 10:28:44 +02:00
Uli Schlachter 420d6551c6 Fix a tiny typo
Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-05-11 15:56:58 +02:00
Daniel Hahler c6c8f62e2d doc: FAQ: fix/improve size_hints_honor section (#1740) 2017-04-19 10:03:47 +02:00
getzze 59662bc971 wibox.widget.base: do not call set_children if children is nil 2017-04-18 15:00:39 +02:00
getzze 0e9a0cdee9 doc: improve doc for creating new widget 2017-04-18 14:42:45 +02:00
Kevin Zander 6cb2e0fa82 Fix some deprecated calls in code and docs
Add missing newline in test runner
2017-03-30 21:26:50 -05:00
Emmanuel Lepage Vallee 652a9f109d Update the NEWS 2017-03-18 15:28:29 -04:00
Emmanuel Lepage Vallée 17051d0520 Merge pull request #1624 from psychon/doc_fix
Use only_on_screen widget in docs
2017-03-16 16:16:42 -04:00
Kevin Zander 45dadde0dd Move filesystem functions out of awful.util into new gears.filesystem
Update awful.util filesystem function calls to gears.filesystem function calls
Rename getdir to get_dir for consistency
2017-03-15 13:46:33 -05:00
Uli Schlachter cb1dec79ab Fix docs/07-my-first-awesome.md
In awesome 3.5, the default themes set a global variable called "theme".
This was, I think, not intentional and we changed this when luacheck
found this issue. However, the "my first awesome" document from the old
wiki made use of this fact and so many people were using this hack. This
commit fixes our copy of "my first awesome".

Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-03-08 16:41:09 +01:00
Uli Schlachter c3be117610 Use only_on_screen in the declarative layout example
This is a follow-up to 052cda939b. Expressions like 's.index == 2'
and 's == screen.primary' might work at first. However, they are not
"dynamic": If screens are added/removed or the primary screen changes,
then the widgets are not updated to follow this.

Instead, the example now uses the new awful.widget.only_on_screen
container which provides the needed dynamic behaviour.

This is arguably "the real fix" to #1562 and #1565.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-03-04 15:57:27 +01:00
Emmanuel Lepage Vallee f24e957c17 doc: Fix wibar documentation
I got it wrong in the PR that introduced the beautiful variables.

Too much find&replace...
2017-02-27 16:12:37 -05:00
Emmanuel Lepage Vallee 2ddbbfb70c doc: Add the default theme to the sample files
Also add the gears to make this more flexible in the future.
2017-02-25 16:42:55 -05:00
Emmanuel Lepage Vallee b697777498 doc: Add the default rc.lua to the API documentation
Enable the `Sample files` section provided by ldoc but unused
until now.
2017-02-25 16:42:55 -05:00
Jonathan McCrohan 052cda939b docs: Update for awesome 4.0 changes
s is now a screen object.

Signed-off-by: Jonathan McCrohan <jmccrohan@gmail.com>
2017-02-23 01:18:27 +01:00
Luke Bonham 3a701f83e5 doc/images/mouse.svg: fix indexes (#1592) 2017-02-22 20:10:50 +01:00
Emmanuel Lepage Vallee 4a4864bb75 doc: Add another declarative syntax example
Better show the composite/encapsulated widgets
2017-02-12 22:19:08 +01:00
Emmanuel Lepage Vallee d6412b96fd doc: Fix an error in the declarative guide
`vicious.register(w, f(args))`
    -> `vicious.register(self, f(args))`

Also add the monkeypatch to other widgets, it makes it more useful
2017-02-11 14:47:31 -05:00
Emmanuel Lepage Vallee 528ab6c7cf doc: Removed remaining references to .lua.in files
The .in is no longer used

Fix #1525
2017-02-05 12:16:27 -05:00
Emmanuel Lepage Vallée cbd22eea50 Merge pull request #1475 from psychon/input-shape-support
Input shape support
2017-02-03 12:25:56 -05:00
Sudo Nice 21906afb5d doc: reflect the actual way to get client object 2017-02-03 18:47:21 +03:00
Justin Charette cc5c4147d9 doc: fix pr 1486 formatting (ldoc bug) with nbsp (0xa0)
ldoc formatting has problems with code block lines that start with
spaces.  use non-blocking-space (unicode 0xa0) as a work around.

Signed-off-by: Justin Charette <charetjc@gmail.com>
2017-01-29 14:31:13 -05:00
boxofrox 420f672661 doc: porting guide corrections, addition, and cleanup (#1486)
- added note that `awesome.quit` must be wrapped in an anonymous
  function when used as a menu command.
- corrected tasklist diff to include missing lines from rc.lua.  the
  porting guide code doesn't make much sense otherwise.
- cleaned up diff columns on a couple other code blocks.

Signed-off-by: Justin Charette <charetjc@gmail.com>
2017-01-29 14:59:57 +01:00
Holger Schurig bf2c1993db doc: fix signals (#1455)
- rule reordering was mentioned twice in the NEWS
- fix all shown luadoc errors
- add missing descriptions for signals in module "awesome"
2017-01-28 15:03:56 +01:00
Uli Schlachter 47d69e7824 Update docs for shape_input
I grepped for shape_clip and edited places that needed editing.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-01-26 11:15:28 +01:00
Holger Schurig 508614dfd2 change module to class when documention links to a class description (#1440) 2017-01-23 18:55:28 -05:00
Holger Schurig 519b65ee14 doc: fix bad link and a double asterisk in NEWS.md (#1442) 2017-01-23 22:50:23 +01:00
Emmanuel Lepage Vallee 8d0001a684 doc: Fix an API error in the NEWS file 2017-01-23 12:40:41 -05:00
Daniel Hahler eefa9fc369 doc: add v4 anchors (#1425) 2017-01-22 19:14:13 +01:00
Emmanuel Lepage Vallée e0bce2936f Merge pull request #1329 from Elv13/prompt_refactor
Prompt documentation & fixes
2017-01-22 09:14:00 -05:00
Emmanuel Lepage Vallee ff78f4a41d porting-tip: Mitigate a bug in the discount MarkDown parser.
Some `+` and `-` were missing because it re-indented the content
based on the first code line. It then truncated whatever was
below.

Pushing this to master because Ubuntu/Z, Debian/Sid and Arch just
upgraded to 4.0 and angry reports are coming in *fast*.
2017-01-22 07:59:25 -05:00
Emmanuel Lepage Vallee 1ff747160e doc: Add a callback section 2017-01-20 01:09:30 -05:00
Daniel Hahler 4b9e8e232d Merge pull request #1341 from psychon/modeline
Lots of fun with vim modelines
2017-01-02 19:56:06 +01:00
Uli Schlachter 1078a9f395 Bump minimal LGI version to 0.8.0 (#1350)
Turns out that menubar already uses features that were only added in
that version.

Fixes: https://github.com/awesomeWM/awesome/issues/1348
Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-01-02 19:53:02 +01:00
Uli Schlachter 7d3b7fc48a Add vim modelines to all CMake files
Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-12-31 14:02:14 +01:00
Uli Schlachter b4387d387d Add error checking in 05-awesomerc.md.lua (#1330)
io.open returns nil, an error message and an error code on failure. This
perfectly fits assert which will make the script fail with the error
message. Previously it would fail with "attempted to index a nil value".

Reference: https://www.reddit.com/r/awesomewm/comments/5kyqji/cant_build_git_awesome/
Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-12-30 14:15:47 +01:00
Uli Schlachter 9077dec275 Add text to ldoc index
This adds a short text with some hopefully helpful pointers to the top
of the index.html generated by ldoc.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-12-28 18:08:28 +01:00
Uli Schlachter fcf2c26bea Documentation: Add "my first awesome"
This document is based on the "my first awesome"-page in the old wiki.
Large parts of it are taken almost verbatim from it while others were
handled more freely. For example, instead of referring to the man page
for an overview of the available key bindings, this now mentions Mod4+S.

The "Add widgets"-section is just a todo. The wiki page refers to
Vicious which does not really work for our api documentation. However, I
also didn't want to just drop this part.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-12-28 18:08:28 +01:00
Mikko Valkonen 397fb2eb7f doc: add instructions to pass args to cmake (#1317)
Adds a small note to the README for passing arguments to cmake during
the build by using the `CMAKE_ARGS` environment variable
2016-12-28 12:39:03 +01:00
Uli Schlachter 32f0ab8198 Guarantee stable order for docs/03-declarative-layout.md (#1312)
Fixes: https://github.com/awesomeWM/awesome/issues/1257
Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-12-27 16:31:07 +01:00
Daniel Hahler 58c068b17e doc: fix authors (#1304)
Proper links for URL/mailto, and minor formatting fixes.
2016-12-27 02:42:41 +01:00
Emmanuel Lepage Vallée c349ff9206 Merge pull request #1283 from Elv13/add_porting_tips
doc: Add a porting guide.
2016-12-21 12:52:44 -05:00
Emmanuel Lepage Vallee 52e31367a7 doc: Add a porting guide. 2016-12-21 12:37:36 -05:00