update

- updated text for Windows
C2DH · Jul 2, 2024 · 16b8116 · 16b8116
1 parent fc78f51
commit 16b8116
Showing 1 changed file with 45 additions and 18 deletions.
diff --git a/examples/Author_Guideline/AuthorGuideline-windows-raw.ipynb b/examples/Author_Guideline/AuthorGuideline-windows-raw.ipynb
@@ -70,13 +70,13 @@
     "tags": []
    },
    "source": [
-    "Here is an overview of the steps to setup the writing environment to start writing:\n",
+    "Here is an overview of the steps to setup the writing environment:\n",
     "1. install [Docker](https://www.docker.com/products/docker-desktop/)\n",
     "2. install [Github](https://desktop.github.com/)\n",
     "3. Github: clone [jupyter-stack](https://github.com/C2DH/journal-of-digital-history-jupyter-stack)\n",
     "4. Console: `docker-compose up`\n",
     "5. Docker: open Jupyterlab in browser\n",
-    "6. enter [Zotero key](https://www.zotero.org/settings/keys/new)\n",
+    "6. enter [Zotero key](https://www.zotero.org/settings/keys/new) to use references\n",
     "7. use JDH template for Python or R"
    ]
   },
@@ -96,7 +96,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 1,
    "id": "6cb6f5f7-9626-4a10-87ab-42f637539699",
    "metadata": {
     "editable": true,
@@ -123,7 +123,7 @@
        "        "
       ],
       "text/plain": [
-       "<IPython.lib.display.VimeoVideo at 0x7fefc43d7690>"
+       "<IPython.lib.display.VimeoVideo at 0x7f529cb7d850>"
       ]
      },
      "metadata": {
@@ -173,7 +173,7 @@
    "id": "f9d8e663",
    "metadata": {},
    "source": [
-    "ℹ️ For writing articles, we use [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/) as it's the best tool to create and share documents that contain live code, media and text."
+    "> ℹ️ For writing articles, we use [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/) as it's the best tool to create and share documents that contain live code, media and text."
    ]
   },
   {
@@ -185,7 +185,7 @@
     ]
    },
    "source": [
-    "ℹ️ To install Jupyter Lab on your device, we use [Docker](https://www.docker.com/). This tool helps us to set up the JDH writing environment wrapped in a lightweight execution environment called _containers_.<"
+    "> ℹ️ To install Jupyter Lab on your device, we use [Docker](https://www.docker.com/). This tool helps us to set up the JDH writing environment wrapped in a lightweight execution environment called _containers_.<"
    ]
   },
   {
@@ -199,7 +199,7 @@
     "tags": []
    },
    "source": [
-    "**Step 1:** Download and install [Docker Desktop](https://www.docker.com/products/docker-desktop/) for Windows"
+    "#### **Step 1:** Download and install [Docker Desktop](https://www.docker.com/products/docker-desktop/) for Windows"
    ]
   },
   {
@@ -228,7 +228,7 @@
     "tags": []
    },
    "source": [
-    "**Step 2:** Download and install [Github Desktop for Windows](https://desktop.github.com/)"
+    "#### **Step 2:** Download and install [Github Desktop for Windows](https://desktop.github.com/)"
    ]
   },
   {
@@ -242,15 +242,15 @@
     "tags": []
    },
    "source": [
-    "ℹ️ As a next step you need to connect a repository, a place where all your data is stored in one place. A repository (or repo) is a storage location for software packages. We use the code hosting platform Github which enables version control and collaboration.\n"
+    "> ℹ️ As a next step you need to connect a repository, a place where all your data is stored in one place. A repository (short 'repo') is a storage location for software packages. We use the code hosting platform Github which enables version control and collaboration.\n"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "85d848c4-8785-4590-a33c-78f91327c18a",
    "metadata": {},
    "source": [
-    "- Sign in or sign up for an account."
+    "- [Sign in](https://github.com/login) or [sign up](https://github.com/signup) for an account."
    ]
   },
   {
@@ -264,7 +264,7 @@
     "tags": []
    },
    "source": [
-    "**Step 3:** Clone the [jupyter-stack](https://github.com/C2DH/journal-of-digital-history-jupyter-stack)"
+    "#### **Step 3:** Clone the [jupyter-stack](https://github.com/C2DH/journal-of-digital-history-jupyter-stack)"
    ]
   },
   {
@@ -286,15 +286,15 @@
    "id": "cdaae355-e6f3-4fe9-bf60-988cd46d5eb6",
    "metadata": {},
    "source": [
-    "**Step 4:** Connect the jupyter-stack with Docker via the console using `docker-compose up`"
+    "#### **Step 4:** Connect the jupyter-stack with Docker via the console using `docker-compose up`"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "2021a6e7-7c59-4a4c-856f-5b0644cf08bb",
    "metadata": {},
    "source": [
-    "- Open Docker, (read and) accept their service agreement. And sign in or sign up.\n",
+    "- Open Docker, (read and) accept their service agreement. And sign in or sign up for an account.\n",
     "- In Github Desktop select _Show in Explorer_. Copy the path of the folder location (Ctrl + C).\n",
     "- Open the console or PowerShell, use the command `cd` and paste (Ctrl + V) the path. Press Enter to execute.\n",
     "- Enter `docker-compose up` and press Enter. Wait until everything has been downloaded and executed. "
@@ -305,7 +305,7 @@
    "id": "22b21193",
    "metadata": {},
    "source": [
-    "**Step 5:** Start the Docker container and open Jupyterlab in browser"
+    "#### **Step 5:** Start the Docker container and open Jupyterlab in browser"
    ]
   },
   {
@@ -314,25 +314,52 @@
    "metadata": {},
    "source": [
     "- Expand the container, press the _container actions_ menu and select _Open with browser_\n",
-    "- A new browser tab will open to start Jupyter Lab"
+    "- A new browser tab will open to start Jupyter Lab and ask for the Token authentication\n",
+    "- Copy (Ctrl + C) the token from the console and paste it into the browser (Ctrl + V)"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "43e77594-14b0-4818-b225-41eedea5a776",
    "metadata": {},
    "source": [
-    "Step 6: Connect with [Zotero](https://www.zotero.org/settings/keys/new) and enter a new API key"
+    "#### **Step 6:** Connect with Zotero and enter a API access key"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "561a9842-fc9d-4053-a317-5159403508b9",
+   "metadata": {},
+   "source": [
+    "> ℹ️ For citation management, we use the plugin [citation-manager](https://github.com/krassowski/jupyterlab-citation-manager). It connects Zotero libraries to the notebook and inserts the citations into the markdown cells. The citations are stored in the notebook metadata and references by an ID. It also renders a bibliography and inline citations."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "952f5a96-04d7-4b93-8658-1659c5b38ad8",
+   "metadata": {},
+   "source": [
+    "> ℹ️ [Zotero](https://www.zotero.org/) is an open-source reference management software to manage bibliographic data and related research material. "
    ]
   },
   {
    "cell_type": "markdown",
-   "id": "f34de7e8",
+   "id": "55f3ecaf-de99-4d0c-b4ab-3ba515aefe23",
    "metadata": {},
    "source": [
-    "### Use the JDH template notebook"
+    "- Jupyter Lab is opened in the browser and requests to enter the Zotero API Access Key\n",
+    "- navigate to [Zotero Settings](https://www.zotero.org/settings/keys/new) and select tab Feeds/API\n",
+    "- Create new private key, give it a description and save key\n",
+    "- Copy the newly generate key (select and Ctrl + C), navigate back to Jupyterlab and paste (Ctrl + V) the key\n",
+    "- Select 'Approve and synchronize'"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "7f196cff-ab4d-4d22-bbc4-9c3235b7fef5",
+   "metadata": {},
+   "source": []
+  },
   {
    "cell_type": "markdown",
    "id": "54516d43",