Collaborative Emacs: Difference between revisions

Latest revision as of 15:16, 1 November 2023

When collaborating on a project, all kinds of problems can occur. In particular, version conflicts can be difficult to resolve and can be interruptive of a workflow. For this problem (and others), version control systems like Git may be used. (Not needed for this page)

Moreover, while collaborating it might be nice to see each other's changes in real time: a particularly difficult case of version control. To this end, the CRDT datastructure can be used. Several editors have an implementation of CRDT to allow for collaboration.

This page focusses on CRDT collaboration with Emacs. Emacs opens in the terminal, and hence this guide allows for collaborative work live on the server.

Step by step guide

The following is a step by step guide to setting up a collaboration session within Emacs. It assumes the user is in a terminal.

Connect to chochop:
1. ssh USERNAME@145.24.139.16 (or to any other address you'd want to ssh to), press return.
2. Enter your password, press return.
Open emacs:
1. Enter emacs. Press return.
IF THIS IS YOUR FIRST TIME COLLABORATING THROUGH EMACS: Install the CRDT package:
1. If you are using MacOS, perform the following steps. Otherwise, skip to 3.2
  1. Go to terminal settings.
  2. Go to profile.
  3. Check the box 'Use Option as Meta Key'.
  4. Close the terminal settings, so that the terminal is in focus again.
2. Press Alt+X (or for MacOS Option+X).
3. Enter package-install, press return.
4. Enter crdt, press return.
IF YOU ARE HOSTING A SESSION:
1. Press Control+X Control+F.
2. Type in the path for the file you want to share, press return.
3. Press Alt+X.
4. Type crdt-share-buffer, press return.

IF YOU ARE JOINING A SESSION:
1. Press Alt+X
2. Use crdt-connect, press return.
3. Fill in the open parameters:
  1. For URL, enter: localhost:6530.
  2. For Display, enter: USERNAME.
  3. Press return.
4. Select the the file you want to work on:
  1. Use the arrow keys to move to the file you want to work on.
  2. Press return.

You should now be able to collaborate! Should being the operative word.... This works in duos, maybe not in groups of six...

@@ Line 1: / Line 1: @@
 When collaborating on a project, all kinds of problems can occur. In particular, version conflicts can be difficult to resolve and can be interruptive of a workflow. For this problem (and others), version control systems like [[Git]] may be used. (Not needed for this page)
-Moreover, while collaborating it might be nice to see eachother's changes in real time: a particularly difficult case of version control. To this end, the [https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type CRDT] datastructure is created. Several [[HTML_%2B_CSS#code_editors|editors]] have an implementation of CRDT to allow for collaboration.
+Moreover, while collaborating it might be nice to see each other's changes in real time: a particularly difficult case of version control. To this end, the [https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type CRDT] datastructure can be used. Several [[HTML_%2B_CSS#code_editors|editors]] have an implementation of CRDT to allow for collaboration.
-This page focusses on CRDT collaboration with Emacs. Emacs open in the terminal, and hence this guide allows for collaborative work live on the server.
+This page focusses on CRDT collaboration with Emacs. Emacs opens in the terminal, and hence this guide allows for collaborative work live on the server.
-=Step by step guide=
+===Step by step guide===
 The following is a step by step guide to setting up a collaboration session within Emacs. It assumes the user is in a terminal.
 # Connect to chochop:
-## <code>ssh USERNAME@145.24.139.16</code> (or to any other address you'd want to <code>ssh</code> to)
+## <code>ssh USERNAME@145.24.139.16</code> (or to any other address you'd want to <code>ssh</code> to), press return.
-## Enter your password
+## Enter your password, press return.
 # Open emacs:
-## Enter <code>emacs</code>
+## Enter <code>emacs</code>. Press return.
 # <b>IF THIS IS YOUR FIRST TIME COLLABORATING THROUGH EMACS:</b> Install the CRDT package:
 ## If you are using MacOS, perform the following steps. Otherwise, skip to 3.2
-### Go to terminal settings
+### Go to terminal settings.
-### Go to profile
+### Go to profile.
-### Check the box 'Use Option as Meta Key'
+### Check the box 'Use Option as Meta Key'.
-## Press <code>Alt+X</code> (Mac <code>Option+X</code>)
+### Close the terminal settings, so that the terminal is in focus again.
-## Enter <code>package-install</code>
+## Press <code>Alt+X</code> (or for MacOS <code>Option+X</code>).
-## Enter <code>crdt</code>
+## Enter <code>package-install</code>, press return.
-# <b>IF YOU ARE THE HOST OF THE SESSION:</b>
+## Enter <code>crdt</code>, press return.
-## Press <code>Control+X Control+F</code>
+# <b>IF YOU ARE HOSTING A SESSION:</b>
+## Press <code>Control+X Control+F</code>.
 ## Type in the path for the file you want to share, press return.
-## Press <code>Alt+X</code>
+## Press <code>Alt+X</code>.
-## Type <code>crdt-share-buffer</code>
+## Type <code>crdt-share-buffer</code>, press return.
-## Press return
 # <b>IF YOU ARE JOINING A SESSION:</b>
 ## Press <code>Alt+X</code>
-## Use <code>crdt-connect</code>
+## Use <code>crdt-connect</code>, press return.
-## For URL, enter: <code>localhost:6530</code>
+## Fill in the open parameters:
-# For Display, enter: <code>USERNAME</code>
+### For URL, enter: <code>localhost:6530</code>.
-# Select the the file you want to work on:
+### For Display, enter: <code>USERNAME</code>.
-## Use the arrow keys to move to the file you want to work on
+### Press return.
-## Press enter
+## Select the the file you want to work on:
+### Use the arrow keys to move to the file you want to work on.
+### Press return.
 You should now be able to collaborate!
 Should being the operative word.... This works in duos, maybe not in groups of six...
 [[Category:Protocol]]
+[[Category:Wordhole]]