From 5f5c9897df78e678d1c8ccc34c864a9ae85af9f3 Mon Sep 17 00:00:00 2001 From: "ay9thqi3tbqiwbegqsg a[soiaosshasdg" <30902201+alx365@users.noreply.github.com> Date: Mon, 26 Oct 2020 08:38:03 +0000 Subject: [PATCH] extended troubleshooting in the docs and fixed a few typos (#46) * extended troubleshooting and fixed typos * extended troubleshooting and fixed typos * Update docs/content/main/troubleshooting.md Co-authored-by: ElKowar <5300871+elkowar@users.noreply.github.com> * Update docs/content/main/troubleshooting.md Co-authored-by: ElKowar <5300871+elkowar@users.noreply.github.com> * Update docs/content/main/configuration.md Co-authored-by: ElKowar <5300871+elkowar@users.noreply.github.com> Co-authored-by: ElKowar <5300871+elkowar@users.noreply.github.com> --- docs/content/main/_index.md | 2 +- docs/content/main/configuration.md | 4 ++-- docs/content/main/troubleshooting.md | 25 ++++++++++++++++++++----- docs/content/main/working_with_gtk.md | 2 +- 4 files changed, 24 insertions(+), 9 deletions(-) diff --git a/docs/content/main/_index.md b/docs/content/main/_index.md index 55a2367..beb7258 100644 --- a/docs/content/main/_index.md +++ b/docs/content/main/_index.md @@ -5,7 +5,7 @@ sort_by = "weight" +++ -Eww (ElKowar's Wacky Widgets, pronounced with sufficient amounts of disgust) Is a widgeting system made in [rust](https://www.rust-lang.org/), which let's you create your own widgets simmilarly to how you can in AwesomeWM. The key difference: It is independent of your window manager! +Eww (ElKowar's Wacky Widgets, pronounced with sufficient amounts of disgust) Is a widgeting system made in [rust](https://www.rust-lang.org/), which let's you create your own widgets similarly to how you can in AwesomeWM. The key difference: It is independent of your window manager! Configured in XML and themed using CSS, it is easy to customize and provides all the flexibility you need! diff --git a/docs/content/main/configuration.md b/docs/content/main/configuration.md index 5cdd5b5..810a958 100644 --- a/docs/content/main/configuration.md +++ b/docs/content/main/configuration.md @@ -6,11 +6,11 @@ weight = 1 ## Configuration -For specific built in widgets `, , , etc` see [Widget Documetation](@/main/widgets.md) +For specific built in widgets `, , , etc` see [Widget Documentation](@/main/widgets.md) ### Placing the configuration file -The configuration file and the scss file should lay in your `$HOME/.config/eww` folder. The xml file should be named `eww.xml` and the scss should be named `eww.scss` +The configuration file and the scss file should lay in `$XDG_CONFIG_HOME/eww` (or, if unset, `$HOME/.config/eww`). The XML file should be named `eww.xml` and the scss should be named `eww.scss` So the directory structure should look like this: ``` $HOME diff --git a/docs/content/main/troubleshooting.md b/docs/content/main/troubleshooting.md index ffd0517..1cf7440 100644 --- a/docs/content/main/troubleshooting.md +++ b/docs/content/main/troubleshooting.md @@ -6,16 +6,15 @@ weight = 4 ## Troubleshooting -Here you will find help if something doesn't work, if the issue isn't listed here please [open an issue on the github repo.](https://github.com/elkowar/eww/issues) +Here you will find help if something doesn't work, if the issue isn't listed here please [open an issue on the GitHub repo.](https://github.com/elkowar/eww/issues) ### My scss isn't being loaded! 1. You have not created a scss file 2. The scss file isn't called correctly. (it should be called `eww.scss` in the `$HOME/.config/eww` folder) 3. The scss file isn't placed in the correct location (check above) -4. You have used two (or more) semi-colons (;;) insted of one (;) at the end of a line. -If none of these fixed your problem [open an issue on the github repo.](https://github.com/elkowar/eww/issues) Or check the [GTK-Debugger](#gtk-debugger). +If none of these fixed your problem [open an issue on the GitHub repo.](https://github.com/elkowar/eww/issues) Or check the [GTK-Debugger](#gtk-debugger). ### Eww can't find my configuration file! @@ -24,7 +23,23 @@ If none of these fixed your problem [open an issue on the github repo.](https:// ### Something isn't styled correctly! -1. You have misstyped the CSS class. +1. You have mistyped the CSS class. 2. Check the [GTK-Debugger](#gtk-debugger) -Remeber if your issue isn't listed here, [open an issue on the github repo](https://github.com/elkowar/eww/issues). +### General issues + +You should try the following things, before opening a issue or doing more specialized troubleshooting: + +- Try killing the eww daemon with `eww kill` and run again +- If you're running with `-d`, run without `-d` to see output, or run `eww logs` to see the logs written by eww. These logs are stored in `~/.cache/eww.log`. +- use `eww state`, to see the state of all variables +- use `eww debug`, to see the xml of your widget and other information +- update to the latest eww version +- sometimes hot reloading doesn't work. restart the widget in that case + +If you're experiencing issues printing variables, try to print them in quotes, so e.g. +``` +onchange="notify-send '{}'" +``` + +Remember if your issue isn't listed here, [open an issue on the GitHub repo](https://github.com/elkowar/eww/issues). diff --git a/docs/content/main/working_with_gtk.md b/docs/content/main/working_with_gtk.md index 31116c7..fab0f0e 100644 --- a/docs/content/main/working_with_gtk.md +++ b/docs/content/main/working_with_gtk.md @@ -6,7 +6,7 @@ weight = 2 ## GTK -### Gtk-Themeing +### Gtk-theming Eww is styled in GTK CSS. To make theming even easier, it makes use of `scss` and then compiles that into CSS for you.