Commit Graph

24 Commits

Author SHA1 Message Date
Emmanuel Lepage Vallee 70cd293839 doc: Integrate `awful.wallpaper` into the guides. 2021-09-24 08:42:42 -07:00
Emmanuel Lepage Vallee b4cf88f4c0 doc: Fix the titlebars widget constructor doc 2021-03-22 00:56:02 -07:00
Emmanuel Lepage Vallee 522d628c2c doc: Complete the widget documentation page.
This adds the `awful.widget` content along with some images.
2021-03-22 00:54:00 -07:00
Emmanuel Lepage Vallee ac0aeb65c0 doc: Modernize the landing page.
The previous index.html was scary and the most useful links were
at the bottom. This commit fixes that.

It also adds an image of the default config with some labels to name
all visible components.
2021-03-22 00:54:00 -07:00
Michael b959c9de1a docs: Fix wrong code example in "03-declarative-layout" 2020-04-16 18:23:50 +00:00
Emmanuel Lepage Vallee 9be03b528c doc: Mentions the notifications in the widget page. 2019-06-08 18:56:08 -04:00
Emmanuel Lepage Vallee 9acc452b1e naughty: Set an action table even if the notification has none.
Less `if` in the code.
2019-06-08 18:56:08 -04:00
Emmanuel Lepage Vallee 8951b88095 doc: Document the new template widget delegate system. 2019-06-08 18:56:08 -04:00
Emmanuel Lepage Vallee e3c1ecfd40 docs: Better document how widgets work
Ref: #1373
2019-01-24 10:58:45 -05: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 5d6d8043ec quality: Remove trailing white spaces
Fix #1129
2017-06-11 00:11:48 -04:00
Uli Schlachter 420d6551c6 Fix a tiny typo
Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-05-11 15:56:58 +02: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
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
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 Vallée 8935ed2a30 Remove traces of the old URL (#1280)
**WARNING**: This breaks the API
2016-12-21 02:03:03 +01:00
Enric Morales 530e64e9ec Fix more typos 2016-12-16 22:02:35 +01:00
Enric Morales 8bd0da5315 Fix typos in declarative layout docs 2016-12-13 23:31:25 +01:00
Uli Schlachter da6012da3e Fix memory leak in the default config on screen removal
The default config had tables like mywibox and mywibox[s] was the wibox
that is visible on screen s. When a screen is removed, nothing cleans up
these tables and so the screen and the wibox could not be garbage
collected. The same applies to the layoutbox, taglist etc.

This commit removes the global mywibox table and instead saves it as a
property on the screen. This way, the screen is not explicitly
referenced and when it is removed, the screen, its wibox and all of its
widgets become unreachable and can be garbage collected.

This commit also updates the docs and the tests that referenced things
(mostly the wibox) via mywibox[s] to now use s.mywibox.

Fixes: https://github.com/awesomeWM/awesome/issues/1125
Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-09-30 22:46:51 +02:00
Emmanuel Lepage Vallee de2d6fb521 doc: Add a system to auto-generate widgets list
This system allow containers, widgets and layouts to be listed in
the documentation with an example screenshot.

It uses raw HTML due to ldoc limitations, but as it is autogenerated,
it wont be user visible.
2016-05-30 18:00:58 -04:00
Emmanuel Lepage Vallee d85588babe wibox: Create a container module
Previously, the "containers" were placed in layout or widget.

They all have similar APIs and usage, so lets bring them together.
2016-05-30 17:51:19 -04:00
Uli Schlachter 3bc8aa2d40 Fix images in the documentation
Instead of copying images to ${BUILD_DIR}/docs/images, which is the directory
with the input to ldoc, this now copies the images to ${BUILD_DIR}/doc/images,
which is where ldoc generates its output. That way, the images are together with
the html files and are automatically picked up by a lot of stuff.

Fixes: https://github.com/awesomeWM/awesome/issues/681
Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-02-13 08:04:14 +01:00
Emmanuel Lepage Vallee 8be1104615 doc: Add layout system documentation 2016-02-10 01:25:41 -05:00