Commit Graph

420 Commits

Author SHA1 Message Date
Thomas Croft 3c214a7883 Examples 2022-10-02 20:27:57 -06:00
Emmanuel Lepage Vallee 88c65a71dd textbox: Rename `align` to `halign`.
`halign` is used in multiple place in the API. Once upon a time,
Awesome only supported horizontal widgets, but this era has long
passed.

Fix #3640
2022-09-06 16:11:04 -07:00
Emmanuel Lepage Vallee b16505733a tests: Add more textbox tests. 2022-09-06 16:09:26 -07:00
Emmanuel Lepage Vallee 328551d479 doc: Fix the UML template luacheck issues 2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee fc95f43bde doc: Add logging to _postprocess.lua.
Try to find why it works locally, but not on GitHub.
2022-08-29 22:49:47 -07:00
Emmanuel Lepage Vallee 0f948c145f tests: Fix a missing --DOC_HIDE in the notification examples. 2022-08-29 22:49:46 -07:00
Emmanuel Lepage Vallee 7091b2720c test: Enforce the maximum size for the `wibox` test example templte.
So far, it worked fine if both `w`/`h` were enforced or neither.
If one was, then there was a chance one axis would end up 9999
pixel wide or tall. This worked fine when the `.svg` was inserted
using `<img>`, but now that it's using `<object>`, it now scales
down to zero.
2022-08-29 22:49:46 -07:00
Emmanuel Lepage Vallee 86d1b1c22c doc: Add a mandatory `@noreturn` for functions and methods.
The goal is to catch cases where the return value exists, but is
forgotten. There was a large enough number of them to turn this
into a real check. Initially, I just wanted to implement it to fix
the problems, then delete the code. But since this is so common, I
think it is worth the annoyance.
2022-08-29 22:49:45 -07:00
Emmanuel Lepage Vallee 3510d96d6c doc: Find and post-process untracked SVG files.
Right now the UML template write many files which were not tracked
by CMake. This caused them to be missing from the doc since the
post-processing was added.
2022-08-29 22:49:03 -07:00
Emmanuel Lepage Vallee b4c989bcf8 doc: Fix some regression introduced when fixing the shims behavior.
Previously, clients were displayed even when they were not tagged
or minimized. This was fixed in the shims. However, some examples
never created tags, so the client were never tagged, thus no longer
displayed.
2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee f3987f43b6 doc: More proof reading fixes. 2022-08-29 22:48:54 -07:00
Aire-One e15205a548 add(css) .image-object max-size (#17)
Co-authored-by: Emmanuel Lepage Vallée <elv1313@gmail.com>
2022-08-29 22:48:54 -07:00
Lucas Schwiderski 20ab3a5fb6 doc: Fix example code header showing in page 2022-08-29 22:48:54 -07:00
Lucas Schwiderski 345de1e9d9 bug: Add workaround for new image paths 2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee 87a69c4d4d doc: Fix a problem which causes the SVG to be blurry. 2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee 93f7269081 doc: Change the default theme to use a "special" fg color.
This magic color will be find&replaced by a post-processing script.
2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee f5b2f34269 doc: Update some examples not to hardcode the foreground color. 2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee 2c18547a6b doc: Post-process all auto-generated SVG.
This removes the hardcoded foreground color and inherit it from
the browser and/or CSS stylesheet.

This commit only support the foreground colors, future changes could
extend it to support all standard colors.
2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee 197ed41c2d doc: Use the theme foreground color instead of black in the templates.
This is a step toward adding a dark theme to the doc. Otherwise, the
images were black on dark grey, which is impossible to read.
2022-08-29 22:48:36 -07:00
Emmanuel Lepage Vallee 8f71ef6dff doc: Document the tasklist widget. 2022-08-29 22:48:35 -07:00
Emmanuel Lepage Vallee cf2129b2fe doc: Add a memento widget for the wibox template. 2022-08-29 22:47:55 -07:00
Emmanuel Lepage Vallee 686c4fec22 doc: Add the ability to render random widgets to the sequence template. 2022-08-29 22:47:55 -07:00
Aire-One 392dbc21ab
[CI] Run `Run examples tests` on every supported Lua Version (#3575)
* ci(main) always run `Run examples tests`

* fix(font1) print with string.format
2022-03-06 14:04:50 +01:00
Lucas Schwiderski 5ac0829f5d
docs(w.w.slider): Add value signal to initial example
Since the primary use case of the slider widget is to do something
with the value when it changes, the initial example should show
how to do that.
2021-12-21 11:55:36 +01:00
sarubo 8d61790be7 doc: Add the markup example of popup_calendar
Refer to tests/examples/awful/widget/calendar_popup/default.lua
2021-11-21 23:49:46 +09:00
Emmanuel Lepage Vallée 2eb035e125
Merge pull request #3493 from Elv13/progressbar_doc
Improve the progressbar doc with more examples.
2021-11-03 12:40:56 -07:00
Emmanuel Lepage Vallee 76704b33e7 progressbar: Make `ticks` and `bar_shape` compatible with each other.
It looked horrible/buggy when combined. Now it looks like people would
expect it to work. Another problem was the `bar_border_width` look
when `ticks` was `true.
2021-11-02 20:36:07 -07:00
Emmanuel Lepage Vallee 0afb719f82 doc: Improve the progressbar doc.
Another commit in the "lets finish the widget doc" serie.
2021-11-02 20:36:07 -07:00
Emmanuel Lepage Vallee 1fa0204d80 doc: Add many textbox examples. 2021-10-30 22:51:40 -07:00
Emmanuel Lepage Vallee c5f81d4aab doc: Add some new lines in an old example. 2021-10-30 22:44:31 -07:00
Emmanuel Lepage Vallee 9a380a492f tests: Do not hardcode the font in the shims. 2021-10-30 22:44:12 -07:00
Emmanuel Lepage Vallee a3c7ed166f tests: Modify the client.relative_move test for the new behavior.
Also add more asserts.
2021-10-27 19:50:48 -07:00
Emmanuel Lepage Vallee 8c9e270477 tests: Improve the sequence template.
* Fix a typo
 * Add some initialization signals
 * Refactor the geometry code to be more resilient
 * Put more data into the memento
2021-10-27 18:30:30 -07:00
Emmanuel Lepage Vallee 94e13b7bb0 shims: Fix some bugs for ruled.tag. 2021-10-27 18:30:30 -07:00
Emmanuel Lepage Vallée 8541637a85
Merge pull request #3475 from Elv13/fix_626
Another doc upgrade.
2021-10-21 15:07:54 -07:00
Emmanuel Lepage Vallee b2603f6a86 doc: Add images for awful.client.* functions. 2021-10-18 14:38:37 -07:00
Emmanuel Lepage Vallee ae71158093 doc: Add documentation for the client "window factor" related functions
It might be a good idea to deprecate them and move them to the tag
class. However, these APIs are not exactly well designed, so
moving them wont solve that. Some day the dynamic client layout will
hopefully be merged and send these functions to the heap of smelly
bad ideas trash.
2021-10-18 14:38:37 -07:00
Emmanuel Lepage Vallee a8d2fa0297 doc: Add a large number of `client` examples.
Backfill some under-documented APIs with yet more shiny images.
2021-10-18 14:38:37 -07:00
Emmanuel Lepage Vallee 73625168f2 doc: Improve the `awful` template.
* Support client shape
 * Support titlebar colors
 * Only render clients part of the selected tag(s).
2021-10-18 14:38:37 -07:00
Emmanuel Lepage Vallee fd8401a399 shims: Send the property:: signal for the client class. 2021-10-18 14:38:37 -07:00
Emmanuel Lepage Vallee 56256d0c38 shims: Add client.first_tag. 2021-10-16 17:07:18 -07:00
Emmanuel Lepage Vallee 667a0dfc18 tests: Add tests for swapping a client. 2021-10-15 20:20:24 -07:00
Emmanuel Lepage Vallee e40ad11ec0 shims: Implement client:swap(). 2021-10-15 19:50:22 -07:00
Emmanuel Lepage Vallee 028d01590a doc: Add a client.border_width example. 2021-10-15 19:50:03 -07:00
Emmanuel Lepage Vallee c1d25cd70d doc: Improve the `awful` template client widget.
It was incorrectly sized.
2021-10-15 19:45:05 -07:00
Emmanuel Lepage Vallee 206bc7e5de doc: Fix client.border_color example rendering. 2021-10-15 17:47:03 -07:00
Emmanuel Lepage Vallee 2a65d8ade1 tests: Fix the layoutlist popup example.
`gears.table.cycle_value` returns 2 values. That accidentally
passed the second one to `awful.layout.set`, which didn't like
it at all.
2021-10-14 14:09:47 -07:00
Emmanuel Lepage Vallee c3fe4c15ed doc: Uncomment the wallpaper `screen` property. 2021-10-01 16:54:22 -07:00
Emmanuel Lepage Vallee 70cd293839 doc: Integrate `awful.wallpaper` into the guides. 2021-09-24 08:42:42 -07:00
Emmanuel Lepage Vallee 4a0645e942 doc: Correctly render --DOC_NO_USAGE + --DOC_GEN_OUTPUT.
It was previously merged into a single block.
2021-09-24 08:42:42 -07:00