1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-11-04 08:17:17 -05:00
elinks/src
Kalle Olavi Niemitalo 5a43c55c9e Rewrap lines in option documentation.
Documentation strings of most options used to contain a "\n" at the
end of each source line.  When the option manager displayed these
strings, it treated each "\n" as a hard newline.  On 80x24 terminals
however, the option description window has only 60 columes available
for the text (with the default setup.h), and the hard newlines were
further apart, so the option manager wrapped the text a second time,
resulting in rather ugly output where long lones are interleaved with
short ones.  This could also cause the text to take up too much
vertical space and not fit in the window.

Replace most of those hard newlines with spaces so that the option
manager (or perhaps BFU) will take care of the wrapping.  At the same
time, rewrap the strings in source code so that the source lines are
at most 79 columns wide.

In some options though, there is a list of possible values and their
meanings.  In those lists, if the description of one value does not
fit in one line, then continuation lines should be indented.  The
option manager and BFU are not currently able to do that.  So, keep
the hard newlines in those lists, but rewrap them to 60 columns so
that they are less likely to require further wrapping at runtime.
2009-03-08 15:18:10 +02:00
..
bfu Rewrap lines in option documentation. 2009-03-08 15:18:10 +02:00
bookmarks Rewrap lines in option documentation. 2009-03-08 15:18:10 +02:00
cache Patch 3: Further fixes including strcasestr and convert_to_lowercase 2008-11-01 22:32:43 +02:00
config Rewrap lines in option documentation. 2009-03-08 15:18:10 +02:00
cookies Rewrap lines in option documentation. 2009-03-08 15:18:10 +02:00
dialogs Bug 1061: Correctly truncate UTF-8 titles in the tab bar. 2009-01-01 20:01:50 +00:00
document Rewrap lines in option documentation. 2009-03-08 15:18:10 +02:00
dom bug 1067: Assertions and comments about done_dom_node(). 2009-02-15 03:39:00 +02:00
ecmascript Rewrap lines in option documentation. 2009-03-08 15:18:10 +02:00
encoding Fallback to the raw deflate only when nothing was decompressed so far. 2009-02-21 14:12:03 +01:00
formhist Rewrap lines in option documentation. 2009-03-08 15:18:10 +02:00
globhist Rewrap lines in option documentation. 2009-03-08 15:18:10 +02:00
intl bug 153, 1066: Convert XBEL bookmarks to/from UTF-8. 2009-02-08 18:26:04 +02:00
main Hurd bug 22861: Do not select() exceptions from pipes. 2008-09-07 22:52:47 +03:00
mime Rewrap lines in option documentation. 2009-03-08 15:18:10 +02:00
network Rewrap lines in option documentation. 2009-03-08 15:18:10 +02:00
osdep Bug 885: Truncate title at 600 bytes, not 1024. 2009-01-01 19:54:35 +00:00
protocol Rewrap lines in option documentation. 2009-03-08 15:18:10 +02:00
scripting Bug 1069: Revert "1031: JS_SetErrorReporter only once per JSRuntime." 2009-02-26 22:56:33 +02:00
session bug 1066: Attempt to convert -remote addBookmark(URL) to UTF-8. 2009-02-08 18:26:19 +02:00
terminal Use get_terminal_codepage in handle_interlink_event. 2009-01-01 22:59:11 +00:00
util bug 153, 1066: Add codepage parameter to update_bookmark(). 2009-02-08 18:26:18 +02:00
viewer Fix crash on search-toggle-regex when RE disabled 2009-02-22 04:06:51 +00:00
.gitignore Ignore tags file 2007-08-08 14:25:38 +02:00
elinks.h Bug 1060: #undef HAVE_TRE_REGEX_H only in elinks.h 2009-02-08 18:26:22 +02:00
Makefile BUILD_ID: Fix dirt check when srcdir != builddir. 2008-03-01 14:30:57 +02:00
README Remove now useless $Id: lines. 2005-10-21 09:14:07 +02:00
setup.h Make copyright info independent from translations. 2007-10-03 11:53:09 +02:00
vernum.c Remove now useless $Id: lines. 2005-10-21 09:14:07 +02:00
vernum.h Remove now useless $Id: lines. 2005-10-21 09:14:07 +02:00

				  The Big View

The whole dependency tree is supposed (in ideal world) to look somewhat like
the following. Please note that this deals only with the core parts of ELinks,
not extensions like bookmarks, cookies, globhist, mime etc. Those act like
modules and are generally self-contained - the main visible difference is that
they don't have their UI stuff in dialogs/foo.c but in foo/dialogs.c.

Note also that it isn't all that clean-cut as it looks. Some parts of e.g.
lowlevel/ or osdep/ are omnipresent as well and it's meant to be so (at least
for now). Also some other exceptions are possible; the exception to this is
util/, where no exceptions are permitted - it must have no dependencies to the
rest of the code whatsoever, not even compile-time ones. The other way around,
the gettext part of intl/ is generally omnipresent but the charset part is
pretty isolated - it could be probably drawn as connected to document and
terminal (actually, it is used when encoding forms in viewer too, but that
stuff should be probably moved to document).

viewer/ contains code concerning that big rectangle between bars at the top
and bars at the bottom, documents usually being shown inside. Logically, it
is in fact kind of a BFU widget, but in practice it has little in common with
the bfu/ widgets, it is special in many ways and deeply woven to the fabric
of session/ (e.g. session history is basically a chain of viewer widget
descriptors).

dialogs/ is special too. It in fact means to say "global and unique BFU
instances belonging to the ELinks core"/ but that's a rather long and boring
name, besides the nightmares associated with maintaining files and directories
containing spaces in GIT. The "global and unique BFU instances" part can be
represented by exmode, menus and leds (were they there). The "ELinks core"
part can be represented by options, document and downloads. The reason those
aren't in their respective directories (while bookmarks or formhist have their
dialogs.c) is that it's important to keep the dependencies sorted out
reasonably. Had there been e.g. terminal/dialogs.c, it would mean libterminal
has to depend on libbfu.a and so. (There are two 'managerial' exceptions
to this; don't dig into them, please. ;-)

scripting/ (== browser scripting) is also expected to hook all around, perhaps
it should be better in the omnipresent box.

The edges are directed and represent the "using" relation. Therefore,
"bfu -> terminal" means "bfu/ is using terminal/ services (but not
the other way around)".

.---------.
| util/   | <-- This is omnipresent :)
| config/ |
| intl/   |
`---------'

                   .-------.         .---------.
                   |  bfu  |<------- | dialogs |
                   `-------' \       `---------'
                       v      `---.       |
                 .----------.      \ .--------.
                 | terminal | <----- | viewer | <-----------------.
               / `----------'     .> `--------'                   |
           .--'        v         /        v                       v
.-------. /      .----------.   |    .----------.       .----/ecmascript/----.
| osdep |<------ | lowlevel |   |    | document | ----> | document scripting |
`-------' \      `----------'   |    `----------'       `--------------------'
           `---.       ^         \        ^
                \ .---------.     `> .---------.        .----/scripting/----.
                  | network | <----- | session | -----> | browser scripting |
                  `---------'      / `---------'        `-------------------'
                       ^       .--'
                 .----------. <
                 | protocol |
                 `----------'