summaryrefslogtreecommitdiff
path: root/doc/modules
AgeCommit message (Collapse)Author
2020-11-01justify: Turn '*margin*' into a parameter.Ludovic Courtès
* src/guile/skribilo/utils/justify.scm (*margin*): Turn into a parameter. (with-justification, with-justification/noflush): Use 'parameterize' instead of 'set!'. * src/guile/skribilo/engine/info.scm: Adjust accordingly. * doc/modules/skribilo/documentation/api.scm (doc-markup): Likewise.
2020-08-02Use '_' as the 'match' wildcard.Ludovic Courtès
This addresses '-Wunused-variable' warnings. * doc/modules/skribilo/documentation/api.scm (define-markup?) (make-engine?, make-engine-custom) (define-markup-formals, define-markup-options) (define-markup-rest, exp->skribe): Use '_' instead of 'else' as the 'match' wildcard. * src/guile/skribilo/package/slide/latex.scm (%slide-advi-setup!): Likewise. * src/guile/skribilo/source/lisp.scm (lisp-extractor) (scheme-extractor, stklos-extractor, skribe-extractor) (bigloo-extractor): Likewise. * src/guile/skribilo/sui.scm (load-sui): Likewise. (sui-title, sui-key, sui-find-ref, sui-filter): Likewise.
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: 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.
2015-03-11doc: Allow several expressions in the body of a markup procedure.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm (define-markup-rest): Add ellipsis in the body pattern for DEF.
2015-03-11Replace "illegal" with "invalid" in error messages.Ludovic Courtès
There's nothing illegal here. * doc/modules/skribilo/documentation/api.scm, src/guile/skribilo/ast.scm, src/guile/skribilo/debug.scm, src/guile/skribilo/engine/base.scm, src/guile/skribilo/engine/context.scm, src/guile/skribilo/engine/html.scm, src/guile/skribilo/engine/html4.scm, src/guile/skribilo/engine/latex.scm, src/guile/skribilo/package/base.scm, src/guile/skribilo/package/html-navtabs.scm, src/guile/skribilo/package/jfp.scm, src/guile/skribilo/package/lncs.scm, src/guile/skribilo/package/slide/latex.scm, src/guile/skribilo/utils/justify.scm, src/guile/skribilo/utils/keywords.scm, src/guile/skribilo/utils/text-table.scm: Change "illegal" to "invalid".
2015-03-11Use quotes instead of backticks in user-facing messages.Ludovic Courtès
Suggested by Benno Schulenberg <coordinator@translationproject.org>. * doc/modules/skribilo/documentation/api.scm, src/guile/skribilo.scm, src/guile/skribilo/condition.scm, src/guile/skribilo/engine/lout.scm, src/guile/skribilo/package/base.scm, src/guile/skribilo/package/jfp.scm, src/guile/skribilo/package/lncs.scm, src/guile/skribilo/package/pie.scm, src/guile/skribilo/package/slide/latex.scm, src/guile/skribilo/utils/compat.scm, src/guile/skribilo/ast.scm, src/guile/skribilo/biblio.scm, src/guile/skribilo/engine/html.scm, src/guile/skribilo/engine/info.scm, src/guile/skribilo/index.scm, src/guile/skribilo/package/web-book2.scm, src/guile/skribilo/reader/rss-2.scm, src/guile/skribilo/source.scm, src/guile/skribilo/utils/compat.scm, src/guile/skribilo/verify.scm: Change `foo' to 'foo'.
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-28doc: Improve Info rendering.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm (ie)[doc-markup]: Use a justifier to output the markup prototypes slightly indented. Prepend "-- Markup: ". (doc-markup-proto): When using the `info' engine, annihilate `code' and `bold'. * doc/modules/skribilo/documentation/manual.scm (param): When using the `info' engine, render parameters as uppercase, without `code'.
2012-05-28doc: Represent (quote x) as 'x.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm (exp->skribe): Fix pattern for EXP as (quote SYM).
2012-05-27doc: Improve Info rendering of the list of "See also" cross-references.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm (ie): Change "See also " to "Also, ".
2012-05-24doc: Always display keywords in DSSSL style.Ludovic Courtès
* doc/modules/skribilo/documentation/manual.scm (keyword): Display ARG in DSSSL keyword style.
2012-05-24doc: lout: Render examples in a colored box.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm (le)[inline-definitions-proc]: Add @SkribiloExample. * doc/modules/skribilo/documentation/manual.scm (example)[lout]: Use @SkribiloExample. (le): Set the `includes' custom to include `diag'. * src/guile/skribilo/engine/lout.scm (frame): Mark the trick about @Floater.
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-14Mention "Guile 2.0" instead of "Guile-VM".Ludovic Courtès
* configure.ac: Remove `--enable-guile-vm' option. Check for `guild' and `guile-tools', defining `GUILD'. Rename `ENABLE_GUILE_VM' to `HAVE_GUILE2'. * guile-vm.am: Rename to... * guilec.am: ... this. * doc/modules/Makefile.am, src/guile/Makefile.am: Update accordingly.
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-04-25Remove support for `guile-lint'.Ludovic Courtès
* guile-lint.am: Remove. * Makefile.am (EXTRA_DIST): Remove `guile-lint.am'. * doc/modules/Makefile.am (lintable): Remove. Remove inclusion of `guile-lint.am'. * src/guile/Makefile.am: Likewise. * configure.ac: Remove check for `guile-lint' and `HAVE_GUILE_LINT' conditional.
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-20Compile documentation modules.Ludovic Courtès
* doc/modules/Makefile.am (moduledir, SOURCES, SUFFIXES): New variables. Include `guile-vm.am'.
2009-11-20Use `(skribilo-module-syntax)' instead of `(fluid-set! current-reader ...)'.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm, doc/modules/skribilo/documentation/extension.scm, doc/modules/skribilo/documentation/manual.scm, src/guile/skribilo/writer.scm: Use `(skribilo-module-syntax)' instead of `(fluid-set! current-reader ...)'.
2009-01-07doc: Start customizing Info output.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm (doc-markup): New write for `info'. (punctuate): New optional argument PERIOD?. (doc-markup): Customize Info output. Rename `doc-markup.lout' to `doc-markup.generic'; use it.
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-04-21Document the `context' engine.Ludovic Courtès
* doc/modules/skribilo/documentation/env.scm (*api-engines*): Add `context'. * doc/user/contexte.skb: New file. * doc/user/engine.skb: Include it. * src/guile/skribilo/engine/context.scm (context-customs): Moved to the `make-engine' call so that automatic documentation extraction works.
2008-04-21Allow builds of the user manual with LaTeX and ConTeXt.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm (doc-engine): Fix `skribe-warning' invocation. * doc/user/Makefile.am (.skb.lout): Move out of `if HAVE_LOUT'. (.skb.tex, .skb.ctx): New targets.
2008-04-21Run Guile-Lint on documentation modules.Ludovic Courtès
* doc/modules/Makefile.am (CLEANFILES, lintable): New. Include `guile-lint.am'. * guile-lint.am: Add "-L $(top_srcdir)/doc/modules".
2008-03-31Remove 4 makefiles from `doc'.Ludovic Courtès
* configure.ac: Update. * doc/Makefile.am (SUBDIRS): Update. (EXTRA_DIST): New. * doc/modules/Makefile.am (SUBDIRS): Remove. (EXTRA_DIST): New.
2008-03-31doc: Produce and install a SUI file.Ludovic Courtès
* doc/modules/skribilo/documentation/manual.scm: Set the `emit-sui' custom to `#t'. * doc/user/Makefile.am (html_DATA): Add `user.sui'.
2008-02-01doc: Add nice(r) front-page in Lout.Ludovic Courtès
* doc/modules/skribilo/documentation/manual.scm: Set the `on-title-page' custom. * doc/user/Makefile.am (EXTRA_DIST): Add `lout/front-page.lout.in'. (BUILT_SOURCES): Add `lout/front-page.lout'. (.lout.ps): Update `-I'. (lout/front-page.lout): New target. (clean-local): Remove the `lout' directory. * doc/user/lout/book-style.lout (@ChapterStartPages): Set to `Odd'.
2008-02-01doc: Various insignificant cleanups.Ludovic Courtès
2008-01-30doc: Improve engine introduction.Ludovic Courtès
2008-01-30doc: Add nice rendering of `doc-engine' in Lout.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm (doc-engine): New `lout' writer. (doc-engine): Check for Lout.
2008-01-29doc: Tiny improvements of the `manual' module.Ludovic Courtès
* doc/modules/skribilo/documentation/manual.scm (disp): Use `resolve' and test that engine, rather than raw `(engine-format? "xxx")'. (compiler-options): Issue a warning if an option is not documented.
2008-01-28doc: Improve rendering of `prgm' and `disp' in Lout.Ludovic Courtès
* doc/modules/skribilo/documentation/manual.scm (prgm): Specialize Lout output. (disp): Likewise.
2008-01-28doc: Provide nicer `doc-markup' output for `lout'.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm: New lout customization. (punctuate): New. (doc-markup)[doc-markup.lout]: New. Use it.
2008-01-25doc: Document the Lout engine.Ludovic Courtès
* doc/modules/skribilo/documentation/env.scm (*api-engines*): Add `lout'. * doc/user/engine.skb: Include `loute.skb'. * doc/user/slide.skb (Slide Package): Add `:ident'.
2008-01-24doc: Document the "compiler".Ludovic Courtès
* doc/modules/skribilo/documentation/manual.scm (compiler-options): Rewritten to suit our needs. * doc/user/Makefile.am (EXTRA_DIST): `skribec.skb' renamed to `compiler.skb'. * doc/user/bib.skb: Fix xref. * doc/user/lib.skb: Likewise. * doc/user/links.skb: Likewise. * doc/user/syntax.skb: Add `:ident'.
2008-01-22doc: Document all the `*xxx-path*' parameters.Ludovic Courtès
* doc/modules/skribilo/documentation/manual.scm (srfi-ref): New. * doc/user/bib.skb: Add `*bib-path*'. * doc/user/image.skb: Add `*image-path*'. * doc/user/lib.skb: Mention `-I' command-line option for `*document-path*'. * doc/user/prgm.skb: Add `*source-path*'. * doc/user/skribec.skb: Add `:ident' for chapter.
2008-01-22doc: Use CSS style sheet in HTML output.Ludovic Courtès
* doc/modules/skribilo/documentation/manual.scm: Set `css' custom of the HTML engine. Explicitly initialize the `chapter-file', etc., customs. * doc/user/Makefile.am (dist_html_DATA): New. * doc/user/skribilo.css: New file.
2007-12-11Improve `(skribilo config)'.Ludovic Courtès
* configure.ac: Don't generate `src/guile/skribilo/config.scm'; don't substitute `SKRIBILO_DOC_DIR', `SKRIBILO_EXT_DIR' and `SKRIBILO_SKR_PATH'. * doc/modules/skribilo/documentation/env.scm (*courtes-mail*): Update. (*skribe-user-doc-url*, *skribe-dir-doc-url*): Update. * src/guile/skribilo/Makefile.am (CLEANFILES, .in): New. Include `substitute.am'. * src/guile/skribilo/config.scm.in: Overhauled. * src/guile/skribilo/engine/context.scm: Use `skribilo-version' instead of `skribilo-release'. * src/guile/skribilo/engine/lout.scm: Likewise. * src/guile/skribilo/utils/compat.scm: Use `(skribilo config)'. (skribe-release, skribe-url, skribe-doc-dir, skribe-ext-dir, skribe-default-path, skribe-scheme): New.
2007-12-01doc: Fix rendering of keywords.Ludovic Courtès
* doc/modules/skribilo/documentation/manual.scm (write <keyword>): New method.
2007-12-01doc: Slightly improve Lout rendering of `prgm'.Ludovic Courtès
* doc/modules/skribilo/documentation/manual.scm (prgm): Better Lout output.
2007-12-01doc: Improved rendering of `example' in Lout.Ludovic Courtès
* doc/modules/skribilo/documentation/manual.scm: Add `lout' writer for `example'. (example-produce): Remove `(it "Example:")'.
2007-12-01doc: Use native API in `(skribilo documentation manual)'.Ludovic Courtès
* doc/modules/skribilo/documentation/manual.scm: Switch to native API.
2007-12-01doc: Improve building using the Lout engine, with a `book' style.Ludovic Courtès
* doc/modules/skribilo/documentation/api.scm (doc-engine): Use `ctrtable' instead of `table'. * doc/modules/skribilo/documentation/manual.scm: Add customs for the `lout' engine. (ctrtable): New. (prgm): Don't center frames in Lout. * doc/user/Makefile.am (EXTRA_DIST): Add `lout/book-style.lout'. (%.ps): Add "-r4 -I$(srcdir)/lout". * doc/user/char.skb: Use `ctrtable' instead of `(center (table...' for the list of chars. * doc/user/markup.skb: Add emacsology. * doc/user/package.skb: Don't show the sample code with non-HTML engines. * doc/user/src/html-navtabs.skb: Fix typo. * doc/user/user.skb: Don't produce out-of-chapter text in Lout.
2007-07-04Linted documentation modules.Ludovic Courtes
* doc/modules/skribilo/documentation/*.scm: Use the `%skribilo-module-reader' and corresponding syntax, no longer use `compat'. git-archimport-id: skribilo@sv.gnu.org--2006/skribilo--devo--1.2--patch-137
generated by cgit v1.2.3 (git 2.45.2) at 2024-11-01 09:29:01 +0000