Skip to content

Commit f976533

Browse files
emacs18emacs18
committed
added a warning message on how to read
1 parent c242154 commit f976533

File tree

2 files changed

+72
-62
lines changed

2 files changed

+72
-62
lines changed

‎emacs.html‎

Lines changed: 69 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
44
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
55
<head>
6-
<!-- 2016-04-24 Sun 07:32 -->
6+
<!-- 2016-04-24 Sun 08:22 -->
77
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1" />
99
<title>My Emacs Notes</title>
@@ -159,29 +159,29 @@ <h1 class="title">My Emacs Notes</h1>
159159
<h2>Table of Contents</h2>
160160
<div id="text-table-of-contents">
161161
<ul>
162-
<li><a href="#org53ae65e">Overview</a>
162+
<li><a href="#org6cb6071">Overview</a>
163163
<ul>
164-
<li><a href="#org6a56b7e">Introduction</a></li>
164+
<li><a href="#orgd508a24">Introduction</a></li>
165165
<li><a href="#learning">How to learn or lookup features</a></li>
166-
<li><a href="#org52ab61b">Document Format</a></li>
167-
<li><a href="#org8193d42">GNU info documentation system</a></li>
166+
<li><a href="#orgc5e666a">Document Format</a></li>
167+
<li><a href="#org80c44b6">GNU info documentation system</a></li>
168168
</ul>
169169
</li>
170170
<li><a href="#resources">Resources</a>
171171
<ul>
172-
<li><a href="#orgb493f28">General Resources</a></li>
173-
<li><a href="#org61fb34c">New User Resources</a></li>
174-
<li><a href="#org2b2dc48">Emacs News/RSS/Blog Sites</a></li>
175-
<li><a href="#org60451c9">Startup Files</a></li>
176-
<li><a href="#orgd4f1e45">Org Mode</a></li>
172+
<li><a href="#orge1e3769">General Resources</a></li>
173+
<li><a href="#org1448624">New User Resources</a></li>
174+
<li><a href="#orgc8e3535">Emacs News/RSS/Blog Sites</a></li>
175+
<li><a href="#org338a6d4">Startup Files</a></li>
176+
<li><a href="#org1c02baf">Org Mode</a></li>
177177
</ul>
178178
</li>
179179
<li><a href="#package">Package</a>
180180
<ul>
181-
<li><a href="#orgcf0a633">Package Overview</a></li>
181+
<li><a href="#orge58b3">Package Overview</a></li>
182182
</ul>
183183
</li>
184-
<li><a href="#orge4dd3b6">Emacs-Lisp</a>
184+
<li><a href="#orgd103a2a">Emacs-Lisp</a>
185185
<ul>
186186
<li><a href="#elisp_basics">Elisp Basics</a></li>
187187
<li><a href="#expressions">Elisp Expressions</a></li>
@@ -193,15 +193,22 @@ <h2>Table of Contents</h2>
193193
</div>
194194
</div>
195195

196-
<div id="outline-container-org53ae65e" class="outline-2">
197-
<h2 id="org53ae65e">Overview</h2>
198-
<div class="outline-text-2" id="text-org53ae65e">
199-
</div><div id="outline-container-org6a56b7e" class="outline-3">
200-
<h3 id="org6a56b7e">Introduction</h3>
201-
<div class="outline-text-3" id="text-org6a56b7e">
196+
<div id="outline-container-org6cb6071" class="outline-2">
197+
<h2 id="org6cb6071">Overview</h2>
198+
<div class="outline-text-2" id="text-org6cb6071">
199+
</div><div id="outline-container-orgd508a24" class="outline-3">
200+
<h3 id="orgd508a24">Introduction</h3>
201+
<div class="outline-text-3" id="text-orgd508a24">
202202
<p>
203203
This is my collection of GNU/Emacs related notes which I wrote for my
204204
own use as well as to share with my friends and colleagues.
205+
This may be a bit chaotic, because much of it was lifted from a much larger
206+
document which I have been carrying around for many years.
207+
</p>
208+
209+
<p>
210+
<b>Warning</b>: many links are not properly rendered by github.
211+
Please see <a href="README.html">README.org</a> on how best to read this document.
205212
</p>
206213

207214
<p>
@@ -240,8 +247,8 @@ <h3 id="org6a56b7e">Introduction</h3>
240247
</div>
241248
</div>
242249

243-
<div id="outline-container-org483bbcc" class="outline-3">
244-
<h3 id="learning"><a id="org483bbcc"></a>How to learn or lookup features</h3>
250+
<div id="outline-container-org308d8f1" class="outline-3">
251+
<h3 id="learning"><a id="org308d8f1"></a>How to learn or lookup features</h3>
245252
<div class="outline-text-3" id="text-learning">
246253
<p>
247254
The chapter of emacs manual details many ways to get help.
@@ -327,9 +334,9 @@ <h3 id="learning"><a id="org483bbcc"></a>How to learn or lookup features</h3>
327334
</div>
328335
</div>
329336

330-
<div id="outline-container-org52ab61b" class="outline-3">
331-
<h3 id="org52ab61b">Document Format</h3>
332-
<div class="outline-text-3" id="text-org52ab61b">
337+
<div id="outline-container-orgc5e666a" class="outline-3">
338+
<h3 id="orgc5e666a">Document Format</h3>
339+
<div class="outline-text-3" id="text-orgc5e666a">
333340
<p>
334341
This document is authored in <a href="http://orgmode.org">org-mode</a> format within GNU/Emacs, then converted to
335342
HTML via emacs. I prefer to use the <i>bigblow</i> HTML theme provided by
@@ -349,14 +356,14 @@ <h3 id="org52ab61b">Document Format</h3>
349356

350357
<p>
351358
Most links to the <a href="http://www.gnu.org/software/emacs/manual/html_mono/info.html#Top">info</a> documents are presented using info node name notation,
352-
e.g., <a href="http://www.gnu.org/software/emacs/manual/html_mono/emacs.html#Help">(emacs)Help</a>. See <a href="#org8193d42">GNU info documentation system</a> below for more info.
359+
e.g., <a href="http://www.gnu.org/software/emacs/manual/html_mono/emacs.html#Help">(emacs)Help</a>. See <a href="#org80c44b6">GNU info documentation system</a> below for more info.
353360
</p>
354361
</div>
355362
</div>
356363

357-
<div id="outline-container-org8193d42" class="outline-3">
358-
<h3 id="org8193d42">GNU info documentation system</h3>
359-
<div class="outline-text-3" id="text-org8193d42">
364+
<div id="outline-container-org80c44b6" class="outline-3">
365+
<h3 id="org80c44b6">GNU info documentation system</h3>
366+
<div class="outline-text-3" id="text-org80c44b6">
360367
<p>
361368
If you hit <code>C-h i</code> or <code>M-x info</code> within emacs, it brings up the <a href="http://www.gnu.org/software/emacs/manual/html_mono/info.html#Top">info</a> document
362369
browser which allows you to browse many info documents. Hitting <a href="http://www.gnu.org/software/emacs/manual/html_mono/info.html#Help-Int">d</a> within the
@@ -368,18 +375,18 @@ <h3 id="org8193d42">GNU info documentation system</h3>
368375
</div>
369376
</div>
370377

371-
<div id="outline-container-org85d6916" class="outline-2">
372-
<h2 id="resources"><a id="org85d6916"></a>Resources</h2>
378+
<div id="outline-container-org9f790eb" class="outline-2">
379+
<h2 id="resources"><a id="org9f790eb"></a>Resources</h2>
373380
<div class="outline-text-2" id="text-resources">
374381
<p>
375382
This chapter lists some of the online emacs resources available that I
376383
came across over the years.
377384
</p>
378385
</div>
379386

380-
<div id="outline-container-orgb493f28" class="outline-3">
381-
<h3 id="orgb493f28">General Resources</h3>
382-
<div class="outline-text-3" id="text-orgb493f28">
387+
<div id="outline-container-orge1e3769" class="outline-3">
388+
<h3 id="orge1e3769">General Resources</h3>
389+
<div class="outline-text-3" id="text-orge1e3769">
383390
<p>
384391
There are just too many resources, but here is my collection of few links.
385392
</p>
@@ -408,9 +415,9 @@ <h3 id="orgb493f28">General Resources</h3>
408415
</div>
409416
</div>
410417

411-
<div id="outline-container-org61fb34c" class="outline-3">
412-
<h3 id="org61fb34c">New User Resources</h3>
413-
<div class="outline-text-3" id="text-org61fb34c">
418+
<div id="outline-container-org1448624" class="outline-3">
419+
<h3 id="org1448624">New User Resources</h3>
420+
<div class="outline-text-3" id="text-org1448624">
414421
<ul class="org-ul">
415422
<li><a href="emacs-lisp-intro.html#Top">An Introduction to Programming in Emacs Lisp</a></li>
416423
<li><a href="http://www.gnu.org/software/emacs/tour/">Official Guided Tour</a>
@@ -426,9 +433,9 @@ <h3 id="org61fb34c">New User Resources</h3>
426433
</div>
427434
</div>
428435

429-
<div id="outline-container-org2b2dc48" class="outline-3">
430-
<h3 id="org2b2dc48">Emacs News/RSS/Blog Sites</h3>
431-
<div class="outline-text-3" id="text-org2b2dc48">
436+
<div id="outline-container-orgc8e3535" class="outline-3">
437+
<h3 id="orgc8e3535">Emacs News/RSS/Blog Sites</h3>
438+
<div class="outline-text-3" id="text-orgc8e3535">
432439
<p>
433440
There are many blog and other site.
434441
These are just a few that I came across.
@@ -446,9 +453,9 @@ <h3 id="org2b2dc48">Emacs News/RSS/Blog Sites</h3>
446453
</div>
447454
</div>
448455

449-
<div id="outline-container-org60451c9" class="outline-3">
450-
<h3 id="org60451c9">Startup Files</h3>
451-
<div class="outline-text-3" id="text-org60451c9">
456+
<div id="outline-container-org338a6d4" class="outline-3">
457+
<h3 id="org338a6d4">Startup Files</h3>
458+
<div class="outline-text-3" id="text-org338a6d4">
452459
<p>
453460
These links discuss emacs startup files.
454461
There are many others I'm sure.
@@ -466,9 +473,9 @@ <h3 id="org60451c9">Startup Files</h3>
466473
</div>
467474
</div>
468475

469-
<div id="outline-container-orgd4f1e45" class="outline-3">
470-
<h3 id="orgd4f1e45">Org Mode</h3>
471-
<div class="outline-text-3" id="text-orgd4f1e45">
476+
<div id="outline-container-org1c02baf" class="outline-3">
477+
<h3 id="org1c02baf">Org Mode</h3>
478+
<div class="outline-text-3" id="text-org1c02baf">
472479
<p>
473480
Some links on org mode:
474481
</p>
@@ -487,14 +494,14 @@ <h3 id="orgd4f1e45">Org Mode</h3>
487494
</div>
488495
</div>
489496

490-
<div id="outline-container-org114788f" class="outline-2">
491-
<h2 id="package"><a id="org114788f"></a>Package</h2>
497+
<div id="outline-container-orgcfc1ad8" class="outline-2">
498+
<h2 id="package"><a id="orgcfc1ad8"></a>Package</h2>
492499
<div class="outline-text-2" id="text-package">
493500
</div>
494501

495-
<div id="outline-container-orgcf0a633" class="outline-3">
496-
<h3 id="orgcf0a633">Package Overview</h3>
497-
<div class="outline-text-3" id="text-orgcf0a633">
502+
<div id="outline-container-orge58b3" class="outline-3">
503+
<h3 id="orge58b3">Package Overview</h3>
504+
<div class="outline-text-3" id="text-orge58b3">
498505
<p>
499506
For an overview see <a href="http://www.gnu.org/software/emacs/manual/html_mono/emacs.html#Packages">Packages</a> section of Emacs manual, and <a href="http://www.gnu.org/software/emacs/manual/html_mono/elisp.html#Packaging">Packaging</a> section of
500507
Emacs-Lisp manual. Also you should be familiar with the following concepts
@@ -562,17 +569,17 @@ <h3 id="orgcf0a633">Package Overview</h3>
562569
</div>
563570
</div>
564571

565-
<div id="outline-container-orge4dd3b6" class="outline-2">
566-
<h2 id="orge4dd3b6">Emacs-Lisp</h2>
567-
<div class="outline-text-2" id="text-orge4dd3b6">
568-
</div><div id="outline-container-org347278a" class="outline-3">
569-
<h3 id="elisp_basics"><a id="org347278a"></a>Elisp Basics</h3>
572+
<div id="outline-container-orgd103a2a" class="outline-2">
573+
<h2 id="orgd103a2a">Emacs-Lisp</h2>
574+
<div class="outline-text-2" id="text-orgd103a2a">
575+
</div><div id="outline-container-org33e5eb9" class="outline-3">
576+
<h3 id="elisp_basics"><a id="org33e5eb9"></a>Elisp Basics</h3>
570577
<div class="outline-text-3" id="text-elisp_basics">
571578
<p>
572579
This chapter points out a few basic emacs-lisp concepts to help
573580
you understand how to install and use add-on packages.
574581
More comprehensive resources on learning elisp are listed at
575-
<a href="#org61fb34c">New User Resources</a>
582+
<a href="#org1448624">New User Resources</a>
576583
</p>
577584

578585
<p>
@@ -677,8 +684,8 @@ <h3 id="elisp_basics"><a id="org347278a"></a>Elisp Basics</h3>
677684
</div>
678685
</div>
679686

680-
<div id="outline-container-org47c7079" class="outline-3">
681-
<h3 id="expressions"><a id="org47c7079"></a>Elisp Expressions</h3>
687+
<div id="outline-container-orgb04c20d" class="outline-3">
688+
<h3 id="expressions"><a id="orgb04c20d"></a>Elisp Expressions</h3>
682689
<div class="outline-text-3" id="text-expressions">
683690
<p>
684691
Resources:
@@ -714,8 +721,8 @@ <h3 id="expressions"><a id="org47c7079"></a>Elisp Expressions</h3>
714721
</div>
715722
</div>
716723

717-
<div id="outline-container-orgd469e0b" class="outline-3">
718-
<h3 id="symbols"><a id="orgd469e0b"></a>Symbols</h3>
724+
<div id="outline-container-org1345b82" class="outline-3">
725+
<h3 id="symbols"><a id="org1345b82"></a>Symbols</h3>
719726
<div class="outline-text-3" id="text-symbols">
720727
<p>
721728
buffer-local dynamic lexical
@@ -762,8 +769,8 @@ <h3 id="symbols"><a id="orgd469e0b"></a>Symbols</h3>
762769
</div>
763770
</div>
764771

765-
<div id="outline-container-orga674e12" class="outline-3">
766-
<h3 id="advising"><a id="orga674e12"></a>Advising</h3>
772+
<div id="outline-container-org8f02965" class="outline-3">
773+
<h3 id="advising"><a id="org8f02965"></a>Advising</h3>
767774
<div class="outline-text-3" id="text-advising">
768775
<p>
769776
Official documentation include:
@@ -804,7 +811,7 @@ <h2 class="footnotes">Footnotes: </h2>
804811
</div></div>
805812
<div id="postamble" class="status">
806813
<p class="author">Author: Richard Y. Kim</p>
807-
<p class="date">Created: 2016-04-24 Sun 07:32</p>
814+
<p class="date">Created: 2016-04-24 Sun 08:22</p>
808815
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
809816
</div>
810817
</body>

‎emacs.org‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ own use as well as to share with my friends and colleagues.
1313
This may be a bit chaotic, because much of it was lifted from a much larger
1414
document which I have been carrying around for many years.
1515

16+
*Warning*: many links are not properly rendered by github.
17+
Please see [[file:README.org][README.org]] on how best to read this document.
18+
1619
This document is written in [[info:org#Top][org-mode]]. It is best viewed using emacs in org
1720
format, but you can also view the HTML version via a web browser.
1821

0 commit comments

Comments
 (0)