mirror of
https://github.com/Llewellynvdm/conky.git
synced 2024-09-29 13:39:10 +00:00
641f4ecfdb
* eve: fix API, empty queue, conky reload, formatting issues Since the EVE module was contributed, CCP has changed how the API works and what the correct API URL is. So the module had to be updated to respect the changes made on the EVE side. Additionally, undefined behavior was occurring for characters without active skill training queue, as is common for folks with multiple characters on a single account, and was also occurring when Conky was reloaded following a config file change. Now the `$eve` variable should just contain an empty string if the character isn't training a skill (to make it detectable by `$is_empty`), and the module should do The Right Thing (tm) when the config file is changed while Conky is running. The time remaining text has been adjusted to be slightly less verbose. The module should do the right thing for up to 64 distinct characters. Presently, though, every additional character requires a blocking CURL request, meaning that querying many characters is presently not ideal. A rewrite of the module to use asynchronous requests is probably in order, but will be left for a future PR. * eve: fix timezone handling; better handling of bad XML * On Linux `gettimeofday()` doesn't return valid timezone data; we use `localtime()` and the `tm_gmtoff` instead. Training times are no longer incorrect as a result. * Sometimes the EVE API will return spurious non-XML tags as part of the response. This previously caused the XML parser to return a null document. We tell libxml to `XML_PARSE_RECOVER` to try to recover from these errors where they occur on real data. |
||
|---|---|---|
| .. | ||
| CMakeLists.txt | ||
| command_options.xml | ||
| config_settings.xml | ||
| config_settings.xsl | ||
| conky-howto.xml | ||
| docgen.sh | ||
| docs.xml | ||
| lua.xml | ||
| lua.xsl | ||
| README.docs | ||
| variables.xml | ||
| variables.xsl | ||
DA DOCS. YO. ============ The main file that contains the bulk of our documentation is docs.xml . We use the DocBook format, which is a really kickass xml-based way of writing documentation, heavily oriented towards programming and computer stuff. There are tags like <command> and <option> that marks up your content without actually having to mark it up, which is why something that's of the <command> shows up in some cool style regardless of whether it's in a man page or a web page. DocBook has been around for 10 years, and there's TONS of resources online about the different tags and the stuff that can be done. FILE ORGANIZATION ================= For the sake of making things readable and organized, docs.xml "includes" three other files, as of 8/18/05. These are config_settings.xml, command_options.xml, and variables.xml . Their names are pretty self-explanatory, and what the "include" essentially does is stick their contents into docs.xml at the appropriate locations when it's time to produce a man page or html file. So if you wanted to add a variable or explain a command line option better, you'd look in variables.xml and command_options.xml. If you wanted to change the authors or something, look in docs.xml BUILDING DA DOCS ================ (NOTE that the docs are now built automatically via doc/Makefile.am, but it requires that you have docbook2x and xsltproc installed) making the html is easy. xsltproc should more than likely already be on your system: xsltproc http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl docs.xml > docs.html ============================================================================================================== making the man page is pretty easy, it uses a program called docbook2x, which you might or might not have. docbook2x-man docs.xml (produces a conky.1 file) gzip conky.1 conky.1.gz can be viewed in man-form by doing "man -l conky.1.gz" ============================================================================================================== making the README (text-only) file is just some simple unix: man -l conky.1.gz | col -b > README