mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-24 06:13:17 +00:00
Code Issues Releases Wiki Activity

Docs tweaks

Browse Source
This commit is contained in:
Jermolene 2014-12-19 14:48:12 +00:00
parent c8e2c2ceb9
commit 5fa8a1e08a
2 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
editions/tw5.com/tiddlers/about/Documentation Style Guide.tid
View File

@ -37,13 +37,18 @@ Use [[British spellings in preference to US spellings|http://en.wikipedia.org/wi
! Abbreviations
We try to avoid abbreviations, but the following are acceptable:
We try to avoid abbreviations for ordinary words, but the following are acceptable:
* `e.g.` for ''for example''
* `i.e.` for ''that is to say''
Note that the periods should not be omitted from these abbreviations.
Technical abbreviations should be in upper case and omit periods:
* ''HTML'', not ''html'' or ''H.T.M.L.''
* ''CSS'', not ''css''
! Typographic Standards
!! Referring to Titles, Fields, Tags

18
editions/tw5.com/tiddlers/howtos/Using Stylesheets.tid
View File

@ -27,19 +27,27 @@ If you wish to use macros and transclusions in your stylesheets you should inste
```
\rules only filteredtranscludeinline transcludeinline macrodef macrocallinline html
body.tc-body pre {
<<box-shadow "inset 0 1px 0 #fff">>
}
```
The `\rules` pragma at the top of the tiddler restricts the WikiText to just allow macros and transclusion. This avoids mistakenly triggering unwanted WikiText processing.
A stylesheet tiddler is processed such that it is first wikified and then the text portion of the ouput is extracted to apply as the CSS. Any HTML tags you will use in your stylesheet are thus ignored. For example, HTML elements generated by the RevealWidget will not affect the output. As in the following example, you can wrap CSS rules in `<pre>` tags to display them as a codeblock without affecting processing, including handling the inner macro.
```
\rules only filteredtranscludeinline transcludeinline macrodef macrocallinline html
<pre>body.tc-body pre {
<<box-shadow "inset 0 1px 0 #fff">>
}
</pre>
```
The `\rules` pragma at the top of the tiddler restricts the WikiText to just allow macros and transclusion. This avoids mistakenly triggering unwanted WikiText processing.
A stylesheet tiddler is processed such that it is wikified first and then its text extracted so as to apply only css. Any html tags you will use in your stylesheet are thus eventually ignored. For example, html elements generated by the reveal widget will not affect the output. As in the example above, you could also wrap css rules in `<pre>` tags to display them as a codeblock which will, however, still correctly wikify the inner macro.
!! Stylesheet Macros
Several globally available macros are provided that are helpful in constructing stylesheets. See [[$:/core/ui/PageStylesheet]] for the definitions of these macros.
Several globally available macros are provided that are helpful in constructing stylesheets. See [[$:/core/macros/CSS]] for the definitions of these macros.
* `<<colour name>>` and `<<color name>>` retrieve named colours from the current [[colour palette|ColourPalettes]]
* `<<box-shadow shadow>>` specify a box-shadow