Updated documentation/README to reflect the new distribution of

pre-generated documentation as separate downloads.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8256 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Albrecht Schlosser 2011-01-11 13:06:15 +00:00
parent b6d2207550
commit 313352b55f
3 changed files with 73 additions and 22 deletions

View File

@ -1,31 +1,73 @@
README
------
README (documentation)
----------------------
FLTK 1.3 documentation is available in HTML and PDF format. The
documentation must be generated in a separate step or downloaded
from FLTK's software download pages. The documentation can also
be accessed online.
The documentation in this directory is in PDF format.
To read it, please open the file "fltk.pdf" in this directory.
To read the docs after downloading or generating them, open the
files:
To generate the doxygen HTML documention, you should have Doxygen
version 1.5.7 or later. Use "make clean html" in the documentation
directory to generate the HTML documentation.
documentation/html/index.html
documentation/fltk.pdf
To read it, please open the file "html/index.html" with your browser.
A documentation version is also available at the FLTK web site,
with your browser or PDF viewer, respectively.
Online Documentation:
---------------------
A documentation version is available online at the FLTK web site,
along with the PDF version of the manual. The docs on the web site
are usually somewhat older (latest release).
are usually somewhat older (latest release). Use this URL to find
the current online documentation:
You can generate your own copy of the PDF manual by typing "make pdf"
in this directory. The resulting file is "latex/refman.pdf". This is
so that "make pdf" does not overwrite the bundled file "fltk.pdf".
http://www.fltk.org/documentation.php
If you type "make pdf-dist" instead, the original file "fltk.pdf"
will be overwritten.
Documentation Download:
-----------------------
To download pre-generated docs, go to
Note that it is usually not necessary to create your own PDF version,
if you use the release version of FLTK, because it comes with a current
"fltk.pdf" file. However, if you use subversion or a snapshot file,
then the included "fltk.pdf" file is likely to be outdated.
http://www.fltk.org/software.php
and look for the files
fltk-<version>-docs-html.tar.gz
fltk-<version>-docs-pdf.tar.gz
Extract the documentation tarballs into the same directory as you
did with the source tarball.
Generation of Documentation:
----------------------------
To generate the documentation yourself, you should have Doxygen
version 1.5.7 or later (recommended version is 1.7.3).
To generate the PDF version you also need a current version of LaTeX.
You can use the packages tetex (older) or texlive (current) if your
distribution provides them. You may need to install additional fonts
and other sub-packages for the PDF version to be generated correctly.
Use "make html" in the documentation directory to generate the HTML
documentation, or "make pdf" to generate the PDF version. "make dist"
generates both versions in one step (as would do "make clean html pdf").
To read the HTML or PDF docs, see above.
FLTK Developer Snapshots or Subversion Usage:
---------------------------------------------
There is no pre-generated documentation available if you use a current
developer snapshot or subversion. You must generate the documentation
yourself.
Bugs and Feature Requests:
--------------------------
If you find any typos, things that are unclear, or would like to
contribute an example, section, or chapter to the FLTK manual, please
post a question in the fltk newsgroup fltk.general or post a bug
report or feature request at http://www.fltk.org/str.php .
report or feature request at:
http://www.fltk.org/str.php

View File

@ -356,11 +356,13 @@ void Fl_Text_Display::resize(int X, int Y, int W, int H) {
if (scrollbar_align() & FL_ALIGN_LEFT) {
text_area.x = X+scrollbar_width()+LEFT_MARGIN;
text_area.w = W-scrollbar_width()-LEFT_MARGIN-RIGHT_MARGIN;
mWrapMarginPix = text_area.w - 2;
mVScrollBar->resize(X, text_area.y-TOP_MARGIN, scrollbar_width(),
text_area.h+TOP_MARGIN+BOTTOM_MARGIN);
} else {
text_area.x = X+LEFT_MARGIN;
text_area.w = W-scrollbar_width()-LEFT_MARGIN-RIGHT_MARGIN;
mWrapMarginPix = text_area.w - 2;
mVScrollBar->resize(X+W-scrollbar_width(), text_area.y-TOP_MARGIN,
scrollbar_width(), text_area.h+TOP_MARGIN+BOTTOM_MARGIN);
}
@ -387,8 +389,14 @@ void Fl_Text_Display::resize(int X, int Y, int W, int H) {
/* WAS: Suggestion: Try turning the horizontal scrollbar on when
you first see a line that is too wide in the window, but then
don't turn it off (ie mix both of your solutions). */
if (scrollbar_align() & (FL_ALIGN_TOP|FL_ALIGN_BOTTOM) &&
#if (1) // original h-scrollbar code
if ((scrollbar_align() & (FL_ALIGN_TOP|FL_ALIGN_BOTTOM)) &&
(mVScrollBar->visible() || longest_vline() > text_area.w))
#else // modified h-scrollbar code
if ((scrollbar_align() & (FL_ALIGN_TOP|FL_ALIGN_BOTTOM)) &&
(mVScrollBar->visible() || longest_vline() > text_area.w) &&
!mContinuousWrap )
#endif // modified h-scrollbar code
{
if (!mHScrollBar->visible()) {
mHScrollBar->set_visible();

View File

@ -776,7 +776,8 @@ Fl_Window* new_view() {
w->editor = new Fl_Text_Editor(0, 30, 660, 370);
w->editor->textfont(FL_COURIER);
w->editor->textsize(TS);
//w->editor->wrap_mode(Fl_Text_Editor::WRAP_AT_BOUNDS, 250);
//
w->editor->wrap_mode(Fl_Text_Editor::WRAP_AT_BOUNDS, 0);
w->editor->buffer(textbuf);
w->editor->highlight_data(stylebuf, styletable,
sizeof(styletable) / sizeof(styletable[0]),