├── LICENSE
├── README.md
├── emacsQuizEssentials0yr2022mo09day01hr09min01sec59.pdf
├── emacsQuizEssentials0yr2022mo09day01hr09min02sec12.pdf
├── emacsQuizEssentials0yr2022mo09day01hr09min03sec55.pdf
├── emacsQuizEssentials0yr2022mo09day01hr09min04sec24.pdf
├── emacsQuizEssentials0yr2022mo09day01hr09min04sec47.pdf
├── emacsQuizLatexyr2022mo09day01hr09min05sec27.pdf
├── emacsQuizLatexyr2022mo09day01hr09min06sec05.pdf
├── emacsQuizLatexyr2022mo09day01hr09min06sec22.pdf
├── emacsQuizLatexyr2022mo09day01hr09min06sec50.pdf
├── emacsQuizLatexyr2022mo09day01hr09min07sec07.pdf
└── init.el
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 | [](https://opensource.org/licenses/MIT)
3 |
4 |
5 | # A GNU Emacs profile for using LaTeX and Org in academic research
6 |
7 | ## Make writing tasks fun by disguising them as coding projects!
8 |
9 | This repo contains an `init.el` file (configuration file) for using LaTeX in GNU Emacs version 29.
10 | You can adapt it to other configurations of Emacs (e.g., Spacemacs, Doom, etc).
11 | The SciMax configuration probably has similar support built-in.
12 | See latex-emacs28 and latex-emacs30 for configurations that work with Emacs version 28 and Emacs version 30, respectively.
13 |
14 | Features include the following:
15 |
16 | * heavily customized auto-complete for LaTeX
17 | * AUCTeX
18 | * atomic-chrome (GhostText)
19 | * awesome-tabs (install from Github)
20 | * dashboard and dashboard-hackernews (keep abreast with the latest distractions)
21 | * org-mode
22 | * org-agenda
23 | * org-roam (capture templates include timestamps)
24 | * org-roam-ui (view your zettelkasten like a mind-maps in your browser, very cool, similar to the one in Obsidian)
25 | * pdf-tools
26 | * pdf-noter
27 |
28 | I built the latex-emacs profile on top of a configuration by [Alvaro Ortiz Troncoso](https://github.com/aot29/Emacs_Python_R_LaTeX).
29 | His configuration included the `auto-complete-auctex.el` package of Chris Monsanto from 2012.
30 | Although the autocompletion is out of style for Emacs fans at the cutting edge of package development, it works!
31 |
32 | I designed this configuration to support the efficient editing of academic documents in LaTeX.
33 | See the [Features](#Features) section below.
34 | See the [related repos](#Related) section below for LaTeX templates for the first manuscript submission, a writing log to accompany every writing project, a poster, a slideshow, a diary for 2022, and a diary for 2023.
35 |
36 | This configuration is compatible with [org-mode](https://de.wikipedia.org/wiki/Org-mode).
37 | Org-mode is an enhanced markdown that reads LaTeX code intermingled with org markup.
38 | Org-mode is very popular with Emacs users because the sections and subsections are easy to fold, and org documents are easy to export to many file formats.
39 | It evolved out of an outliner package.
40 | It greatly eases the creation of lists, so it is useful for planning and brainstorming.
41 | Org-mode also has a powerful org-agenda component for scheduling events.
42 | Many have tried to use org-mode to implement the Getting Things Done method of Jim Allen.
43 | Org-mode also powers the [org-roam](https://www.orgroam.com/) package, which implements electronically the [zettelkasten system](https://wiki2.org/en/Zettelkasten) or slip-box system of taking smart notes.
44 |
45 |
46 | In addition to Emacs, you can edit org-mode markdown in several other leading text editors like [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=BobbyBoyd.vs-org), so you can still use org-mode if you fear Emacs.
47 | Org-mode is responsible for the recent resurgence in the popularity of Emacs.
48 | (The median age of an Emacs user is about 33 years).
49 | The recurring annual [emacsconfs](https://emacsconf.org/) reflects this surge in popularity.
50 | The two-day conference is virtual and free.
51 |
52 | Org-mode supports literate programming with almost any programming language, although the latex-emacs init.el file is not configured for literate programming.
53 | Instead, see my complete configuration for [Emacs](https://github.com/MooersLab/configorg).
54 | Unlike the above configuration written in Emacs lisp (elisp), the complete configuration is wrapped in org-mode.
55 | It is a 6000-line literature programming document.
56 | I wrote the comments in org-mode; they flank blocks of elisp code.
57 |
58 | You can read an org-mode document into Emacs with the *latex-emacs* configuration, even though the latex-emacs init.el file does not call org-mode because the base distribution of Emacs now contains org-mode.
59 | See this [repo](https://github.com/MooersLab/manuscriptInOrg) for a manuscript template that can be edited in `org-mode`.
60 | For a writing log to be used in parallel to writing a manuscript in org-mode, see this [repo] (https://github.com/MooersLab/writingLogTemplateInOrg).
61 |
62 | I am keeping the *latex-emacs* configuration isolated from my main configuration to ease the development of *latex-emacs*.
63 | The *latex-emacs* profile also serves as a backup configuration when I break my main configuration, which happens less often these days.
64 |
65 | I use the following bash alias to start Emacs29 with the configuration stored in the folder *~/latex-emacs29*.
66 | Note that I am not hiding this folder in my top directory.
67 | The hindrance of hiding the Emacs configuration folder is greater than the benefit of not accidentally deleting it once in a lifetime.
68 | With my init.el file on GitHub, I can easily restore my Emacs configuration if disaster strikes.
69 |
70 | ```bash
71 | alias e29l='/Applications/Emacs29.0.5.app/Contents/MacOS/Emacs --init-directory ~/latex-emacs29'.
72 | ```
73 |
74 | The **--init-directory** flag has been available as of January 2022 with Emacs version 29.0.5.
75 | This flag negates the need for the package chemacs2 and its slightly more complex setup.
76 |
77 | I made a second variant of the above alias for debugging:
78 |
79 | ```bash
80 | alias e29ld='/Applications/Emacs29.0.5.app/Contents/MacOS/Emacs --init-directory ~/latex-emacs29 --debug-init'.
81 | ```
82 |
83 |
84 | ## Multiple versions of Emacs on the same computer
85 |
86 | You can have multiple versions of Emacs on your system; however, you must match the profiles to the Emacs version because the binaries in the `elpa` subfolder of the latex-emacs29 folder may not run with different versions of Emacs.
87 |
88 | No warranty is implied.
89 | Use at your own risk.
90 |
91 | I used this configuration to prepare the [presentation](https://github.com/MooersLab/BerlinEmacsAugust2022) given to the Berlin Emacs Meetup on 31 August 2022.
92 |
93 | ## Why LaTeX?
94 |
95 | LaTeX is the gold standard markup system for technical writing.
96 |
97 | - Combine a passion for coding with writing (i.e., make writing fun by disguising it as coding).
98 | - Code reuse: recycle old documents.
99 | - Precise control over the appearance of the output.
100 | - Equation typesetting par none.
101 | - Automated scaling and placement of figures.
102 | - Syntax highlighting of code fragments.
103 | - Reduced use of the mouse: More ergonomic.
104 | - Reduced context switching: Be more productive.
105 | - Slideshows as PDFs are immune to embarrassing font issues when presenting slides on another operating system.
106 | - Support for multi-part documents (books).
107 | - Precise control over typesetting of the bibliography.
108 | - Automated table of contents and list assembly.
109 | - Automated index generation.
110 | - Source files are compact and easy to share by e-mail.
111 | - You can put the source files under version control.
112 | - Overleaf supports collaborative writing.
113 |
114 | Most markdown variants do not support the automated generation of indices for large documents.
115 | Most literate programming projects built on top of markdown have this serious limitation, but org-mode does not. See the section `Why Org`.
116 |
117 |
118 | ## Why Emacs?
119 |
120 | Over the past several decades, many Emacs and package developers have developed a suite of packages to aid the writing of LaTeX documents.
121 | These features support efficient editing of LaTeX documents.
122 |
123 | In addition, you can extend Emacs with the Emacs Lisp programming language.
124 | Elisp is a variant of LISP that was customized to ease Emacs configuration.
125 | Emacs is a platform for building a customized text editor.
126 | You can customize your LaTeX environment and add functions to aid your workflow.
127 |
128 | Of course, other text editors have these features too, but Emacs is the most extensible.
129 | It is the ultimate editor.
130 | You might still use other editors, but Emacs will meet most of your needs.
131 |
132 | Emacs has been under development for 45 years.
133 | According to the [Lindy effect](https://wiki2.org/en/Lindy_Effect), it should be available for another 45 years.
134 |
135 |
136 | ## Why Overleaf?
137 |
138 | Overleaf is a web-based LaTeX editor.
139 | Overleaf is excellent for maintaining multiple writing projects and strongly supports collaborative editing.
140 | I find the Overleaf GUI intuitive and has good support for debugging.
141 | The GUI provides helpful tools for generating the code for tables of various sizes and for selecting images to be inserted into figure environments.
142 | It provides an outside view of the document.
143 | I use this feature to generate outline views of the slide shows I am developing in Beamer.
144 | I use this outline view to navigate to specific slides and to rearrange slides while editing the beamer file.
145 | Overleaf also has an extensive collection of attractive documentation about LaTeX, a nice supplement to TeX StackExchange.
146 |
147 | I have over 780 writing projects on Overleaf.
148 | These projects include grant applications, manuscripts, slideshows, and posters.
149 | I often use an old project as a template to make a new project.
150 | This saves a lot of time.
151 |
152 | I use it multiple times daily because I store my daily writing in a book document as my digital laboratory notebook.
153 | I speed up navigation to active projects by storing their URLs on a private homepage (index.html).
154 |
155 | I have subscribed to the Pro license for several years and have used Overleaf for six years.
156 | I recommend the free account to anyone trying to master LaTeX.
157 | I recommend the Pro license for anyone doing collaborative writing or managing dozens to 100s of projects.
158 | The Pro license enables you to use Git to make copies of your writing projects on your computer using Git.
159 |
160 | The reasons not to use Overleaf include the following:
161 |
162 | - pricey annual subscription
163 | - poor support for Emacs key bindings
164 | - lack of a system for storing snippets of custom LaTeX boilerplate
165 | - time spent in Overleaf is not time spent in Emacs (but see workaround solution below via GhostText)
166 |
167 |
168 | #### GhostText and Overleaf
169 | Overleaf does support a small subset of Emacs keybindings.
170 | Even better, if you select the legacy mode on Overleaf, you can send the text area to Emacs for editing via the GhostText plugin for your browser and the atomic-chrome package for Emacs.
171 | You can use snippets on the Emacs side of the websocket; the inserted code will appear immediately on the Overleaf side.
172 | My configuration for atomic-chrome is below:
173 |
174 | ```emacs-lisp
175 | ;; atomic-chrome, used to interact with GhostText extension for Google Chrome.
176 | (use-package atomic-chrome)
177 | (atomic-chrome-start-server)
178 | (setq atomic-chrome-default-major-mode 'python-mode)
179 | (setq atomic-chrome-extension-type-list '(ghost-text))
180 | ;;(atomic-chrome-start-httpd)
181 | (setq atomic-chrome-server-ghost-text-port 4001)
182 | (setq atomic-chrome-url-major-mode-alist
183 | '(("github\\.com" . gfm-mode)
184 | ("overleaf.com" . latex-mode)
185 | ("750words.com" . latex-mode)))
186 | ; Select the style of opening the editing buffer by atomic-chrome-buffer-open-style.
187 | ; full: Open in the selected window.
188 | ; split: Open in the new window by splitting the selected window (default).
189 | ; frame: Create a new frame and window in it. You must be using some windowing package.
190 | (setq atomic-chrome-buffer-open-style 'split)
191 | ```
192 |
193 | If you use the text area of Overleaf, 750words, or WriteHoney and you have Voice In plus installed in Google Chrom, you can carry out dictation in a text area that will be mirrored in Emacs via GhostText.
194 | The advantage of doing this over using the `whisper.el` package is that you can dictate in longer spurts, and you can use your custom voice triggers to activate the insertion of text replacements.
195 |
196 | For example, I abhor English contractions because I do not believe they will weather well over time.
197 | They also violate the principles of scientific writing, which are be clear, precise, and concise.
198 | Above all, scientific writing must be clear.
199 | Contractions reduce clarity, especially for non-native English speakers.
200 | I have mapped almost 200 contractions to their expansions.
201 | When I say an English contraction, it serves as a voice trigger that leads to the insertion of its expansion.
202 | This spares me the trouble of correcting these manually.
203 | I have also mapped expansions of acronyms to voice triggers so that I can accurately expand the acronym on the fly without looking it up for the 10th time.
204 | I have also mapped various kinds of LaTeX codes to voice triggers.
205 | See the bottom section of the Mooerslab GitHub landing page for more information about [how I use voice computing in my daily work](https://github.com/MooersLab#voice-computing).
206 |
207 |
208 |
209 | ### Advantages of using LaTeX in Emacs over Overleaf
210 |
211 | - The availability of the *yasnippets* package. You can build document templates and save them as yasnippet snippets. You then insert the document template into a new file upon entering the snippet name and hitting tab.
212 | - Powerful macros in AUCTeX support creating and editing new documents.
213 | - Syntax checking before compiling is available. See the keybinding lists below.
214 | - Terse and clear bug reporting during PDF compiling.
215 | - Preview a rendered version of a select region in the buffer. You remove the preview with a key binding. The preview allows you to check an equation's typesetting without going through the longer step of compiling the file into a PDF.
216 |
217 |
218 | ## Why Org-mode
219 |
220 | Org-mode includes support for document preparation, time management, and literate programming.
221 | Many people in the past decade were drawn to Emacs by org-mode.
222 | Org documents recognize the most commonly used features of LaTeX markup.
223 | You can use a LaTeX preamble in the front matter of your org file to use your favorite LaTeX packages and settings.
224 | You can make the PDF coming out of org look precisely like the PDF that you would generate from LaTeX.
225 | You can use LaTeX to build indices, glossaries, list of acronyms, lists the tables, list of figures, lists of code listings, list of equations, and so on.
226 |
227 | I now think of org-mode as a thin but very powerful wrapper around LaTeX.
228 | By utilizing org-mode, you gain the very easy-to-assemble tables that org-mode provides.
229 | You also gain some very convenient ways of utilizing Gnuplot to quickly generate plots.
230 | You gain integration with org-roam for knowledge management because the notes in the system are org files.
231 | You can use this knowledge management in lieu of or in addition to an annotated bibliography.
232 | You gain interactive computing in source blocks.
233 |
234 |
235 | The main drawbacks to org-mode for me are as follows:
236 |
237 | - Most publishers do not accept org files, but they do accept tex files. (You can export the org file to a LaTeX file that might still need heavy editing of the preamble to get the publisher's acceptance.)
238 | - Overleaf does not support the use of org files.
239 | - Org markup adds another layer of abstraction on top of LaTeX. This layer is thin and not that big of a deal.
240 |
241 |
242 |
243 |
244 |
245 | - Install packages from MELPA with use-package.
246 | - Uses Protesilaos Stavrou's (Prot's) [ef-themes](https://github.com/protesilaos/ef-themes) package. Set to the ef-cyprus theme. The ef-light theme is good too.
247 | - latex-mode and auctex-mode with an old autocompletion package that works,
248 | - Keybindings remapped for macOS so Meta is `cmd`, Super is `cap locks`, and Hyper is `Fn`.
249 | - Numerous keybindings from *outline-mode* to fold and unfold sections in a LaTeX file.
250 | - Configured to cope with the minted package under compiling. It gets around the `compile with -shell-escape` command.
251 | - Configured to use snippets from the *snippets* subfolder.
252 | - Has hippieexpand enabled.
253 | - Uses the *awesome-tabs* package to enable navigation between buffers via tabs. (The keybindings s-0, s-1, ..., s9 enable switching tabs from the keyboard.)
254 | - Has the word count mode (*wc-mode*) enabled.
255 | - Includes pomodoro-mode.
256 | - Has minibuffer history.
257 | - Includes *ivy* enabled for enhanced auto-completion selections.
258 | - *atomic-chrome* configured to interact with *GhostText* extension for Google Chrome so you can edit in Emacs LaTeX documents on Chrome.
259 | - Includes the *texcount* script with `C-c w` to get a more accurate word count when in latex-mode.
260 | - Move N-selected lines up and down with the meta and the arrow keys.
261 | - Scratch buffer retained.
262 | - Add the itemize, enumerate, and description functions to convert selected markdown lists into LaTeX itemize, description, or enumerated lists.
263 | - Includes configuration for changing the size of the font in the modeline. This is useful for preparing slides about using Emacs.
264 |
265 |
266 | ## Installation
267 |
268 | 1. `git clone https://MooersLab/github.com/latex-emacs latex-emacs` in your home directory.
269 | 2. Create link to your snippets folder: `ln -s snippets ~/.emacs.d/snippets`. This link negates the need to maintain multiple copies of the snippet libraries.
270 | 3. Edit file paths in init.el as needed. Git clone the packages stored in manual-packages.
271 | 4. Add `alias e29l='/Applications/Emacs29.0.5.app/Contents/MacOS/Emacs --init-directory ~/latex-emacs29` to your `.bashrc` or `.zshrc` file so you can open Emacs with alias `e29l`.
272 | 5. Add the GhostText extension to Chrome or Firefox or Safari or Edge.
273 | 6. Install LaTeX and include in your PATH.
274 | 7. Edit in `init.el` the file path to texcount. This Perl script comes with LaTeX. You might be able to invoke texcount without the file path if you have no previously defined aliases to do texcount.
275 |
276 |
277 | ## Operation
278 |
279 | This setup can be run in versions > 29.0.5 with `emacs --init-directory ~/latex-emacs29` or the alias `e29l`.
280 | This command ignores your default Emacs configuration in `~/.emacs.d`
281 | You can run it in isolation from your default emacs configuration.
282 | It makes a nice backup system when you break the main configuration.
283 |
284 | Create an empty text file with `touch start.tex`.
285 | Start Emacs and load the file.
286 | Enter `C-o C-e` to create a new document using the corresponding [AUCTeX](https://www.gnu.org/software/auctex/) macro.
287 |
288 |
289 | ## Key bindings
290 |
291 | ### Useful key bindings: LaTeX specific
292 | These keybindings are active in the latex-mode or useful in this mode.
293 |
294 | |Key binding | Description|
295 | |:-----------|:-----------|
296 | |C-c w | Run the texcount script on the buffer. It does not count the words in the LaTeX markup. |
297 | |C-c C-j | Enter at the end of a line for an item in the list. Then a new item is inserted into the next line. |
298 | |M-RET | To insert an item in the middle of the list. |
299 | |C-c C-e | Enter to get a prompt for the kind of environment.|
300 | |C-c C-s | Enter to insert a section or subsection.|
301 | | C-c C-a | Compile and open PDF in the default viewer.|
302 | |C-c C-c | Compile document.|
303 | |C-c ` | Go to compile error.|
304 | |C-c C-p C-s | Preview regions.|
305 | | C-c = | Open the navigable table of contents view of the document. |
306 | |C-c C-k | Kill the text file processing. |
307 | |C-c ; | Comment out a region.|
308 | |C-c % | Comment out a paragraph.|
309 | |C-c C-a | Compile a LaTeX text file and display the PDF in the default PDF viewer.|
310 | |C-j | Add a new line and indent the new line.|
311 | |M-q | To fill in a paragraph (text-wrap) and indent the current paragraph. |
312 | |C-c C-q C-e | Fill and indent the current environment.|
313 | |C-c C-q C-s | Fill and indent the current section.|
314 | |C-c C-q C-r | Fill and indent the current region.|
315 | |C-c { | To insert open and close braces and position the cursor between the braces. |
316 | |C-c } | To move the cursor past the right brace.|
317 | |M-x tex-validate-buffer | Enter to check the entire buffer for syntax errors.|
318 | |M-x tex-validate-region | Enter to check the entire region for syntax errors.|
319 | |C-c C-f | To process a file. |
320 | |C-c C-v | To view a DVI file. |
321 | |C-c C-b | To process the buffer. |
322 | |C-c TAB | To run M-x tex-bibtex-file. |
323 |
324 |
325 | ### Useful key bindings: General editing
326 |
327 | If you are rusty or just starting to use Emacs, you need only these 23 key bindings to function in Emacs.
328 |
329 | |Key binding | Description|
330 | |:-----------|:-----------|
331 | |C-x C-c | Quit Emacs.|
332 | |C-g | Abort current command.|
333 | |C-x C-f | Open a file.|
334 | |M-! | Open a shell, perhaps to create a file to open: touch new.tex.|
335 | |C-SPC | Mark the beginning of a selected region.|
336 | |C-x SPC | Start marking rectangular box selection.|
337 | |C-x u | Undo last command.|
338 | |C-M-_ | Redo undone changes.|
339 | |C-x C-s | Save file.|
340 | |C-x C-w | Save the current buffer to the specified filename.|
341 | |C-y | Paste clipboard. |
342 | |C-w | Cut and store in kill-ring (and clipboard).|
343 | |M-w | Copy to kill-ring (and clipboard). |
344 | |s-c | Copy (option-c). The init.el file above maps the Mac option key to `s`, the Super key.|
345 | |C-k | Delete line and store in kill ring (i.e., clipboard). Repeat to delete the new-line character.|
346 | |C-a | Move the cursor to the beginning of the line.|
347 | |C-e | Move the cursor to the end of the line.|
348 | |C-x d | Open dired for directory navigation.|
349 | |C-h | Invoke the help menu. |
350 | |M-x package-list-packages | Refresh list of packages. Emacs may prompt you to install updates: enter u x y to upgrade packages.|
351 | |M-x package-install | Must run `package-list-packages` first.|
352 | |M-\ | Will join the two words by removing the whitespaces between two words. |
353 | |M-d | Delete word. |
354 | |C-d | Delete character. |
355 | |M-t | Transpose two words when the cursor is in the space between the two words. Useful for editing full names in BibTeX entries.|
356 |
357 |
358 |
359 | Vim users can turn on evil mode to emulate Vim key bindings.
360 |
361 | Uncommenting the corresponding code in the init. el file invokes CUA keybindings (C-c, C-v, and C-x for copy, paste, and cut).
362 | However, there are conflicts with the LaTeX keybindings.
363 | I recommend either using evil-mode or learning the essential Emacs key bindings; they are much easier to master than they look :).
364 |
365 |
366 | ## Quizzes
367 |
368 | The recall of key bindings fades quickly after the first encounter but improves with spaced repetitions.
369 | I have provided two sets of quizzes to improve recall: One set for each set of the above key bindings.
370 | The quizzes in the set have the same questions, but I randomized their order to break up your memory of the answers based on the context of the question in the quiz.
371 |
372 | ## Related projects by Others
373 |
374 | ### Peter Prevos's Emacs Writing Studio (EWS)
375 |
376 | Peter Prevos developed a similar Emacs profile (i.e., init.el file) for academic writing focused on utilizing org-mode for document assembly, citar for bibliography management, and denote for knowledge management. He gave a talk about EWS in December 2025 at the emacsconf. He gave one of the best-organized talks at this conference. Furthermore, he has a playlist of five videos on YouTube about various aspects of deploying EWS.
377 |
378 | He has also written a book about how to utilize EWS. The book is available for purchase as an e-book, but you can compile it via org-mode. Open the top-level org file ./Documents/book/00-emacs-writing-studio.org that imports the book's chapters and other parts. To make a PDF of the book, use the key binding `C-c C-e l o` to export it PDF and open it.
379 |
380 | This book is groundbreaking in several regards. This is the first book about Emacs to discuss modern writing workflows utilizing packages like citar and denote. It is also the first Emacs book I know that is built around an `init.el` file. Hopefully, this book will inspire other authors to write books about their `init.el` files.
381 |
382 | The first 50 pages of this book provide an excellent introduction to Emacs for both coders and writers. The following 100 pages are more focused on the writing process in EWS. The last 50 pages is an Appendix that walks through the init.el file and explains the roles of each of the settings and packages. This is one of the most valuable appendices I have ever read and one of the few I have read in one sitting from beginning to end.
383 |
384 | The book lacks an index, which is surprising because utilizing the LaTeX indexing system inside org-mode is relatively trivial. He might have faced limitations with exporting indices to other publication formats beyond LaTeX. His intent was to make this book available in multiple formats.
385 |
386 | I recommend taking a learning spiral approach to getting started with EWS. I first watched his emacsconf talk. I did not discover his YouTube videos until after I had installed EWS and read his book. If I were to do things over again, I would watch the YouTube videos before reading his book. His book is highly accessible, but I am a poor judge of what a beginner would think because I have been a daily user of Emacs for four years.
387 |
388 | He developed several packages that bring functionality similar to that of org-roam. His citar-denote package integrates the use of citar to assist the generation of literature notes for use in denote. His denote-explore package provides tools for analyzing the distribution of notes across topics and generating directed graphs of links between notes. The first functionality is absent from org-roam. The second functionality mimics the org-roam-ui. These two packages are integrated into his init.el file. These are valuable contributions because Peter has made the denote package attractive to org-roam users and more accessible to academics.
389 |
390 | The denote system of personal knowledge management relies on filenames for information retrieval. It does not utilize a database, like org-roam. The filename has five components. Retrieval of notes and their linking is based on elements of the filename. I find this approach to be very robust to future changes in technology.
391 |
392 | However, assembling a personal Knowledge Management System can be quite a time-sink. Creating forward and backlinks is as time-consuming and tedious as in org-roam. I would not start such a knowledge base if I faced a deadline.
393 |
394 | His profile is meant to be easy to install and requires little customization. You do have to define a few file paths, such as where you will install your denote notes. You will have to wait several minutes while the new packages are installed the first time that you launch Emacs with his init.el file. Emacs will start in 1-2 seconds the second time that you start Emacs with the EWS init.el file.
395 |
396 | I have installed his profile for use with Emacs 30.1. An error message was reported, but it can be safely ignored. The profile works as expected. It uses a beautiful theme that makes working in Emacs more pleasant. I have started using his key bindings for denote and denote-explore. They are pleasant to work with.
397 |
398 |
399 |
400 |
401 |
402 |