aboutsummaryrefslogtreecommitdiff
path: root/doc/user
AgeCommit message (Collapse)Author
2021-10-01doc: Document the skribilo emacs mode.Arun Isaac
* doc/user/emacs.skb (Skribe Emacs Mode): Rename to ... (Skribilo Emacs Mode): ... this. Document the skribilo emacs mode.
2021-10-01doc: Re-indent and re-fill paragraph.Arun Isaac
* doc/user/emacs.skb: Re-indent and re-fill paragraph. Start block comments with double semicolons. Replace double spaces between sentences with a single space.
2021-10-01doc: Remove redundant footnote.Arun Isaac
The text already says that any valid Scheme code is allowed. It is redundant to mention again that any valid GNU Guile Scheme code is allowed. * doc/user/start.skb (Dynamic Documents)[Simple Computations]: Remove redundant footnote.
2021-10-01doc: Replace unreproducible date->string computation.Arun Isaac
The date->string computation is unreproducible. A slightly different version of the documentation is built each time. Also, the output of date->string is locale dependent, and does not render correctly in all locales. * doc/user/start.skb (Dynamic Documents)[Simple Computations]: Replace unreproducible date->string computation with a square root computation.
2020-11-01info: Emit dir-category and dir-entry.Ludovic Courtès
Reported by nly <nly@disroot.org>. * src/guile/skribilo/package/base.scm (document): Add :info-dir-category and :info-dir-entry. * doc/user/document.skb: Document them. * doc/user/user.skb: Pass :info-dir-category. * src/guile/skribilo/engine/info.scm (scribe-document->info): Create INFO-DIR-CATEGORY and START-INFO-DIR-ENTRY.
2020-08-01Write '#:use-module', '#:export', etc. instead of ':use-module', etc.Ludovic Courtès
Changes made by running: for i in $(git ls-tree -r HEAD --name-only) ; do sed -i $i -e's/:use-module/#:use-module/g ; s/:autoload/#:autoload/g ; s/:export/#:export/g' ; done
2018-04-29doc: Remove reference to non-existent CSS file.Ludovic Courtès
* doc/user/static/main.css: Remove reference to "base.css".
2018-04-29doc: Use the same CSS as the web site.Ludovic Courtès
* web/static: Move to... * doc/user/static: ... this. * web/static: Turn into a symlink. * doc/user/skribilo.css: Remove. * doc/modules/skribilo/documentation/manual.scm: Use "static/manual.css" instead of "skribilo.css". * doc/user/Makefile.am (dist_html_DATA): Remove. (nobase_dist_html_DATA): New variable. * doc/user/static/manual.css: New file.
2018-04-22doc: In HTML, use CSS for the 'doc-engine' markup.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm (he): Add 'doc-engine' writer. (doc-engine): Add a case for HTML alongside Lout. * doc/user/skribilo.css (.skribilo-doc-markup, .skribilo-doc-engine) (.skribilo-api-engine-custom-name) (.skribilo-api-engine-custom-description) (.skribilo-api-engine-custom-default): New entities.
2018-04-22doc: In HTML, use CSS to render 'doc-markup'.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm (he): Add writer for 'doc-markup'. (le): Add LE as an argument to 'markup-writer' where it was missing. (doc-markup): Remove 'doc-markup.html', and use 'doc-markup.generic' for HTML.
2018-04-22doc: In HTML, 'prgm' and 'disp' presentation moved to CSS.Ludovic Courtès
* doc/modules/skribilo/documentation/manual.scm (prgm): Add a case for HTML. (disp): Likewise. * doc/user/skribilo.css (.skribilo-manual-prgm, .skribilo-manual-disp): New items.
2018-04-07doc: Improve Lout style.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm (le): Change 'initial-font and 'initial-break. Use 9p font in @SkribiloExample. Add writer for 'prog.
2016-04-13doc: pluralize "meta keywords" to match contextozzloy
* doc/user/user.skb: Add missing 's'. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2016-04-13doc: Remove explicit gendering of author fieldsChristopher Allan Webber
* doc/user/document.skb: Switch gendering from "his" to "their". Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2016-01-13doc: Mention the effect of locales on bibliographies.Ludovic Courtès
* doc/user/bib.skb (Printing a Bibliography): Add note on the effect of locales.
2015-03-11build: Add silent rules for substitutions.Ludovic Courtès
* substitute.am (AM_V_SUBSTITUTE, AM_V_SUBSTITUTE_, AM_V_SUBSTITUTE_0): New variables. * doc/man/Makefile.am (.in): Use $(AM_V_SUBSTITUTE). * doc/user/Makefile.am (lout/front-page.lout): Likewise. * src/Makefile.am (.in): Likewise. * src/guile/Makefile.am (.in.scm): Likewise. * emacs/Makefile.am (.in): Likewise.
2015-03-11build: Invoke 'lout' with the GNU-style error message format.Ludovic Courtès
* doc/user/Makefile.am (.lout.ps): Add '-a'.
2015-03-11build: Add silent rules for the manual.Ludovic Courtès
* doc/user/Makefile.am (AM_V_SKRINFO, AM_V_SKRINFO_, AM_V_SKRINFO_0, AM_V_SKRHTML, AM_V_SKRHTML_, AM_V_SKRHTML_0): New variables. (skribilo.info, .skb.html): Use them. (AM_V_SKRLOUT, AM_V_SKRLOUT_, AM_V_SKRLOUT_0, AM_V_LOUT, AM_V_LOUT_, AM_V_LOUT_0): New variables. (.lout.ps, .skb.lout): Use them.
2012-08-18doc: Mention the (skribilo biblio) module.Ludovic Courtès
* doc/user/bib.skb ("Sorting Bibliography Entries"): Mention the (skribilo biblio) module. Reported by Roger Mason <rmason@mun.ca>.
2012-08-18doc: Document the use of Guile's module system.Ludovic Courtès
* doc/user/start.skb (Using Modules): New section.
2012-07-07Fix build without Lout.Ludovic Courtès
Reported by rvclayton@verizon.net (R. Clayton). * doc/user/Makefile.am (BUILT_SOURCES): Leave empty when !HAVE_LOUT. (skrflags): Add `-e "(define %have-lout? ...)". * doc/user/loute.skb (Additional Markup): Don't evaluate `src/lout-illustration.skb' when not %HAVE-LOUT?. * doc/user/eq.skb (Equation Formatting): Use 'lout as the renderer only when %HAVE-LOUT?. * doc/user/src/eq3.skb: Likewise.
2012-05-30doc: CSS: Increase interline spacing.Ludovic Courtès
* doc/user/skribilo.css (.skribilo-body): Set `line-height' to 1.6. * web/skribilo.css (.skribilo-body): Likewise.
2012-05-30build: Remove potential `.png' files in $(infodir) before recreating them.Ludovic Courtès
* doc/user/Makefile.am (install-data-hook): Remove the symlink's target before creating it.
2012-05-30build: Use @PACKAGE_URL@ instead of hard-coded URLs.Ludovic Courtès
* doc/user/lout/front-page.lout.in: Use @PACKAGE_URL@ instead of the hard-coded URL. * src/guile/skribilo/config.in (skribilo-url): Likewise. * substitute.am (substitute): Substitute @PACKAGE_URL@.
2012-05-29doc: Add a `lout-illustration' example.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm (le)[inline-definitions-proc]: Add @TeX and @LaTeX definitions. * doc/user/src/lout-illustration.skb: New file. * doc/user/Makefile.am (EXTRA_DIST): Add it. * doc/user/loute.skb (Additional Markup): Add `src/lout-illustration.skb' as an example.
2012-05-29doc: Install images alongside the Info manual.Ludovic Courtès
* configure.ac: Invoke `AC_PROG_LN_S' and `AC_PROG_MKDIR_P'. * doc/user/Makefile.am (install-data-hook): Create symlinks to the PNG files from $(infodir).
2012-05-27info: Implement the `image' markup.Ludovic Courtès
* src/guile/skribilo/engine/info.scm (image): New markup writer. * doc/user/infoe.skb (Info Engine): Mention image rendering.
2012-05-26doc: Fix line numbers in `prgm' examples.Ludovic Courtès
* doc/user/src/prgm2.skb: Increase line numbers since the new licenses headers occupies two more lines.
2012-05-26doc: Improve CSS using nice fonts with `@font-face'.Ludovic Courtès
* doc/user/FONTS, doc/user/junction.ttf, doc/user/lobster-1.4.otf: New files. * doc/user/Makefile.am (EXTRA_DIST): Add `FONTS'. (dist_html_DATA): Add `lobster-1.otf', and `junction.ttf'. * doc/user/skribilo.css: Use Lobster and Junction via `@font-face'. Improve other details. * web/skribilo.css: Likewise.
2012-05-24doc: Clarify affiliations.Ludovic Courtès
* doc/user/user.skb: Add missing hyphen in "Sophia-Antipolis"; change Manuel's affiliation to "Inria".
2012-05-23doc: Give engine sections an ident and remove the mark with that ident.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm (doc-markup): Refer to engines by `ident' instead of by `mark'. * doc/user/compiler.skb, doc/user/engine.skb, doc/user/links.skb, doc/user/package.skb, doc/user/sectioning.skb: Update references accordingly. * doc/user/contexte.skb, doc/user/htmle.skb, doc/user/infoe.skb, doc/user/latexe.skb, doc/user/loute.skb, doc/user/xmle.skb: Give sections an ident, and remove the mark.
2012-05-17Switch to GPLv3+.Ludovic Courtès
2012-05-12doc: Update Manuel's affiliation, email, and URL.Ludovic Courtès
* doc/user/user.skb: "Inria" instead of "INRIA". * doc/modules/skribilo/documentation/env.scm (*serrano-url*): Update. (*serrano-mail*): Shorten.
2012-05-10info/latex/lout: Set the output port's encoding.Ludovic Courtès
* src/guile/skribilo/engine/html.scm (document): Fix typo in comment. * src/guile/skribilo/engine/info.scm (document)[guile-2]: Set the current output port's encoding to "UTF-8". * src/guile/skribilo/engine/latex.scm (latex-engine)[encoding]: New custom. (document): Set the output port's encoding to that. When that encoding is "UTF-8", add the right \usepackage. * src/guile/skribilo/engine/lout.scm (lout-engine)[encoding]: New custom. (document): Set the output encoding. Emit `@SysInclude { latin2 }' for ISO-8859-2.
2012-04-25doc: Have `user.sui' depend on `user.html'.Ludovic Courtès
* doc/user/Makefile.am (user.sui): New dependency.
2010-03-08Factorize encoding twiddling in `set-correct-file-encoding!'.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm (api-search-definition): Call `set-correct-file-encoding!'. * doc/user/src/outline.txt (Author): Remove accent from last name, as a temporary hack. * doc/user/syntax.skb: Call `set-correct-file-encoding!' in the `outline' syntax example. * doc/user/user.skb: Use `(skribilo utils syntax)'. * src/guile/skribilo.scm (skribilo): Replace encoding twiddling with `set-correct-file-encoding!' call. * src/guile/skribilo/evaluator.scm (load-document, include-document): Likewise. * src/guile/skribilo/source.scm (source-read-lines): Call `set-correct-file-encoding!'. (source-read-definition): Likewise. * src/guile/skribilo/utils/syntax.scm (set-correct-file-encoding!): New macro.
2009-11-27Add `coding:' comments.Ludovic Courtès
Add `coding:' comments for use by both Emacs and Guile 2.x.
2009-11-20Define $GUILE_LOAD_COMPILED_PATH for Guile 2.x.Ludovic Courtès
* guile-vm.am (guile_warnings): New variable. (.scm.go): Set $GUILE_LOAD_COMPILED_PATH appropriately, specify Guile compilation warnings. * src/pre-inst-skribilo.in, src/skribilo.in: Set $GUILE_LOAD_COMPILED_PATH appropriately. * tests/Makefile.am (TESTS_ENVIRONMENT): Set $GUILE_AUTO_COMPILE and $GUILE_LOAD_COMPILED_PATH. * doc/user/Makefile.am (skribilo.info, .skb.html, .skb.lout, .skb.tex, .skb.ctx): Set $GUILE_LOAD_COMPILED_PATH. (load_compiled_path): New variable.
2009-11-20Choose the right encoding for input documents.Ludovic Courtès
* src/guile/skribilo.scm (skribilo): Use the right encoding for the current input port. * src/guile/skribilo/evaluator.scm (load-document, include-document): Likewise. * doc/user/user.skb: Add a `coding:' comment for use by Guile at the top.
2009-05-27doc: Fix `eq' markup documentation.Ludovic Courtès
* doc/user/eq.skb (Summary): Unquote Sk-expressions.
2009-05-27doc: Document `pie' markups.Ludovic Courtès
* doc/user/pie.skb (Syntax): Document markups. * src/guile/skribilo/package/pie.scm (pie, slice, sliceweight): Add `:class' option. (pie, slice, sliceweight)[writers]: Add `:options'.
2009-05-26doc: Improve `slide' example.Ludovic Courtès
* doc/user/src/slides.skb (Table of Contents): Rewrite using `resolve' so that the TOC isn't empty. Reported by James Haggerty <james.haggerty@gmail.com>.
2009-01-12doc: Minor Info documentation improvements.Ludovic Courtès
* doc/user/infoe.skb: Minor improvements.
2009-01-07doc: Use `:info-node' to avoid name clashes; document it.Ludovic Courtès
* doc/user/eq.skb (Syntax): Add `:info-node' to avoid name clash. * doc/user/package.skb (Example): Likewise. * doc/user/pie.skb (Syntax): Likewise. * doc/user/skribilo-config.skb (Synopsis): Likewise. * doc/user/slide.skb (Example): Likewise. * doc/user/sectioning.skb: Document the `:info-node' option.
2009-01-07doc: Document the Info engine.Ludovic Courtès
* doc/modules/skribilo/documentation/env.scm (*api-engines*): Add `info'. * doc/user/Makefile.am (EXTRA_DIST): Add `infoe.skb'. * doc/user/engine.skb: Include `infoe.skb'.
2008-12-23Make `distcheck' happy.Ludovic Courtès
* doc/user/Makefile.am (CLEANFILES): Add `skribilo.info'.
2008-12-22Update `.gitignore'.Ludovic Courtès
2008-12-21Add `rss-2' reader, for RSS 2.0 feeds as an input syntax.Ludovic Courtès
* src/guile/skribilo/reader/rss-2.scm: New file. * src/guile/Makefile.am (readers): Add `rss-2.scm'. * po/POTFILES.in: Add `rss-2.scm'. * doc/user/syntax.skb (rss2-syntax): New section. * NEWS: Update.
2008-12-21Add `--custom' option to `skribilo'.Ludovic Courtès
* src/guile/skribilo.scm (skribilo-show-help): Update. (%options)[#\c]: New option. (%default-options)[:customs]: New option. (skribilo): Handle it. * doc/user/compiler.skb (Skribilo Compiler)[Options]: Add. * NEWS: Update.
2008-12-13doc: Add "Writing New Readers".Ludovic Courtès
* doc/user/syntax.skb (syntax)[custom-syntax]: New section. Suggested by Klaus Schilling <schilling.klaus@web.de>. * doc/user/engine.skb (custom-engine): Link to `custom-syntax'.