From 242821c06c44429369cbf1f542bf07be5d51e955 Mon Sep 17 00:00:00 2001 From: Ludovic Courtes Date: Sun, 3 Sep 2006 11:43:41 +0000 Subject: Doc: Various fixes (non-unique idents, dangling refs). * 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 --- ChangeLog | 27 +++++++++++++++++++++++++++ doc/modules/skribilo/documentation/api.scm | 8 +++++--- doc/user/Makefile.am | 2 +- doc/user/markup.skb | 2 +- doc/user/package.skb | 2 ++ doc/user/src/links1.skb | 2 +- 6 files changed, 37 insertions(+), 6 deletions(-) diff --git a/ChangeLog b/ChangeLog index bba377e..8eb7f73 100644 --- a/ChangeLog +++ b/ChangeLog @@ -2,6 +2,33 @@ # arch-tag: automatic-ChangeLog--lcourtes@laas.fr--2005-mobile/skribilo--devel--1.2 # +2006-09-03 10:49:42 GMT Ludovic Courtes patch-71 + + Summary: + Doc: Various fixes (non-unique idents, dangling refs). + Revision: + skribilo--devel--1.2--patch-71 + + * 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'). + + modified files: + ChangeLog doc/modules/skribilo/documentation/api.scm + doc/user/Makefile.am doc/user/markup.skb doc/user/package.skb + doc/user/src/links1.skb + + 2006-09-03 10:36:42 GMT Ludovic Courtes patch-70 Summary: diff --git a/doc/modules/skribilo/documentation/api.scm b/doc/modules/skribilo/documentation/api.scm index d27d074..84108c9 100644 --- a/doc/modules/skribilo/documentation/api.scm +++ b/doc/modules/skribilo/documentation/api.scm @@ -347,9 +347,10 @@ ;* doc-markup ... */ ;*---------------------------------------------------------------------*/ (define-markup (doc-markup id args - #!rest + #!rest opts - #!key + #!key + (ident #f) (writer-id #f) (common-args '((:ident "The node identifier.") (:class "The node class."))) @@ -557,7 +558,8 @@ (if (and (pair? drest) (not (define-markup-rest d))) (skribe-error 'doc-markup "No rest argument for" id) options) - (list (mark :class "public-definition" (symbol->string id)) + (list (mark :class "public-definition" + (or ident (symbol->string id))) (map (lambda (i) (mark (symbol->string i))) others) (map (lambda (i) (let ((is (symbol->string i))) diff --git a/doc/user/Makefile.am b/doc/user/Makefile.am index f3c6620..3b67dea 100644 --- a/doc/user/Makefile.am +++ b/doc/user/Makefile.am @@ -11,7 +11,7 @@ EXTRA_DIST = bib.skb char.skb colframe.skb document.skb emacs.skb \ BUILT_SOURCES = doc-config.scm html_DATA = user.html -skribilo = $(top_srcdir)/src/skribilo +skribilo = $(top_builddir)/src/skribilo load_path = $(top_srcdir)/src/guile:$(top_srcdir)/src/guile/skribilo/package:$(top_builddir)/src/guile:$(top_srcdir)/doc/modules diff --git a/doc/user/markup.skb b/doc/user/markup.skb index 0348325..3607053 100644 --- a/doc/user/markup.skb +++ b/doc/user/markup.skb @@ -21,7 +21,7 @@ ;*---------------------------------------------------------------------*/ ;* API */ ;*---------------------------------------------------------------------*/ -(chapter :title "Standard Markups" [ +(chapter :title "Standard Markups" :ident "std-markups" [ This chapter describes the forms composing Skribe texts. In XML/HTML these forms are called ,(emph "markups"). In LaTeX they are called diff --git a/doc/user/package.skb b/doc/user/package.skb index 816d322..c81dacb 100644 --- a/doc/user/package.skb +++ b/doc/user/package.skb @@ -52,6 +52,7 @@ markup ,(code "abstract"):]) (doc-markup 'abstract `((:class "The node class.") (:postscript [The URL of the PostScript version of the paper.])) + :ident "abstract(acmproc)" :common-args '() :idx-note "acmproc" :idx-suffix " (acmproc)" @@ -66,6 +67,7 @@ This package enables producing LaTeX documents conforming to the markup ,(code "abstract"):]) (doc-markup 'abstract `((:postscript [The URL of the PostScript version of the paper.])) + :ident "abstract(jfp)" :common-args '() :idx-note "jfp" :idx-suffix " (jfp)" diff --git a/doc/user/src/links1.skb b/doc/user/src/links1.skb index e0ce61c..e0b393b 100644 --- a/doc/user/src/links1.skb +++ b/doc/user/src/links1.skb @@ -1,6 +1,6 @@ [This hyperlink points to the ,(ref :figure "The great Penguin" :text "figure") of the chapter ,(ref :chapter "Standard Markups") (or also, the -,(ref :ident "Standard Markups" :text "chapter") about markups). +,(ref :ident "std-markups" :text "chapter") about markups). In the second example of reference, no ,(code ":text") option is specified: ,(ref :figure "The great Penguin"). One may use the ,(param ":ident") field when specified such as: ,(ref :ident "fig1") or ,(ref :figure "fig1"). -- cgit v1.2.3