diff --git a/module2/ressources/emacs_orgmode.html b/module2/ressources/emacs_orgmode.html index 3c0fb6424189dc9eb74e4044082e510548dad97a..d7886858c1d5cb25edce30a674083f25099a04b5 100644 --- a/module2/ressources/emacs_orgmode.html +++ b/module2/ressources/emacs_orgmode.html @@ -4,43 +4,43 @@

Table of Contents

@@ -58,17 +58,17 @@ The next sections provide information on how to install emacs. Before proceeding, make sure you have read the "Git and GitLab" instructions.

-
-

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

-
+
+

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

+
-
-

OS-specific installation procedure

-
+
+

OS-specific installation procedure

+
-
-

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 @@ -130,9 +130,9 @@ which is now deprecated.

-
-

Mac OS X

-
+
+

Mac OS X

+

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

-
-

Windows

-
+
+

Windows

+

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

-
-

TODO A simple "reproducible research" emacs configuration

-
+
+

TODO A simple "reproducible research" emacs configuration

+

There will be a mini video illustrating these steps at some point @@ -202,9 +202,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 @@ -225,9 +225,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:

@@ -244,9 +244,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.

@@ -258,9 +258,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: @@ -291,9 +291,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 @@ -304,9 +304,9 @@ forums.

-
-

TODO A stub of replicable article

-
+
+

TODO A stub of replicable article

+

There will be a mini video illustrating these steps at some point @@ -323,11 +323,7 @@ source (archive and untar it. -

- -

- and simply make to generate the +Download the following archive, untar it and simply make to generate the article. You should then be able to open the resulting article. This is summarized in the following command:

@@ -338,9 +334,13 @@ tar zxf replicable.tgz; cd replicable; m

-If the make command fails (especially on Mac), it may be because emacs -or something else is not correctly installed. In that case, open the -article directly with the following command: +Possible issues: +

+
    +

  • +If the make command fails (especially on Mac), it may be because +emacs or something else is not correctly installed. In that case, +open the article directly with the following command: 

    emacs -q --eval "(setq enable-local-eval t)" --eval "(setq enable-local-variables t)"  article.org
@@ -348,14 +348,12 @@ article directly with the following command:

    and export it to pdf with the following shortcut: C-c C-e l o -

    - -

    -If it still doesn't work and emacs complains about not finding ESS, it -may be because you installed ESS in your home instead of +

    • +
  • If it still doesn't work and emacs complains about not finding ESS, +it may be because you installed ESS in your home instead of system-wide. In that case, try to remove the -q in the previous -command line to load your personal emacs configuration. -

    +command line to load your personal emacs configuration.
    • +

Finally, when you'll be tired of always reexecuting all the source @@ -373,22 +371,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 @@ -432,22 +430,24 @@ official webpage: http://company-mode.g

-
-

Magit

-
+
+

Magit

+

Magit is an emacs interface for Git. It is very powerfull 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 +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.

-
-

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 bc286454f6eac150e54a33a3e5a78a74217a9549..5bf598da8c4a6bd8dccdf701723e1f3650a2aa20 100644 --- a/module2/ressources/emacs_orgmode.org +++ b/module2/ressources/emacs_orgmode.org @@ -174,9 +174,8 @@ make -C replicable_article/ all replicable_article.tgz #+end_src #+RESULTS: -Download the following [[https://app-learninglab.inria.fr/gitlab/learning-lab/mooc-rr-ressources/raw/master/module2/ressources/replicable_article/replicable_article.tgz][archive]] and untar it. - and simply =make= to generate the +Download the following [[https://app-learninglab.inria.fr/gitlab/learning-lab/mooc-rr-ressources/raw/master/module2/ressources/replicable_article/replicable_article.tgz][archive]], untar it and simply =make= to generate the article. You should then be able to open the [[https://app-learninglab.inria.fr/gitlab/learning-lab/mooc-rr-ressources/blob/master/module2/ressources/replicable_article/article.pdf][resulting article]]. This is summarized in the following command: #+begin_src sh :results output :exports both @@ -184,18 +183,18 @@ wget --no-check-certificate -O replicable.tgz https://github.com/alegrand/RR_web tar zxf replicable.tgz; cd replicable; make ; evince article.pdf #+end_src -If the =make= command fails (especially on Mac), it may be because emacs -or something else is not correctly installed. In that case, open the -article directly with the following command: -#+begin_src sh :results output :exports both -emacs -q --eval "(setq enable-local-eval t)" --eval "(setq enable-local-variables t)" article.org -#+end_src -and export it to pdf with the following shortcut: =C-c C-e l o= - -If it still doesn't work and emacs complains about not finding ESS, it -may be because you installed ESS in your home instead of -system-wide. In that case, try to remove the =-q= in the previous -command line to load your personal emacs configuration. +*Possible issues*: +- If the =make= command fails (especially on Mac), it may be because + emacs or something else is not correctly installed. In that case, + open the article directly with the following command: + #+begin_src sh :results output :exports both + emacs -q --eval "(setq enable-local-eval t)" --eval "(setq enable-local-variables t)" article.org + #+end_src + and export it to pdf with the following shortcut: =C-c C-e l o= +- If it still doesn't work and emacs complains about not finding ESS, + it may be because you installed ESS in your home instead of + system-wide. In that case, try to remove the =-q= in the previous + command line to load your personal emacs configuration. Finally, when you'll be tired of always reexecuting all the source code when exporting, just look for the following line in [[https://app-learninglab.inria.fr/gitlab/learning-lab/mooc-rr-ressources/blob/master/module2/ressources/replicable_article/article.org][article.org]]: