-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathindex.html
192 lines (159 loc) · 12.4 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
---
layout: default
---
<!DOCTYPE html>
<html>
<head>
</head>
<body>
<h1 id="rho-emacs">RHO Emacs</h1>
<p><img height="16px" width="16px" src="/images/download.png" alt="Download"/> <img height="16px" width="16px" src="/images/windows.png" alt="Windows"/>
<a id="app-link" href="#">Download installer for Windows (64-bit)</a>
<!--:: <img height="16px" width="16px" src="/images/youtube.png" alt="Youtube" style="max-width:100%;">
<a href="https://youtu.be/YEdsVDZhcoQ" rel="nofollow" target="_blank">Video Manual</a> -->
</p>
<script>
getLatestGHRelease("retreat", function (release) {
setDownloadLink(release, ".exe", "exe-link");
});
function watch(delay) {
delayedPlayProductVideo("product-poster", "product-video", 34000, delay);
}
watch(1000);
</script>
<div id="product-poster" style="display: block; text-align: center; width: 100%">
<div style="position: relative; display: table; width: 100%" onclick="watch()">
<!--img title="Watch on Youtube" style="cursor: pointer;" src="/enso-portable/screen.jpg" alt="screen" /-->
<img style="cursor: pointer;" src="/rho-emacs/media/logo.png" alt="screen"/>
<div style="position: absolute; right: 10px; bottom: 10px; color: white; font-weight: bold; cursor: pointer;" onclick="watch()"
><img src="/images/play_video.png" style="vertical-align: middle; cursor: pointer; margin-right: 50px;"></div>
</div>
</div>
<div id="product-video" style="display: none; text-align: center;">
<video src="/rho-emacs/media/emacs.webm" type="video/webm" muted />
</div>
<p>SEE ALSO: <a href="https://gchristensen.github.io/enso-portable/" >Enso Launcher</a>,
<a href="https://gchristensen.github.io/scrapyard/">Scrapyard</a></p>
<h4><a id="user-content-description" class="anchor" aria-hidden="true" href="#description"></a>Description</h4>
<p style="text-align: justify;">
<b>ρEmacs</b> is a preconfigured distribution of
<a href="https://www.gnu.org/software/emacs/" target="_blank">GNU Emacs</a> editor for
<b>Microsoft Windows</b>. It offers some enhancements over the standard <b>Emacs</b> experience and targets
several Windows-specific issues.
</p>
<h4><a id="features" class="anchor" aria-hidden="true" href="#description"></a>Features</h4>
<ul>
<li style="text-align: justify;">RHO Emacs provides a custom launcher that starts <b>Emacs</b> in a <a href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html" target="_blank">server</a>
mode and then acts like <a href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Invoking-emacsclient.html#Invoking-emacsclient" target="_blank">emacsclient</a>.</li>
<li style="text-align: justify;">The home directory of the standard <b>Emacs</b> is bound to <code>USERPROFILE</code> or <code>HOME</code>
environment variables.
The home directory of <b>ρEmacs</b> could be anywhere, and even could be specified as a command-line argument to the launcher.</li>
<li style="text-align: justify;">A portable installation is possible.</li>
<li style="text-align: justify;">The <a href="https://github.com/source-foundry/Hack">Hack</a> typeface, which works quite fast with <b>Emacs</b> font-lock mode, is used by default.
This allows to avoid lags and freezes when editing large files.</li>
<li style="text-align: justify;">Some common <b>POSIX</b> utilities used by <b>Emacs</b>, such as <b>find</b>/<b>grep</b> and <b>aspell</b>, are provided by the distribution.</li>
<li style="text-align: justify;"><b>ρEmacs</b> also includes several popular libraries, modes and themes which comprise a reasonably
convenient configuration out of the box.</li>
<li style="text-align: justify;"><a href="https://orgmode.org/manual/Capture.html" target="_blank">Capture</a>
with <a href="https://orgmode.org/manual/Protocols.html" target="_blank">org-protocol</a>
may be configured by a single check in the installer.</li>
<li style="text-align: justify;">The preconfigured <a href="https://github.com/caiorss/org-wiki" target="_blank">org-wiki</a> package allows to create a local <b>org-mode</b> based wiki.
<li style="text-align: justify;">The preconfigured <a href="https://www.orgroam.com/" target="_blank">org-roam</a> package could be used for non-hierarchical knowledge management.
</ul>
<h4>Emacs Home Directory</h4>
<p style="text-align: justify;"><b>ρEmacs</b> installer will ask where do you want to store your personal settings and files. The
following three options are available:</p>
<ul>
<li style="text-align: justify;"><i>Create a dedicated home directory for Emacs</i> - installer will ask you to manually specify the path of <b>ρEmacs</b>
home directory.
</li>
<li style="text-align: justify;"><i>Portable installation</i> - <b>ρEmacs</b> will be installed as a portable
distribution. In
this case <b>Emacs</b> will use the directory named <code>home</code> at the root of the installation as
user's personal directory. Installer will also not create shortcuts or perform any other system
integration.
</li>
<li style="text-align: justify;"><i>Always use the environment of a current user</i> - <b>Emacs</b> will always use a subfolder
named <code>rho-emacs</code> inside <code>My Documents</code> folder of a current user.
</li>
</ul>
<h4><a id="launcher" class="anchor" aria-hidden="true" href="#description"></a><b>ρEmacs</b> launcher</h4>
<p style="text-align: justify;"><b>ρEmacs</b> could be launched using a shortcut from <b>Windows</b> Start Menu, but the launcher is also accessible
in the command line as the <code>rho</code> command.
It passes any arguments that do not start with a slash (<code>/</code>) to the underlying program which may be <code>emacs</code> if <b>Emacs</b>
is not running, or <code>emacsclient</code> otherwise. The <code>/HOME</code> command-line argument allows to specify the home directory of <b>ρEmacs</b>
in the following form <code>/HOME:path/to/the/directory</code>, for example: <code>/HOME:d:/rho-home</code>. This may be convenient for use in <b>Windows</b> shortcuts.</p>
<p style="text-align: justify;">Use <code>rhoc</code> command to run <b>Emacs</b> in the terminal (it will act as
<code>emacsclient</code> if <b>Emacs</b> is already running).</p>
<h4><a id="enhancements" class="anchor" aria-hidden="true" href="#description"></a><b>ρEmacs</b> enhancement libraries</h4>
<p style="text-align: justify;"><a href="https://emacswiki.org/emacs/InteractivelyDoThings" target="_blank">ido</a>,
<a href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Icomplete.html" target="_blank">fido</a>,
<a href="https://www.emacswiki.org/emacs/IswitchBuffers" target="_blank">iswitchb</a>,
<a href="https://www.emacswiki.org/emacs/IbufferMode" target="_blank">ibuffer</a>,
<a href="https://www.emacswiki.org/emacs/uniquify" target="_blank">uniquify</a>,
<a href="https://www.emacswiki.org/emacs/SavePlace" target="_blank">save-place</a>,
<a href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Desktop-Save-Mode.html" target="_blank">desktop-save</a>,
<a href="https://github.com/sabof/org-bullets" target="_blank">org-bullets</a>,
<a href="https://www.emacswiki.org/emacs/TabBarMode" target="_blank">tabbar</a> and
<a href="https://www.emacswiki.org/emacs/BookmarkPlus" target="_blank">bookmark+</a> modes could be enabled by default.
</p>
<p style="text-align: justify;"><b>ρEmacs</b> installer will also offer to activate one of the following UI themes:
<a href="https://github.com/nashamri/spacemacs-theme" target="_blank">Spacemacs theme</a>,
<a href="https://github.com/kuanyui/moe-theme.el" target="_blank">Moe theme</a>,
<a href="https://emacsthemes.com/themes/arjen-theme.html" target="_blank">Arjen</a>. More themes could be selected after the installation.
</p>
<p style="text-align: justify;">You may install <b>ρEmacs</b> without any enhancements and configure it as you wish.</p>
<h4>Org Mode tools</h4>
<p><b>ρEmacs</b> takes care of the configuration of some <b>org-mode</b> tools that are very tedious to set up manually:</p>
<h5>org-protocol</h5>
<p style="text-align: justify;">The installer is able to automatically configure <a href="https://orgmode.org/manual/Protocols.html" target="_blank">org-protocol</a>
to capture links and selected text from web browsers. Notably, in the case of western system locales it should seamlessly work with
the <b>Org Capture</b> extension
(<a href="https://chrome.google.com/webstore/detail/org-capture/kkkjlfejijcjgjllecmnejhogpbcigdc?hl=en" target="_blank">Chrome</a>,
<a href="https://addons.mozilla.org/en-US/firefox/addon/org-capture/" target="_blank">Firefox</a>) without any additional configuration
(<b>Emacs</b> should be running during the capture process).
More complex capture schemes <a href="https://gchristensen.github.io/posts/dynamic-org-capture-templates/" target="_blank">are possible</a>.
By default, the captured content is saved at the file named <code>~/org/capture.org</code> (configurable through the
<a href="https://orgmode.org/manual/Setting-up-capture.html#index-org_002ddefault_002dnotes_002dfile" target="_blank">org-default-notes-file</a> variable).
</p>
<h5>org-wiki</h5>
<p style="text-align: justify;"><a href="https://caiorss.github.io/org-wiki/" target="_blank">org-wiki</a> package offers a firm foundation for a personal
knowledge base. Its <a href="https://github.com/caiorss/org-wiki#paste-image" target="_blank">clip.jar</a> utility is included into the distribution
(a private Java runtime necessary to run it is provided by the installer).
The default wiki root directory is located at <code>~/org/wiki</code>.
</p>
<p style="text-align: justify;">
<b>org-wiki</b> will install the <a href="https://github.com/emacs-helm/helm" target="_blank">helm</a> package with its dependencies on the
first run of <b>Emacs</b>, so Internet connection is required.
</p>
<h5>org-roam</h5>
<p style="text-align: justify;">
<b>org-roam</b> package could be used for non-hierarchical knowledge management, such as Zettelkasten. Its <b>emacsql-sqlite.exe</b> utility
is already precompiled, so no compiler installation is necessary. <b>org-roam</b> files and database are stored in the
<code>~/org-roam</code> directory. The following key-bindings are available:
<table class="mono">
<tr><td>C-c n f</td><td>org-roam-node-find</td></td>
<tr><td>C-c n r</td><td>org-roam-node-random</td></td>
<tr><td>C-c n i</td><td>org-roam-node-insert</td></td>
<tr><td>C-c n o</td><td>org-id-get-create</td></td>
<tr><td>C-c n t</td><td>org-roam-tag-add</td></td>
<tr><td>C-c n a</td><td>org-roam-alias-add</td></td>
<tr><td>C-c n l</td><td>org-roam-buffer-toggle</td></td>
</table>
</p>
</body>
</html>
<h4>Installing Third Party Emacs Extensions</h4>
<h5>Automated installation</h5>
<p style="text-align: justify;">
Automated package installation is possible through the <a href="https://melpa.org/" target="_blank">MELPA</a>
repository available with the <code>M-x package-list-packages</code> command.
</p>
<h5>Manual installation</h5>
<p style="text-align: justify;">To install a package manually, you need to place it into a subdirectory of <code>~/.emacs.d</code>
folder (where <code>~</code> is a shortcut for the home directory).
Then you need to add the following line to your <code>~/.emacs</code> configuration file:<br><br>
<code>(add-to-list 'load-path "~/.emacs.d/my-library/")</code><br><br>
to add the package to <b>Emacs</b> load list. Then you should initialize the package according to its manual, for example, by placing
<code>(require 'my-library)</code> line into <code>~/.emacs</code>.</p>
</p>