summaryrefslogtreecommitdiff
path: root/docbook/Makefile.am
AgeCommit message (Collapse)AuthorFilesLines
2016-11-11AsciiDoc: Create an include file for attributes.Gerald Combs1-0/+3
Move the replacement definitions in asciidoc.conf to attributes.asciidoc. This makes the markup a bit cleaner and is more compatible with AsciiDoctor. Use a standard naming scheme for URLs. Change-Id: Ica73aaadb013be2a4e6a3963fb54e6db6e02e98f Reviewed-on: https://code.wireshark.org/review/18655 Reviewed-by: Peter Wu <peter@lekensteyn.nl> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-09-23WSDG: Layout and content updates.Gerald Combs1-0/+1
Adjust the column widths of some tables to that they render more cleanly and without FOP warnings. Move some table content to plain text instead of trying to shove it into table cells. Fix some other layout and formatting. Change-Id: I40e40fd7ca5c3cc594ea30c8b1ad233afd4cdca4 Reviewed-on: https://code.wireshark.org/review/17880 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-06-30Remove Makefile.common filesJoão Valverde1-1/+318
Now that nmake build system has been removed they are not needed anymore. Change-Id: I88075f955bb4349185859c1af4be22e53de5850f Reviewed-on: https://code.wireshark.org/review/16050 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-06-15Remove Nmake build systemPascal Quantin1-1/+0
Change-Id: I3bd474f3cda9667dec66426b5729449953df3e61 Reviewed-on: https://code.wireshark.org/review/15777 Petri-Dish: Pascal Quantin <pascal.quantin@gmail.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Jörg Mayer <jmayer@loplof.de> Reviewed-by: Balint Reczey <balint@balintreczey.hu>
2016-05-13Fix inclusion of images in PDF versions of the guides.Jeff Morriss1-0/+4
We need to point xsltproc to the images directories. The bigger images have scaling problems but at least they're there now. This is already done in cmake. Change-Id: I260a8f3e335b9f5726811bcd6811f6c5b9f3a6b2 Reviewed-on: https://code.wireshark.org/review/15408 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2016-05-13automake: fix wslua generation in out-of-source-tree builds.Jeff Morriss1-6/+7
We neeed to set the build directory (because that's where the wslua stuff gets put). Also fix up wslua dependencies: - It's needed (only) for the asciidoc->XML step - It's not needed for the wsug any more Change-Id: Ic1231a964b1edfb7d2eeacc5cc1c3fdda6969f21 Reviewed-on: https://code.wireshark.org/review/15407 Petri-Dish: Jeff Morriss <jeff.morriss.ws@gmail.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Jeff Morriss <jeff.morriss.ws@gmail.com>
2016-05-10autotools: docbook build improvementsJoão Valverde1-36/+12
Let the make recipe fail if a dependency is missing. That is more user-friendly (a2x: command not found) than an empty target and having to re-run configure. Test for both w3m and lynx when generating text files. If neither is available skip it. Add an explicit target to build pdf documentation. Change-Id: I760475acd7278f5ab5a782c1828a134c58cf7b42 Reviewed-on: https://code.wireshark.org/review/15229 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
2016-05-03autotools: Fix make news targetJoão Valverde1-1/+2
a2x outputs the file 'release-notes.text'. Change-Id: Ia3c78fd27dd0b2d27e0837f0984f1f6b125122c1 Reviewed-on: https://code.wireshark.org/review/15228 Reviewed-by: João Valverde <j@v6e.pt>
2016-03-18DocBook: Don't require xmllint.Gerald Combs1-24/+4
Remove dependencies on xmllint. We don't write DocBook by hand any more and we haven't used it in a long time in the CMake builds. Change-Id: Ic07f03b00c4554c058eece0462b0925d565b6da1 Reviewed-on: https://code.wireshark.org/review/14506 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-09-30automake: get docbook builds working for out of (source) tree builds.Jeff Morriss1-8/+12
Change-Id: I483596d21f072b97ae87d5032bd450adcafcf243 Reviewed-on: https://code.wireshark.org/review/10678 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2015-04-17Retire git_version.xml.Gerald Combs1-16/+1
Remove check_git_version.sh and its associated targets. We haven't used git_version.xml since the AsciiDoc conversion. Change-Id: I480f0094c4355d71201f2dd285198581bbbfc415 Reviewed-on: https://code.wireshark.org/review/8104 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-03-25Always use html2text.py for FAQ, improve outputPeter Wu1-20/+0
A recent commit broke compilation with Python 3. The original author of html2text.py is deceased and the fork has increased the number of files for this "simple" helper. The html2text.py script in this patch was rewritten and its output matches with lynx (except for a few newlines around lists). This means that indentation has been added for headings, paragraphs and lists. Also, since it was written from scratch, a new license could be chosen that matches Wireshark. Since now the in-tree html2text.py script provides nicer output, remove detection of the alternative programs (elinks, links). lynx/w3m is somehow still necessary for asciidoc though. (I also looked into reusing html2text.py for the release notes to replace asciidoc, but the --format=html output produces different output (HTML adds a ToC and section numbers). For now still require lynx for release notes) Tested with Python 2.6.6, 2.7.9, 3.2.6 and 3.4.3 under LC_ALL=C and LC_ALL=en_US.UTF-8 on Linux. Tested reading from stdin and file, writing to file, pipe and tty. Tested with cmake (Ninja) and autotools on Arch Linux x86_64. Test: # For each $PATH per python version, execute (with varying LC_ALL) help/faq.py -b | tools/html2text.py /dev/stdin | md5sum help/faq.py -b | tools/html2text.py | md5sum help/faq.py -b | tools/html2text.py help/faq.py -b | tools/html2text.py >/dev/null Change-Id: I6409450a3e6c8b010ca082251f9db7358b0cc2fd Reviewed-on: https://code.wireshark.org/review/7779 Petri-Dish: Peter Wu <peter@lekensteyn.nl> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-11-10Finish converting the User's Guide to AsciiDoc.Gerald Combs1-14/+9
As with the Developer's Guide, add user-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in user-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Remove the various makefile targets for converting AsciiDoc files to DocBook chapters. Remove GPL_appendix.xml. We use the AsciiDoc version. Change-Id: I543fa2a92f2c735c5f00c97ec65cff2187e09e3a Reviewed-on: https://code.wireshark.org/review/5216 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-09WSUG: Convert ``Files'' to AsciiDoc.Gerald Combs1-1/+1
Leave most of the content intact for now. Change-Id: I78f47b8310cb41ac5a07d352e56ec907b36665f8 Reviewed-on: https://code.wireshark.org/review/5209 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-09Convert the Lua reference to AsciiDoc.Gerald Combs1-12/+10
Move it to the Developer's Guide while we're here. Nudge the markup in epan/wslua where needed. Note that we should probably convert it to AsciiDoc (if we're going to keep it in the DG) or Doxygen. Change-Id: Ie175111043f98b7a37eeeb8d185a833d8e866f8b Reviewed-on: https://code.wireshark.org/review/5203 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-25As long as NEWS is still part of the git tree: At least don't differJoerg Mayer1-1/+1
because of different timezones. Change-Id: I93809447db29c2cc5f848edb438ee16372b57453 Reviewed-on: https://code.wireshark.org/review/3824 Reviewed-by: Jörg Mayer <jmayer@loplof.de>
2014-08-24Fix Autotools AsciiDoc configuration + CSS updates.Gerald Combs1-2/+2
Fix --asciidoc-opts in Makefile.am. Add borders around menu and keycap markup. I like the latter but the former could probably use more work. Change-Id: If02e3d00875106d6b8f8bcf01cd52b1df4f9b6c8 Reviewed-on: https://code.wireshark.org/review/3817 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-24Fix admon.graphics.path.Gerald Combs1-4/+5
Change-Id: I43d7d56f0fc2bd73efc54a685aea90f635b145ff Reviewed-on: https://code.wireshark.org/review/3807 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-24Convert admon graphics to SVG.Gerald Combs1-21/+12
Use a common set of SVG files for AsciiDoc / DocBook admonition graphics. Put them in a common directory. According to http://caniuse.com/svg all common browsers have had SVG support for a while now. The graphics themselves were created with Inkscape. If you would like to refine them further you are more than welcome. Use variables to assemble xsltproc commands in Autotools and Nmake while we're here. Try to update Debian rules to reflect ga92c3fb. Change-Id: If82647af27a60117c517125dff0aca81c033be72 Reviewed-on: https://code.wireshark.org/review/3206 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-17Add a few more NEWS items.Jeff Morriss1-1/+1
Fix a typo in the generation of top_srcdir NEWS. Change-Id: I20a140a68b9afca5096d33d99a3ea5d24e776f05 Reviewed-on: https://code.wireshark.org/review/3626 Tested-by: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Michael Mann <mmann78@netscape.net>
2014-08-06Support building the NEWS file in out-of-source-tree builds.Jeff Morriss1-1/+2
Copy the built file into the source directory (since it's generated but checked in). Don't fail to build, though, if we can't do that copy. Change-Id: Ia94a19b6f813ee78b191cd09d51198462f95b223 Reviewed-on: https://code.wireshark.org/review/3425 Reviewed-by: Jeff Morriss <jeff.morriss.ws@gmail.com>
2014-07-21Start converting the User's Guide to AsciiDoc.Gerald Combs1-4/+4
Convert the preface and introduction. Update various makefiles. Change-Id: Id998cabadb6de458f04b7a43bdba4f98e4edb052 Reviewed-on: https://code.wireshark.org/review/3139 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-06-16Support out-of-source docbook buildStig Bjørlykke1-20/+30
Change-Id: I273a6317c459664a247d3f5623ef54b0a70a9ab8 Reviewed-on: https://code.wireshark.org/review/2232 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-03-31Continue to remove $Id$ from top of fileAlexis La Goutte1-2/+0
(Using sed : sed -i '/^\# \$Id\$/,+1 d') (start with dash) Change-Id: Ia4b5a6c2302f6a531f6a86c1ec3a2f8205c8c2dd Reviewed-on: https://code.wireshark.org/review/881 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-03-16Remove Visual Studio solution and project files (and their existence from ↵Michael Mann1-1/+0
Makefiles) There have been discussions on -dev about removing this and I believe I was the last holdout. Finally convinced that I should just have a local copy (ignored by git) Change-Id: Ic72a22baf58e3412023cf851f0fce16eb07113b0 Reviewed-on: https://code.wireshark.org/review/681 Reviewed-by: Michael Mann <mmann78@netscape.net> Reviewed-by: Evan Huus <eapache@gmail.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-02-25Add Git+Gerrit command line instructions.Gerald Combs1-0/+4
Add a Git+Gerrit command line example to the Developer's Guide. Convert some Subversion text to Git. Skip building the Developer's Guide if we don't have a2x. Change-Id: I62e9e71eb3ffc07d8677df35b4b197f53f77b4f2 Reviewed-on: https://code.wireshark.org/review/384 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-11Try to fix dist. Change the .asciidoc.xml inference rule to a patternGerald Combs1-1/+1
rule specific to wsug_src similar to the nmake change in gedc06c1. Change-Id: I6d4bffc5391bd84a83fca8acb6a3688805e05de6 Reviewed-on: https://code.wireshark.org/review/179 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-11Finish converting the Developer's Guide to AsciiDoc.Gerald Combs1-1/+11
Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-01-27Convert the preface to AsciiDoc with minor edits.Gerald Combs1-1/+1
svn path=/trunk/; revision=54970
2014-01-25Fix xpath selector. Clean up whitespace.Gerald Combs1-1/+2
svn path=/trunk/; revision=54955
2014-01-24Start migrating the Developer's Guide to AsciiDoc. So far only oneGerald Combs1-1/+1
chapter (WSDG_chapter_sources) has been converted. Conversion was done using the script in https://code.wireshark.org/review/#/c/9/ along with manual cleanup. Changes are mostly limited formatting. It's helpful to have a copy of the pre-conversion guide for comparison. I've placed a chunked copy online at http://www.wireshark.org/~gerald/wsdg_html_2014_01/ . Tested under Autotools. Nmake and CMake will likely break. I'll take a look shortly. If only we had documention adding a feature branch to Gerrit and using it to test different platforms... svn path=/trunk/; revision=54945
2014-01-24Prepare for conversion of Guide chapters to AsciiDoc.Gerald Combs1-0/+11
svn path=/trunk/; revision=54936
2014-01-22Prepare for Git migration.Gerald Combs1-6/+6
Mass-replace "svn" with "git". Add commented code to use git to fetch the repository version. svn path=/trunk/; revision=54905
2013-07-30Have docbook/Makefile.nmake use index.html similar to r51021. Make someGerald Combs1-3/+3
target names less confusing. svn path=/trunk/; revision=51032
2013-07-29Name our index pages "index.html". This is follows a well-establishedGerald Combs1-6/+6
convention and lets us avoid a bit of juggling on the server side. svn path=/trunk/; revision=51021
2013-05-30Oops: revert 49636. We tell a2x to use fop to generate the PDFs.Jeff Morriss1-0/+4
svn path=/trunk/; revision=49638
2013-05-30Which release notes targets we can build no longer depends on whether we ↵Jeff Morriss1-4/+0
HAVE_FOP. svn path=/trunk/; revision=49636
2013-03-15Switch to Asciidoc for the release notes. The initial conversion fromGerald Combs1-27/+31
Docbook was done using Pandoc and cleaned up by hand. Add an asciidoc.conf which contains macros for linking to Wireshark bugs and CVE IDs. Remove the release-notes.chm target. I don't think we ever used it and we're probably better off generating PDF or HTML if we need something fancier than plain text. In configure.ac, consolidate program path discovery a bit and add a2x discovery. svn path=/trunk/; revision=48307
2012-11-12Print an explanatory message when asked to build a PDF but FOP is not installed.Jeff Morriss1-1/+3
svn path=/trunk/; revision=46015
2011-10-25From Ed Beroset: Fix a typo in MakefileBill Meier1-2/+2
https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=6482 svn path=/trunk/; revision=39548
2011-09-30More tpo fixes.Guy Harris1-2/+2
svn path=/trunk/; revision=39202
2011-09-30s/wsug_/wsdg_/g in the Developer's Guide targets.Gerald Combs1-6/+5
svn path=/trunk/; revision=39199
2011-09-16wsdg_graphics/toolbar is a directory; fix the rules that weren't alreadyGuy Harris1-4/+6
fixed to cope with that. svn path=/trunk/; revision=39021
2011-05-27Remove some stuff again.Anders Broman1-2/+1
svn path=/trunk/; revision=37437
2011-05-27Include missing files in distribution.Anders Broman1-1/+4
svn path=/trunk/; revision=37435
2010-09-23Install guides into DOC_DIR if definedJörg Mayer1-0/+1
svn path=/trunk/; revision=34198
2010-06-30Add Visual C++ project files to the distribution.Gerald Combs1-0/+1
svn path=/trunk/; revision=33386
2010-05-14Add Cmake stuff to the source distribution so more people can try it out.Jeff Morriss1-4/+8
svn path=/trunk/; revision=32807
2010-04-05Disable the possible use of 'links' to generate release-notes.txtBill Meier1-4/+6
"Fixes" Bug #4631. See https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=4631 svn path=/trunk/; revision=32389
2010-02-12'lint' the XML source even when building individual documents.Jaap Keuter1-18/+31
svn path=/trunk/; revision=31867
generated by cgit v1.2.1 (git 2.18.0) at 2024-05-18 13:51:29 +0000