Three-sided box - Revision history

Lemzwerg at 19:22, 30 November 2025

2025-11-30T19:22:47Z

← Older revision		Revision as of 19:22, 30 November 2025
Line 1:		Line 1:
	This example shows how to add a markup command to get a three sided box around some text (or other markup).		This example shows how to add a markup command to get a three-sided box around some text (or other markup).

	<lilypond version="2.24">		<lilypond version="2.24">
	% New command to add a three sided box, with sides north, west and south		% New command to add a three-sided box, with sides north, west, and south.
	% Based on the box-stencil command defined in scm/stencil.scm		% Based on the `box-stencil` command defined in `scm/stencil.scm`.
	% Note that ";;" is used to comment a line in Scheme		% Note that ";;" is used to comment a line in Scheme.
	#(define-public (NWS-box-stencil stencil thickness padding)		#(define-public (NWS-box-stencil stencil thickness padding)
	"Add a box around STENCIL, producing a new stencil."		"Add a box around STENCIL, producing a new stencil."
Line 18:		Line 18:
	stencil))		stencil))

	% The corresponding markup command, based on the \box command defined		% The corresponding markup command, based on the `\box` command defined
	% in scm/define-markup-commands.scm		% in `scm/define-markup-commands.scm`.
	#(define-markup-command (NWS-box layout props arg) (markup?)		#(define-markup-command (NWS-box layout props arg) (markup?)
	#:properties ((thickness 0.1) (font-size 0) (box-padding 0.2))		#:properties ((thickness 0.1) (font-size 0) (box-padding 0.2))
	"Draw a box round ~~@var{arg}~~. ~~Looks~~ at ~~@code{thickness}~~,		"Draw a box round ARG.
	~~@code{box~~-~~padding}~~ and ~~@code{font~~-~~size}~~ properties to determine line
	thickness and padding around the markup."		Look at THICKNESS, BOX-PADDING, and FONT-SIZE properties to determine
			line thickness and padding around the markup."
	(let ((pad (* (magstep font-size) box-padding))		(let ((pad (* (magstep font-size) box-padding))
	(m (interpret-markup layout props arg)))		(m (interpret-markup layout props arg)))
	(NWS-box-stencil m thickness pad)))		(NWS-box-stencil m thickness pad)))

	~~% Test it:~~

	\relative c' {		\relative c' {
Line 37:		Line 37:
	</lilypond>		</lilypond>

	~~[[Category:Education]]~~
	[[Category:Text]]		[[Category:Text]]
	[[Category:Scheme]]		[[Category:Scheme]]

Lemzwerg: New category

2025-11-21T23:29:47Z

New category

← Older revision		Revision as of 23:29, 21 November 2025
Line 41:		Line 41:
	[[Category:Scheme]]		[[Category:Scheme]]
	[[Category:Rhythms]]		[[Category:Rhythms]]
	[[Category:Included in the official documentation]][[Category:Snippet]]		[[Category:Included in the official documentation]]
			[[Category:Snippet]]

Lemzwerg at 23:01, 21 November 2025

2025-11-21T23:01:29Z

← Older revision		Revision as of 23:01, 21 November 2025
Line 41:		Line 41:
	[[Category:Scheme]]		[[Category:Scheme]]
	[[Category:Rhythms]]		[[Category:Rhythms]]
	[[Category:Included in the official documentation]]		[[Category:Included in the official documentation]][[Category:Snippet]]

Jean Abou Samra: Replace version="2.24.0" with version="2.24" now that the LilyWiki extension supports auto-selecting the latest release in a stable series

2025-11-16T18:57:44Z

Replace version="2.24.0" with version="2.24" now that the LilyWiki extension supports auto-selecting the latest release in a stable series

← Older revision		Revision as of 18:57, 16 November 2025
Line 1:		Line 1:
	This example shows how to add a markup command to get a three sided box around some text (or other markup).		This example shows how to add a markup command to get a three sided box around some text (or other markup).

	<lilypond version="2.24.0">		<lilypond version="2.24">
	% New command to add a three sided box, with sides north, west and south		% New command to add a three sided box, with sides north, west and south
	% Based on the box-stencil command defined in scm/stencil.scm		% Based on the box-stencil command defined in scm/stencil.scm

Jean Abou Samra: Import snippet from LSR

2025-10-26T22:40:13Z

Import snippet from LSR

New page

This example shows how to add a markup command to get a three sided box around some text (or other markup).

<lilypond version="2.24.0">
% New command to add a three sided box, with sides north, west and south
% Based on the box-stencil command defined in scm/stencil.scm
% Note that ";;" is used to comment a line in Scheme
#(define-public (NWS-box-stencil stencil thickness padding)
"Add a box around STENCIL, producing a new stencil."
(let* ((x-ext (interval-widen (ly:stencil-extent stencil X) padding))
(y-ext (interval-widen (ly:stencil-extent stencil Y) padding))
(y-rule (make-filled-box-stencil (cons 0 thickness) y-ext))
(x-rule (make-filled-box-stencil
(interval-widen x-ext thickness) (cons 0 thickness))))
;; (set! stencil (ly:stencil-combine-at-edge stencil X 1 y-rule padding))
(set! stencil (ly:stencil-combine-at-edge stencil X LEFT y-rule padding))
(set! stencil (ly:stencil-combine-at-edge stencil Y UP x-rule 0.0))
(set! stencil (ly:stencil-combine-at-edge stencil Y DOWN x-rule 0.0))
stencil))

% The corresponding markup command, based on the \box command defined
% in scm/define-markup-commands.scm
#(define-markup-command (NWS-box layout props arg) (markup?)
#:properties ((thickness 0.1) (font-size 0) (box-padding 0.2))
"Draw a box round @var{arg}. Looks at @code{thickness},
@code{box-padding} and @code{font-size} properties to determine line
thickness and padding around the markup."
(let ((pad (* (magstep font-size) box-padding))
(m (interpret-markup layout props arg)))
(NWS-box-stencil m thickness pad)))

% Test it:

\relative c' {
c1^\markup { \NWS-box ABCD }
c1^\markup { \NWS-box \note {4} #1.0 }
}
</lilypond>

[[Category:Education]]
[[Category:Text]]
[[Category:Scheme]]
[[Category:Rhythms]]
[[Category:Included in the official documentation]]