summaryrefslogtreecommitdiff
path: root/doc/user/line.skb
blob: 3f9dab336da8674eff98ed6707d320f18fa052bd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
;;; line.skb  --  Line breaks
;;;
;;; Copyright 2003  Manuel Serrano
;;;
;;;
;;; This program is free software; you can redistribute it and/or modify
;;; it under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 2 of the License, or
;;; (at your option) any later version.
;;;
;;; This program is distributed in the hope that it will be useful,
;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with this program; if not, write to the Free Software
;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
;;; USA.

;*---------------------------------------------------------------------*/
;*    Line breaks                                                      */
;*---------------------------------------------------------------------*/
(section :title "Line breaks" :file #t

(p [Line breaks and horizontal rules enable text cutting.])

;*--- linebreak -------------------------------------------------------*/
(subsection :title "Linebreak"

(p [The Skribe function ,(code "linebreak") is unportable. Even if
most engines handle it for their code production, using ,(code "linebreak")
generally produces expected result. For instance, using ,(code "linebreak")
with an engine producing LaTeX code is bound to fail. In consequence, 
as much as possible, one should prefer other ways for splitting a text])

(doc-markup 'linebreak
	    '((#!rest num "The number of line breaks."))
	    :see-also '(paragraph table)))

;*--- Horizontal rule -------------------------------------------------*/
(subsection :title "Horizontal rule"

(doc-markup 'hrule
	    `((:width ,[The ,(ref :mark "width") of the horizontal rule.])
	      (:height [The thickness of the rule. A positive integer
                        value stands for a number of pixels.])))))