Skip to content

Commit 2f2ae6a

Browse files
committed
update manual
1 parent aa10ac9 commit 2f2ae6a

13 files changed

+93
-50
lines changed

CHANGELOG.html

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77
<meta property="og:type" content="website" />
88
<meta property="og:url" content="CHANGELOG.html" />
99
<meta property="og:site_name" content="TeXstudio" />
10-
<meta property="og:description" content="TeXstudio 4.8.4: fix word selection#3812. TeXstudio 4.8.3: use argument position to assign argument type (fixes some issues concerning keyval arguments), windows binaries are code signed for easier..." />
11-
<meta name="description" content="TeXstudio 4.8.4: fix word selection#3812. TeXstudio 4.8.3: use argument position to assign argument type (fixes some issues concerning keyval arguments), windows binaries are code signed for easier..." />
10+
<meta property="og:description" content="TeXstudio 4.8.5: fix false delimiter mismatch marker which gets stuck under certain circumstances#489, fix label stop working when using subfigure package#3816, fix ai wizard conversation history#3..." />
11+
<meta name="description" content="TeXstudio 4.8.5: fix false delimiter mismatch marker which gets stuck under certain circumstances#489, fix label stop working when using subfigure package#3816, fix ai wizard conversation history#3..." />
1212
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="Background information" href="background.html" />
1313

1414
<link rel="shortcut icon" href="_static/texstudio.ico"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
15-
<title>CHANGELOG - TeXstudio 4.8.4 documentation</title>
15+
<title>CHANGELOG - TeXstudio 4.8.5 documentation</title>
1616
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=9701f087" />
1818
<link rel="stylesheet" type="text/css" href="_static/tabs.css?v=4c969af8" />
@@ -131,7 +131,7 @@
131131
</label>
132132
</div>
133133
<div class="header-center">
134-
<a href="index.html"><div class="brand">TeXstudio 4.8.4 documentation</div></a>
134+
<a href="index.html"><div class="brand">TeXstudio 4.8.5 documentation</div></a>
135135
</div>
136136
<div class="header-right">
137137
<div class="theme-toggle-container theme-toggle-header">
@@ -154,7 +154,7 @@
154154
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
155155

156156

157-
<span class="sidebar-brand-text">TeXstudio 4.8.4 documentation</span>
157+
<span class="sidebar-brand-text">TeXstudio 4.8.5 documentation</span>
158158

159159
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
160160
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -208,6 +208,26 @@
208208
<article role="main">
209209
<section id="changelog">
210210
<h1>CHANGELOG<a class="headerlink" href="#changelog" title="Link to this heading">#</a></h1>
211+
<section id="texstudio-4-8-5">
212+
<h2>TeXstudio 4.8.5<a class="headerlink" href="#texstudio-4-8-5" title="Link to this heading">#</a></h2>
213+
<ul class="simple">
214+
<li><p>fix false delimiter mismatch marker which gets stuck under certain circumstances <a class="reference external" href="https://github.com/texstudio-org/texstudio/issues/489">#489</a></p></li>
215+
<li><p>fix label stop working when using subfigure package <a class="reference external" href="https://github.com/texstudio-org/texstudio/issues/3816">#3816</a></p></li>
216+
<li><p>fix ai wizard conversation history <a class="reference external" href="https://github.com/texstudio-org/texstudio/issues/3820">#3820</a></p></li>
217+
<li><p>fix colspec parsing <a class="reference external" href="https://github.com/texstudio-org/texstudio/issues/3831">#3831</a></p></li>
218+
<li><p>fix user command handling in cached files <a class="reference external" href="https://github.com/texstudio-org/texstudio/issues/3828">#3828</a></p></li>
219+
<li><p>fix label detection on memoir class <a class="reference external" href="https://github.com/texstudio-org/texstudio/issues/3829">#3829</a></p></li>
220+
<li><p>fix crash when %Tex root document was not found</p></li>
221+
<li><p>class are used for completion in documentclass</p></li>
222+
<li><p>class names are not used anymore for package name completion</p></li>
223+
<li><p>local packages can provide local cwl files ,<a class="reference external" href="https://texstudio-org.github.io/advanced.html#local-packages">see manual</a></p></li>
224+
<li><p>fix handling of user definition commands in subfiles <a class="reference external" href="https://github.com/texstudio-org/texstudio/issues/3885">#3885</a></p></li>
225+
<li><p>fix crash in preview tooltip if no pdflatex is defined <a class="reference external" href="https://github.com/texstudio-org/texstudio/issues/3875">#3875</a></p></li>
226+
<li><p>handle special columntypes (m[l],NiceMatrix) better <a class="reference external" href="https://github.com/texstudio-org/texstudio/issues/3881">#3881</a></p></li>
227+
<li><p>handle key/val completion in frame environment better <a class="reference external" href="https://github.com/texstudio-org/texstudio/issues/3846">#3846</a></p></li>
228+
<li><p>fix caching of newly defined colornames</p></li>
229+
</ul>
230+
</section>
211231
<section id="texstudio-4-8-4">
212232
<h2>TeXstudio 4.8.4<a class="headerlink" href="#texstudio-4-8-4" title="Link to this heading">#</a></h2>
213233
<ul class="simple">
@@ -1834,6 +1854,7 @@ <h2>Texmaker 1.2<a class="headerlink" href="#texmaker-1-2" title="Link to this h
18341854
<div class="toc-tree">
18351855
<ul>
18361856
<li><a class="reference internal" href="#">CHANGELOG</a><ul>
1857+
<li><a class="reference internal" href="#texstudio-4-8-5">TeXstudio 4.8.5</a></li>
18371858
<li><a class="reference internal" href="#texstudio-4-8-4">TeXstudio 4.8.4</a></li>
18381859
<li><a class="reference internal" href="#texstudio-4-8-3">TeXstudio 4.8.3</a></li>
18391860
<li><a class="reference internal" href="#texstudio-4-8-2">TeXstudio 4.8.2</a></li>
@@ -1940,7 +1961,7 @@ <h2>Texmaker 1.2<a class="headerlink" href="#texmaker-1-2" title="Link to this h
19401961

19411962
</aside>
19421963
</div>
1943-
</div><script src="_static/documentation_options.js?v=4f6f18ad"></script>
1964+
</div><script src="_static/documentation_options.js?v=e62f6ccb"></script>
19441965
<script src="_static/doctools.js?v=888ff710"></script>
19451966
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
19461967
<script type="module" src="_static/scripts/furo.js?v=3e7832f7"></script>

_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '4.8.4',
2+
VERSION: '4.8.5',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

advanced.html

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Configuring TeXstudio" href="configuration.html" /><link rel="prev" title="Viewing a document (pdf)" href="viewing.html" />
1313

1414
<link rel="shortcut icon" href="_static/texstudio.ico"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
15-
<title>Advanced features - TeXstudio 4.8.4 documentation</title>
15+
<title>Advanced features - TeXstudio 4.8.5 documentation</title>
1616
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=9701f087" />
1818
<link rel="stylesheet" type="text/css" href="_static/tabs.css?v=4c969af8" />
@@ -131,7 +131,7 @@
131131
</label>
132132
</div>
133133
<div class="header-center">
134-
<a href="index.html"><div class="brand">TeXstudio 4.8.4 documentation</div></a>
134+
<a href="index.html"><div class="brand">TeXstudio 4.8.5 documentation</div></a>
135135
</div>
136136
<div class="header-right">
137137
<div class="theme-toggle-container theme-toggle-header">
@@ -154,7 +154,7 @@
154154
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
155155

156156

157-
<span class="sidebar-brand-text">TeXstudio 4.8.4 documentation</span>
157+
<span class="sidebar-brand-text">TeXstudio 4.8.5 documentation</span>
158158

159159
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
160160
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -424,6 +424,20 @@ <h2>Advanced header usage<a class="headerlink" href="#advanced-header-usage" tit
424424
</dd>
425425
</dl>
426426
</section>
427+
<section id="local-packages">
428+
<h2>Local packages<a class="headerlink" href="#local-packages" title="Link to this heading">#</a></h2>
429+
<p>Many users define personal commands, settings, colors, etc in a personal file which is included into the latex document via <code class="docutils literal notranslate"><span class="pre">\include</span></code> or <code class="docutils literal notranslate"><span class="pre">\input</span></code>.
430+
TeXstudio can read the files and take up the defined commands for completion but is does not have any understanding of the arguments like if they are labels, texts or math elements.
431+
The syntactital definition is given to TeXstudio via <a class="reference internal" href="background.html#description-of-the-cwl-format"><span class="std std-ref">cwl files</span></a>.
432+
TeXstudio searches for local cwl files for local packages. To notify TeXstudio that a package is local, the package name has to be given as a relative path, e.g. <code class="docutils literal notranslate"><span class="pre">\usepackage{./myPackage}</span></code>.
433+
TeXstudio looks for <code class="docutils literal notranslate"><span class="pre">./myPackage.cwl</span></code> and loads it if present.</p>
434+
<div class="admonition note">
435+
<p class="admonition-title">Note</p>
436+
<p>The local package filename needs to be <code class="docutils literal notranslate"><span class="pre">myPackage.sty</span></code>.
437+
Otherwise all normal commands are valid.</p>
438+
<p>If a cwl file is changed, the updated version is only loaded into TeXstudio after a restart of TeXstudio.</p>
439+
</div>
440+
</section>
427441
<section id="personal-macros">
428442
<h2>Personal macros<a class="headerlink" href="#personal-macros" title="Link to this heading">#</a></h2>
429443
<p>TeXstudio allows you to insert your own macros. These macros are defined
@@ -1220,6 +1234,7 @@ <h2>The “Convert to Html” command<a class="headerlink" href="#the-convert-to
12201234
<li><a class="reference internal" href="#bibliography">Bibliography</a></li>
12211235
<li><a class="reference internal" href="#git-svn-support">GIT/SVN Support</a></li>
12221236
<li><a class="reference internal" href="#advanced-header-usage">Advanced header usage</a></li>
1237+
<li><a class="reference internal" href="#local-packages">Local packages</a></li>
12231238
<li><a class="reference internal" href="#personal-macros">Personal macros</a><ul>
12241239
<li><a class="reference internal" href="#text-macros">Text macros</a></li>
12251240
<li><a class="reference internal" href="#environment-macros">Environment macros</a></li>
@@ -1245,7 +1260,7 @@ <h2>The “Convert to Html” command<a class="headerlink" href="#the-convert-to
12451260

12461261
</aside>
12471262
</div>
1248-
</div><script src="_static/documentation_options.js?v=4f6f18ad"></script>
1263+
</div><script src="_static/documentation_options.js?v=e62f6ccb"></script>
12491264
<script src="_static/doctools.js?v=888ff710"></script>
12501265
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
12511266
<script type="module" src="_static/scripts/furo.js?v=3e7832f7"></script>

background.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="CHANGELOG" href="CHANGELOG.html" /><link rel="prev" title="Configuring TeXstudio" href="configuration.html" />
1313

1414
<link rel="shortcut icon" href="_static/texstudio.ico"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
15-
<title>Background information - TeXstudio 4.8.4 documentation</title>
15+
<title>Background information - TeXstudio 4.8.5 documentation</title>
1616
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=9701f087" />
1818
<link rel="stylesheet" type="text/css" href="_static/tabs.css?v=4c969af8" />
@@ -131,7 +131,7 @@
131131
</label>
132132
</div>
133133
<div class="header-center">
134-
<a href="index.html"><div class="brand">TeXstudio 4.8.4 documentation</div></a>
134+
<a href="index.html"><div class="brand">TeXstudio 4.8.5 documentation</div></a>
135135
</div>
136136
<div class="header-right">
137137
<div class="theme-toggle-container theme-toggle-header">
@@ -154,7 +154,7 @@
154154
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
155155

156156

157-
<span class="sidebar-brand-text">TeXstudio 4.8.4 documentation</span>
157+
<span class="sidebar-brand-text">TeXstudio 4.8.5 documentation</span>
158158

159159
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
160160
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -1111,7 +1111,7 @@ <h3>Translating manual<a class="headerlink" href="#translating-manual" title="Li
11111111

11121112
</aside>
11131113
</div>
1114-
</div><script src="_static/documentation_options.js?v=4f6f18ad"></script>
1114+
</div><script src="_static/documentation_options.js?v=e62f6ccb"></script>
11151115
<script src="_static/doctools.js?v=888ff710"></script>
11161116
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
11171117
<script type="module" src="_static/scripts/furo.js?v=3e7832f7"></script>

compiling.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Viewing a document (pdf)" href="viewing.html" /><link rel="prev" title="Editing a TeX document" href="editing.html" />
1313

1414
<link rel="shortcut icon" href="_static/texstudio.ico"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
15-
<title>Compiling a document - TeXstudio 4.8.4 documentation</title>
15+
<title>Compiling a document - TeXstudio 4.8.5 documentation</title>
1616
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=9701f087" />
1818
<link rel="stylesheet" type="text/css" href="_static/tabs.css?v=4c969af8" />
@@ -131,7 +131,7 @@
131131
</label>
132132
</div>
133133
<div class="header-center">
134-
<a href="index.html"><div class="brand">TeXstudio 4.8.4 documentation</div></a>
134+
<a href="index.html"><div class="brand">TeXstudio 4.8.5 documentation</div></a>
135135
</div>
136136
<div class="header-right">
137137
<div class="theme-toggle-container theme-toggle-header">
@@ -154,7 +154,7 @@
154154
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
155155

156156

157-
<span class="sidebar-brand-text">TeXstudio 4.8.4 documentation</span>
157+
<span class="sidebar-brand-text">TeXstudio 4.8.5 documentation</span>
158158

159159
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
160160
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -331,7 +331,7 @@ <h2>The log files<a class="headerlink" href="#the-log-files" title="Link to this
331331

332332
</aside>
333333
</div>
334-
</div><script src="_static/documentation_options.js?v=4f6f18ad"></script>
334+
</div><script src="_static/documentation_options.js?v=e62f6ccb"></script>
335335
<script src="_static/doctools.js?v=888ff710"></script>
336336
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
337337
<script type="module" src="_static/scripts/furo.js?v=3e7832f7"></script>

0 commit comments

Comments
 (0)