1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-09 11:29:58 +00:00
TiddlyWiki5/editions/tw5.com/tiddlers/pragmas/Pragma_ _procedure.tid

40 lines
1.3 KiB
Plaintext
Raw Normal View History

2022-10-07 15:56:21 +00:00
created: 20221007132845007
2022-10-09 16:34:22 +00:00
modified: 20221009163250309
2022-10-07 15:56:21 +00:00
tags: Pragmas
title: Pragma: \procedure
type: text/vnd.tiddlywiki
2022-10-09 16:34:22 +00:00
<<.from-version "5.3.0">> The ''\procedure'' [[pragma|Pragmas]] is used to [[define procedures|Procedure Definitions]]. It is a shortcut syntax for the SetVariableWidget with an implicit ParametersWidget.
2022-10-07 15:56:21 +00:00
The usual form allows procedures to span multiple lines:
```
\procedure <procedure-name>(<param-name>[:<param-default-value>],<param-name>[:<param-default-value>]...)
<multiple-line-definition-text>
\end
```
There is also a single line form for shorter procedures:
```
\define <procedure-name>(<param-name>[:<param-default-value>],<param-name>[:<param-default-value>]...) <single-line-definition-text>
```
2022-10-09 12:54:33 +00:00
The first line of the definition specifies the procedure name and any parameters. Each parameter has a name and, optionally, a default value that is used if no value is supplied on a particular call to the procedure. The lines that follow contain the text of the procedure text (i.e. the snippet represented by the procedure name), until `\end` appears on a line by itself:
2022-10-07 15:56:21 +00:00
For example:
```
2022-10-09 12:54:33 +00:00
\procedure sayhi(name:"Bugs Bunny")
Hi, I'm $name$.
\end
2022-10-07 15:56:21 +00:00
2022-10-09 12:54:33 +00:00
<<sayhi "Jeremy">>
2022-10-07 15:56:21 +00:00
```
Alternatively, the entire definition can be presented on a single line without an `\end` marker:
```
2022-10-09 12:54:33 +00:00
\procedure sayhi(name:"Bugs Bunny") Hi, I'm $name$.
2022-10-07 15:56:21 +00:00
```