From bfbf4f51e7f13449bac000793eb3c37bd8dc854b Mon Sep 17 00:00:00 2001 From: Arnaud Legrand Date: Wed, 25 Jul 2018 19:20:13 +0200 Subject: [PATCH] Final (?) reorganization and link to FUN video tutorials --- module2/ressources/emacs_orgmode.html | 194 +++++++++++++------------- module2/ressources/emacs_orgmode.org | 36 +++-- 2 files changed, 113 insertions(+), 117 deletions(-) diff --git a/module2/ressources/emacs_orgmode.html b/module2/ressources/emacs_orgmode.html index de60757..191370c 100644 --- a/module2/ressources/emacs_orgmode.html +++ b/module2/ressources/emacs_orgmode.html @@ -4,39 +4,39 @@

Table of Contents

@@ -45,25 +45,24 @@

Disclaimer: The two sections A simple "reproducible research" emacs configuration and A stub of replicable article explain how to set up -org-mode for this MOOC. I have prepared two video tutorials (here and -here) for each, which you really should follow carefully. Otherwise, -you may have trouble doing the exercises later on. Likewise, I -strongly encourage you to watch the "emacs and git" video tutorial. +org-mode for this MOOC. These sections are illustrated in two out of +the three video tutorials of this sequence, and which you really +should follow carefully. Otherwise, you may have trouble doing the +exercises later on. Likewise, I strongly encourage you to watch the +"emacs and git" video tutorial available at the same place.

-The next sections provide information on how to install emacs. Before -proceeding, make sure you have read the "Git and GitLab" instructions -(tutorial and resources from the 4th sequence of the 2nd module). +The next section provides information on how to install emacs.

-
-

Installing emacs, org-mode, ess, and auctex.

-
+
+

Installing emacs, org-mode, ess, and auctex.

+
-
-

Linux (Debian, Ubuntu)

-
+
+

Linux (Debian, Ubuntu)

+

We provide here only instructions for debian-based distributions. Feel free to contribute to this document to provide up-to-date information @@ -125,9 +124,9 @@ which is now deprecated.

-
-

Mac OS X

-
+
+

Mac OS X

+

  • Option 1: Install the .dmg file from Vincent Goulet: @@ -160,9 +159,9 @@ brew install wget

-
-

Windows

-
+
+

Windows

+

Install the .exe file from Vincent Goulet: https://vigou3.github.io/emacs-modified-windows/. It ships with recent @@ -176,11 +175,11 @@ versions:

-
-

A simple "reproducible research" emacs configuration

-
+
+

A simple "reproducible research" emacs configuration

+

-This section is illustrated in a video tutorial (in French). Watching +This section is illustrated in a video tutorial (in French). Watching it before following the instructions given in this section may help.

@@ -196,9 +195,9 @@ adding a few org-mode specific configurations.

-
-

Step 0: Backup and download our configuration

-
+
+

Step 0: Backup and download our configuration

+

The procedure we propose will wipe your already existing custom emacs configuration if you already have one. You should thus beforehand make @@ -219,9 +218,9 @@ rr_org/journal.org

-
-

Step 1: Prepare your journal

-
+
+

Step 1: Prepare your journal

+

Create an org/ directory in the top of your home:

@@ -238,9 +237,9 @@ should give a try.

-
-

Step 2: Set up Emacs configuration

-
+
+

Step 2: Set up Emacs configuration

+

Copy rr_org/init.el in your ~/.emacs.d/ directory.

@@ -252,9 +251,9 @@ configuration with the following command: emacs -q -l rr_org/init.el
-
-

Step 3: Check whether the installation is working or not

-
+
+

Step 3: Check whether the installation is working or not

+

Open a new instance of Emacs and open a foo.org file. Copy the following lines in this file: @@ -285,9 +284,9 @@ is demonstrated in the -

Step 4: Open and play with your journal:

-
+
+

Step 4: Open and play with your journal:

+

In step 1, you were told to create an journal in ~org/journal.org. First you probably want to make sure this file is @@ -298,11 +297,11 @@ forums.

-
-

A stub of replicable article

-
+
+

A stub of replicable article

+

-This section is illustrated in a video tutorial (in French). Watching +This section is illustrated in a video tutorial (in French). Watching it before following the instructions given in this section may help.

@@ -363,22 +362,22 @@ chunk of code when exporting.
-
-

Emacs Tips and tricks

-
+
+

Emacs Tips and tricks

+
-
-

Cheat-sheets

-
+
+

Cheat-sheets

+

Learning emacs and org-mode can be difficult as there is an inordinate amount of shortcuts. Many people have thus come up with cheat-sheats. Here is a selection in case it helps:

-
-

Emacs

-
+
+

Emacs

+
-
-

Org-mode

-
+
+

Org-mode

+
-
-

Video tutorials

-
+
+

Video tutorials

+

For those of you who prefer video explanations, here is a Youtube channel with many step by step emacs tutorials.

-
-

Additional useful emacs packages

-
+
+

Additional useful emacs packages

+
-
-

Company-mode

-
+
+

Company-mode

+

Company-mode is a text completion framework for Emacs. It allows to have smart completion in emacs for the most common languages. If you @@ -422,29 +421,28 @@ official Web page: http://company-mode.

-
-

Magit

-
+
+

Magit

+

-Magit]] is an emacs interface for Git. It is briefly illustrated in a -video tutorial. +Magit is an emacs interface for Git. Its usage is briefly illustrated +in the context of this MOOC in a video tutorial (in French).

-It is very powerful and we use -it on a daily basis but you should definitely understand what git does -behind the scene beforehand. If you feel this would be useful for you, -you should follow the instructions from here: -https://www.emacswiki.org/emacs/Magit. If you installed the previous -"reproducible research" emacs configuration, you can easily invoke -magit by using C-x g. +It is very powerful and we use it on a daily basis but you should +definitely understand what git does behind the scene beforehand. If +you feel this would be useful for you, you should follow this visual +walk-through or this really short "crash course". If you installed the +previous "reproducible research" emacs configuration, you can easily +invoke magit by using C-x g.

-
-

Other resources

-
+
+

Other resources

+
  • The compact Org-mode Guide
  • Many examples illustrating the use of different languages in org-mode
    • diff --git a/module2/ressources/emacs_orgmode.org b/module2/ressources/emacs_orgmode.org index a162237..db2beb3 100644 --- a/module2/ressources/emacs_orgmode.org +++ b/module2/ressources/emacs_orgmode.org @@ -8,14 +8,13 @@ *Disclaimer:* The two sections _A simple "/reproducible research/" emacs configuration_ and _A stub of replicable article_ explain how to set up -org-mode for this MOOC. *I have prepared two video tutorials (here and -here) for each, which you really should follow carefully*. *Otherwise, -you may have trouble doing the exercises later on*. Likewise, I -strongly encourage you to watch the "emacs and git" video tutorial. +org-mode for this MOOC. *These sections are illustrated in two out of +the [[https://www.fun-mooc.fr/courses/course-v1:inria+41016+session01bis/courseware/66bc811404b8481da5f794de54681c5e/aefd774dcd2342c6aa769c87e2d0993a/3][three video tutorials of this sequence]], and* *which you really +should follow carefully*. *Otherwise, you may have trouble doing the +exercises later on*. Likewise, I strongly encourage you to watch the +[[https://www.fun-mooc.fr/courses/course-v1:inria+41016+session01bis/courseware/66bc811404b8481da5f794de54681c5e/aefd774dcd2342c6aa769c87e2d0993a/3]["emacs and git" video tutorial available at the same place]]. -The next sections provide information on how to install emacs. Before -proceeding, make sure you have read the "Git and GitLab" instructions -(tutorial and resources from the 4th sequence of the 2nd module). +The next section provides information on how to install emacs. * Installing emacs, org-mode, ess, and auctex. ** Linux (Debian, Ubuntu) @@ -83,7 +82,7 @@ versions: - Org-mode 9.1.13 - ESS 17.11 * A simple "/reproducible research/" emacs configuration -This section is illustrated in a video tutorial (in French). Watching +This section is illustrated in a [[https://www.fun-mooc.fr/courses/course-v1:inria+41016+session01bis/courseware/66bc811404b8481da5f794de54681c5e/aefd774dcd2342c6aa769c87e2d0993a/3][video tutorial]] (in French). Watching it before following the instructions given in this section may help. Emacs comes with very basic default configuration and it appears like @@ -159,7 +158,7 @@ backed up in a revision control system like git. We leave it up to set this up but if you have any trouble, feel free to ask on the FUN forums. * A stub of replicable article -This section is illustrated in a video tutorial (in French). Watching +This section is illustrated in a [[https://www.fun-mooc.fr/courses/course-v1:inria+41016+session01bis/courseware/66bc811404b8481da5f794de54681c5e/aefd774dcd2342c6aa769c87e2d0993a/3][video tutorial]] (in French). Watching it before following the instructions given in this section may help. Remember, you need a working LaTeX and R environment. If you can't @@ -229,16 +228,15 @@ have smart completion in emacs for the most common languages. If you feel this is needed, you should follow the instructions from the official Web page: http://company-mode.github.io/ *** Magit -Magit]] is an emacs interface for Git. It is briefly illustrated in a -video tutorial. - -It is very powerful and we use -it on a daily basis but you should definitely understand what git does -behind the scene beforehand. If you feel this would be useful for you, -you should follow the instructions from here: -https://www.emacswiki.org/emacs/Magit. If you installed the previous -"/reproducible research/" emacs configuration, you can easily invoke -magit by using ~C-x g~. +[[https://magit.vc/][Magit]] is an emacs interface for Git. Its usage is briefly illustrated +in the context of this MOOC in a [[https://www.fun-mooc.fr/courses/course-v1:inria+41016+session01bis/courseware/66bc811404b8481da5f794de54681c5e/aefd774dcd2342c6aa769c87e2d0993a/3][video tutorial]] (in French). + +It is very powerful and we use it on a daily basis but you should +definitely understand what git does behind the scene beforehand. If +you feel this would be useful for you, you should follow [[https://magit.vc/screenshots/][this visual +walk-through]] or [[https://www.emacswiki.org/emacs/Magit][this really short "crash course"]]. If you installed the +previous "/reproducible research/" emacs configuration, you can easily +invoke magit by using ~C-x g~. ** Other resources - [[https://orgmode.org/orgguide.pdf][The compact Org-mode Guide]] - [[https://github.com/dfeich/org-babel-examples][Many examples illustrating the use of different languages in org-mode]] -- 2.18.1