TiddlyWiki5/editions/tw5.com/tiddlers/system/style-guide-macros.tid

created: 20220227210120989
modified: 20220227210123695
tags: $:/tags/Macro
title: $:/editions/tw5.com/style-guide-macros

\define style-guide(good,bad)
<table>
<tbody>
<tr>
<th>Good</th>
<td>``$good$``</td>
</tr>
<tr>
<th>Bad</th>
<td>``$bad$``</td>
</tr>
</tbody>
</table>
\end

<pre><$view field="text"/></pre>
Improve readability for documentation macros (#6494) 2022-03-02 18:36:53 +01:00			`created: 20220227210120989`
			`modified: 20220227210123695`
Documentation tweaks @erwanm I ended up making some fairly extensive tweaks. One issue is that the (excellent) material you’ve provided on transclusion with templates covers very much the same ground as the existing TemplateTiddlers tiddler. The existing text was focused on transclusion with widgets; I think your material using transclusion notation is much easier to understand. I’ve also removed the exercises section. We don’t have exercises elsewhere in the documentation, so I think we need to make a conscious decision about whether we’re going to try to add them, and then do so consistently across the material. I also made some changes to bring the text into house style for consistency (which I’ve also tried to start documenting). 2014-12-10 17:08:59 +00:00			`tags: $:/tags/Macro`
Improve readability for documentation macros (#6494) 2022-03-02 18:36:53 +01:00			`title: $:/editions/tw5.com/style-guide-macros`
Documentation tweaks @erwanm I ended up making some fairly extensive tweaks. One issue is that the (excellent) material you’ve provided on transclusion with templates covers very much the same ground as the existing TemplateTiddlers tiddler. The existing text was focused on transclusion with widgets; I think your material using transclusion notation is much easier to understand. I’ve also removed the exercises section. We don’t have exercises elsewhere in the documentation, so I think we need to make a conscious decision about whether we’re going to try to add them, and then do so consistently across the material. I also made some changes to bring the text into house style for consistency (which I’ve also tried to start documenting). 2014-12-10 17:08:59 +00:00
			`\define style-guide(good,bad)`
			`<table>`
			`<tbody>`
			`<tr>`
			`<th>Good</th>`
			<td>``$good$``</td>
			`</tr>`
			`<tr>`
			`<th>Bad</th>`
			<td>``$bad$``</td>
			`</tr>`
			`</tbody>`
			`</table>`
			`\end`
Improve readability for documentation macros (#6494) 2022-03-02 18:36:53 +01:00
			`<pre><$view field="text"/></pre>`