← Back to branch summary

~ubuntu-branches/debian/sid/texstudio/sid

« back to all changes in this revision

Viewing changes to utilities/usermanual_en.html

  • Committer: Package Import Robot
  • Author(s): Tom Jampen
  • Date: 2014-09-10 07:36:27 UTC
  • mfrom: (1.1.8)
  • Revision ID: package-import@ubuntu.com-20140910073627-25emtb7omxdfjuvl
Tags: 2.8.4+debian-1
* Merging upstream version 2.8.4+debian.
* Regenerating 01-use-libhunspell.patch.
* Updating 04-no-qt-translations.patch to also exclude qt_pl.qm.
* Regenerating 05-use-libsynctex.patch.
* Updating package description to include new polish translations.
* Switching to default xz compression level in rules.
* Rebuilding upstream tarball without:
  - conflicting debian directory
  - unused hunspell directory
  - unused include_win32 directory
  - unused include_win32_qt5 directory
  - unused qt translations
  - unused dictionary and thesaurus files
  - unused TexTablet directory
  - unused poppler-data directory

Show diffs side-by-side

added added

removed removed

Lines of Context:
utilities/usermanual_en.html
12
12
<ul class="two-columns">
13
13
<li><a href="#SECTIONNEW">0. What's new</a>
14
14
        <ul>
15
 
        <li><a href="#SECTIONNEW281">Version 2.8.0 -> Version 2.8.2</a></li>
 
15
        <li><a href="#SECTIONNEW284">Version 2.8.2 -> Version 2.8.4</a></li>
 
16
        <li><a href="#SECTIONNEW282">Version 2.8.0 -> Version 2.8.2</a></li>
16
17
        <li><a href="#SECTIONNEW280">Version 2.7.0 -> Version 2.8.0</a></li>
17
18
        <li><a href="#SECTIONNEW270">Version 2.6.6 -> Version 2.7.0</a></li>
18
19
        <li><a href="#SECTIONNEW266">Version 2.6.4 -> Version 2.6.6</a></li>
100
101
<hr>
101
102
<h1 id="SECTIONNEW">0. What's new</h1>
102
103
 
103
 
<h2 id="SECTIONNEW281">Version 2.8.0 -> Version 2.8.2</h2>
 
104
<h2 id="SECTIONNEW284">Version 2.8.2 -> Version 2.8.4</h2>
 
105
<ul>
 
106
<li><p>improved syncing to PDF: don't scroll PDF to top of page if the highlighted area is already visible</p></li>
 
107
<li><p>support command detection for \DeclareRobustCommand</p></li>
 
108
<li><p>persistently store fit and center options of preview panel</p></li>
 
109
<li><p>support more environments for table auto-formatting</p></li>
 
110
<li><p>remember scope when deleting auxiliary files</p></li>
 
111
<li><p>improved handling of incomplete options in the syntax checker</p></li>
 
112
<li><p>new/improved cwls: mathtools, circuitikz</p></li>
 
113
<li><p>fix: crash with RTL text input</p></li>
 
114
<li><p>fix: some shortcuts couldn't be assigned on OSX</p></li>
 
115
<li><p>fix: multi-cursor edits are now grouped into a single undo action</p></li>
 
116
<li><p>fix: lost scroll position when previewing large images</p></li>
 
117
<li><p>fix: assignment of multiple shortcuts to editor operations</p></li>
 
118
<li><p>fix: unindent per shortcut without selection</p></li>
 
119
<li><p>fix: more consistent behavior for PgUp/PgDown in PDF viewer</p></li>
 
120
<li><p>fix: immediately generate cursor mirrors when inserting via the menu</p></li>
 
121
<li><p>fix: commands defined in one file included by many documents were only known in the completion list  of one them</p></li>
 
122
<li><p>fix: compile option without poppler</p></li>
 
123
<li><p>fix: crash with \newcommands{xyz}{123456789}</p></li>
 
124
<li><p>fix: %BEGIN_FOLD could not be folded</p></li>
 
125
<li><p>fix: apply grayscale and invert color settings also to magnifier</p></li>
 
126
<li><p>fix: incorrect search hightlight region in PDF viewer with Qt5</p></li>
 
127
<li><p>fix: drag&amp;drop of text already started +/-5 lines from the border (now 1 line)</p></li>
 
128
</ul>
 
129
 
 
130
<h2 id="SECTIONNEW282">Version 2.8.0 -> Version 2.8.2</h2>
104
131
<ul>
105
132
<li><p>color completion</p></li>
106
133
<li><p>some more predefined completions for tikz</p></li>
110
137
<li><p>improved input method support</p></li>
111
138
<li><p>improved \todo highlighting</p></li>
112
139
<li><p>texstudio.ini settings GUI/ToobarIconSize and GUI/SecondaryToobarIconSize</p></li>
 
140
<li><p>portable version uses relative paths to dictionaries, so they stay valid independent of the current location of the portable version</p></li>
113
141
<li><p>several bugfixes</p></li>
114
142
</ul>
115
143
 
440
468
The advanced options allows finer customization which is in general not necessary.<br>
441
469
</p>
442
470
<p><IMG src="configure_build.png" border="1" alt="Configure Build System"></p>
443
 
User commands can be defined here by "adding" them. Each user command has  a name like "user%n:" where "%n" is a number. After the colon a name can be stated which is shown in the tools menu. The user commands can be activated either by short cut (alt+shift+F%n) or by the tools menu (Tools/User).<br>
 
471
User commands can be defined here by "adding" them. Each user command has a name with a pattern <code>&lt;command id&gt;:&lt;display name&gt;</code>, e.g. <code>user0:User Command 0</code>. The command id has to be unique and must not contain spaces. In <a href="SECTION02a1">advanced mode</a>, you can reference it using <code>txs:///"&lt;command id&gt;</code>. The display name will be shown in the tools menu. The user commands can be activated either by short cut (alt+shift+F%n) or by the tools menu (Tools/User).<br>
444
472
User commands can either consist of a combination of known commands by selecting them from a list of available commands. This is triggered by clicking the spanner-symbol.<br>
445
473
Alternatively a command can be directly selected through the file system.
446
474
<p><IMG src="doc21.png" border="1" alt="Configure user commands from known commands"></p>
447
475
 
448
476
<h2 id="SECTION02a1">1.3.1 Advanced configuration of the build system</h2>
449
477
 
450
 
<p>If you enable the advanced options, you can configure the build system in more details.
 
478
<p>If you enable the advanced options, you can configure the build system in more detail.
451
479
 
452
480
<p>Every txs-command is a list of external programs/latex-commands and other txs-commands to call. An external program can be called with its usual command line, while a txs-command with id "foobar" is called by txs:///foobar. <br>
453
481
The commands in the list are separated by |, which is just a separator (i.e. it will <i>not</i> pass the stdout from one program to the stdin of the next).
493
521
 
494
522
<p>
495
523
Finally, there are also hidden options, which can only be changed by modifing the ini-file: Tools/Kind/LaTeX, Tools/Kind/Rerunnable, Tools/Kind/Pdf, Tools/Kind/Stdout, Tools/Kind/Viewer, which give a list of commands that are treated as latex compiler (e.g. show the log afterwards), rerunnable (repeat command call, if there are warnings), pdf generators (e.g. pdflatex), commands that prints to stdout (e.g. bibtex), and viewers (e.g. only open once).
496
 
 
 
524
</p>
 
525
<h2 id="SECTION02a2">1.3.2 Details of the execution environment</h2>
 
526
<p>
 
527
The PATH for the execution is the same as the PATH used when executing TeXstudio. On Linux/OS X the PATH may depend on the way you started TeXstudio. Programs started from the GUI may have a different PATH setting than programs started from a shell.
 
528
</p>
 
529
<p>
 
530
The working directory is set to the path of the master document, or to the path of the current file if there is no master document.
 
531
</p>
 
532
<p>
 
533
All commands specified in the configuration (i.e. Commands and User Commands) are executed directly. There is no shell involved. So output redirection and other shell functionality does not work.
 
534
</p>
 
535
<p>
 
536
You can see the difference with the following scipt:
 
537
</p>
 
538
<pre>
 
539
#! /bin/sh
 
540
# I am testscript
 
541
echo "Working Directory"
 
542
pwd
 
543
echo "Arg1: $1"
 
544
echo "Arg2: $2"
 
545
echo "Arg3: $3"
 
546
</pre>
 
547
<p>When calling <code>/path/to/testscript foo > bar</code> from the shell, you will pass one argument (foo) and redirect the output to bar. When writing this as a user command in TeXstudio, you will have three arguments(foo, &gt; bar) and no redirection.</p>
 
548
<p>If you need shell functionality, you have to explicitly run a shell. You can either do this directly in the user command.</p>
 
549
<pre>
 
550
sh -c "/path/to/testscript foo > bar"
 
551
</pre>
 
552
<p>or on Windows:</p>
 
553
<pre>
 
554
cmd /C "/path/to/testscript.bat foo > bar"
 
555
</pre>
 
556
<p>or call a wrapper script in the user command</p>
 
557
<pre>/path/to/wrapperscript foo bar</pre>
 
558
<p>and do the actual work inside the wrapper script:</p>
 
559
<pre>
 
560
#! /bin/sh
 
561
# I am wrapperscript
 
562
/path/to/testscript $1 > $2
 
563
</pre>
497
564
 
498
565
<h2 id="SECTION030">1.4 Configuring some general issues</h2>
499
566
<p>This panel allows the setting of some general aspects.</p>