mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2025-08-07 22:33:50 +00:00
Improve docs of transcludes and backtranscludes operators (#8247)
* Improve docs of transcludes and backtranscludes operators * Improve docs: cross reference hard/soft links and transclusions
This commit is contained in:
parent
bf9865af20
commit
d276e0aa25
@ -70,7 +70,7 @@ Improvements to the following translations:
|
|||||||
|
|
||||||
! Filter Improvements
|
! Filter Improvements
|
||||||
|
|
||||||
* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/7966">> new [[backtranscludes Operator]]
|
* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/7966">> new [[transcludes|transcludes Operator]] and [[backtranscludes|backtranscludes Operator]] operators
|
||||||
|
|
||||||
! Usability Improvements
|
! Usability Improvements
|
||||||
|
|
||||||
|
@ -1,10 +1,10 @@
|
|||||||
created: 20150123220237000
|
created: 20150123220237000
|
||||||
modified: 20150226163104000
|
modified: 20240610085736941
|
||||||
tags: Concepts
|
tags: Concepts
|
||||||
title: Hard and Soft Links
|
title: Hard and Soft Links
|
||||||
type: text/vnd.tiddlywiki
|
type: text/vnd.tiddlywiki
|
||||||
|
|
||||||
A <<.def "hard link">> is one that can be detected by a superficial examination of WikiText.
|
A <<.def "hard link">> is a [[link|Linking in WikiText]] that can be detected by a superficial examination of WikiText.
|
||||||
|
|
||||||
A link is <<.def "soft">> if it is:
|
A link is <<.def "soft">> if it is:
|
||||||
|
|
||||||
@ -13,3 +13,5 @@ A link is <<.def "soft">> if it is:
|
|||||||
* generated by a link widget whose <<.attr to>> attribute is a transclusion, macro or variable
|
* generated by a link widget whose <<.attr to>> attribute is a transclusion, macro or variable
|
||||||
|
|
||||||
<$macrocall $name=".warning" _="""Soft links are not detected by link-related filter operators such as <<.olink backlinks>>, <<.olink links>>, <<.olink all>> and <<.olink is>>."""/>
|
<$macrocall $name=".warning" _="""Soft links are not detected by link-related filter operators such as <<.olink backlinks>>, <<.olink links>>, <<.olink all>> and <<.olink is>>."""/>
|
||||||
|
|
||||||
|
This concept is analogous to [[Hard and Soft Transclusions]].
|
||||||
|
@ -0,0 +1,16 @@
|
|||||||
|
created: 20240610085133221
|
||||||
|
modified: 20240610085613037
|
||||||
|
tags: Concepts
|
||||||
|
title: Hard and Soft Transclusions
|
||||||
|
|
||||||
|
A <<.def "hard transclusion">> is a [[transclusion|Transclusion]] that can be detected by a superficial examination of WikiText.
|
||||||
|
|
||||||
|
A transclusion is <<.def "soft">> if it is:
|
||||||
|
|
||||||
|
* contained in text [[trancluded|Transclusion]] from elsewhere
|
||||||
|
* supplied via a [[macro|Macros]], [[procedure|Procedures]] or [[variable|Variables]]
|
||||||
|
* generated by a [[transclude widget|TranscludeWidget]] whose <<.attr $tiddler>> attribute is a transclusion, macro or variable
|
||||||
|
|
||||||
|
<$macrocall $name=".warning" _="""Soft transclusions are not detected by transclusion-related filter operators <<.olink transcludes>> and <<.olink backtranscludes>>."""/>
|
||||||
|
|
||||||
|
This concept is analogous to [[Hard and Soft Links]].
|
@ -20,3 +20,4 @@ To learn more:
|
|||||||
* TextReference
|
* TextReference
|
||||||
* TemplateTiddlers
|
* TemplateTiddlers
|
||||||
* TranscludeWidget
|
* TranscludeWidget
|
||||||
|
* [[Hard and Soft Transclusions]]
|
||||||
|
@ -1,13 +1,14 @@
|
|||||||
|
caption: backtranscludes
|
||||||
created: 20211002204500000
|
created: 20211002204500000
|
||||||
|
modified: 20240610085949413
|
||||||
|
op-input: a [[selection of titles|Title Selection]]
|
||||||
|
op-output: any non-[[system|SystemTiddlers]] titles that [[hard-transclude|Hard and Soft Transclusions]] the input titles
|
||||||
|
op-parameter: none
|
||||||
|
op-purpose: find the titles that transclude each input title
|
||||||
tags: [[Filter Operators]]
|
tags: [[Filter Operators]]
|
||||||
title: backtranscludes Operator
|
title: backtranscludes Operator
|
||||||
type: text/vnd.tiddlywiki
|
type: text/vnd.tiddlywiki
|
||||||
caption: backtranscludes
|
|
||||||
op-purpose: find the titles that transcludes to each input title
|
|
||||||
op-input: a [[selection of titles|Title Selection]]
|
|
||||||
op-parameter: none
|
|
||||||
op-output: any non-[[system|SystemTiddlers]] titles that contain [[transclusion|Transclusion]] to the input titles
|
|
||||||
|
|
||||||
<<.from-version 5.3.4>> Similar to [[backlinks|backlinks Operator]]. Each input title is processed in turn. The corresponding tiddler's list of backtranscludes is generated, sorted alphabetically by title, and then [[dominantly appended|Dominant Append]] to the operator's overall output.
|
<<.from-version 5.3.4>> Each input title is processed in turn. The corresponding tiddler's list of backtransclusions is generated, sorted alphabetically by title, and then [[dominantly appended|Dominant Append]] to the operator's overall output. Analogous to [[backlinks|backlinks Operator]].
|
||||||
|
|
||||||
<<.operator-examples "backtranscludes">>
|
<<.operator-examples "backtranscludes">>
|
||||||
|
@ -1,13 +1,14 @@
|
|||||||
|
caption: transcludes
|
||||||
created: 20211002204500000
|
created: 20211002204500000
|
||||||
|
modified: 20240610085927867
|
||||||
|
op-input: a [[selection of titles|Title Selection]]
|
||||||
|
op-output: the titles which the input tiddlers [[hard-transclude|Hard and Soft Transclusions]]
|
||||||
|
op-parameter: none
|
||||||
|
op-purpose: find the titles transcluded by each input title
|
||||||
tags: [[Filter Operators]] [[Common Operators]]
|
tags: [[Filter Operators]] [[Common Operators]]
|
||||||
title: transcludes Operator
|
title: transcludes Operator
|
||||||
type: text/vnd.tiddlywiki
|
type: text/vnd.tiddlywiki
|
||||||
caption: transcludes
|
|
||||||
op-purpose: find the titles linked to by each input title
|
|
||||||
op-input: a [[selection of titles|Title Selection]]
|
|
||||||
op-parameter: none
|
|
||||||
op-output: the titles to which the input tiddlers [[transcludes|Transclusion]]
|
|
||||||
|
|
||||||
Each input title is processed in turn. The corresponding tiddler's list of transcludes is generated, in the order in which they appear in the tiddler's text, and [[dominantly appended|Dominant Append]] to the operator's overall output.
|
<<.from-version 5.3.4>> Each input title is processed in turn. The corresponding tiddler's list of transclusions is generated, in the order in which they appear in the tiddler's text, and [[dominantly appended|Dominant Append]] to the operator's overall output.
|
||||||
|
|
||||||
<<.operator-examples "transcludes">>
|
<<.operator-examples "transcludes">>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user