Provide option to open .tex file with *tikzpicture* elementes collapsed

Describe the feature and the current behavior/state

Currently, when opening a large tex file, it is difficult to navigate. To make navigation easier, the user sometimes collapses some unnecessary section, such as tikzpictures. Why not provide an option to collapse them automatically on opening a .tex file?

Who will benefit with this feature?

Those who draw images by hand (they take a lot of space) especially \begin{tikzpicture} \end{tikzpicture}

Any Other info

[muzimuzhi]

Here is a script macro which collapses every line containing \begin{tikzpicture} and is automatically triggered (see the trigger ?load-file) when a file is loaded.

PS: A macro can also be triggered by menu item under Macro, as well as a keyboard shortcut, or by a pattern of user input so you can choose which environment to be collapsed. For example, with trigger #collapse-all:(\S+)\s and the script adapted to envname = triggerMatches[1], typing #collapse-all:tikzpicture<space> will do the same as the original macro.

%SCRIPT
envname = "tikzpicture";

lines = editor.document().textLines();
for (var i=0; i<lines.length; i++) {
    l = lines[i];
    if (l.includes("\\begin{" + envname + "}")) {
			editor.document().collapse(i);
    }
}

Doc for and examples of user macros:

• sec. 4.6.3 Script Macros, user manual
• sec. 4.6.4 Triggers, user manual
• Collection of user macro scripts, wiki
• https://github.com/texstudio-org/texstudio-macro, repository for official macro scripts

[sunderme]

Is the script sufficient ?

It does not work!

[sunderme]

the code works with txs4.0.0

%SCRIPT
envname = "tikzpicture";

lines = editor.document().textLines();
for (var i=0; i<lines.length; i++) {
    l = lines[i];
    if (l.indexOf("\\begin{" + envname + "}")>-1) {
			editor.document().collapse(i);
    }
}

works with all txs versions.

[sunderme]

I assume the code works, solves the issue -> closed