Mirrors
/
atom-beautify
mirror of https://github.com/Glavin001/atom-beautify.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
atom-beautify/docs/code/class/LatexBeautify.html

272 lines
7.1 KiB
HTML
Raw Normal View History

Update documentation
2016-07-04 20:58:48 -06:00
<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>Atom-Beautify Documentation</title>
<script src='../javascript/application.js'></script>
<script src='../javascript/search.js'></script>
<link rel='stylesheet' href='../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../'></div>
<div id='header'>
<div id='menu'>
<a href='../extra/README.md.html' title='Atom-Beautify'>
Atom-Beautify
</a>
&raquo;
<a href='../alphabetical_index.html' title='Index'>
Index
</a>
&raquo;
<span class='title'>LatexBeautify</span>
</div>
</div>
<div id='content'>
<h1>
Class:
LatexBeautify
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src&#47;beautifiers&#47;latex-beautify.coffee</td>
</tr>
<tr>
<td>Inherits:</td>
<td>
<a href='../class/Beautifier.html'>Beautifier</a>
</td>
</tr>
</table>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='name-variable'>
name
=
</dt>
<dd>
<pre><code class='coffeescript'>&quot;Latex Beautify&quot;</code></pre>
</dd>
<dt id='link-variable'>
link
=
</dt>
<dd>
<pre><code class='coffeescript'>&quot;https:&#47;&#47;github.com&#47;cmhughes&#47;latexindent.pl&quot;</code></pre>
Update code docs
2018-03-01 21:11:16 -07:00
</dd>
<dt id='isPreInstalled-variable'>
isPreInstalled
=
</dt>
<dd>
<pre><code class='coffeescript'>false</code></pre>
Update documentation
2016-07-04 20:58:48 -06:00
</dd>
<dt id='options-variable'>
options
=
</dt>
<dd>
<pre><code class='coffeescript'>{
LaTeX: true
}</code></pre>
</dd>
</dl>
<h3 class='inherited'>
Variable inherited from
<a href='../class/Beautifier.html'>Beautifier</a>
</h3>
<p class='inherited'>
<a href='../class/Beautifier.html#Promise-variable'>Promise</a>
<a href='../class/Beautifier.html#name-variable'>name</a>
<a href='../class/Beautifier.html#options-variable'>options</a>
Update code docs
2018-03-01 21:11:16 -07:00
<a href='../class/Beautifier.html#executables-variable'>executables</a>
<a href='../class/Beautifier.html#_exe-variable'>_exe</a>
Update documentation
2016-07-04 20:58:48 -06:00
<a href='../class/Beautifier.html#languages-variable'>languages</a>
<a href='../class/Beautifier.html#beautify-variable'>beautify</a>
<a href='../class/Beautifier.html#logger-variable'>logger</a>
</p>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#buildConfigFile-dynamic'>
#
(void)
<b>buildConfigFile</b><span>(options)</span>
</a>
</span>
<span class='desc'>
There are too many options with latexmk, I have tried to slim this down to the most useful ones.
</span>
</li>
<li>
<span class='signature'>
<a href='#setUpDir-dynamic'>
#
(void)
<b>setUpDir</b><span>(dirPath, text, config)</span>
</a>
</span>
<span class='desc'>
Latexindent accepts configuration <em>files</em> only.
</span>
</li>
<li>
<span class='signature'>
<a href='#beautify-dynamic'>
#
(void)
<b>beautify</b><span>(text, language, options)</span>
</a>
</span>
<span class='desc'>
Beautifier does not currently have a method for creating directories, so we call temp directly.
</span>
</li>
</ul>
<h2>
<small>Inherited Method Summary</small>
<h3 class='inherited'>
Methods inherited from
<a href='../class/Beautifier.html'>Beautifier</a>
</h3>
<p class='inherited'>
Update code docs
2018-03-01 21:11:16 -07:00
<a href='../class/Beautifier.html#isPreInstalled-dynamic'>#isPreInstalled</a>
<a href='../class/Beautifier.html#loadExecutables-dynamic'>#loadExecutables</a>
<a href='../class/Beautifier.html#exe-dynamic'>#exe</a>
Update documentation
2016-07-04 20:58:48 -06:00
<a href='../class/Beautifier.html#deprecate-dynamic'>#deprecate</a>
Update code docs
2018-03-01 21:11:16 -07:00
<a href='../class/Beautifier.html#deprecateOptionForExecutable-dynamic'>#deprecateOptionForExecutable</a>
Update documentation
2016-07-04 20:58:48 -06:00
<a href='../class/Beautifier.html#tempFile-dynamic'>#tempFile</a>
<a href='../class/Beautifier.html#readFile-dynamic'>#readFile</a>
<a href='../class/Beautifier.html#findFile-dynamic'>#findFile</a>
Update code docs
2018-03-01 21:11:16 -07:00
<a href='../class/Beautifier.html#getDefaultLineEnding-dynamic'>#getDefaultLineEnding</a>
Update documentation
2016-07-04 20:58:48 -06:00
<a href='../class/Beautifier.html#which-dynamic'>#which</a>
<a href='../class/Beautifier.html#run-dynamic'>#run</a>
<a href='../class/Beautifier.html#setupLogger-dynamic'>#setupLogger</a>
</p>
</h2>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='buildConfigFile-dynamic'>
#
(void)
<b>buildConfigFile</b><span>(options)</span>
<br>
</p>
<div class='docstring'>
<p>There are too many options with latexmk, I have tried to slim this down to the most useful ones.
This method creates a configuration file for latexindent.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='setUpDir-dynamic'>
#
(void)
<b>setUpDir</b><span>(dirPath, text, config)</span>
<br>
</p>
<div class='docstring'>
<p>Latexindent accepts configuration <em>files</em> only.
This file has to be named localSettings.yaml and be in the same folder as the tex file.
It also insists on creating a log file somewhere.
So we set up a directory with all the files in place.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='beautify-dynamic'>
#
(void)
<b>beautify</b><span>(text, language, options)</span>
<br>
</p>
<div class='docstring'>
<p>Beautifier does not currently have a method for creating directories, so we call temp directly.</p>
</div>
<div class='tags'>
</div>
</div>
</div>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
docs: generate docs after adding nunjucks
2016-09-11 15:48:16 -06:00
2.1.2
Update documentation
2016-07-04 20:58:48 -06:00
&#10034;
Press H to see the keyboard shortcuts
&#10034;
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
&#10034;
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>