summaryrefslogtreecommitdiff
path: root/documentation/Makefile
AgeCommit message (Collapse)Author
2021-12-08Documentation on widget coordinates and layout, plus new test programs (#304)engelsman
Add coordinates and layout section to user manual add section to user manual to clarify the use of window-relative coordinates in both Fl_Group and Fl_Window containers, and include brief descriptions of current layout manager widgets in one place. add test/coordinates.cxx, test/wizard.cxx and related screenshots under documentation/src. update CMakeLists.txt, Makefile and .gitignore for new files. Co-authored-by: Albrecht Schlosser <albrechts.fltk@online.de>
2020-09-21PDF docs: generate LaTeX header file from sourceAlbrecht Schlosser
The LaTeX header file used when creating PDF documentation depends on the doxygen and latex versions, respectively. The old header file 'documentation/src/fltk-book.tex.in' had been generated manually and needed to be updated for new doxygen versions which made the PDF documentation generation dependent on the doxygen/latex versions on the build system. The new LaTeX header file 'fltk-book.tex' is generated by doxygen, i.e. taking into account the doxygen and latex versions on the build system and "edited" to include the page title defined in the new file 'documentation/src/fltk-title.tex.in'. This makes the PDF documentation independent of the doxygen and latex versions of the build system.
2020-07-15CMake: refactor and reformat CMake filesAlbrecht Schlosser
- raise minimum CMake version from 2.6.3 to 3.2.3 (Jun 01, 2015) - indent all CMake files according to the CMP (2 col.) - refactor FLTK version number definitions and usage - unify CMake and autoconf/configure variable names: - FL_VERSION -> FLTK_VERSION - FL_MAJOR_VERSION -> FLTK_VERSION_MAJOR - etc. for _MINOR_ and _PATCH_, respectively - note: this does not affect FL_VERSION etc. in source code - generate "export headers" for all libraries (experimental: OFF) - port some forgotten goodies from branch-1.3 to master - merge and improve macro 'create_example' (WIP) - remove "temporary" options and code for older CMake versions - include and use 'GenerateExportHeader' (experimental, WIP: OFF) - note: created header files are not yet used - build only *one* DLL with Visual Studio (tested, works) - similar to the bundled IDE projects in 1.3.x - add some dynamically linked test/demo programs ('*-shared') if shared libraries are built (WIP) - split 'macros.cmake': use one file per macro
2020-07-13add resize documentation as per STR3433Duncan Gibson
add resize chapter to documentation, plus images, based on Article #415: How does resizing work? https://www.fltk.org/articles.php?L415 see also https://www.fltk.org/str.php?L3433
2020-07-06Remove $Id$ tags, update URL's, and moreAlbrecht Schlosser
- remove obsolete svn '$Id$' tags from all source files - update .fl files and generated files accordingly - replace 'http://www.fltk.org' URL's with 'https://...' - replace bug report URL 'str.php' with 'bugs.php' - remove trailing whitespace - fix other whitespace errors flagged by Git - add and/or fix missing or wrong standard headers - convert tabs to spaces in all source files The only relevant code changes are in the fluid/ folder where some .fl files and other source files were used to generate the '$Id' headers and footers.
2020-01-08Drop 1.0 compatibility; document 1.4 migrationAlbrecht Schlosser
The FLTK 1.0 compatibility support by defining macro 'FLTK_1_0_COMPAT' did no longer work since FLTK 1.3.x and nobody complained. Hence we can safely remove this "feature". Documentation changes: - Drop chapter 'Migrating Code from FLTK 1.0 to 1.1' - Drop chapter 'Migrating Code from FLTK 1.1 to 1.3' - Add chapter 'Migrating Code from FLTK 1.3 to 1.4' The removed chapters are still available in FLTK 1.3 docs.
2018-01-16Remove obsolete replacement of CMAKE_SOURCE_DIR.Albrecht Schlosser
The correct fix in the previous commit (svn r12636) would have been to replace CMAKE_SOURCE_DIR with FLTK_SOURCE_DIR since CMAKE_SOURCE_DIR is no longer used in doxygen docs generation. Sorry for the noise. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12637 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-01-16Implement Jakub's patch for the missing FLTK_SOURCE_DIR inIan MacArthur
the doxyfile generation of the html docs. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12636 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2015-06-16Generate Doxyfile and Doxybook from common source file Doxyfile.in.Albrecht Schlosser
Now we have less files to edit, and Doxyfile.in is shared with the CMake generation of Doxyfile and Doxybook. Besides that two files with FLTK version numbers are now removed (less work for future version updates). git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10762 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2015-04-25Simplify documentation generation, remove obsolete file.Albrecht Schlosser
Doxybook and Doxyfile have been compared and differences have been adjusted so there are only _relevant_ differences now. The dependency on fltk-book.tex in html generation has been removed. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10718 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2015-04-13Documentation: move PDF creation from Makefile to new script 'make_pdf'.Albrecht Schlosser
The new script make_pdf can be used in the Makefile and in the CMake PDF generation process. CMake update will follow in a later step. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10702 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2014-10-05Add html doc dependency on (unused) src/fltk-book.tex for doxygen.Albrecht Schlosser
This is not intended and could also be removed from Doxyfile, but currently this is the best way - more changes to come... git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10361 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2014-10-04Improve documentation generation (pdf only).Albrecht Schlosser
Add file VERSION that includes the FLTK version number (only), generate fltk.pdf with automatic copyright year and doxygen version. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10352 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-10-25Introducing a FAQ to the FLTK docs.Greg Ercolano
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9146 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-07-19Modifications to all LGPL headers for STR #2685.Greg Ercolano
(to clarify static exception LGPL by changing license references) git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8864 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-05Added refman.pdf to clean target in documentation/Makefile.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8195 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-05Modified documentation/Makefile to correctly generate docs.Albrecht Schlosser
Generating HTML and PDF docs is now independent, order doesn't matter. New and modified make targets: - html: generate HTML docs only - pdf: generate PDF docs only - dist: generate HTML and PDF docs (use for distribution files) - html-online: HTML docs with "stripping" modification dates - alldocs: retained as synonym for 'dist' To do: README file must be updated... git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8191 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-01Documentation: fixed copying of tiny.png to documentation directory.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8158 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-30fix install without building fltk.pdfyuri
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8145 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-27Removing unused doc dependencies on images.Greg Ercolano
Mods as per conversation on fltk.development today, subject: "Re: Remove image dependencies ? [was: Re: [Library] r8091 - in branches/branch-1.3:FLdocumentation/src]" git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8116 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-21New image added to documentation dependencies.Greg Ercolano
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8095 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-09IMAGEFILES macro: gif -> pngGreg Ercolano
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7986 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-08As per thread on fltk.development: "RFC: Docs - getting rid of .eps files"Greg Ercolano
Summary: Get rid of eps files, change all doxygen '\image latex' references to eps files to png/jpeg instead, convert doxygen images from gif -> png (to support html+latex). Actual operations: 1) svn remove *.eps 2) convert all gifs -> png 3) svn remove *.gif 4) svn add *.png 5) For jpeg/png images, change all \image latex foo.eps .. -> \image latex foo.[jpg,png] .. 6) For gif images, change all \image html foo.gif .. -> \image html foo.png and (harder to do): change \image latex foo.eps .. -> \image latex foo.png .. 7) Remove EPSFILES macro from documentation/Makefile and remove eps related dependencies that were added recently git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7981 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-06Added rules to create eps files (if they don't exist) using ImageMagick ↵Greg Ercolano
convert(1). This would probably allow us to remove the documentation/src/*.eps files from svn at some point. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7958 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-06Removed unused FL.eps (see today's thread on fltk.development: "RFC docs")Greg Ercolano
Adjusted documentation/Makefile: in IMAGEFILES and EPSFILES: removed duplicates, added missing, sorted all. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7957 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-05Fixed tree-elements imageGreg Ercolano
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7955 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-05Fixed one doxygen warning and cleaned up documentation/Makefile.Albrecht Schlosser
Removed unused statements and old comment. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7953 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-12-05Added latex \image refs to tree+table docs,Greg Ercolano
and eps image filenames to documentation/Makefile. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7952 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-11-28Fixed yet more Copyright to 2010.Matthias Melcher
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7905 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-24fix generated manpages cleaningyuri
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6778 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-25removed numbering from doxygen chapters and navigation bars,engelsman
moved class/function reference pages to end of index table, swapped editor/drawing chapters in Doxybook for PDF version git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6721 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-21Moved the stripping of date comments (strip_tags) to its own targetAlbrecht Schlosser
"html-dist", just like it has been done for pdf-dist. Stripping the date comments roughly doubled the time of html generation for daily use, although it is only needed before a web update. *** Please use "make html-dist" before updating the web docs. *** Just for reference: Measurement values on my Windows system with cygwin: - make html 1:01 minutes - strip_tags 1:05 minutes - strip_tags 0:49 minutes after removal of cat Todo: - Why do we need the external script strip_tags, are there reasons not to integrate it in the Makefile? - If it would be in the Makefile, should we use ${RM} instead of literally using "rm" ? git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6702 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-14Updated the make html process, adding a new strip functionality that removes ↵Fabien Costantini
the date in each and every html autogenerated files. Now a constant message is displayed thus reducing drastically the size of future web updates. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6686 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-01-01Changed the copyright to 2009 for header files. Still todo: src and test ↵Matthias Melcher
directory. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6614 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-07Fixed documentation dependencies and changed Doxybook (for latex/pdf gen.)Albrecht Schlosser
to _not_ generate the html files. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6557 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-03Doxygen documentation:Fabien Costantini
- Fixed recent documentation update problems in fl_draw.cxx : \ and @ char must be doubled otherwise interpreted as doxygen keywords - Fixed some doxygenized parameters problems in Fl_Preferences.cxx - Added the treeview mode, now featuring a vertical left tree browser in html doc - Splitted html configuration file from pdf configuration file, now a new Doxybook config file permits to customize independtly both html and pdf modes without risking side effects and also without assuming an fltk user will have the Tex tools installed to generate the html doc. Now only pdf generation will need LaTex tools. - Updated the doxygen based documentation to revison 9 and added new significant contributors to index.dox in alphabetical order. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6539 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-19Minor documentation Makefile tweaks.Albrecht Schlosser
Removed fltk.pdf from svn:ignore and make distclean. Added svn:ignore for man pages in documentation/src. Added *.log to make clean in documentation. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6465 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17Documentation makefile: Fixed make install would return an error if html ↵Fabien Costantini
folder does not exist. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6455 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17Moved latex related files to src, man files to src, updated Makefile and ↵Fabien Costantini
Doxyfile accordingly. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6453 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-16Doxygen documentation: Fixes obsolete install data when using make install. ↵Fabien Costantini
Now fltk.pdf and all potential html files are installed in the fltk docdir. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6443 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15documentation Makefile:Fabien Costantini
+ Added all eps files to pdf gen dependencies. + Added Doxyfile to html and latex/pdf deps + Added a new pdf-dist target to please mum & dad there in heaven. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6441 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15Doxygen documentation: commented out the 1.5.7 specific doc options, updated ↵Fabien Costantini
README for pdf and html use. Now minimum version required is 1.5.5 git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6440 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15Doxygen documentation: added svn properties to ignore temp files, set pdf ↵Fabien Costantini
file mime-type to octet stream. Created a custom output log that captures all pdflatex output and makeindex output as we could loose some of them in the standard refman.log because of the iterating crazy nature of these latex tools. Now make pdf file generates the full baby (including ToC) in one shot. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6435 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15Doxygen pdf documentation: made pdflatex run in batchmode. This is non ↵Fabien Costantini
verbose and nonstopmode is, but pdflatex also furthers refman.log containing all the error report... git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6434 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-14Doxygen makefile: added new html and pdf targets, to use it run : make html, ↵Fabien Costantini
make pdf. for the last case, when an error is detected, the gen stops and you may have to run manually pdflatex again to have a correct toc ... git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6432 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-14Doxygen pdf man: First version added in documentation/fltk.pdf, old doc ↵Fabien Costantini
removed, images, dox files moved to a new src directory. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6431 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-02-06Use install command instead of CHMOD, CP, and MKDIR.Michael R Sweet
Drop all POSTBUILD stuff as it is no longer used. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5663 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-01-18Typo. Likely more to come.Matthias Melcher
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5622 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2007-01-18Added chapter 10 with documentation about multithreadingMatthias Melcher
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5621 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2006-08-29Add examples.html to list of documentation files.Michael R Sweet
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@5382 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
generated by cgit v1.2.3 (git 2.25.1) at 2026-02-11 17:13:45 +0000