Skip to content

Commit

Permalink
Update (2016-07-26)
Browse files Browse the repository at this point in the history 
This commit introduces a massive refactoring in the source. So the diff is not very
helpful. In order to see a plain text diff, you can see commit
64bb333.
  • Loading branch information
@maliayas
maliayas committed Jul 26, 2016
1 parent 89ad189 commit 4144c1f
Show file tree
Hide file tree
Showing 22 changed files with 5,293 additions and 1,617 deletions.
2,789 changes: 2,106 additions & 683 deletions www.sublimetext.com/docs/3/api_reference.html
View file

Large diffs are not rendered by default.

61 changes: 42 additions & 19 deletions www.sublimetext.com/docs/3/auto_complete.html
View file
@@ -1,38 +1,61 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<!DOCTYPE html>
<html>
<head>
<title>Auto Complete - Sublime Text 3 Documentation</title>
<link rel="stylesheet" type="text/css" href="sublime_docs.css">
<title>Auto Complete – Sublime Text 3 Documentation</title>
<meta charset="UTF-8">
<link rel="stylesheet" type="text/css" href="sublime_docs.css">
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Open+Sans:400,600,700">
</head>
<body>
<script src="prism.js"></script>

<p class="contents"><a href="index.html">Contents</a></p>
<header>
<section>
<nav>
<a href="https://sublimetext.com">Website</a>
<a href="https://forum.sublimetext.com">Forum</a>
</nav>
<div class="index">
<a href="index.html"><span>Sublime Text 3</span> Documentation</a>
</div>

<h1>Auto Complete</h1>
<h1>Auto Complete</h1>
</section>
</header>

<h3>Overview</h3>
<section>
<p>
Auto complete shows the completion popup as you type, so you can fill in long words by typing only a few characters. It's enabled by default for source code and HTML (but only after entering a &lt; character).
</p>

<p>Auto complete shows the completion popup as you type, so you can fill in long words by typing only a few characters. It's enabled by default for source code and HTML (but only after entering a &lt; character).
<h2>Disabling Auto Complete</h2>

<h2>Disabling Auto Complete</h2>
<p>
Auto complete can be disabled with the <span class="setting">auto_complete</span> setting. To disable it, add this line to the right-hand pane of <span class="menu">Preferences &#9656; Settings</span>:
</p>

<p>Auto complete can be disabled with the <tt>auto_complete</tt> setting. To disable it, add this line to <tt>Preferences/File Settings - User</tt>:
<pre><code class="language-js">"auto_complete": false</code></pre>

<pre class="code">
"auto_complete": false
</pre>
<p>
If auto complete is disabled, the completion popup can be shown manually, or tab can be used to insert the highest ranking completion without showing the popup.
</p>

<p>If auto complete is disabled, the completion popup can be shown manually, or tab can be used to insert the highest ranking completion without showing the popup.
<h2>Manually Showing Completions</h2>

<h2>Manually Showing Completions</h2>
<p>
Pressing <span class="key">ctrl+space</span> will show the completion popup if it's not currently showing. If it is showing, it'll select the next item.
</p>

<p>Pressing <tt>Ctrl+Space</tt> will show the completion popup if it's not currently showing. If it is showing, it'll select the next item.
<h2>Commit on Tab</h2>

<h2>Commit on Tab</h2>
<p>
By default, the selected item in the completion popup will be committed when enter is pressed. This can create ambiguity between committing the completion, and inserting a newline. By setting the <span class="setting">auto_complete_commit_on_tab</span> setting to <tt>true</tt>, enter will insert a newline, and tab will commit the current completion. There are other benefits, too: because Sublime Text knows there is no ambiguity, it will show a more curated list of completions, with the one you want more likely to be in first place.
</p>

<p>By default, the selected item in the completion popup will be committed when enter is pressed. This can create ambiguity between committing the completion, and inserting a newline. By setting the <tt>auto_complete_commit_on_tab</tt> setting to true, enter will insert a newline, and tab will commit the current completion. There are other benefits, too: because Sublime Text knows there is no ambiguity, it will show a more curated list of completions, with the one you want more likely to be in first place.

<p>Enabling Commit on Tab is recommended, but it will take a short time to get used to.
<p>
Enabling Commit on Tab is recommended, but it will take a short time to get used to.
</p>
</section>

</body>
</html>
163 changes: 91 additions & 72 deletions www.sublimetext.com/docs/3/column_selection.html
View file
@@ -1,79 +1,98 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<!DOCTYPE html>
<html>
<head>
<title>Column Selection - Sublime Text 3 Documentation</title>
<link rel="stylesheet" type="text/css" href="sublime_docs.css">
<title>Column Selection – Sublime Text 3 Documentation</title>
<meta charset="UTF-8">
<link rel="stylesheet" type="text/css" href="sublime_docs.css">
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Open+Sans:400,600,700">
</head>
<body>

<p class="contents"><a href="index.html">Contents</a></p>

<h1>Column Selection</h1>

<h3>Overview</h3>

<p>Column Selection can be used to select a rectangular area of a file. Column selection doesn't operate via a separate mode, instead it makes use of multiple selections.

<p>You can use additive selections to select multiple blocks of text, or subtractive selections to remove a block.

<h2>Using the Mouse</h2>

<p>Different mouse buttons are used on each platform:

<h3>OS X</h3>
<ul>
<li><span class="key">Left Mouse Button + Option</span>
<li>OR: <span class="key">Middle Mouse Button</span>
</ul>

<ul>
<li>Add to selection: <span class="key">Command</span>
<li>Subtract from selection: <span class="key">Command+Shift</span>
</ul>

<h3>Windows</h3>
<ul>
<li><span class="key">Right Mouse Button + Shift</span>
<li>OR: <span class="key">Middle Mouse Button</span>
</ul>

<ul>
<li>Add to selection: <span class="key">Ctrl</span>
<li>Subtract from selection: <span class="key">Alt</span>
</ul>

<h3>Linux</h3>
<ul>
<li><span class="key">Right Mouse Button + Shift</span>
</ul>

<ul>
<li>Add to selection: <span class="key">Ctrl</span>
<li>Subtract from selection: <span class="key">Alt</span>
</ul>



<h2>Using the Keyboard</h2>

<h3>OS X</h3>
<ul>
<li><span class="key">Ctrl + Shift + Up</span>
<li><span class="key">Ctrl + Shift + Down</span>
</ul>

<h3>Windows</h3>
<ul>
<li><span class="key">Ctrl + Alt + Up</span>
<li><span class="key">Ctrl + Alt + Down</span>
</ul>

<h3>Linux</h3>
<ul>
<li><span class="key">Ctrl + Alt + Up</span>
<li><span class="key">Ctrl + Alt + Down</span>
</ul>

<script src="prism.js"></script>

<header>
<section>
<nav>
<a href="https://sublimetext.com">Website</a>
<a href="https://forum.sublimetext.com">Forum</a>
</nav>
<div class="index">
<a href="index.html"><span>Sublime Text 3</span> Documentation</a>
</div>

<h1>Column Selection</h1>
</section>
</header>

<section>
<p>
Column selection can be used to select a rectangular area of a file. Column selection doesn't operate via a separate mode, instead it makes use of multiple selections.
</p>

<p>
You can use additive selections to select multiple blocks of text, or subtractive selections to remove a block.
</p>

<h2>Using the Mouse</h2>

<p>
Different mouse buttons are used on each platform:
</p>

<h3>OS X</h3>

<ul>
<li><span class="key">Left Mouse Button + Option</span></li>
<li>OR: <span class="key">Middle Mouse Button</span></li>
</ul>

<ul>
<li>Add to selection: <span class="key">Command</span></li>
<li>Subtract from selection: <span class="key">Command+Shift</span></li>
</ul>

<h3>Windows</h3>

<ul>
<li><span class="key">Right Mouse Button + Shift</span></li>
<li>OR: <span class="key">Middle Mouse Button</span></li>
</ul>

<ul>
<li>Add to selection: <span class="key">Ctrl</span></li>
<li>Subtract from selection: <span class="key">Alt</span></li>
</ul>

<h3>Linux</h3>

<ul>
<li><span class="key">Right Mouse Button + Shift</span></li>
</ul>

<ul>
<li>Add to selection: <span class="key">Ctrl</span></li>
<li>Subtract from selection: <span class="key">Alt</span></li>
</ul>

<h2>Using the Keyboard</h2>

<h3>OS X</h3>
<ul>
<li><span class="key">Ctrl + Shift + Up</span></li>
<li><span class="key">Ctrl + Shift + Down</span></li>
</ul>

<h3>Windows</h3>
<ul>
<li><span class="key">Ctrl + Alt + Up</span></li>
<li><span class="key">Ctrl + Alt + Down</span></li>
</ul>

<h3>Linux</h3>
<ul>
<li><span class="key">Ctrl + Alt + Up</span></li>
<li><span class="key">Ctrl + Alt + Down</span></li>
</ul>
</section>

</body>
</html>
80 changes: 51 additions & 29 deletions www.sublimetext.com/docs/3/distraction_free.html
View file
@@ -1,39 +1,61 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<!DOCTYPE html>
<html>
<head>
<title>Distraction Free Mode - Sublime Text 3 Documentation</title>
<link rel="stylesheet" type="text/css" href="sublime_docs.css">
<title>Distraction Free Mode – Sublime Text 3 Documentation</title>
<meta charset="UTF-8">
<link rel="stylesheet" type="text/css" href="sublime_docs.css">
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Open+Sans:400,600,700">
</head>
<body>

<p class="contents"><a href="index.html">Contents</a></p>

<h1>Distraction Free Mode</h1>

<h3>Overview</h3>

<p>Distraction Free Mode shows your files full screen, with nothing but text shown in the center of your monitor. All UI chrome is hidden, but accessible. Distraction Free Mode can be entered into via the <span class="menu">View/Enter Distraction Free Mode</span> menu item.

<p>When in Distraction Free Mode, all UI chrome (side bar, minimap, status bar, etc) will be hidden. You can selectively enable parts of the UI via the View menu - your settings will be remembered next time you enter Distraction Free Mode.

<h2>Customization</h2>

<p>Certain settings will be applied when in Distraction Free Mode. The default settings (located in <span class="file">Packages/Default/Distraction Free.sublime-settings</span>) are:

<pre class="code">
{
"line_numbers": false,
"gutter": false,
"draw_centered": true,
"wrap_width": 80,
"word_wrap": true,
"scroll_past_end": true
<script src="prism.js"></script>

<header>
<section>
<nav>
<a href="https://sublimetext.com">Website</a>
<a href="https://forum.sublimetext.com">Forum</a>
</nav>
<div class="index">
<a href="index.html"><span>Sublime Text 3</span> Documentation</a>
</div>

<h1>Distraction Free Mode</h1>
</section>
</header>

<section>
<p>
Distraction Free Mode shows your files full screen, with nothing but text shown in the center of your monitor. All UI chrome is hidden, but accessible. Distraction Free Mode can be entered into via the <span class="menu">View &#9656; Enter Distraction Free Mode</span> menu item.
</p>

<p>
When in Distraction Free Mode, all UI chrome (side bar, minimap, status bar, etc) will be hidden. You can selectively enable parts of the UI via the <span class="menu">View</span> menu – your settings will be remembered next time you enter Distraction Free Mode.
</p>

<h2>Customization</h2>

<p>
Certain settings will be applied when in Distraction Free Mode. The default settings (located in <span class="file">Packages/Default/Distraction Free.sublime-settings</span>) are:
</p>

<pre><code class="language-js">{
"line_numbers": false,
"gutter": false,
"draw_centered": true,
"wrap_width": 80,
"word_wrap": true,
"scroll_past_end": true
}
</pre>
</code></pre>

<p>You can customize these via editing <span class="file">Packages/User/Distraction Free.sublime-settings</span>, which is accessible via the <span class="menu">Preferences/File Settings - More</span> menu.
<p>
You can customize these via editing <span class="file">Packages/User/Distraction Free.sublime-settings</span>, which is accessible via the <span class="menu">Preferences &#9656; Settings – Distraction Free</span> menu item.
</p>

<p>It's worth noting the <span class="setting">wrap_width</span> setting, above. The value of 80 causes wrapping to happen at 80 characters. You may want to set this to a higher value, or wrap to the window width, by setting it to 0.
<p>
It's worth noting the <span class="setting">wrap_width</span> setting, above. The value of <tt>80</tt> causes wrapping to happen at 80 characters. You may want to set this to a higher value, or wrap to the window width, by setting it to <tt>0</tt>.
</p>
</section>

</body>
</html>

0 comments on commit 4144c1f

Please sign in to comment.