Skip to content

Commit

Permalink
docs: transclude usage
Browse files Browse the repository at this point in the history
  • Loading branch information
linonetwo committed Oct 29, 2024
1 parent 59a971f commit e763e45
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
9 changes: 7 additions & 2 deletions src/streams-outliner-lib/language/en-GB/Readme.tid
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,16 @@ Read the interactive doc on [ext[https://tiddly-gittly.github.io/streams-outline

Create an outliner that will add information to tiddler [[Index]]'s fields:

<<wikitext-example-without-html """<<stream-outliner Index>>
""">>
<<wikitext-example-without-html """<<stream-outliner Index>>""">>

Or use the transclude widget:

<<wikitext-example-without-html """<$transclude $variable="stream-outliner" currentTiddler="Index"/>""">>

!!! Navigation with breadcrumbs

Here we have switched to the `stream-outliner-breadcrumbs` macro, which comes with breadcrumb navigation (see Breadcrumb Navigation in Other Tools below). And we've added an `id` parameter so that we can create multiple outlines on the same page, which, as you may have noticed, can interact with each other and display the same content at the same time if you don't specify the `id` parameter.

<<wikitext-example-without-html """<<stream-outliner-breadcrumbs Index1 id:stream-outliner-1>>""">>

!!! The node is edited with a toolbar
Expand Down
6 changes: 6 additions & 0 deletions src/streams-outliner-lib/language/zh-Hans/Readme.tid
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,14 @@ title: $:/plugins/linonetwo/streams-outliner-lib/language/zh-Hans/Readme

<<wikitext-example-without-html """<<stream-outliner Index>>""">>

或使用嵌入微件:

<<wikitext-example-without-html """<$transclude $variable="stream-outliner" currentTiddler="Index"/>""">>

!!! 带面包屑导航

这里我们改用 `stream-outliner-breadcrumbs` 宏,它自带面包屑导航(详见下面的其它工具里的面包屑导航)。而且我们添加了一个 `id` 参数,这样我们可以在同一个页面上创建多个大纲,你可能已经注意到了,如果不指定 `id` 参数,多个大纲会互相影响、同时展示相同的内容。

<<wikitext-example-without-html """<<stream-outliner-breadcrumbs Index1 id:stream-outliner-1>>""">>

!!! 节点编辑时带有工具栏
Expand Down

0 comments on commit e763e45

Please sign in to comment.