\rules only

[S. S.]

In this GoogleGroups post: W5 plugin: escapecss[] filter 

BurningTreeC uses: \rules only at one point inside a macro

On tiddywiki.com I read the tiddler: Pragma but I didn't really understand what \rules could do.
In the tiddler: Using Stylesheets it has this:

\rules only filteredtranscludeinline transcludeinline macrodef macrocallinline html

Is there a place that explains:
1) What are all the different \rules.
2) How are they used (what do they do)?

If not, it would be useful to know.

Thanks!

[S. S.]

This is where I reached:

In the tiddler: $:/core/modules/parsers/wikiparser/rules/ it says:

Wiki pragma rule for rules specifications

\rules except ruleone ruletwo rulethree
\rules only ruleone ruletwo rulethree

In Advanced Search , on the Shadows tab , I searched for: $:/core/modules/parsers/wikiparser/rules/

There are a little over 35 rules - perhaps these are all the rules availbale!

So, now, why do we use them, and where is this useful?

[BurningTreeC]

Hi S.S.,

that's a very good question and I'm glad you're opening a discussion about it

these pragmas are very under-documented (is that english?)

I don't have a good overview neither. It would be very useful if we can create one and finally create documentation on tiddlywiki.com

the \rules pragma defines the rules for the wiki-parser that should be applied for the following block/for the macro/for the tiddler - that's how I understand it

I'm using "\rules only" - note: without specifying rules - to switch OFF processing within that macro, so that text doesn't get wikified whatever that means - the text produced within that macro should look exactly like its input, parser please don't change it

[TonyM]

Folks,

I would be keen to know more as well but as I understand it these are the parsing rules applied to the wikification of a tiddlers content as found in control panel > info > advanced > parsing (bit which applies to the whole wiki)

Do be carful and backup because some of these could damage the user interface and leave your wiki broken.

Regards
Tony

[BurningTreeC]

Yes, very good point! Don't use them if you don't know why

such a rule can be used on top of a macro - then it gets applied to that macro-body only, like:

\define mymacro()

\rules only somerule anotherrule

macro, do your work here

\end

this rules pragma is only "active" for whatever is between \define and \end

I'd add that such experiments should be done in dedicated throwaway-wikies and one should expect them to break from time to time

[Ton Gerner]

Hi all,

Control panel > Info > Advanced > Parsing shows the list of wiki parser rules.

Cheers,

Ton

[BurningTreeC]

Hi all,

Control panel > Info > Advanced > Parsing shows the list of wiki parser rules.

Thanks Ton, I think this simple line should be on top of the doc tiddler on tidd.com

Cheers,

Ton

 

[S. S.]

Thanks everyone for explaining. The fog is clearing.

One case I have where it is immediately useful - when CamelCase is turned on and I don't want CamelCase linking to apply. This can cause mayhem when working with variables that contain text in CamelCase. I only realised this when, for testing, I moved a perfectly working macro (where CamelCase was off) into tiddlywiki.com (where CamelCase is on). I found it extremely difficult to fix!

Abbreviated example: In tiddlywiki.com try the below with and without the \rules line.

\define makeLink(site link)
\rules except wikilink
<a href="$link$" target="_blank">$site$</a>
\end

<<makeLink TiddlyWiki https://tiddlywiki.com/>>

With \rules except wikilink - the link created is correct: TiddlyWiki : https://tiddlywiki.com/
Without \rules - the link is wrong: TiddlyWiki : https://tiddlywiki.com/#TiddlyWiki

Cheers


On Thursday, January 10, 2019 at 6:01:25 PM UTC+7, @TiddlyTweeter wrote:

The "pragma" can be switched off or switched on selectively as others have indicated. This can be done inside macros or applied to a single tiddler on its own via \rules.

TonyM also pointed out that you can also globally selectively toggle many of the pragma in settings.

I agree it can be helpful to understand what is going on with them. A major purpose is many (most?) do the basic parsing of raw content of Tiddlers into rendered HTML.

They have been of much interest to me because I do a lot of work using TW to process and auto-convert non-standard text formats. 

It is in fact possible to access the TW process prior to the standard pragma. This can give you amazing flexibility in combining ad-hoc text changes for "pre-conversion" of non-standard text formats that then are further processed using the standard parsers.

I mention this because its given me quite a lot understanding of pragma in TW. Note that Content Types can define which pragma to run and offer ways you can make new pragma. Its possible to make new Content Types.

The best resources I know about this are from BJ's work ...

Flexitype ... http://bjtools.tiddlyspot.com/#Flexitype%20Demos

Flexity ... http://flexibility.tiddlyspot.com/

Here are discussions that may shed a bit of light on this largely undocumented topic ...

https://groups.google.com/forum/#!msg/tiddlywiki/bl_GiI63X84/_naCQEG1AAAJ

https://groups.google.com/forum/#!searchin/tiddlywiki/pragma$20jeremy%7Csort:date/tiddlywiki/A7vdxcRb8lQ/yycBBydIEwAJ

Best wishes

Josiah

[S. S.]

The full working macro where I used: \rules except wikilink
Here: Dictionary - lookup macro

Cheers!

[Ste Wilson]

Oooh! That's quite cool!