Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

Commit

Permalink
Merge pull request #2 from atom/chapter-2
Browse files Browse the repository at this point in the history
Chapter 2 - Using Atom
  • Loading branch information
schacon committed Jan 8, 2015
2 parents a25d45c + c0b9aac commit 4842d55
Show file tree
Hide file tree
Showing 55 changed files with 771 additions and 61 deletions.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ This book is open source under a Creative Commons license.

To check the current progress and planned content of the book, check out the [outline](outline.md).


## How To Generate the Book

There are two ways to generate e-book content from this source code.
Expand Down
Binary file modified book/01-introduction/images/advanced-settings.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified book/01-introduction/images/command-palette.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified book/01-introduction/images/finder.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified book/01-introduction/images/first-launch.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified book/01-introduction/images/linux-downloads.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified book/01-introduction/images/open-file.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified book/01-introduction/images/project-view.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified book/01-introduction/images/settings-wrap.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified book/01-introduction/images/settings.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified book/01-introduction/images/theme.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 10 additions & 2 deletions book/01-introduction/sections/03-basics.asc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ image::images/first-launch.png[Atom welcome screen]

This is the Atom welcome screen and gives you a pretty good starting point for how to get started with the editor.

==== Basic Terminology

First of all, let's get acquainted with some of the terminology we'll be using in this manual.

Buffer::
A buffer is the text content of a file in Atom. It's basically the same as a file for most descriptions, but it's the version Atom has in memory. For instance, you can change the text of a buffer and it isn't written to it's associated file until you save it.

Pane::
A pane is a visual section of Atom. If you look at the welcome screen we just launched, you can see four Panes - the tab bar, the gutter (which has line numbers in it), the status bar at the bottom and finally the text editor.

==== Command Palette

In that welcome screen, we are introduced to probably the most important command in Atom, the ``Command Palette''. If you hit `cmd-shift-P` while focused in an editor pane, the command palette will pop up.
Expand Down Expand Up @@ -54,8 +64,6 @@ The UI themes modify the color of UI elements like the tabs and the tree view, w

There are also dozens of themes on Atom.io that you can choose from if you want something different. We will also cover customizing a theme in <<_customizing_themes>> and creating your own theme in <<_creating_themes>>.

TODO: screenshot of various themes on Atom.io

===== Soft Wrap

You can also use the Settings view to specify your whitespace and wrapping preferences.
Expand Down
6 changes: 3 additions & 3 deletions book/02-using-atom/1-using-atom.asc
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ include::sections/03-interface.asc[]

include::sections/04-git-markdown.asc[]

include::sections/05-customizing.asc[]
include::sections/05-writing.asc[]

include::sections/06-common-packages.asc[]
include::sections/06-customizing.asc[]

=== Summary

At this point you should be something of an Atom master user. You should be able to navigate and manipulate your text and files like a wizard. You should also be able to customize Atom backwards and forwards to make it your ultimate editing environment.
At this point you should be something of an Atom master user. You should be able to navigate and manipulate your text and files like a wizard. You should also be able to customize Atom backwards and forwards to make it look and act just how you want it to.

Next we're going to take the next step, which is to look at changing and adding new functionality to the core of Atom itself. We're going to start creating packages for Atom. If you can dream it, you can build it.
Binary file added book/02-using-atom/images/autocomplete.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/02-using-atom/images/bookmarks.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/02-using-atom/images/devtools.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/02-using-atom/images/dictionary.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/02-using-atom/images/encodings.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/02-using-atom/images/find-replace-file.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/02-using-atom/images/folding.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/02-using-atom/images/git-checkout-head.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/02-using-atom/images/git-lines.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/02-using-atom/images/git-message.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/02-using-atom/images/git-status-bar.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/02-using-atom/images/git-status.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/02-using-atom/images/goto.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/02-using-atom/images/grammar.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/02-using-atom/images/menubar.png
Binary file added book/02-using-atom/images/multiple-cursors.gif
Binary file added book/02-using-atom/images/open-on-github.png
Binary file modified book/02-using-atom/images/package-settings.png
Binary file modified book/02-using-atom/images/packages.png
Binary file added book/02-using-atom/images/panes.png
Binary file added book/02-using-atom/images/preview.png
Binary file added book/02-using-atom/images/python-grammar.png
Binary file added book/02-using-atom/images/python-settings.png
Binary file added book/02-using-atom/images/snippet-scope.png
Binary file added book/02-using-atom/images/snippets.png
Binary file added book/02-using-atom/images/spellcheck.png
Binary file added book/02-using-atom/images/symbol.png
Binary file modified book/02-using-atom/images/themes.png
Binary file modified book/02-using-atom/images/unity-theme.png
Binary file added book/02-using-atom/images/whitespace.png
60 changes: 58 additions & 2 deletions book/02-using-atom/sections/01-packages-themes.asc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ In fact, there are more than 70 packages that comprise all of the functionality

This means that packages can be incredibly powerful and can change everything from the very look and feel of the entire interface to the basic operation of even core functionality.

In order to install a new package, you can use the Packages tab in the now familiar Settings view. Simply open up the Settings view (`cmd-,`), click on the ``Packages'' tab and type your seach query into the box under Install Packages that hints ``Search Packages''. This will go to the atom.io package registry and pull in anything that matches your search terms.
In order to install a new package, you can use the Packages tab in the now familiar Settings view. Simply open up the Settings view (`cmd-,`), click on the ``Packages'' tab and type your seach query into the box under Install Packages that hints ``Search Packages''.

The packages listed here have been published to http://atom.io/packages[atom.io] which is the official registry for Atom packages. Searching on the settings pane will go to the atom.io package registry and pull in anything that matches your search terms.

.Package install screen
image::images/packages.png[Package install screen]
Expand All @@ -27,7 +29,7 @@ Clicking on one of the package names will give you the settings screen for the p
If a new version of any of your packages is released, Atom will automatically detect it and you can upgrade the package from either this screen or from the main package search tab. This helps you easily keep all your installed packages up to date.

[[_atom_themes]]
=== Atom Themes
==== Atom Themes

You can also find and install new themes for Atom from the Settings view. These can be either UI themes or syntax highlighting themes and you can search for them from the ``Themes'' tab, just like searching for new packages.

Expand All @@ -40,3 +42,57 @@ Clicking on ``Install'' will install the theme and make it available in the Them

.Example of the Unity UI theme with Monokai syntax theme
image::images/unity-theme.png[Theme search screen]


==== Command Line

You can also install packages or themes from the command line using `apm`.

Check that you have `apm` installed by running the following command in your
terminal:

[source,shell]
----
$ apm help install
----

You should see a message print out with details about the `apm install` command.

If you do not, launch Atom and run the _Atom > Install Shell Commands_ menu to install the `apm` and `atom` commands.

You can also install packages by using the `apm install` command:

* `apm install <package_name>` to install the latest version.

* `apm install <package_name>@<package_version>` to install a specific version.

For example `apm install emmet@0.1.5` installs the `0.1.5` release of the https://github.com/atom/emmet[Emmet] package.

You can also use `apm` to find new packages to install. If you run `apm search`, you can search the package registry for a search term.

[source]
----
$ apm search coffee
Search Results For 'coffee' (5)
├── coffee-trace Add smart trace statements to coffee files with one keypress each. (77 downloads, 3 stars)
├── coffee-navigator Code navigation panel for Coffee Script (557 downloads, 8 stars)
├── atom-compile-coffee This Atom.io Package compiles .coffee Files on save to .js files. (myJavascript.coffee -> myJavascript.js) (349 downloads, 4 stars)
├── coffee-lint CoffeeScript linter (3336 downloads, 18 stars)
└── git-grep `git grep` in atom editor (1224 downloads, 9 stars)
----

You can use `apm view` to see more information about a specific package.


[source]
----
$ apm view git-grep
git-grep
├── 0.7.0
├── git://github.com/mizchi/atom-git-grep
├── `git grep` in atom editor
├── 1224 downloads
└── 9 stars
Run `apm install git-grep` to install this package.
----

0 comments on commit 4842d55

Please sign in to comment.