Commit Graph

134 Commits

Author SHA1 Message Date
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
Emmanuel Lepage Vallee 2fe4e68355 doc: Add keybinding documentation 2016-12-21 11:41:29 -05:00
Emmanuel Lepage Vallée 8935ed2a30 Remove traces of the old URL (#1280)
**WARNING**: This breaks the API
2016-12-21 02:03:03 +01:00
Emmanuel Lepage Vallée ab38876b0d Merge pull request #1272 from kiike/fix-docs-grammar
Fix typos, grammar in docs
2016-12-16 16:37:54 -05:00
Enric Morales 530e64e9ec Fix more typos 2016-12-16 22:02:35 +01:00
Emmanuel Lepage Vallée 620f64f29d Merge pull request #1274 from Elv13/more_spawn_doc
More spawn doc
2016-12-16 12:59:03 -05:00
Emmanuel Lepage Vallee 9ef84550f9 FAQ: Add more entries for common questions
Data mined from the IRC logs by checking for a "?" from users who
had not spoken for >= 5 hours.
2016-12-16 12:38:33 -05:00
Enric Morales 4bed437d50 Fix some minor typos in 89-NEWS.md 2016-12-14 16:26:00 +01:00
Enric Morales 2338f84369 Should be non-exhaustive instead of non-extensive 2016-12-14 15:53:13 +01:00
Enric Morales c2b265f3ba Correct minor typos in 16-using-cairo.md 2016-12-14 15:41:01 +01:00
Enric Morales d7a0486da9 `awesomerc.md.lua` typos and grammar 2016-12-14 15:37:34 +01:00
Enric Morales 8bd0da5315 Fix typos in declarative layout docs 2016-12-13 23:31:25 +01:00
Uli Schlachter 731ddfe9c9 Remove docs/doing_a_release.md
I am no longer sure why I added this file. It doesn't really belong into
the awesome source code. It is better suited to be added to our web
page, I think.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-12-13 17:48:13 +01:00
Emmanuel Lepage Vallee ff1201f047 FAQ: Add an entry about the recent multi-screen changes 2016-12-12 13:05:08 -05:00
Emmanuel Lepage Vallee 6aa42ff8e3 doc: Change the wording of the module aliases
Fixes #1146
2016-12-11 14:45:23 -05:00
Emmanuel Lepage Vallee 0a1897946c doc: Add the 4.0 changelog 2016-12-11 00:10:39 -05:00
Emmanuel Lepage Vallee aed2268a18 doc: Update the authors
Cleanup and point to the GitHub page for the recent contributors.

Some older contributors don't have GitHub accounts, so are
invisible, so I left the old list intact.
2016-12-11 00:10:39 -05:00
Emmanuel Lepage Vallée 548b15e883 doc: Document the client layouts. (#1247)
This commit doesn't add any useful documentation, but adds
previously hidden documentation variables. It can be the basis
of a better layout documentation.

Fix #1246
2016-12-10 02:24:22 +01:00
Uli Schlachter 41a055cf83 Guarantee stable output from 06-appearence.md.lua (#1233)
This function was iterating over a table with pairs() to generate output (the
sample theme file). Since pairs() does not guarantee any iteration order, this
lead to a different order each time this file was generated. This is, for
example, visible in the diffs in the generate api documentation repository.

Fix this by using a self-made iteration function which behaves like pairs(), but
guarantees an iteration order sorted by keys.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-11-25 22:41:58 +01:00