Text editor: Difference between revisions

From 太極
Jump to navigation Jump to search
(32 intermediate revisions by the same user not shown)
Line 128: Line 128:
** [https://orgmode.org/ Org mode]
** [https://orgmode.org/ Org mode]
** Howm
** Howm
== Spacemacs ==
https://www.spacemacs.org/


= Gedit =
= Gedit =
Line 157: Line 160:
*# Edit -> Preferences -> Plugins -> Embedded terminal  
*# Edit -> Preferences -> Plugins -> Embedded terminal  
*# View -> Bottom panel
*# View -> Bottom panel
== Zoom in ==
[https://askubuntu.com/questions/108967/how-to-zoom-in-and-out-of-text-in-gedit How to zoom in and out of text in Gedit?]


== markdown preview plugin ==
== markdown preview plugin ==
Line 358: Line 364:
* Alt+u (Option+u): Undo [There is a hint at bottom right, M-u where M stands for meta]. Require nano 2.3.5 (2014)
* Alt+u (Option+u): Undo [There is a hint at bottom right, M-u where M stands for meta]. Require nano 2.3.5 (2014)
* Alt+e (Option+e): Redo
* Alt+e (Option+e): Redo
== Modern keybind shortcuts ==
* If we use nano in a browser, Ctrl+w means a search but it also means to close a tab in a browser.
* One solution is to use '''F6''' and forget Ctrl+w.
* [https://github.com/davidhcefx/Modern-Nano-Keybindings Modern Nano Keybindings].


== Permission denied and '''sudoedit''' command ==
== Permission denied and '''sudoedit''' command ==
Line 397: Line 408:


== show line number/cursor position ==
== show line number/cursor position ==
PS for Mac
* it seems nano on MacOS does not work even I installed it through homebrew (brew install nano).
* I need to modify ~/.zshrc and add a line '''PATH=$PATH:/opt/homebrew/Cellar/nano/7.2/bin'''
Use the '''-c''' option for cursor position.
Use the '''-c''' option for cursor position.
<syntaxhighlight lang='bash'>
<syntaxhighlight lang='bash'>
Line 459: Line 474:


= vim editor =
= vim editor =
* [https://askubuntu.com/questions/418396/what-is-the-difference-between-vi-and-vim What is the difference between Vi and Vim?]. '''Vim''' is much better than ''vi''. On Mac, vi is soft linked to vim.
* [https://askubuntu.com/questions/418396/what-is-the-difference-between-vi-and-vim What is the difference between Vi and Vim?]. '''Vim''' is much better than ''vi''.  
** On Mac, vi is soft linked to vim.
** On Debian 11, vi is a soft link to vim. But it is strange when I enter an edit mode, the screen does not show the text '''-- INSERT --'''. But after I run "apt install vim", then when I use '''vi''' the screen can show the text '''-- INSERT --''' even the vim version is not changed!
* [https://opensource.com/article/19/3/getting-started-vim Getting started with Vim: The basics]. Three major modes
* [https://opensource.com/article/19/3/getting-started-vim Getting started with Vim: The basics]. Three major modes
** '''Normal''': Default; for navigation and simple editing. Click 'Esc' to go back to the normal mode.
** '''Normal''': Default; for navigation and simple editing. Click 'Esc' to go back to the normal mode.
Line 467: Line 484:
* [https://www.makeuseof.com/how-to-use-vim/ How to Use Vim: A Guide to the Basics]
* [https://www.makeuseof.com/how-to-use-vim/ How to Use Vim: A Guide to the Basics]
* [https://linuxhandbook.com/basic-vim-commands/ Basic Vim Commands Every Linux User Must Know (Free Cheat Sheet Included)]
* [https://linuxhandbook.com/basic-vim-commands/ Basic Vim Commands Every Linux User Must Know (Free Cheat Sheet Included)]
* On Debian 11, ''vi'' does not show '''-- INSERT --''' at the bottom of screen when it is in an edit mode. But '''vim''' or '''neovim''' can show '''-- INSERT --'''. I use '''apt install''' to install "vim".
* [https://github.com/neovim/neovim/wiki/Installing-Neovim Installing Neovim]


== One advantage over nano ==
== One advantage over nano ==
Line 540: Line 559:


= micro =
= micro =
* https://micro-editor.github.io/
<ul>
* [https://www.cyberciti.biz/open-source/awesome-text-editors-for-linux-and-unix-command-line-users-developers/ Top 6 awesome text editors for Linux and Unix command-line users/developers]
<li>https://micro-editor.github.io/.
* [https://youtu.be/kqCQLyrEZww Awesome Linux Tools: The "micro" text editor] (video)
* Line number is enabled by default.
* Keybinding is the same as popular GUI editors.
* Binary of static builds are available.
<li>Keybinding:
* Ctrl+O: Open File
* Ctrl+S: Save File
* Ctrl+Q: Quit
* Ctrl+F: Find
* Ctrl+N: Find Next
* Ctrl+P: Find Previous
* Ctrl+Z: Undo
* Ctrl+Y: Redo
* Ctrl+C: Copy
* Ctrl+X: Cut
* Ctrl+V: Paste
<li>[https://linuxiac.com/micro-text-editor/ Micro Text Editor: Lightweight and Intuitive Terminal-Based Editor]
<li>[https://www.cyberciti.biz/open-source/awesome-text-editors-for-linux-and-unix-command-line-users-developers/ Top 6 awesome text editors for Linux and Unix command-line users/developers]
<li>[https://youtu.be/kqCQLyrEZww Awesome Linux Tools: The "micro" text editor] (video)
</ul>


= Theme =
= Theme =
Line 553: Line 590:
* [https://www.makeuseof.com/tag/extensions-visual-studio-code/ 9 Visual Studio Code Extensions That Make Programming Even Easier]
* [https://www.makeuseof.com/tag/extensions-visual-studio-code/ 9 Visual Studio Code Extensions That Make Programming Even Easier]
* [https://www.youtube.com/watch?v=yGGyRrcRXfc&list=PLvKOuwv1u7bF0x8HqOaBWbbdUMAHyI5V3 VS code tips] (video, playlist)
* [https://www.youtube.com/watch?v=yGGyRrcRXfc&list=PLvKOuwv1u7bF0x8HqOaBWbbdUMAHyI5V3 VS code tips] (video, playlist)
* [https://www.makeuseof.com/tag/10-essential-productivity-tips-visual-studio-code/ 10 Essential Productivity Tips for Visual Studio Code]


== Use significant energy ==
== Use significant energy ==
Line 558: Line 596:


[[File:VscodeEnergy.png|200px]]
[[File:VscodeEnergy.png|200px]]
== VS Code vs VS Codium ==
* https://vscodium.com/


== Change to use as the default text editor ==
== Change to use as the default text editor ==
Line 577: Line 618:
* See [https://code.visualstudio.com/Docs/supporting/FAQ Visual Studio Code FAQ]
* See [https://code.visualstudio.com/Docs/supporting/FAQ Visual Studio Code FAQ]
* [https://code.visualstudio.com/docs/editor/workspaces What is a VS Code "workspace"?]
* [https://code.visualstudio.com/docs/editor/workspaces What is a VS Code "workspace"?]
* [https://stackoverflow.com/a/66164934 How to rename a workspace in vscode?].
** Use the "File -> Save Workspace As ..." to save it into a file.
** The workspace file has a file name  '''<name>.code-workspace'''.


=== Manage multiple projects ===
=== Manage multiple projects ===
[https://youtu.be/MUlisk6Om20 Working with Multiple Projects in VS Code]
* [https://youtu.be/MUlisk6Om20 Working with Multiple Projects in VS Code]
* [https://stackoverflow.com/a/30234987 Open multiple Projects/Folders in Visual Studio Code]. File -> Add folder to Workspace...


== Activity Bar (User Interface): left most ==
== Activity Bar (User Interface): left most ==
Line 589: Line 634:


The 'gear' icon at the bottom shows a bunch of shortcuts: Command Palette, Settings, Extensions, Keyboard Shortcuts, User Snippets, Color Theme, File Icon Theme and Check for Updates.
The 'gear' icon at the bottom shows a bunch of shortcuts: Command Palette, Settings, Extensions, Keyboard Shortcuts, User Snippets, Color Theme, File Icon Theme and Check for Updates.
== Disable check for updates ==
[https://stackoverflow.com/a/50162860 How do I disable VS Code of updating itself?] Settings. Search "update". Change of value of "update.mode" from default to "none".


== Explorer: left pane (OUTLINE view, switch open files) ==
== Explorer: left pane (OUTLINE view, switch open files) ==
Line 596: Line 644:


It has an '''OUTLINE''' view On the left bottom corner. Useful for me to switch to any section of my document. I need to click "..." to change to sort by position.
It has an '''OUTLINE''' view On the left bottom corner. Useful for me to switch to any section of my document. I need to click "..." to change to sort by position.
== Code navigation ==
* [https://code.visualstudio.com/Docs/editor/editingevolved Code Navigation]
** Ctrl + Tab
** Breadcrumbs (navigation bar above its contents. It shows the current location and allows you to quickly navigate between folders, files, and symbols.)
** Go to Definition
** Go to Symbol


== Set up for R ==
== Set up for R ==
[https://youtu.be/hOe5eYcQrCw How to set up VSCode for R] from IDG Techtalk and [https://www.infoworld.com/article/3625488/how-to-run-r-in-visual-studio-code.html the article].
* [https://youtu.be/hOe5eYcQrCw How to set up VSCode for R] (7/22/2021) from IDG Techtalk and [https://www.infoworld.com/article/3625488/how-to-run-r-in-visual-studio-code.html the article].
* [https://renkun.me/2022/03/06/my-recommendations-of-vs-code-extensions-for-r/ My recommendations of VS Code extensions for R] and more topics on https://renkun.me/
* (2023/5/19)
** https://code.visualstudio.com/docs/languages/r and refer to the [https://github.com/REditorSupport/vscode-R/wiki wiki] on Github for a comprehensive overview of the features. PS: '''R LSP Client''' has been integrated into vscode-R.
** https://github.com/REditorSupport/vscode-R/wiki/R-Markdown. Do add a new item in VS Code Setting.
** httpgd: we need to install the R package and [https://stackoverflow.com/a/71107298 enable it] in R extension
** [https://youtu.be/NGM7Z1Dd9fE Github copilot for R] (video)
* (2023/12/31)
** '''install.packages("languageserver") '''
** In VS code, click on the "Extensions" icon on the LHS, type "R" and install the 1st one R Extension for Visual Studio by REditorSupport. After that, we can click the "Extensions" icon again to hide the left panel.
** Open an R file in VS Code
** Click menu -> Terminal -> New Terminal. This will open a Terminal at the bottom of VS Code. Alternatively, you could create an R terminal via command '''R: Create R terminal''' in the ''Command Palette''.
** Move mouse cursor to one R statement in the R file. Use ''' "Ctrl + Enter" ''' to open an R terminal and send R statements to the terminal.
** If I want to run the code in a different R, I can open that specific R in the Terminal. After that, R statements will be sent to that specific version of R.
** R graphics will be generated on a new window. So it is more convenient to use [https://github.com/nx10/httpgd httpgd]. '''install.packages("httpgd")''' . See [https://cran.r-project.org/web/packages/httpgd/vignettes/a01_how-to-get-started.html Getting Started] guide. <syntaxhighlight lang='rsplus'>
library(httpgd)
hgd()
hgd_browse()
...
dev.off() # stop the server
</syntaxhighlight>
** '''R Markdown All in One''' extension
** [https://github.com/randy3k/radian radian]. It can give syntax highlighting on R terminal. Need Python to install it. After install radian, go to R extension settings. Fill out "R > Rterm: Mac" (if we are using Mac) with the path to radian. Also remove "R > Rterm: Option". Check the option of "R: Bracketed Paste". And more need to be taken care.


== R markdown files ==
== R markdown files ==
[https://stackoverflow.com/a/62416283 How to review the outline of `.rmd` file in vs code?] If you don't want to do install any extensions you can just simply go to the status bar and click on Plain Text and select Markdown from the menu that pops up and that will generate the outline treating the file as a Markdown file.
* [https://github.com/REditorSupport/vscode-R/wiki/R-Markdown R Markdown] in VS Code. Chunk navigation (Left side panel), chunk execution, Live preview of rmd. See the gif images on the wiki.
 
* How to launch a specific version of R from the terminal? We can do that by for example,
:<syntaxhighlight lang='sh'>
/Library/Frameworks/R.framework/Versions/4.2-arm64/Resources/R
</syntaxhighlight>
* [https://stackoverflow.com/a/62416283 How to review the outline of `.rmd` file in vs code?] If you don't want to do install any extensions you can just simply go to the status bar and click on Plain Text and select Markdown from the menu that pops up and that will generate the outline treating the file as a Markdown file.
** '''CMD + b''' (mac) OR Ctrl+b (Windows/Linux) to hide/show the sidebar panel (~'''Activity Bar'''). In the sidebar panel, it shows '''EXPLORER''' on top. Under it, we have a dropdown for the current directory and a dropdown for '''OUTLINE'''
** We can use the left-most icon shown on top-right corner.
** We can use View -> Appearance -> toggle ''' "Primary Side Bar" '''
** See also [https://code.visualstudio.com/docs/getstarted/userinterface Visual Studio Code -> User Interface] for beginners. We can see "Activity Bar" != "Side bar". We can hide '''Activity Bar''' on the left-hand-side by View -> Appearance -> Activity Bar Position.
 
* [https://stackoverflow.com/a/48610661 Disable (or toggle) the wavy underline/squigglies (problems) in VS Code]. It works. Shift + Cmd + p and type “settings.json”. Then I choose "Preferences: Open User Settings (JSON)" which is essentially the file "~/Library/Application\ Support/Code/User/settings.json". I insert a new item (5 lines) related to ''' "workbench.colorCustomizations" '''.
:<syntaxhighlight lang='json'>
    "workbench.colorCustomizations": {
        "editorError.foreground":  "#00000000",
        "editorWarning.foreground": "#00000000",
        "editorInfo.foreground":    "#00000000"
    }
</syntaxhighlight>
 
* [https://towardsdev.com/r-markdown-notebook-in-vs-code-3adb5a61417a R Markdown Notebook in VS code]
 
== R markdown outline preview ==
* Enable eval=T in "knitr::opts_chunk$set(echo = TRUE, eval = FALSE)"
* Click the second from the top-right list of icons: '''Open Preview to the Side'''. This will knit the document. However, the scrolling of the source code and the preview window are not synchronized. It means the preview is not a live preview (Markdown can do this, but markdown file type will lose the send code functionality).


== Markdown preview ==
== Markdown preview ==
Line 635: Line 737:


From there we can quickly try different color theme (use arrow key to select but do not use mouse to click). See the video [https://code.visualstudio.com/docs/introvideos/configure VS Code - Customization].
From there we can quickly try different color theme (use arrow key to select but do not use mouse to click). See the video [https://code.visualstudio.com/docs/introvideos/configure VS Code - Customization].
== Color theme ==
* https://code.visualstudio.com/docs/getstarted/themes, especially "Color themes from the marketplace". I choose "vibrant ink".
* View - Command Palette - Preferences Settings.json. This will open the user's settings.
* View - Command Palette - Preferences "Color theme" - Pick one of color scheme. You will see a change in the "settings.json" file in the editor.
== Themes ==
[https://vscodethemes.com/e/yurihs.sublime-vscode-theme/sublime-vscode-theme?language=javascript Sublime] where the text editor panel is dark but the taskbar on the LHS is light.


== Open a file from the command line ==
== Open a file from the command line ==
Line 693: Line 803:
* [https://www.raspberrypi.org/blog/coding-on-raspberry-pi-remotely-with-visual-studio-code/ Coding on Raspberry Pi remotely with Visual Studio Code]
* [https://www.raspberrypi.org/blog/coding-on-raspberry-pi-remotely-with-visual-studio-code/ Coding on Raspberry Pi remotely with Visual Studio Code]
* [https://www.cloudsavvyit.com/13454/how-to-develop-on-a-remote-ssh-server-with-visual-studio-code/ How to Develop on a Remote SSH Server With Visual Studio Code]
* [https://www.cloudsavvyit.com/13454/how-to-develop-on-a-remote-ssh-server-with-visual-studio-code/ How to Develop on a Remote SSH Server With Visual Studio Code]
== ChatGPT/copilot ==
* [https://docs.github.com/en/copilot/getting-started-with-github-copilot Getting started with GitHub Copilot]
* [https://www.makeuseof.com/ways-you-can-use-chatgpt-vscode-together/ 10 Ways You Can Use ChatGPT With VS Code]. Unlike GitHub Copilot, these are not officially directly from OpenAI.


= Notepad ++ =
= Notepad ++ =

Revision as of 20:42, 27 February 2024

Comparison

Stack Overflow Developer Survey 2021

Platforms Pros Cons
Atom Cross built-in markdown file preview
Bluefish Cross remote file, project support crash when I try Print->Preview
Brackets Cross good for web designer
Emacs Cross split the buffers
Gedit Cross print preview (incorrect when landscape but pdf is right) no code folding
Geany Cross print preview; Terminal; split window
IntelliJ IDEA Cross
Notepad++ Win print line numbers, Right-click menu R syntax highlight not work with most themes
Qt Creator Cross split a window (even same file)
RStudio Cross folding, best IDE for R coding not support drag and drop a file but SendTo works
Sublime Cross menu -> Goto -> Bookmarks -> Toggle bookmarks (Ctrl + F2)
Typora Cross Markdown editor (Preview, TOC, LaTex)
vim Cross
Visual Studio Code Cross Integrated Terminal,

Markdown preview. Github markdown extension.

CMD+K and V to open the preview panel side by side.

"minimap" can be removed from menu -> View.


HTML editors: see here.

Atom

  • Markdown preview feature is OK but it cannot export to pdf or HTML.
  • pandoc conversion to html/PDF is not good; scripts part has no rectangle, tables have no separate lines.

Packages

To install a new package, go to Preferences -> Install -> type the package name and hit ENTER.

To remove a package, just delete the related folder.

rm -rf ~/.atom/packages/markdown-toc
  • Markdown Preview Enhanced. It allows to view in browser (html) or export to PDF. Use r instead of R for R language syntax highlight. Another nice feature is the scrollings of the markdown file and preview are together.
  • Markdown TOC. It messes up the # sign in script blocks :( So I switch to RStudio which has a good support to create the TOC (YAML header).

Emacs

$ cat ~/.emacs
;disable backup
(setq backup-inhibited t)
;disable auto save
(setq auto-save-default nil)
(load-theme 'manoj-dark)

Spacemacs

https://www.spacemacs.org/

Gedit

  • Homebrew or Macport on Mac. Windows binary is available too.
  • To create a new tab, Ctrl + t.
  • Preferences
    • View: display line numbers, highlight current line
    • Font and colors: change to font size 14, color scheme = Cobalt
    • Plugins: External Tools
  • To split a screen, Do "Documents -> New Tab Group. No extra plugin is needed to download. I am using version 3.10.4 from Ubuntu 14.04.
  • Restore tabs plugin. It works on my gedit 3.4 (ubuntu 12.04). Follow the instruction there exactly.
  • Source code browser plugin. This makes gedit a good IDE for developing C++/Java code since the left panel can show symbols. Click F9 to show the side panel.
  • Darkmate theme.
cd /usr/share/gtksourceview-3.0/styles
sudo gedit darkermate.xml

gedit > Edit > preferences > font and colors > color scheme.

Launch from a command line

gksu gedit XXXX

Plugins

Zoom in

How to zoom in and out of text in Gedit?

markdown preview plugin

How To Add Markdown Support To Gedit Using `Markdown Preview` Plugin

Geany

Geany can be used to run a bash script file line by line. See Debugging_Scripts.

Display special characters

Geany has a way to show special characters (Tabs/LF/CR). Edit > Preferences > Display > Tick, Show whitespace (tabs) & Show Line endings(CR/LF).

For DOS text file, the line ending is CR+LF.

For Unix text file, the line ending is LF.

Font size

Users can use either one of the following methods

  1. Edit -> Preferences -> Interface -> Fonts to adjust the font size.
  2. Keyboard bindings: Ctrl + Shift + '+' to increase the font size or Ctrl + '-' to decrease the font size. This does not affect the font size in Preferences.

Printing

The font size in Preferences affects the printing. The font size changed by using the keyboard bindings does not affect printing.

Remove vertical line

Edit -> Preferences -> Editor -> Display -> Uncheck Long line marker.

Obsidian

Markdown editor

Sublime

My settings file which takes care of the scheme, font size and word wrap.

{
	"color_scheme": "Packages/Color Scheme - Default/Monokai.sublime-color-scheme",
	"font_size": 16,
	"open_files_in_new_window": false,
	"word_wrap": true,
	"theme": "Default.sublime-theme"
}

Tips from youtube

  • View - Groups/Focus Group (^1, ^2)
    • This shortcuts are consistent with RStudio. ^1 moves to source code & ^2 moves to R console.
  • Alt key to show the menu
  • base16 color scheme (Enter)
  • select color scheme (Arrow keys to cycle through)
    • goog (Pick base16-google-dark for example)
  • install package - Cyanide theme (Enter)
  • select theme (Arrow keys to cycle through)
  • Alt (to see the menu bar) - Preference - Settings
    • Left = default settings, right = custom settings
    • change the settings (eg font size) on RHS panel.
    • "font_size": 16,
    • "highlight_line": true,
    • Ctr + s to save.
  • Ctrl+b to run the code
  • ESC to close the output pane (did not stop the run)
  • Preference - Color scheme - Monokai
  • Preference - Theme - Adaptive.sublime-theme
  • Tools - Build System - Python (or Automatic)
  • Preference - Key binding
  • C+S+p - Package Control
  • F11/fn + F11 full screen mode

License key

Preferences/settings

On my mac & Sublime Text 4 (don't add "~/" to the path),

$ cd
$ ls "Library/Application Support/Sublime Text/Packages"                                                     
Citer           User            markupsafe      ptyprocess      pyte            pyyaml
R-IDE           backrefs        mdpopups        pygments        python-jinja2   wcmatch
SendCode        bracex          pathlib         pymdownx        python-markdown wcwidth
$ ls "Library/Application Support/Sublime Text/Packages/User"                                              
Package Control.sublime-settings Preferences.sublime-settings     SendCode.sublime-settings
Package Control.user-ca-bundle   R-IDE                            Terminus

Projects

Package Control

File explorer

standard file browser in sidebar. Go to menu View > Side Bar > Show Side Bar. Then, open windows explorer and drag the root folder into the Side Bar, The folders should now be available on the Side Bar. (it works on Sublime Text 4 macOS)

Terminus package

*SendCode

  • https://github.com/randy3k/SendCode. It is not specific to R code.
  • See a screenshot Meta-Analysis in R with {metafor}
  • A guide to using R in Sublime Text. It does not mention about R-box or R-IDE.
  • SendCode will work automatically next time when I use it to send statements from an R or Rmd file. I just need to manually open Terminus window.
  • (Outdated) R-Box. R-Box is succeeded by R-IDE
    • Cannot Uninstall R-box. You could remove it manually - Run Browse Packages and then go to User/R-Box and remove the menu file. (it works)
  • In summary for a new sublime session
    • Open Terminus (Shift + CMD + p) by typing "Terminus: Open Default Shell in Tab (View)"
    • cd $ProjectFolder (can I edit Project Setting to automate this process?)
    • Type "R"
    • Open an R/Rmd file. Make sure Terminus is where "SendCode" will send code (Shift + CMD + p, SendCode: Choose Program - Terminus). Now I can use CMD + Enter to send a line or a function to Terminus.

radian: alternative R console

https://github.com/randy3k/radian. Written in Python.

  • q() will not ask to save the workspace
  • up arrow key will recall the command in chunks rather lines
  • We can change the color scheme from 'native' (operator "<-" is grey) to 'fruity' (operator "<-" is grey) or 'monokai' (operator "<-" is red) or 'vim' (operator "<-" is blue, hide comments)for dark scheme. Default seems OK.
  • If we try to change the default prompt, it will lose all the features. See Update radian prompt e.g. via options() #270.

Rmd file and R-IDE

  • (2021) *Scientific writing made easy - Sublime and R-IDE. This will add R-IDE to the menu bar.
    • I found when I edit an rmd file, sublime recognized it as a text file. So I need to click on the bottom right corner and select R Markdown as a language syntax. After the change, SendCode works again. Once I've done this one time, a new rmd file will be recognized as R Markdown automatically.
  • R-IDE: Make Sublime Text a perfect IDE for R
  • It seems R-IDE provides a menu to give shortcuts to render R Markdown to HTML/PDF. Many (9) menu items related to package development are grayed out for some reasons.
  • (2015, outdated) R Markdown: Syntax Highlighting for Sublime Text. Install package -> type "r-box". (Re)load Rmd files. This will add R-Box to the menu bar.
  • Compare to RStudio, R-IDE still cannot
    • Quickly jump to one chunk
    • Preview figure files in Rmd files without knitting them

Memory requirement

On my mac, it uses only 55MB when running Sublime without turning on R. So I can leave Sublime on and use it as an R console at any time.

If we use RStudio IDE with Docker, the total memory allocation used by Docker can be controlled in Docker Desktop Settings/Resource (the default is 2 GB). If we check the process com.docker.hyperkit in system monitor we can see its memory usage is close to (a litter larger than) the specified value.

Graphics Device (Quartz)

Don't 'x' the graphics window/tabs. If you x the graphics window, it will trigger *** caught segfault *** and forcibly to take one of possible actions: 1: abort (with core dump, if enabled) 2: normal R exit 3: exit R without saving workspace 4: exit R saving workspace

The graphics device will be closed automatically when you exit R in Terminus.

nano editor

Build/upgrade it

wget https://www.nano-editor.org/dist/v4/nano-4.2.tar.gz
sudo nano /etc/apt/sources.list # Uncomment 'deb-src http://us.archive.ubuntu.com/ubuntu/ xenial main restricted'
                                # The source package is at 'main'. See https://packages.ubuntu.com/xenial/nano
sudo apt-get build-dep nano
sudo apt-get install libmagic-dev
tar -xzvf nano-4.2.tar.gz
cd nano-4.2
./configure --enable-utf8
make
sudo apt-get remove nano
sudo make install
# In case we want to remove the manually installed nano
# sudo apt-get autoremove nano
# sudo rm /etc/nanorc
  • Tested using nano 3.2 on CentOS 7.6.
./configure --prefix=/home/USERNAME/bin/nano
make
make install
nano  ~/.bashrc
# alias nano="~/bin/nano/bin/nano -c --softwrap"

Change as default editor

Keyboard shortcuts

Actually there is no need to memorize them because the common shortcuts are always displayed at the bottom of the screen (ctrl+g to get more).

  • Ctrl+c: cur pos
  • Ctrl+y: prev screen
  • Ctrl+v: next screen
  • Ctrl+k: cut
  • Ctrl+u: paste
  • Ctrl+w: search. Alt+w: find next occurrence
  • Ctrl+q: search backward. Alt+q: find next occurrence backward
  • Ctrl+r: insert another file at cur
  • Alt+r: search and replace
  • Alt+u (Option+u): Undo [There is a hint at bottom right, M-u where M stands for meta]. Require nano 2.3.5 (2014)
  • Alt+e (Option+e): Redo

Modern keybind shortcuts

  • If we use nano in a browser, Ctrl+w means a search but it also means to close a tab in a browser.
  • One solution is to use F6 and forget Ctrl+w.
  • Modern Nano Keybindings.

Permission denied and sudoedit command

When I run 'nano tmp', I got a message: Error reading /home/odroid/.nano/search_history: Permission denied. Press Enter to continue.

odroid@odroid:~$ ls -ld /home/odroid/.nano
drwxr-xr-x 2 root root 4096 Feb 12 08:01 /home/odroid/.nano
odroid@odroid:~$ ls -l /home/odroid/.nano
total 4
-rw------- 1 root root 15 Feb 12 08:01 search_history

A simple solution is

sudo chown -R odroid:odroid /home/odroid/.nano  # note '-R' has to be capital

This seems to be a bug in nano after we use 'sudo nano [file]' (eg 'sudo nano /etc/chromium-browser/default') when the 'nano' program has not been run before.

The bottom line is use something like below for editing system files

EDITOR=nano sudoedit /etc/chromium-browser/default

Enable soft line wrapping

nano -$ FILENAME
nano --softwrap FILENAME

Not that

  1. "-$" is the same as "--softwrap". The option "-s" has a different meaning; see below.
  2. "-s program" means to use this alternative spell checker command.
  3. these options are not available on the NIH/Biowulf. I need to use emacs/vi/joe. The keyboard shortcuts for joe can be found here.

show line number/cursor position

PS for Mac

  • it seems nano on MacOS does not work even I installed it through homebrew (brew install nano).
  • I need to modify ~/.zshrc and add a line PATH=$PATH:/opt/homebrew/Cellar/nano/7.2/bin

Use the -c option for cursor position.

nano -c FILENAME

This does not add line numbers on the left hand side.

Show line number on the left hand side like vi & .nanorc

  • Alt/option + n (according to the help Ctrl+g where 'Alt' is the meta key (option), on mac) OR Shift + Alt + 3
  • Add set linenumbers to .nanorc to make it permanent. So my ~/.nanorc looks like
    set linenumbers
    set softwrap
    include /usr/share/nano/sh.nanorc
    include /usr/share/nano/c.nanorc
    include ~/bin/r.nanorc
    

See

syntax highlight & .nanorc

Add a syntax highlight support for some languages

$ ls /usr/share/nano/
asm.nanorc    html.nanorc  mutt.nanorc    perl.nanorc    ruby.nanorc
c.nanorc      java.nanorc  nanorc.nanorc  pov.nanorc     sh.nanorc
groff.nanorc  man.nanorc   patch.nanorc   python.nanorc  tex.nanorc
$ cat ~/.nanorc
include /usr/share/nano/sh.nanorc
include /usr/share/nano/c.nanorc
include ~/r.nanorc

Note that on mac, replace /usr/share/nano/ with /usr/local/share/nano/.

R syntax highlight file r.nanorc. Note that I have to comment out line 29 starting with 'header'. A personal copy is saved in github. Grab it using wget https://gist.githubusercontent.com/arraytools/8b52cc749c2fa6d45c16/raw/22af7ac21581604a2418875b4308a6cc65065ddd/r.nanorc -O ~/Downloads/nano-4.2/syntax/R.nanorc

Since I am using my compiled nano, my ~/.nanorc file becomes

set linenumbers
set softwrap
include ~/Downloads/nano-4.2/syntax/sh.nanorc
include ~/Downloads/nano-4.2/syntax/c.nanorc
include ~/Downloads/nano-4.2/syntax/R.nanorc

To disable syntax highlight (useful if we use a terminal app on an Android ebook reader such as Boox), add -Ynone parameter.

Delete multiple lines

Nano does not delete lines. It only cuts lines.

ctrl + shift + 6 to mark the beginning of the block and use mouse to mark the end of the block. Hit ctrl+k to cut lines.

vim editor

  • What is the difference between Vi and Vim?. Vim is much better than vi.
    • On Mac, vi is soft linked to vim.
    • On Debian 11, vi is a soft link to vim. But it is strange when I enter an edit mode, the screen does not show the text -- INSERT --. But after I run "apt install vim", then when I use vi the screen can show the text -- INSERT -- even the vim version is not changed!
  • Getting started with Vim: The basics. Three major modes
    • Normal: Default; for navigation and simple editing. Click 'Esc' to go back to the normal mode.
    • Insert: For explicitly inserting and modifying text. The screen will show the text -- INSERT -- on the last line of the vim editor (vi editor does not have this function).
    • Command Line: For operations like searching, navigating, saving, exiting, etc. Pressing the colon in Normal mode switches Vim to Command Line mode.
    • Last line mode: Press ':', vi editor will show ':' on the last line. If we continue to type 'q[Enter]' we will quit vi. If we continue to type 'wq', it will write the file and quits.
  • How to Use Vim: A Guide to the Basics
  • Basic Vim Commands Every Linux User Must Know (Free Cheat Sheet Included)
  • On Debian 11, vi does not show -- INSERT -- at the bottom of screen when it is in an edit mode. But vim or neovim can show -- INSERT --. I use apt install to install "vim".
  • Installing Neovim

One advantage over nano

When I copy text (say from a shell script), long line won't break when I paste it to a terminal. Even I copy the text from the output of "cat" command, it has the same problem.

Keys

  • quit without saving: ":q!"
  • save and quit: ":x" or ":wq" (note that ":qw" won't work; you want to write and then quit!)
  • Page down: ctrl +f. Page up: Ctrl +b
  • ^: beginning of a line. $: end of a line.
  • Moving around
    • line beginning: "0"
    • line end: "$"
    • last row: "G"
  • delete a character under the cursor: "x". Delete the remainder of line: "D". Delete entire line: "dd"
  • undo: "u"
  • search forward: "/pattern" (case sensitive). Hit "n" to repeat search.
  • Highlight search ":set hlsearch". To disable highlight ":set nohlsearch"
  • search backward: "?pattern" (case sensitive). Hit "n" to repeat search.
  • save: ":w"
  • quit: ":q"
  • Run external command ":! command"
  • Display line numbers ":set nu" or ":set number". To hide the line numbers ":set nonu" or ":set nonumber". Add "set number" to your .vimrc file in your home directory.
  • Ignore cases when searching ":set ic"

Some helps

color schemes

On my Mint 18.2, the color syntax is off. It does not work if I try to enable it.

The solution is install vim (sudo apt-get install vim). After that, the syntax highlight works automatically; no need to turn it on manually.

To change the color scheme on-the-fly, type :colorscheme then Space followed by TAB. The 'darkblue' looks cool.

The list can be found at /usr/share/vim/vimNN/colors.

On Raspbian OS , we should use the method described here. That is, sudo nano /etc/vim/vimrc and uncomment out the line containing syntax on.

plugin

On Mac, I need to run mkdir ~/.vim/plugin'. Then I can put the downloaded .vim file (e.g. R syntax highlight) there.

Also I may need to modify ~/.vimrc file by adding some options,

syntax on
filetype plugin on

How to Install a Plugin In Vim

view: read-only mode

  • ctrl+f - forward next page
  • ctrl+b - backward
  • :q - quit

Nvim-R

neovim

micro

Theme

Write or Code Faster in Your Linux Text Editor With Custom Themes

Visual Studio Code/VS code

Use significant energy

I saw the message from the battery icon on my mac computer. It's also reported by other people.

VscodeEnergy.png

VS Code vs VS Codium

Change to use as the default text editor

Visual Studio Code on Linux

xdg-mime default code.desktop text/plain

Untitled tab

New Project

File → New Window. Open folder...

Workspace

Manage multiple projects

Activity Bar (User Interface): left most

This is the bar on the left hand side. See User Interface. We can toggle it use View > Appearance.

The Activity Bar on the left lets you quickly switch between Views. You can also reorder Views by dragging and dropping them on the Activity Bar or remove a View entirely (right click Hide from Activity Bar). By default, it contains Explorer, Search, Git, Debug and Extensions.

If you right click on the Activity Bar, we can see a right-click menu for several options.

The 'gear' icon at the bottom shows a bunch of shortcuts: Command Palette, Settings, Extensions, Keyboard Shortcuts, User Snippets, Color Theme, File Icon Theme and Check for Updates.

Disable check for updates

How do I disable VS Code of updating itself? Settings. Search "update". Change of value of "update.mode" from default to "none".

Explorer: left pane (OUTLINE view, switch open files)

https://code.visualstudio.com/docs/getstarted/userinterface#_explorer

I can use it to switch opened files through OPEN EDITORS.

It has an OUTLINE view On the left bottom corner. Useful for me to switch to any section of my document. I need to click "..." to change to sort by position.

Code navigation

  • Code Navigation
    • Ctrl + Tab
    • Breadcrumbs (navigation bar above its contents. It shows the current location and allows you to quickly navigate between folders, files, and symbols.)
    • Go to Definition
    • Go to Symbol

Set up for R

  • How to set up VSCode for R (7/22/2021) from IDG Techtalk and the article.
  • My recommendations of VS Code extensions for R and more topics on https://renkun.me/
  • (2023/5/19)
  • (2023/12/31)
    • install.packages("languageserver")
    • In VS code, click on the "Extensions" icon on the LHS, type "R" and install the 1st one R Extension for Visual Studio by REditorSupport. After that, we can click the "Extensions" icon again to hide the left panel.
    • Open an R file in VS Code
    • Click menu -> Terminal -> New Terminal. This will open a Terminal at the bottom of VS Code. Alternatively, you could create an R terminal via command R: Create R terminal in the Command Palette.
    • Move mouse cursor to one R statement in the R file. Use "Ctrl + Enter" to open an R terminal and send R statements to the terminal.
    • If I want to run the code in a different R, I can open that specific R in the Terminal. After that, R statements will be sent to that specific version of R.
    • R graphics will be generated on a new window. So it is more convenient to use httpgd. install.packages("httpgd") . See Getting Started guide.
      library(httpgd)
      hgd()
      hgd_browse()
      ...
      dev.off() # stop the server
    • R Markdown All in One extension
    • radian. It can give syntax highlighting on R terminal. Need Python to install it. After install radian, go to R extension settings. Fill out "R > Rterm: Mac" (if we are using Mac) with the path to radian. Also remove "R > Rterm: Option". Check the option of "R: Bracketed Paste". And more need to be taken care.

R markdown files

  • R Markdown in VS Code. Chunk navigation (Left side panel), chunk execution, Live preview of rmd. See the gif images on the wiki.
  • How to launch a specific version of R from the terminal? We can do that by for example,
/Library/Frameworks/R.framework/Versions/4.2-arm64/Resources/R
  • How to review the outline of `.rmd` file in vs code? If you don't want to do install any extensions you can just simply go to the status bar and click on Plain Text and select Markdown from the menu that pops up and that will generate the outline treating the file as a Markdown file.
    • CMD + b (mac) OR Ctrl+b (Windows/Linux) to hide/show the sidebar panel (~Activity Bar). In the sidebar panel, it shows EXPLORER on top. Under it, we have a dropdown for the current directory and a dropdown for OUTLINE
    • We can use the left-most icon shown on top-right corner.
    • We can use View -> Appearance -> toggle "Primary Side Bar"
    • See also Visual Studio Code -> User Interface for beginners. We can see "Activity Bar" != "Side bar". We can hide Activity Bar on the left-hand-side by View -> Appearance -> Activity Bar Position.
    "workbench.colorCustomizations": {
        "editorError.foreground":   "#00000000",
        "editorWarning.foreground": "#00000000",
        "editorInfo.foreground":    "#00000000"
    }

R markdown outline preview

  • Enable eval=T in "knitr::opts_chunk$set(echo = TRUE, eval = FALSE)"
  • Click the second from the top-right list of icons: Open Preview to the Side. This will knit the document. However, the scrolling of the source code and the preview window are not synchronized. It means the preview is not a live preview (Markdown can do this, but markdown file type will lose the send code functionality).

Markdown preview

use the Command Palette (Ctrl+Shift+P) to run the Markdown: Open Preview to the Side command.

Tab to space conversion

How can I customize the tab-to-space conversion factor?. Take a look at the bottom right-hand side of the screen. You should see something that says Spaces or Tab-Size. For the HTML file I am editing, I need to change the spaces from the default 4 to 8. Note that the spacing of HTML file edited by using nano or vi looks the same (a tab represents 8 spaces).

Markdown TOC (table of contents) extension

https://marketplace.visualstudio.com/items?itemName=AlanWalk.markdown-toc and Github page

  1. Follow the instruction here to fix a problem of extra 'autoauto' words in TOC
    • File > Preferences > Settings
    • Filter setting by typing 'eol'
    • Make appropriate changes ('auto' to '\n')
  2. Modify the setting to start the level from 2 instead of 1. Change the anchor mode from Github to Bitbucket.

Python Extension

Docker Extension

Live Server extension

Live Server extension and github

Hide the left most pane/side bar

Use mouse to drag the boundary between two panes. Once one pane is too narrow, it will disappear.

Command palette

Ctrl + Shift + p. Or View -> Command Palette.

From there we can quickly try different color theme (use arrow key to select but do not use mouse to click). See the video VS Code - Customization.

Color theme

  • https://code.visualstudio.com/docs/getstarted/themes, especially "Color themes from the marketplace". I choose "vibrant ink".
  • View - Command Palette - Preferences Settings.json. This will open the user's settings.
  • View - Command Palette - Preferences "Color theme" - Pick one of color scheme. You will see a change in the "settings.json" file in the editor.

Themes

Sublime where the text editor panel is dark but the taskbar on the LHS is light.

Open a file from the command line

macOS instruction. Press "F1" or Shift + CMD + p and type "shell Command" to find the Shell Command: Install 'code' command in PATH command.

This will create a soft link file </usr/local/bin/code> which links to </Applications/Visual Studio Code.app/Contents/Resources/app/bin/code>.

Restart the terminal for the new $PATH value to take effect.

You'll be able to type code FileName in any folder to start editing files in Visual Studio Code.

Integrated Terminal

R and code remotely

  • R Extension for Visual Studio Code by Yuki Ueda
    • install.packages("languageserver") # need to install on the remote server
    • Click the brick icon on LHS & type ext:R, install R extension for VS. Or we can follow the instruction on the extension web page (1 time only on my local machine)
    • Ctrl + Shift + P (or View → Command Palette) and choose R: create R terminal
    • Select lines and Ctrl + Enter to send the code to R terminal (cursor will auto move to the next line)
    • For some reason, it just add another empty line in the source panel without sending the line.
  • https://github.com/REditorSupport/vscode-R/wiki
  • How to enable using R Programming with Visual Studio VS Code
    • Source (Ctrl + Shift + S)
    • Run selected lines (Ctrl + Enter). It works!
    • On Mac, Ctrl = CMD
  • Note it is possible to show HTML help (top right pane) by clicking R icon on the sidebar and clicking HELP PAGES -> HOME). It is also possible to use rmarkdown::run("XXX.Rmd") to show a shiny app (it's shown next to my Rmd file) in VS code.

VscodeR.png

Toggle between editor and terminal

Toggle Sidebar

Ctrl + b. Or View -> Appearance -> Toggle Side Bar.

Disable wavy underline

Disable wavy underline in VS Code

To open settings.json file, click File -> Preferences -> Settings. Type workbench.colorCustomizations to search. It will show Workbench: Color Customizations from the only 1 match. It'll also show a link to Edit in settings.json. Click on it and insert the following 3 lines and switch to the original file and the wavy underline will be gone.

        "editorError.foreground":   "#00000000",
        "editorWarning.foreground": "#00000000",
        "editorInfo.foreground":    "#00000000"

From the VS Code, it shows the file is located at ~/.config/Code/User/settings.json on Linux and ~/Library/Application Support/Code/User/settings.json on macOS.

Cloud/server IDE

Coding remotely

ChatGPT/copilot

Notepad ++

Add line breaks in large XML file in one line

Notepad Next

Notepad Next is a Reimplementation of Notepad++ for Linux Users

Text editor with navigation

7 Best Note-Taking Tools for Programmers

http://www.makeuseof.com/tag/best-note-taking-tools-programmers/

RStudio

Code -> Insert Section

We can create different levels of sections.

Netbeans and navigator

On ODroid (ARM works too!) Ubuntu 16.04

# Note: OpenJDK 8 will not work
# We have to install Oracle Java
sudo add-apt-repository ppa:webupd8team/java
sudo apt-get update
sudo apt-get install oracle-java8-installer

sudo apt-get install netbeans # version 8.1 in my case

See screenshots

Note:

  • Netbeans has a built-in support for HTML/XML files. XML has an advantage over HTML since HTML cannot have any tags you want.
  • We need to download a plugin for markdown file support. Go to Tools -> Plugins. In the 'Settings' tab make sure the 3 items are checked. Go to 'Available plugins' tab

search 'markdown'. Install 'Markdown support'. It works on Netbeans 8.0 on x64 Ubuntu 14.04 and Netbeans 8.1 on my ARM Ubuntu 16.04.

  • For Markdown or XML, the comment syntax can be found here.
  • For some reason, the order of headlines on the navigator pane is not the same as they appeared on the file. So it is better to use XML file format.
  • My hack on Netbeans options (change to use a dark color on background).
    • Profile: NetBeans
    • Syntax. Default: Foreground=White, Background=Dark Gray. Comment: Foreground=cyan. Keyword: Foreground=Orange.
    • Highlighting. Highlight Caret Row: Foreground=Dark Gray. Background=Pink.
  • For choosing colors, go to Google: rgb to hex
  • For some reason, it makes my graphical Mint desktop unstable. I have to use Ctrl + Alt + F1 and Ctrl + Alt + F8 to fix it temporarily. Deal breaker!

Netbeans.png NetbeansMarkdown.png

IntelliJ IDEA

It requires JDK. The community version is free. Download the tarball. Extract it and run bin/idea.sh. It even identifies a mismatch in my XML documentation that netbeans does not find.

  • Viewing Structure of a Source File or Alt + 7
  • Open a terminal at the bottom; Alt + F12
  • SOLARIZED color. Copy icls file to ~/.IdeaIC2016.2/config/colors directory. Restart Intellij IDEA. Go to File -> Settings -> Editor -> Colors & Fonts -> Font.
  • To deactivate spelling checking: Ctrl + Alt + s -> Editor -> Inspections -> Spelling -> Typo. Uncheck it.
  • We need to create a project for IntelliJ IDEA to automatically open the file we are working on. IDEA will create a hidden folder call .idea. For git repository, we shall create the .gitignore file contains
.idea/workspace.xml
.idea/misc.xml

Zim

  • Available in Linux, Windows & Mac.
  • The side panel contains a hierarchical view of the pages.
  • Right click on the page tab, we can create a new page or sub page.
  • On Ubuntu, the title bar is on the top of the desktop.
  • Auto save. Auto re-open the last session.
  • Handles several types of markup, like headings, bullet lists and of course bold, italic and highlighted. This markup is saved as wiki text so you can easily edit it with other editors.
  • Toggle notebook editable.
  • Insert image (cannot resize)
  • Plugins, e.g. Equation editor, R plot,
  • The default folder for storing the notes is ~/Notebook. Each page has its own file in storage.
~/Notebooks/Notes/
~/Notebooks/Notes/notebook.zim
~/Notebooks/Notes/Home.txt

If we create a 2nd page called 'Home2' with sub pages 'Subpage1' and 'subpage2' we will have

~/Notebooks/Notes/Home2.txt
~/Notebooks/Notes/Home2
~/Notebooks/Notes/Home2/subpage1.txt
~/Notebooks/Notes/Home2/subpage2.txt

Cherrytree - a hierarchical note taking application

featuring rich text and syntax highlighting, storing data in a single xml or sqlite file.

Vim

with the Tagbar plugin.

The instruction works for cpp file.

Unfortunately xml files are not supported from my testing. See its wiki for supported filetypes.

Lime

Maybe

Note taking

Best Note Taking Apps for Linux (some of them are cross-platform)

Online IDEs

The 13 Best Browser IDEs Every Programmer Should Know About