From 347a52bf5d8007b405a32a613e5dac7ae399eb1c Mon Sep 17 00:00:00 2001 From: "Karsten D. Wolf" Date: Thu, 21 Mar 2024 15:28:34 +0100 Subject: [PATCH 1/3] Update index.js with some first explanations I just added more descriptive descriptions to test, if everything is pushed to the static site. --- src/components/HomepageFeatures/index.js | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/components/HomepageFeatures/index.js b/src/components/HomepageFeatures/index.js index 078b19d..ff5def4 100644 --- a/src/components/HomepageFeatures/index.js +++ b/src/components/HomepageFeatures/index.js @@ -8,7 +8,8 @@ const FeatureList = [ img: 'img/data_collection.png', description: ( <> - Some line on data collection + Here you upload, create or import data.
+ In the Early Access, you can only import .txt and .rtf file types. ), }, @@ -17,7 +18,7 @@ const FeatureList = [ img: 'img/data_preparation.png', description: ( <> - Some lines on data preparation + Here you prepare your data, e.g. you fix typos in your transcripts. ), }, @@ -26,7 +27,7 @@ const FeatureList = [ img: 'img/data_coding.png', description: ( <> - Some lines on coding + Here you code your data and create your code systems. ), }, @@ -35,7 +36,7 @@ const FeatureList = [ img: 'img/data_analysis.png', description: ( <> - Some lines on analysis + Here you analyse your coded data. ), } From 0581bb058536792e70fd94476a4b325321392070 Mon Sep 17 00:00:00 2001 From: "Karsten D. Wolf" Date: Thu, 21 Mar 2024 15:32:49 +0100 Subject: [PATCH 2/3] Update index.js - fixed error MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ok, ok, I thought a
is a good way to insert a line break… --- src/components/HomepageFeatures/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/components/HomepageFeatures/index.js b/src/components/HomepageFeatures/index.js index ff5def4..7da1e34 100644 --- a/src/components/HomepageFeatures/index.js +++ b/src/components/HomepageFeatures/index.js @@ -8,7 +8,7 @@ const FeatureList = [ img: 'img/data_collection.png', description: ( <> - Here you upload, create or import data.
+ Here you upload, create or import data. In the Early Access, you can only import .txt and .rtf file types. ), From f8064c0502a2db7c86a582da6163a42bb7549bb9 Mon Sep 17 00:00:00 2001 From: "Karsten D. Wolf" Date: Sun, 24 Mar 2024 19:05:30 +0100 Subject: [PATCH 3/3] Wrote down the basic steps We need to make and insert screenshots and do short tutorial videos for all of the sections. Also I did not finish the analysis section. --- docs/intro.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 56 insertions(+), 5 deletions(-) diff --git a/docs/intro.md b/docs/intro.md index 92838c8..1d88122 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -4,23 +4,74 @@ sidebar_position: 1 # Introduction to OpenQDA -Let's discover **OpenQDA in less 5 minutes**. +Let's discover **OpenQDA in under 10 minutes**. ## Register a new account -TBD +Head over to [the OpenQDA website at openqda.org](https://openqda.org). + +IMG +Click on the orange **Register** button. + +IMG +Now fill out the register form with your name or pseudonym, your email and a secure password. +Then click the **Register** button. + +IMG +A verification email should appear in your email program. Please click the link for verification. + +IMG +Now that you are verified, you can either edit your profile or create a project. + +## Create your first project + +Your work in OpenQDA is organized in projects. + +IMG +Fill out the project form and give Your first project a nice name (and optionally write a description). +Then click the **Create a new project** button. +Your new project is created, and you go to the project tab. If you want to go back and create more projects or switch between projects, click on the little blue owl in the left corner (this will change in the next version of OpenQDA, because it is not self-evident). + +## Manage your project + +You are now in the project tab of OpenQDA. Here you can change the project name, project description and even delete your project. +In the sub tab **Collaboration** you can set up your project to work with others. We skip this part for now. +In the sub tab **Codebook** you can manage different codebooks, share, reuse and import codebooks from other people. We skip this part also. +In the sub tab **History** you see a full log of all actions within the project. + +BTW, if you want to edit your profile picture, click on the profile picture in the right upper corner, right now it should be your initials, and select profile. Now you can select a new photo for your profile, change your name or password. ## Upload and prepare a text file -TBD +Let's upload and prepare our first text file for coding (right now, OpenQDA only supports RTF and TXT files - NO .doc, .docx or .pdf files!). +Please click on the **Preparation** tab at the top of the page. + +IMG +Now you can import TXT or RTF files into OpenQDA (as OpenQDA has a plug-in architecture, we or other people of the community may create import plug-ins for other file formats). +Click the **Import** button to select a TXT or RTF file. Click on the title of the document to see the contents of the file in the editor in the right pane. Now you can edit the document. + +You can also create new text documents when you click **New file**. You can then paste your text contents into the new document. + +When you are ready with editing, you can press the **Lock and Code** button to lock the file and start coding. ## Coding the text -TBD +Now you are in the **Coding** tab section. +In the left pane there is your text (you can switch between texts with the blue menu button). +On the right you see your codes pane. Right now you need to activate a codebook to start coding. +If you do not have any codes in your code book, let's create one by clicking on **Add Code**. +A new code category appears. You can edit it's name by double clicking on the text. +You can also create a note (click on the pen icon). +To create subcodes or move your codes, click on the mini-menu button of the code. +You can code text in 3 ways: +- make a text selection and use right mouse click / contextual menu click and select a code +- drag the text selection to the code +- drag the code to the text selection +All dragging only works on Macs and PCs, not on smartphones or tablets (we are working on it). ## Analysis -TBD +To do your analysis, go to the **Analysis** tab section. ## What next?