summaryrefslogtreecommitdiff
path: root/doc/user
AgeCommit message (Collapse)Author
2006-11-24Cleaned up `(skribilo biblio)' a bit.Ludovic Court`es
* doc/user/bib.skb: Replaced `default-bib-table' with `*bib-table*'. * src/guile/skribilo/biblio.scm: Clean up. (skribe-open-bib-file): Renamed to `open-bib-file'. * src/guile/skribilo/package/base.scm: Use `*bib-table*' instead of `default-bib-table'. * src/guile/skribilo/utils/compat.scm: Autoload `biblio'. (default-bib-table): New. (skribe-open-bib-file): New. git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-79
2006-11-24doc: Documented `numref'.Ludovic Court`es
* doc/user/links.skb (Reference): Added identifier `refs'. [ref](page): Explain that this option is hardcopy-specific. [numref]: New. * doc/user/src/links1.skb: Show `numref' usage. git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-78
2006-10-23Added a `:arguments' keyword to `slide-embed'.Ludovic Court`es
* src/guile/skribilo/package/slide.scm (slide-embed): Added an `arguments' keyword. * doc/user/slide.skb: Updated the markup documentation. git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-66
2006-10-12doc: Fixed the Fibonacci example in ``Computer Programs''.Ludovic Court`es
* doc/user/prgm.skb: Use title case for the chapter title. * doc/user/src/prgm2.skb: Fixed the line numbers for `fib'. git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-63
2006-09-03Doc: Various fixes (non-unique idents, dangling refs).Ludovic Courtes
* doc/modules/skribilo/documentation/api.scm (doc-markup): Added an `ident' argument, use it. * doc/user/package.skb (Articles): Differentiate the identifiers for the various `abstract' markups. * doc/user/Makefile.am (skribilo): Look for it in `$(top_builddir)' rather than `$(top_srcdir)'. * doc/user/markup.skb (Standard Markups): Added an identifier. * doc/user/src/links1.skb: When referring to `Standard Markups' by identifier, use its current identifier (`std-markups'). git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-56
2006-09-01Turned `doc/skr' into `doc/modules', `skribe-load' into `use-modules'.Ludovic Court`es
git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-54
2006-08-30Added a GPL header to the documentation files (license confirmed by Manuel ↵Ludovic Court`es
Serrano). git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-50
2006-08-29Doc: Converted GIF images to PNG.Ludovic Court`es
git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-49
2006-08-29Tiny Arch inventory fix.Ludovic Court`es
git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-48
2006-08-24doc: Documented `slide-topic' and `slide-subtopic'.Ludovic Court`es
* doc/user/slide.skb (Slide): Renamed to `Slides and Slide Topics'. Added the relevant markup documentation. * doc/user/src/slides.skb: Added an introduction and a slide topic. git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-46
2006-08-24doc: Fixed index-related documentation.Ludovic Court`es
* doc/user/index.skb (default-index): Fixed `:source' argument. git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-44
2006-07-28Fixed `ref' for references by title (`:chapter', `:section', etc.).Ludovic Court`es
* src/guile/skribilo/package/base.scm (ref)[doref]: Renamed to `do-ident-ref'. [do-title-ref]: New. Originally, default identifiers for chapters, sections, etc. in Skribe were the `:title' option passed through `ast->string'. However, now (it's been a while actually), default identifiers for chapters, etc., are random (returned by `gensym') so the assumption that default identifiers are title no longer holds. Hence the distinction between `do-ident-ref' and `do-title-ref'. * do/user/links.skb (ref): Clarified the doc of `:chapter' et al. git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-34
2006-07-28Moved `skribe/api.scm' to `(skribilo package base)'.Ludovic Court`es
* doc/skr/api.skr (doc-markup): Updated default value of SOURCE. * doc/user/bib.skb (bib-sort/authors): Change value of SOURCE (should have been done earlier!). * doc/user/sectioning.skb (p): Likewise. * src/guile/skribilo/evaluator.scm (%evaluate): Updated comment. * src/guile/skribilo/module.scm (%skribilo-user-imports): Added `(skribilo package base)'. (%skribe-core-modules): Removed `api'. * src/guile/skribilo/package/Makefile.am (dist_guilemodule_DATA): Added `base.scm'. * src/guile/skribilo/package/base.scm: No longer use `define-skribe-module'. Use an appropriate `define-module' instead. Fixed uses of `gensym' so that they pass a string instead of a symbol or nothing. Similarly, use Guile's native hash table API instead of the one in `compat'. (include): Use `include-document' instead of `skribe-include'. * src/guile/skribilo/package/eq.scm: Use `package base' instead of `skribe api'. * src/guile/skribilo/package/pie.scm: Likewise. * src/guile/skribilo/skribe/Makefile.am (dist_guilemodule_DATA): Removed `api.scm'. * src/guile/skribilo/utils/compat.scm (date): Export it. (correct-arity?): New. git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-32
2006-07-24Updated the FSF address.Ludovic Court`es
From "59 Temple Place - Suite 330, Boston, MA 02111-1307" to "51 Franklin Street, Fifth Floor, Boston, MA 02110-1301". Magic command line: find . -type f -print0 | xargs -0 sed -i -e 's/51 Franklin Street, Fifth Floor/51 Franklin Street, Fifth Floor/;s/02110-1301/02110-1301/; git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-29
2006-07-24Added before the introduction of the User Manual.Ludovic Court`es
* doc/user/user.skb: Added welcome text before the introduction (so that `user.html' is not empty). (Introduction): Added an identifier; set `:toc' to `#t' so that it is actually reachable. git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-28
2006-07-24Detect Ploticus at configuration-time and decide how to build the doc.Ludovic Court`es
* configure.ac: Look for `ploticus' or `pl'. Create an AM conditional. * doc/user/Makefile.am (BUILT_SOURCES): Set to `doc-config.scm'. (html_DATA): New, set to `user.html'. (ps_DATA): Likewise. (doc-config.scm): New target. * doc/user/user.skb: Load `doc-config.scm' and update `%ploticus-program' accordingly. Decide whether or not to include `pie.skb'. * src/guile/skribilo/package/pie.scm: Export `%ploticus-program' and `%ploticus-debug?'. git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-26
2006-07-24Updated Automake/Autoconf files for the `pie' package.Ludovic Court`es
git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-25
2006-07-23Added a pie-chart package that can use either Ploticus or Lout.Ludovic Courtes
* doc/user/user.skb: Use the `pie' package and include `pie.skb'. git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-24
2006-07-21Added support for the `:keywords' option of `document' (Lout + HTML).Ludovic Court`es
* NEWS: Mention it. * doc/user/document.skb: Document it. * doc/user/user.skb (document): Added keywords. Slightly modified the introduction. * src/guile/skribilo/engine/html.scm (document): Added `:keywords' to the list of supported options. (&html-head): Reformatted. (&html-meta): New. (&html-generic-document): Use it. * src/guile/skribilo/engine/lout.scm: Document `pdf-keywords' as deprecated. (lout-pdf-docinfo): Check the `:keywords' option. (document): Mention it as supported. * src/guile/skribilo/skribe/api.scm (document): Added the `keywords' option. (keyword-list->comma-separated): New (stolen from Lout). git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-20
2006-03-19Various documentation fixes + completed the doc automake stuff.Ludovic Courtes
* doc/user/Makefile.am (%.html): Added `-P ../img'. (%.lout): Likewise. (SUBDIRS): New. * doc/user/char.skb (Some characters): Use the Lout-specific example for `!' when relevant. * doc/user/figure.skb (The figure markup): Avoid using `example-produce'. * doc/user/slide.skb (dummy-slide-set-output): New. (dummy-slide-output): New. (dummy-slide-vspace-output): New. (dummy-slide-embed-output): New. (Example of Skribilo Slides): Use a processor, as in `document.skb', in order to use the dummy output functions. git-archimport-id: lcourtes@laas.fr--2005-mobile/skribilo--devel--1.2--patch-50
2006-03-02Inventory fix.Ludovic Court`es
* doc/user/.arch-inventory (precious): More HTML files. git-archimport-id: lcourtes@laas.fr--2004-libre/skribilo--devel--1.2--patch-69
2006-03-02Doc: undoed `patch-65'.Ludovic Court`es
* doc/user/markup.skb: Undoed `patch-65'. git-archimport-id: lcourtes@laas.fr--2004-libre/skribilo--devel--1.2--patch-67
2006-03-01Doc: commented out code that uses processors to work around bug.Ludovic Court`es
* doc/user/markup.skb: Commented out inclusion of `document.skb' and `sectioning.skb'. git-archimport-id: lcourtes@laas.fr--2004-libre/skribilo--devel--1.2--patch-65
2006-03-01Various fixes in the documentation code.Ludovic Court`es
* doc/skr/manual.skr: Fixed uses of `format'. * doc/user/document.skb (dummy-document-output): Fixed handling of non-list author. * doc/user/src/api2.skb: Fixed the title. ;-) * doc/user/src/bib1.sbib (bigloo): Added a year and author as expected by `bib5.skb'. * doc/user/user.skb (Introduction): Explicitly added `:file #f'. git-archimport-id: lcourtes@laas.fr--2004-libre/skribilo--devel--1.2--patch-61
2006-02-27Doc: Added a chapter (stub) about the `eq' package.Ludovic Court`es
* doc/user/user.skb: Use `(skribilo package eq)'. Include `eq.skb'. git-archimport-id: lcourtes@laas.fr--2004-libre/skribilo--devel--1.2--patch-59
2006-02-10Fixed syntax highlighting thanks to SILex.Ludovic Courtes
* arch-config: New file. * src/guile/skribilo/coloring/c-lex.l.scm: New. * src/guile/skribilo/coloring/lisp-lex.l.scm: New. * src/guile/skribilo/coloring/xml-lex.l.scm: New. * doc/user/user.skb: Include `prgm.skb' (works now). * src/guile/skribilo/ast.scm: Export `node-body'. * src/guile/skribilo/coloring/Makefile.am (dist_guilemodule_DATA): Added the SILex-generated files. (%.l.scm): New rule. * src/guile/skribilo/coloring/lisp-lex.l: Use the SRFI-39 parameters. * src/guile/skribilo/coloring/lisp.scm: Use SRFI-39 parameters instead of fluids. Load `lisp-lex.l.scm'. * src/guile/skribilo/prog.scm: Autoload `ast' upon `node-body' too. (make-line-mark): Use `hash-set!'. (resolve-line): Use `hash-ref'. * src/guile/skribilo/source.scm (source-read-lines): Use `string-prefix-length' instead of `substring=?'. git-archimport-id: lcourtes@laas.fr--2005-mobile/skribilo--devel--1.2--patch-33
2006-01-31First time the user manual is compiled to HTML.Ludovic Courtes
* doc/skr/api.skr (make-engine?): Fixed. (make-engine-custom): Likewise. * doc/skr/manual.skr (the-index): Don't pass `:&skribe-eval-location'. * doc/user/emacs.skb: Fixed typo. * doc/user/htmle.skb: Documented the `file-name-proc' custom. * doc/user/package.skb: Fixed the `prgm' example there. * doc/user/skribe-config.skb: Commented out the `OPTIONS' section. * doc/user/skribec.skb: Likewise. * doc/user/slide.skb: Don't refer to HTML-ENGINE, use `find-engine' instead. * doc/user/src/slides.skb: Don't pass `:slide' to `toc'. * doc/user/toc.skb: Commented the `:subsubsection' argument. * doc/user/user.skb (Index): Set `:indent' to "Index". * src/guile/skribilo.scm (skribilo-options): Added `--image-path'. (skribilo): Handle it. * src/guile/skribilo/ast.scm (ast->file-location): Exported. * src/guile/skribilo/engine/base.scm (the-index): Don't pass `:&skribe-eval-location'. * src/guile/skribilo/engine/html.scm: Export `html-width' and `html-title-authors'. * src/guile/skribilo/engine/lout.scm (lout-width): Don't use `flonum?'. * src/guile/skribilo/evaluator.scm (load-document): Added `:allow-other-keys' so that the optional parameters may contain keywords, too. * src/guile/skribilo/package/slide.scm: Use `(skribilo engine html)'. * src/guile/skribilo/skribe/api.scm (toc): Added `subsubsection'. git-archimport-id: lcourtes@laas.fr--2005-mobile/skribilo--devel--1.2--patch-31
2006-01-25More progress towards a working user manual.Ludovic Courtes
* doc/skr/api.skr (define-markup?): Support `define*' and `define*-public'. * doc/user/bib.skb: Commented out problematic `skribebibtex'-related things. * doc/user/lib.skb (skribe-load): Replaced by `load-document'. (skribe-load-options): Replaced by `*load-options*'. (skribe-path): Replaced by `*document-path*'. * src/guile/skribilo/coloring/lisp.scm (definition-search): Removed debugging statement. * src/guile/skribilo/engine.scm (find-engine): For documentation purposes, explicitly list all keyword parameters. * src/guile/skribilo/source.scm (source-read-lines): Start line numbers from 0. * src/guile/skribilo/utils/compat.scm (skribe-path-set!): New. (skribe-image-path-set!): New. (skribe-source-path-set!): New. (skribe-bib-path-set!): New. git-archimport-id: lcourtes@laas.fr--2005-mobile/skribilo--devel--1.2--patch-30
2006-01-18More fixes in the hope to get the manual compiled.Ludovic Courtes
* doc/skr/api.skr (define-markup?): Accept `define-public'. (define-markup-options): Accept any kind of `define' symbol. (define-markup-rest): Likewise. * doc/user/bib.skb (bibliography): Use `src/bib1.sbib'. (bib-table?): Provide a definition. (default-bib-table): Likewise. (make-bib-table): Likewise. (bibliography): Fixed a `ref'. (example): Fixed file name. This example does not work yet. * doc/user/footnote.skb (footnote): Documented `label', removed `number'. * doc/user/table.skb (th): Documented `rowspan'. * src/guile/skribilo.scm (skribilo-options): Added `-S'/`--source-path'. Honor it. * src/guile/skribilo/coloring/lisp.scm: Use `(ice-9 match)'. Rewrote all the `match-case' code into corresponding `match' statements. (definition-search): Fixed, using `source-property' and `port-line'. Does not work yet due to a bug in guile-reader's source position recording (shows 1 line earlier). Added a READ parameter. * src/guile/skribilo/skribe/api.scm: Mark SYMBOL as replaced instead of blindly overriding the core binding. git-archimport-id: lcourtes@laas.fr--2005-mobile/skribilo--devel--1.2--patch-28
2006-01-17Towards a self-hosted user manual.Ludovic Courtes
* doc/skr/api.skr: Use `(skribilo reader)' and `(skribilo utils syntax)'. (api-search-definition): Added a SKRIBE-SOURCE? argument. Determine the appropriate reader based on its value. (keyword->symbol): Removed. (define-markup?): Fixed. (make-engine?): Fixed (but unverified). (make-engine-custom): Likewise. (sym/kw?): New. (define-markup-formals): Fixed. (define-markup-options): Likewise. (define-markup-rest): Likewise. (doc-markup): Added a SKRIBE-SOURCE? argument. (doc-engine): Likewise. * doc/user/*.skb: Updated the `:source' arguments to `doc-markup' and `doc-engine'. * src/guile/skribilo/utils/compat.scm (hashtable-update!): Fixed according to the Bigloo manual. git-archimport-id: lcourtes@laas.fr--2005-mobile/skribilo--devel--1.2--patch-26
2006-01-16More SRFI-3[45] enhancements; first stab at the user documentation.Ludovic Courtes
* src/guile/skribilo/biblio.scm (skribe-open-bib-file): Raise a `&file-search-error' when needed. * src/guile/skribilo/runtime.scm (convert-image): Likewise. * src/guile/skribilo/source.scm (source-read-lines): Likewise. (source-read-definition): Likewise. * src/guile/skribilo/utils/compat.scm (skribe-load): Only look up `%skribe-known-files' when `load-document' failed. (find-file/path): Use `search-path'. (find-runtime-type): Implemented. * doc/skr/api.skr: Use `(ice-9 match)'. Use `match' instead of `match-case'. (api-search-definition): Search in `%load-path' and `(skribe-path)'. (define-markup?): First stab at getting the `match' syntax right. * doc/user/src/start[3-5].skb: Small fixes. git-archimport-id: lcourtes@laas.fr--2005-mobile/skribilo--devel--1.2--patch-25
2006-01-15Cleaned up the Arch inventory and removed old useless makefiles.Ludovic Courtes
Cleaned up the Arch inventory and removed old useless makefiles. git-archimport-id: lcourtes@laas.fr--2005-mobile/skribilo--devel--1.2--patch-23
2006-01-08Cleaning the compatibility module and other annoyances.Ludovic Courtes
* src/skribilo.in: Catch exceptions and call `(exit 1)' when caught. * doc/user/Makefile.am (skribilo): Fixed. * src/guile/skribilo.scm: Updated copyright year. * src/guile/skribilo/compat.scm: Moved to `utils'. * src/guile/skribilo/Makefile.am (dist_guilemodule_DATA): Removed `compat.scm'. * src/guile/skribilo/Makefile.am (dist_guilemodule_DATA): Added `compat.scm'. * src/guile/skribilo/coloring/lisp.scm: Use `(skribilo utils syntax)'. * src/guile/skribilo/module.scm (%skribilo-user-imports): Import `(skribilo utils compat)' instead of `(skribilo compat)'. Added more triggering procedures for `(skribilo source)'. * src/guile/skribilo/skribe/api.scm: Moved the definition of a Skribe-compatible `gensym' to `compat.scm'. * src/guile/skribilo/source.scm: Use `*source-path*' instead of `skribe-source-path'. git-archimport-id: lcourtes@laas.fr--2005-mobile/skribilo--devel--1.2--patch-19
2005-11-26Fixed the documentation's Makefile.am.Ludovic Courtes
* doc/user/Makefile.am: Fixed GUILE_LOAD_PATH. git-archimport-id: lcourtes@laas.fr--2005-mobile/skribilo--devel--1.2--patch-12
2005-11-01Changes related to source-highlighting and to the manual.Ludovic Courtes
* src/guile/skribilo/engine/lout.scm (lout-make-doc-cover-sheet): Fixed the definition of MULTI-COLUMN? (fixes a bug when producing multi-column documents). (lout-definitions): `@SkribeLeaders' renamed to `@SkribiloLeaders'. * doc/skr/api.skr (api-search-definition): Fixed calls to `format'. * doc/skr/manual.skr (keyword): Use `write' instead of `keyword->string'. * doc/user/start.skb: Cosmetic changes. * src/guile/skribilo/coloring/lisp.scm: First stab at its adaptation. * src/guile/skribilo/coloring/xml.scm: Rewritten "by hand". * src/guile/skribilo/evaluator.scm (skribe-include): Removed debugging statements. * src/guile/skribilo/lib.scm (new): Added a trick such that users of this macro don't have to use `(oop goops)' and `(skribilo types)'. (date): New procedure. * src/guile/skribilo/module.scm (*skribe-core-modules*): Renamed to `%skribe-core-modules'. (%skribe-core-modules): Removed `(oop goops)'. Added `(skribilo source)', `(skribilo coloring lisp)' and `(skribilo coloring xml)'. * src/guile/skribilo/skribe/api.scm (footnote): Fixed. * src/guile/skribilo/source.scm: Cosmetic changes. * src/guile/skribilo/types.scm: Export `language-extractor' and `language-fontifier'. git-archimport-id: lcourtes@laas.fr--2005-mobile/skribilo--devel--1.2--patch-11
2005-10-31Installed Autoconf/Automake machinery. Fixed a few things.Ludovic Courtes
* src/guile/skribilo/evaluator.scm (skribe-load): Search through `%load-path' and try with a `.scm' extension (rather than the `.skr' one provided by the user). (skribe-include): Added a few debugging statements. * src/guile/skribilo/lib.scm (fix-rest-arg): Handle the dot notation for rest arguments. * src/guile/skribilo/reader/skribe.scm (%make-skribe-reader): Use SQUARE-BRACKET-FREE-SYMBOL-MISC-CHARS. * src/guile/skribilo/skribe/index.scm: Use `define-public' instead of `define'. * src/guile/skribilo/packages/*.scm: Moved to `skribilo/package'. * LICENSE: Removed. * COPYING: New. * AUTHORS: New. * NEWS: New. * ChangeLog: New. * configure.ac: New. * Makefile.am: New. In various directories. git-archimport-id: lcourtes@laas.fr--2005-mobile/skribilo--devel--1.2--patch-10
2005-10-31Removed useless files, integrated packages.Ludovic Courtes
* src/guile/skribilo/packages: New directory and files. * bin: Removed. * skr: Removed (files moved to `src/guile/skribilo/packages'). * skribe: Removed. * doc/skr/env.skr (*courtes-mail*): New. * doc/user/user.skb: Removed postal addresses, added my name. * src/guile/skribilo/engine/lout.scm: Uncommented the slide-related markup writers. * src/guile/skribilo/evaluator.scm (%evaluate): Try weird things with source properties. * src/guile/skribilo/reader/skribe.scm: Comply with the new guile-reader API. * src/guile/skribilo/types.scm: Removed the special `initialize' method for ASTs which was supposed to set their location. git-archimport-id: lcourtes@laas.fr--2005-mobile/skribilo--devel--1.2--patch-7
2005-06-15Various bugfixes; new `file-name-proc' custom for the HTML engine.Ludovic Court`es
* tools/skribebibtex/bigloo/skribebibtex.scm (skribebibtex): Don't enclose `ident' in double quotes. * doc/user/user.skb: Made "Introduction" a chapter rather than a section; likewise for its subsections. * skr/html.skr (itemize): Produce an anchor if `ident' is not false. (enumerate): Likewise. (html-file-default): New procedure. (file-name-proc): New custom. * src/bigloo/color.scm (*color-parser*): Fixed the "black" and "white" colors (were inverted). git-archimport-id: lcourtes@laas.fr--2004-libre/skribilo--devel--1.2--patch-1
2005-06-15Initial import of Skribe 1.2d.Ludovic Court`es
Initial import of Skribe 1.2d. git-archimport-id: lcourtes@laas.fr--2004-libre/skribilo--devel--1.2--base-0
generated by cgit v1.2.3 (git 2.45.2) at 2024-11-01 23:13:43 +0000