## File: CHANGES

package info (click to toggle)
gap-gapdoc 1.6.2-1
 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425  CHANGES of the GAPDoc package 1.6.1 -> 1.6.2 - Improved 'InitialSubstringUTF8String' by an optional argument to return a string with a suffix. - Change access of javascript code for MathJax to https protocol (such that MathJax works for help pages accessed via https). - Added option ".uri := true" to 'SearchMR' to return URI instead of sending a request to MathSciNet. - Added many cases handled by 'HeuristicTranslationsLaTeX2XML', this is needed because MathSciNet has changed the markup for accented characters in many cases. - Made 'SearchMR' work again using 'wget' or 'curl' (MathSciNet is now only accessible via HTTPS). - Better ordering of help matches if the first word is the query string (patch provided by Max Horn). - Escape the special characters @!|" for 'makeindex' in index entries for LaTeX. - Removed dependency on 'a4wide.sty' file in LaTeX installation. 1.6 -> 1.6.1 - Slightly nicer display of header lines of ManSection's with long names and/or long argument lists. - Added an element to be used in ManSection's on constructors. - Minimal changes to make GAPDoc (translation of manual, and handler functions for the help system) work in any single thread in HPCGAP. 1.5.1 -> 1.6 - Changed and documented the handling of elements; its content is not reformatted. - Can now handle help books with empty bibliography. - Some technical adjustments which make it easier to use GAPDoc with HPC-GAP. - Some cosmetic improvements, mainly for text output and markup of nested elements. - Introduce finer distinction of -elements for HTML with/without MathJax. - 'StringBibXMLEntry' supports now a 'rec(MathJax := true)' option. - Added a new utility function 'InitialSubstringUTF8String'. - 'NormalizedNameAndKey' can now find initials from UTF-8 encoded name strings. - The HTML manuals in Browsers with Javascript now always have the [Style] link, even if no MathJax version is generated. - 'RunExamples' now returns 'true' or 'false'. - Removed support for the "MathML" variant of 'GAPDoc2HTML' which was probably not used anyway. - MakeGAPDocDoc (more precisely AddPageNumbersToSix) will no longer enter a break loop in case of an empty index (noticed by Thomas Breuer). - New function 'LabelsFromBibTeX'. If BibTeX is available this is used to unify the labels used for citations and the ordering of the reference list in the LaTeX, text and HTML version of a GAPDoc document. - 'ComposedDocument' now accepts also file names with absolute paths and relative to GAP roots. (Uses a new function 'FilenameGAP'.) - Documented 'DOCCOMPOSEERROR' for 'ComposedDocument' to ignore missing chunks. - Mention that .bib files for must be in latin1-encoding, and corrected 3k+1.bib accordingly (error noticed by Bill Allombert). - Corrected HorLine in tables without trailing | column (report and fix by Max Horn). - Recognize document encoding in 1.5.1 - Adjustments to GAP's new DeclareUserPreference setup. 1.4 -> 1.5 - Substituted the TestManual functions by new ones based on the new 'Test' functionality in the GAP library: ExtractExamples, RunExamples. (Used this to adjust all manual examples.) - Added a copy of GPL text. - Corrected/improved handling of certain external references, and some other small errors (reported by James Mitchell). - Improved detection of UTF-8 input. - Improved/adjusted manual examples. 1.3 -> 1.4 - Made license statement more direct. - Slight change of the dtd: The elements now permit elements in their content. The converters were adjusted accordingly. - Several layout changes in text version: More unicode characters are used, e.g., for fill strings and table borders (see BOXCHARS). Also mathematical symbols from unicode are used more often. Less colors are used in default text theme. - Several text themes are available in the distribution (more by others are welcome). The preferred theme can be configured by the user via SetGAPDocTextTheme and at startup via a user preference SetUserPreference("GAPDoc", "TextTheme", ...). - Improved markup of elements in function definitions in Text and HTML conversion. - The text version of the manuals now contains more hooks (by pseudo escape sequences) for preprocessing before display. Paragraphs are now reformatted to current screen width. Unicode to latinX translation is now done with multi-character substitution. And markup with visible characters becomes possible, e.g. the "old" text theme (tables are not reformatted which can lead to some problems). - Slightly changed layout of the title page in LaTeX/PDF manuals. - The LaTeX/PDF manuals use less colors by default. - The tables of content contain now references and index (not convinced that this is ok, but was often requested). - Preferred style for viewing the HTML manuals can be configured by the user via user preferences: SetUserPreference("GAPDoc", "HTMLStyle", ...) and SetUserPreference("GAPDoc", "UseMathJax", true/false) - The HTML manuals support style switching (via URL and cookie) with javascript and cookie enabled browsers. Several styles (and combinations) are offered in the distribution (more by others are welcome). - The HTML manuals contain now a hook to use javascript and a few more hooks for CSS style sheets. - All output versions contain now markup for coloring GAP examples as with ColorPrompt(true). (Easy to switch off for text and HTML in user config.) - Link from MathJax HTML manuals to central server http://cdn.mathjax.org to get scripts and fonts. - Added a link to the "Contents" on top and bottom of each HTML manual page. - For LaTeX/PDF conversion of manuals we use now the "psnfss" for postscript fonts. - Added more hooks and simplified customization of LaTeX/PDF manuals (see "SetGapDocLaTeXOptions"). - PDF-verison is now by default generated with bookmarks (for acroread and other viewers), but such that they are not opened by default. - Fixed a bug when displaying multiple hits while ANSI_COLORS=false. 1.2 -> 1.3 - Improved the example ./gapdoc.css file (also used for the GAPDoc manuals): when hovering over a link to a section its subsections are now shown in a separate block. - The Arg attribute in and other elements now allows for GAP options. - Added support for HTML output using MathJax (http://www.mathjax.org/). MakeGAPDocDoc and GAPDoc2HTML now allow an optional argument "MathJax". - Better bound for long index entries to be hyphenated (can now also be changed by setting GAPDoc2LaTeXProcs.MaxIndexEntryWidth). - Improved the \description environment in LaTeX output using the enumitem LaTeX packages. Now works with very long labels. - Now a warning is given if ComposedDocument finds several pieces of documentation with the same label. - Fixed a problem which caused ParseError in rare cases to display the wrong line (reported by Laurent Bartholdi). - Tables without | or HorLine are now distinguished in HTML version, such that they can be configured to be displayed without borders. - There is a new attribute Mode="M" for elements, if this is given the formula is processed as in elements. 1.1 -> 1.2 - New utility to access the MathSciNet data base from within GAP (only if your computer has access, of course), see documentation of 'SearchMR'. - Now letters counting appendices are also printed without trailing dot in references. - Slightly changed HorLine's in text-version of output. - Various changes in tools for bibliography data (many suggested by Thomas Breuer): - Avoid some syntax errors caused by 'NormalizedNameAndKey' in case of first names starting with non-ASCII character (but still cannot correctly handle these cases, use BibXMLext instead). - Improved sorting of bib-entries in HTML/Text output. - Better heuristic functions for translating characters in LaTeX code in BibTeX entries to unicode, see 'HeuristicTranslationsLaTeX2XML'. - Handle (rare) short MathReview numbers. - Better formatted output for HTML version of bib-entries. - Fixed the case of an empty 'strings' list in 'RecBibXMLEntry'. - Apply recoding to strings from BibXMLext data. - Use default markup in StringBibAsText (undocumented, internally used by StringBibXMLEntry) when called with one argument. - Added more simplifications and LaTeX translations of unicode characters. - Improved "RepeatedString". - XML parser: - Could show wrong line number for original position of code with error. - Now the ":" is allowed in element and attribute names, this allows to implement utilities for dealing with XML name spaces (http://www.w3.org/TR/2006/REC-xml-names-20060816/). - Corrected bug in normalization of argument lists (if "," was used as separator). Also the layout was changed in case of leading optional arguments (reported by Laurent Bartholdi). 1.0 -> 1.1 - We allow unicode characters which have useful translations to LaTeX and as simplified string (with one character, for the moment) in mathematical formulae. Introduced entities &CC;, &ZZ;, &NN;, &PP;, &QQ;, &HH;, &RR; for \mathbb characters. - Now chapter numbers in references to chapters are without trailing dot in text and HTML converters. - Fixed bug with vertical spacing for in text converter. - GAPDoc can now be used with other languages than English, see 'SetGapDocLanguage' for details. - Various documentation improvements. - New options "utf8" and "nopslatex" for LaTeX converter, see 'SetGapDocLaTeXOptions'. - Introduced "LaTeXUTF8" encoding (uses known translations but leaves other characters as they are). - Removed support of '\N, \Z, ...' for '{\mathbb N}, {\mathbb Z}, ... (was not documented before). But see &NN; above. - Introduced 'WrapTextAttribute' which takes care of existing escape sequences in the text to wrap. Use it for the text converter to handle elements with markup which are contained in each other correctly. 0.99999 -> 1.0 - Changed the status of the package from "deposited" to "accepted". - GAPDoc language (only few changes, all are fully backward compatible): - Made entities for LaTeX special characters (\$tamp;, &percent; and so on) unnecessary (but kept them--with simplified definitions--for backward compatibility). Now just write characters in content and attribute values directly, except for math elements which contain LaTeX code. - A does now allow an optional (I would not like if this would be used extensively, but can be sensible for ManSections which explain several commands.) - does now allow an optional element to specify subkeys with further markup (not possible in 'Subkey' attribute). - , , now allow optional elements and to specify text with further markup (not possible in 'Text' attribute). - New element . Can be used everywhere (e.g., for additional data like source code, or to comment non finished parts of the document). - MakeGAPDocDoc: - Now the text converter is called first to produce labels for (sub-)sections which are independent of their number (see 'Text converter:' below). - Now only the PDF manual is compiled from the LaTeX version. - The .log file written by pdflatex is checked for errors, warnings and overfull boxes; these are displayed. - Bibliography data (see '?GAPDoc: Utilities for Bibliographies'): - Defined a 'BibXMLext' format for bibliographies with DTD bibxmlext.dtd (better data format if not used for LaTeX). - Utilities for parsing BibXMLext data and translating them to various formats (BibTeX, Text, HTML). Includes a utility to approximate BibXMLext data from given BibTeX data. - BibXMLext databases can be specified in (and I suggest to use this possibility). - Labels for references in Text and HTML converter are now similar to those produced by BibTeX. - New functions for extracting and checking the code in all elements, see 'ManualExamples', 'TestManualExamples'. - Unicode strings: - Introduced unicode strings and characters as GAP objects, see '?Unicode'. - Translations between unicode strings and GAP strings in various character encodings, see '?Encode'. (Mainly UTF-8, ISO-8859-X, "XML" and "URL" encodings.) - Some non-injective (partial) maps from unicode: a "LaTeX" encoding, simplifications to ASCII or latin1, conversions to lowercase and uppercase characters. - The internal encoding for the XML parsed data is now UTF-8, this is also recommended for input (all GAPDoc files are now in UTF-8 encoding), but all latin? encodings work as well. - LaTeX converter: - Convert long URLs such that LaTeX can hyphenate them after slashes (but without a maybe confusing hyphenation dash). - Documented SetGapDocLaTeXOptions, see ?GAPDoc2LaTeX. (E.g., settings for hyperref, using colors or not.) - The default LaTeX markup for , is now by slanted typewriter font. - Very long identifier names are now hyphenated in the (two-column) index. - The pdf-manuals now know their paper size. - The pdf-manuals contain the robust labels generated by the text converter (see below). E.g., with xpdf one can display a labeled text directly: xpdf manual.pdf +L.