Add documenation for article

okfn · Sep 22, 2023 · b6bd24f · b6bd24f
1 parent e62f3df
commit b6bd24f
Show file tree

Hide file tree

Showing 16 changed files with 90 additions and 0 deletions.
diff --git a/portal/src/content/docs/documentation/assets/working-with-articles/article-add.png b/portal/src/content/docs/documentation/assets/working-with-articles/article-add.png
diff --git a/...tent/docs/documentation/assets/working-with-articles/article-ai-edit-output.png b/...tent/docs/documentation/assets/working-with-articles/article-ai-edit-output.png
diff --git a/...src/content/docs/documentation/assets/working-with-articles/article-ai-edit.png b/...src/content/docs/documentation/assets/working-with-articles/article-ai-edit.png
diff --git a/...ontent/docs/documentation/assets/working-with-articles/article-ai-generated.png b/...ontent/docs/documentation/assets/working-with-articles/article-ai-generated.png
diff --git a/portal/src/content/docs/documentation/assets/working-with-articles/article-ai.png b/portal/src/content/docs/documentation/assets/working-with-articles/article-ai.png
diff --git a/...docs/documentation/assets/working-with-articles/article-markdown-attributes.png b/...docs/documentation/assets/working-with-articles/article-markdown-attributes.png
diff --git a/...rc/content/docs/documentation/assets/working-with-articles/article-metadata.png b/...rc/content/docs/documentation/assets/working-with-articles/article-metadata.png
diff --git a/...content/docs/documentation/assets/working-with-articles/article-save-revert.png b/...content/docs/documentation/assets/working-with-articles/article-save-revert.png
diff --git a/...c/content/docs/documentation/assets/working-with-articles/article-tag-chart.png b/...c/content/docs/documentation/assets/working-with-articles/article-tag-chart.png
diff --git a/...c/content/docs/documentation/assets/working-with-articles/article-tag-image.png b/...c/content/docs/documentation/assets/working-with-articles/article-tag-image.png
diff --git a/...nt/docs/documentation/assets/working-with-articles/article-tag-map-filename.png b/...nt/docs/documentation/assets/working-with-articles/article-tag-map-filename.png
diff --git a/...src/content/docs/documentation/assets/working-with-articles/article-tag-map.png b/...src/content/docs/documentation/assets/working-with-articles/article-tag-map.png
diff --git a/portal/src/content/docs/documentation/assets/working-with-articles/article-tag.png b/portal/src/content/docs/documentation/assets/working-with-articles/article-tag.png
diff --git a/...c/content/docs/documentation/assets/working-with-articles/article-undo-redo.png b/...c/content/docs/documentation/assets/working-with-articles/article-undo-redo.png
diff --git a/portal/src/content/docs/documentation/assets/working-with-articles/article.png b/portal/src/content/docs/documentation/assets/working-with-articles/article.png
diff --git a/portal/src/content/docs/documentation/working-with-articles.md b/portal/src/content/docs/documentation/working-with-articles.md
@@ -0,0 +1,90 @@
+---
+title: Working With Articles
+sidebar:
+  order: 5
+---
+
+This section explains about how to work with articles in the editor using markdown language. The editor offers both editing and previewing features, which enables you to simultaneously edit and view the article.
+
+## Creating an Article
+
+If you already have article file, just `Click` on the article file in `File Explorer` on the left side of the editor to open the file in the editable form. You can format the article using markdown supported formatting rules.
+
+![ARTICLE](./assets/working-with-articles/article.png)
+
+If you haven't already added the article to the editor, click `ADD` button at the bottom left of the editor as shown below. It will open a file dialog to select the file to upload.
+
+![ADD ARTICLE](./assets/working-with-articles/article-add.png)
+
+## Editing Article
+
+Once you have the file, you can start adding the contents using markdown formatting features. It supports all the formatting elements of the markdown language such as headers, lists, emphasis etc.
+
+![MARKDOWN ATTRIBUTE](./assets/working-with-articles/article-markdown-attributes.png)
+
+To learn more about markdown formatting, refer to this [link](https://www.markdownguide.org/basic-syntax/).
+
+## Including Image
+
+To include image `image.png` in the article, use `@image` tag.
+
+![INCLUDE IMAGE](./assets/working-with-articles/article-tag-image.png)
+
+To include another image `dog.png` simply use `@dog1` tag. The files can be referenced using their unique name displayed in grey color as `@{name}`.
+
+![INCLUDE DOG IMAGE](./assets/working-with-articles/article-tag.png)
+
+## Including Chart
+
+Likewise, if you have a chart and want to include it in the article, you can do so by using `@{name}` tag. Similar to other files, chart is given a unique name, so we can reference them using their name.
+
+![INCLUDE CHART](./assets/working-with-articles/article-tag-chart.png)
+
+## Including Map
+
+Using same tag, you can also include map in the article. To include a map `extinct-dogs.geojson` we use tag
+`@extinct_dogs`. 
+
+![INCLUDE MAP](./assets/working-with-articles/article-tag-map.png)
+
+File name may differ from unique name(identifier), which is displayed in grey color as `@{uniquename}` in the `File Explorer`.
+
+![UNIQUE FILENAME](./assets/working-with-articles/article-tag-map-filename.png)
+
+## Editing Metadata
+
+To edit metadata of the article such as licenses, contributors, sources etc use metadata editor. Click `Metadata` menu on the toolbar to open the editor. To hide the editor, click on the menu again.
+
+![METADATA EDITOR](./assets/working-with-articles/article-metadata.png)
+
+## Undo or Redo
+
+You can undo or redo your last change using `undo` or `redo` feature in the `tools` menu.
+
+![METADATA EDITOR](./assets/working-with-articles/article-undo-redo.png)
+
+## Saving or Reverting
+
+Once you modify the article, you can save the changes using `Save` button. When changes are made, the `Save` and `Revert` button gets activated at the bottom of the editor. If needed, you can revert the changes by clicking the `Revert` button.
+
+![SAVE AND REVERT](./assets/working-with-articles/article-save-revert.png)
+
+The changes can be saved in a different file using `Save As` button.
+
+## Creating / Editing an Article with AI
+
+To generate data using AI, click `Create` button. A `Create File` dialog box will appear. Navigate to the `Article` tab.
+
+![ARTICLE AI](./assets/working-with-articles/article-ai.png)
+
+In `Article` tab, input `filename` and write a data generation command in the `prompt` input box. We use OpenAI's `ChatGPT` large language model API.
+
+![AI GENERATED](./assets/working-with-articles/article-ai-generated.png)
+
+Similarly, you can edit a table content by issuing command to AI. To access this window, select `Chat AI` option from the toolbar menu.
+
+![AI GENERATED](./assets/working-with-articles/article-ai-edit.png)
+
+Enter your instruction to AI in the promt input box and apply the command by clicking the `EDIT` button. The resulting output is as follows:
+
+![AI GENERATED](./assets/working-with-articles/article-ai-edit-output.png)