You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TiddlyWiki's language plugin mechanism includes a primitive mechanism for setting the HTML 5 "dir" attribute on the document body to "RTL", thus switching the direction of the user interface. This mechanism is used by languages such as Farsi and Hebrew.
Some of the issues with the current approach is that it is hard to work with tiddlers that have a different directionality to the main interface. For example, the document direction is "LTR" when using the default "en-GB" language plugin, but pasting (say) Farsi into the title, tags, or text fields of a tiddler doesn't switch direction to "RTL".
Prompted by discussions with @kookma, this experimental PR explores two separate mechanisms that help when working with text of a different directionality than the main interface.
The first is a new \dir rtl pragma that can be used at the top of a tiddler to specify that it should be rendered as RTL. This setting is respected if the tiddler content is transcluded elsewhere.
(A shortcoming at present is that the \dir pragma must be used after any \define pragmas if those macro definitions are to be imported elsewhere with the `\import' pragma).
The second change in this PR is support for a new $:/config/DefaultTextDirection hidden setting. It can be set to "rtl", "ltr" or "auto". It sets the "dir" attribute on several different parts of the view template and edit template.
The interesting thing is the setting "auto", part of the HTML 5 spec. It applies a simple heuristic to detect the appropriate direction for a fragment of text. The default value of $:/config/DefaultTextDirection is "auto". With this setting in place it becomes possible to paste fragments of RTL text into titles, tags, or text fields, and have things work as expected.
(A shortcoming that won't be going away is that the CodeMirror engine doesn't support "auto", just the explicit "RTL" and "LTR" settings. So I think we'll have to handle that entirely differently.
The change that I haven't explored here is adding a "_direction" field on individual tiddlers. That would work much better with the CodeMirror editor, but the disadvantage is that transclusion wouldn't respect the setting.
@Jermolene
Is there any way to update this branch with the latest version of TiddlyWiki? I use the rtl features implemented in this branch. The latest version I have working with this branch is TW 5.3.0
@Jermolene -- I did just have a look at the code here and I could not find any difference to the original "reverted" PR. So does this one still have the performance penalty?
@Jermolene -- I did just have a look at the code here and I could not find any difference to the original "reverted" PR. So does this one still have the performance penalty?
As I said in that original comment "Sadly, this PR will have to be reverted. I'll also create a new PR with the changes so that we can continue investigations". So at this point this is a duplicate of the original PR so that we can continue to experiment; we can't use #4541 because that has already been merged.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR is a recreation of #4541 which was merged and then later reverted when it was discovered that it caused a serious performance regression.
TiddlyWiki's language plugin mechanism includes a primitive mechanism for setting the HTML 5 "dir" attribute on the document body to "RTL", thus switching the direction of the user interface. This mechanism is used by languages such as Farsi and Hebrew.
Some of the issues with the current approach is that it is hard to work with tiddlers that have a different directionality to the main interface. For example, the document direction is "LTR" when using the default "en-GB" language plugin, but pasting (say) Farsi into the title, tags, or text fields of a tiddler doesn't switch direction to "RTL".
Prompted by discussions with @kookma, this experimental PR explores two separate mechanisms that help when working with text of a different directionality than the main interface.
The first is a new
\dir rtlpragma that can be used at the top of a tiddler to specify that it should be rendered as RTL. This setting is respected if the tiddler content is transcluded elsewhere.(A shortcoming at present is that the
\dirpragma must be used after any\definepragmas if those macro definitions are to be imported elsewhere with the `\import' pragma).The second change in this PR is support for a new $:/config/DefaultTextDirection hidden setting. It can be set to "rtl", "ltr" or "auto". It sets the "dir" attribute on several different parts of the view template and edit template.
The interesting thing is the setting "auto", part of the HTML 5 spec. It applies a simple heuristic to detect the appropriate direction for a fragment of text. The default value of $:/config/DefaultTextDirection is "auto". With this setting in place it becomes possible to paste fragments of RTL text into titles, tags, or text fields, and have things work as expected.
(A shortcoming that won't be going away is that the CodeMirror engine doesn't support "auto", just the explicit "RTL" and "LTR" settings. So I think we'll have to handle that entirely differently.
The change that I haven't explored here is adding a "_direction" field on individual tiddlers. That would work much better with the CodeMirror editor, but the disadvantage is that transclusion wouldn't respect the setting.