1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-12-25 12:10:03 +00:00
conky/doc
Nikolas Garofil d872562942 Undid last 3 commits, see rest of the comment for the reason:
I am not really comfortable with adding support to the conky-code
for sites that only work when you register, that's more something
for in a script.
But the biggest reason I undid the commits is that it is now
impossible to compile conky with support for weather if you don't
have the xml libs installed. Users used to be able to compile with
support for weather (using the other site) without xml2.
If you really want to include this other site in the conky code
then split WEATHER in WEATHERCOM and WEATHERNOAA (altough my personal
opinion is that weather.com should only be supported with scripts)
2009-07-18 16:22:43 +02:00
..
command_options.xml A whole bunch of changes, mostly Lua related. 2009-07-09 22:47:41 -06:00
config_settings.xml A whole bunch of changes, mostly Lua related. 2009-07-09 22:47:41 -06:00
config_settings.xsl Refactor some of the new weather code, fix docs. 2009-07-12 23:31:57 -06:00
conky-howto.xml Updated docs to include RSS and wireless. README has not been built. 2007-08-07 22:42:30 +00:00
docgen.sh Removing old svn keywords. 2008-12-09 16:35:49 -07:00
docs.xml Fix man page name. 2009-07-12 12:32:31 -06:00
lua.xml Refactor some of the new weather code, fix docs. 2009-07-12 23:31:57 -06:00
lua.xsl Refactor some of the new weather code, fix docs. 2009-07-12 23:31:57 -06:00
Makefile.am A whole bunch of changes, mostly Lua related. 2009-07-09 22:47:41 -06:00
README.docs Reformatted all code 2008-02-20 20:30:45 +00:00
variables.xml Undid last 3 commits, see rest of the comment for the reason: 2009-07-18 16:22:43 +02:00
variables.xsl Refactor some of the new weather code, fix docs. 2009-07-12 23:31:57 -06:00

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