How to add comments to style packages?

[mirkov]

Hello,

Just doing my first style package (for Dirac brackets, using this post for guidance).

I’d like to add some comments to the package.

I found nothing in the Jolly Writer or in the documentation on the format for comments. (And I am not familiar enough with my Macbook to figure out where TeXmac’ own packages reside (for inspection)).

Thanks for your help,

[pireddag]

Hi @mirkov.
You can insert comments in a style file using the tag src-comment. This tag is available when you use the source style—you have to select that style in addition to naming your style file with the .ts extension. You get a pastel yellow box framed with a thin black line.

When using the source style you see the assign tags even if you are in text mode, i.e. Document->Source->Edit source tree is unchecked. (edited 2023-12-29, see next post for correct version)

In source style you have available as well the tag src-title, which is used by TeXmacs to check whether a style is being applied to the document, see incomplete details here:

Custom title page style / loading .scm module with relative path

I have been able to get the script to run with :require, there was a step which I did not expect—explanation follows. I renamed the style file and that may be relevant although in case it is the pattern of the renaming and of the :require check which is important, not the name itself. At the beginning the style was named custom-book-style.ts and the check that was failing was (style-has? "custom-book-style") which was returning #f (testing Scheme functions is done conveniently in a Scheme s…

[pireddag]

When using the source style you see the assign tags even if you are in text mode, i.e. Document->Source->Edit source tree is unchecked.

This is wrong.
Here is a better version.
You have to be in source mode editing to see by default the assign tags, and you can activate the comments and title by selecting them with the cursor and then using the menu to add the active* tag:

Source->Activation->Activate

The other way round, i.e. not being in source mode and deactivating the assign tags to see them, might not work as you want the assign tags to assign. I did not try this.

[darcy]

I just started a physics style package plugin:

GitHub - XmacsLabs/physics: LaTeX physics package equiv in TeXmacs

We can work together to improve it.