diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 3f6e520c..9b7a08ac 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -4,12 +4,23 @@ on: branches: - master - main + pull_request: permissions: contents: read pages: write id-token: write jobs: + check-anchors: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v5 + - uses: actions/setup-python@v5 + with: + python-version: 3.x + - name: Check translated heading anchors + run: python scripts/check_anchors.py deploy: + if: github.event_name == 'push' environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} diff --git a/docs/doc/de/1.-Overview.md b/docs/doc/de/1.-Overview.md index 5cded3e3..c061ebb0 100644 --- a/docs/doc/de/1.-Overview.md +++ b/docs/doc/de/1.-Overview.md @@ -5,19 +5,19 @@ path: 1.-Overview.md Diese Anleitung beschreibt die Installation und Nutzung der aktuellen Version von QualCoder. -## Was ist QualCoder? +## Was ist QualCoder? {#what-is-qualcoder} QualCoder ist eine kostenlose Open-Source-Software für die qualitative Datenanalyse. Sie können damit Texte, Bilder und Audio/Video codieren sowie Notizbücher und Memos schreiben. Codes lassen sich in einem hierarchischen Kategoriensystem organisieren. Verschiedene Berichte können erstellt und meist als HTML, ODT, reine Textdateien oder Excel-Dateien exportiert werden. -Neuere Versionen enthalten optionale KI-Funktionen, die GPT-4 oder andere große Sprachmodelle nutzen. Mit der [Themenexploration](5.1.-AI-chat-based-analysis.md#2-themenexploration) können Sie neue Daten in einem interaktiven Chat kennenlernen. Die [KI-gestützte Codierung](4.2.-AI-Assisted-Coding.md) und die [Textanalyse](5.1.-AI-chat-based-analysis.md#3-textanalyse) helfen Ihnen, einzelne Aspekte zu vertiefen. Zur Zusammenführung und Verdichtung Ihrer Ergebnisse können Sie eine [Codeanalyse](5.1.-AI-chat-based-analysis.md#4-codeanalyse) mit der KI durchführen. +Neuere Versionen enthalten optionale KI-Funktionen, die GPT-4 oder andere große Sprachmodelle nutzen. Mit der [Themenexploration](5.1.-AI-chat-based-analysis.md#2-topic-exploration) können Sie neue Daten in einem interaktiven Chat kennenlernen. Die [KI-gestützte Codierung](4.2.-AI-Assisted-Coding.md) und die [Textanalyse](5.1.-AI-chat-based-analysis.md#3-text-analysis) helfen Ihnen, einzelne Aspekte zu vertiefen. Zur Zusammenführung und Verdichtung Ihrer Ergebnisse können Sie eine [Codeanalyse](5.1.-AI-chat-based-analysis.md#4-code-analysis) mit der KI durchführen. QualCoder ist für die lokale Arbeit jeweils einer Person ausgelegt. Eine zweite Coder:in kann dasselbe Projekt auf demselben Computer bearbeiten, oder Sie können den Projektordner auf deren Computer übertragen. Gleichzeitiger Zugriff auf dasselbe Projekt ist nicht vorgesehen. Arbeiten Sie nicht direkt mit einem Projekt in einem Cloud-Ordner: Geht die Datenbankverbindung während einer Aktualisierung verloren, kann die Datenbank beschädigt werden. -## Gemeinsam an einem QualCoder-Projekt arbeiten +## Gemeinsam an einem QualCoder-Projekt arbeiten {#collaboration-on-a-qualcoder-project} Siehe [Zusammenarbeit im Team](2.4.-Working-in-a-Team.md). -## Aktuelle Veröffentlichung +## Aktuelle Veröffentlichung {#latest-release} [:octicons-archive-24: Neueste Version auf GitHub herunterladen](https://github.com/ccbogel/QualCoder/releases/latest){ .md-button .md-button--primary } @@ -26,7 +26,7 @@ Siehe [Zusammenarbeit im Team](2.4.-Working-in-a-Team.md). ![Warnung beim ersten Start](/images/12d00e05-3844-4b48-9dc9-ff657aa7382f.png) -## Aktueller Entwicklungsstand +## Aktueller Entwicklungsstand {#latest-code-software-under-development} [Laden Sie die Entwicklungsversion herunter](https://github.com/ccbogel/QualCoder/archive/refs/heads/master.zip), entpacken Sie sie und folgen Sie den Installationsanweisungen in der README-Datei. @@ -34,4 +34,4 @@ Ein weiteres Code-Repository finden Sie auf [Codeberg](https://codeberg.org/qual **Wenn Sie QualCoder nutzen und mögen, unterstützen Sie bitte die Entwicklung.** -[![Buy Me A Coffee](/images/buymeacoffee-default-orange.png)](https://www.buymeacoffee.com/ccbogelB) +[![Buy Me A Coffee](/images/buymeacoffee-default-orange.png)](https://www.buymeacoffee.com/ccbogelB) \ No newline at end of file diff --git a/docs/doc/de/2.1.-Installation.md b/docs/doc/de/2.1.-Installation.md index 4043dc78..12984cd2 100644 --- a/docs/doc/de/2.1.-Installation.md +++ b/docs/doc/de/2.1.-Installation.md @@ -4,11 +4,11 @@ icon: lucide/package-open --- # Installation und Programmstart -## Installation +## Installation {#installation} Bei der manuellen Installation über die Eingabeaufforderung oder das Terminal wird stellenweise eine bestimmte Version genannt, etwa 4.0. Prüfen Sie auf der [Veröffentlichungsseite](https://github.com/ccbogel/QualCoder/releases), ob bereits eine neuere Version verfügbar ist. -### Voraussetzungen +### Voraussetzungen {#prerequisites} VLC wird optional für das Codieren von Audio/Video benötigt. Für die Darstellung einer Wellenform können Sie zusätzlich ffmpeg installieren; siehe [Anleitung für Windows](https://phoenixnap.com/kb/ffmpeg-windows). Unter Fedora kann QualCoder beim Anzeigen oder Codieren von Audio/Video abstürzen. @@ -216,4 +216,4 @@ VLC wird optional für das Codieren von Audio/Video benötigt. Für die Darstell ```bash bash -c 'cd ~/.local/share/qualcoder/src/ && ~/.local/share/qualcoder/env/bin/python3.12 -m qualcoder' - ``` + ``` \ No newline at end of file diff --git a/docs/doc/de/2.2.-Settings.md b/docs/doc/de/2.2.-Settings.md index 31a6e609..d22ca4c1 100644 --- a/docs/doc/de/2.2.-Settings.md +++ b/docs/doc/de/2.2.-Settings.md @@ -7,15 +7,15 @@ In den Einstellungen können Sie unter anderem die Sprache, den Namen der Coder: ![Einstellungen](/images/baec9b31-e0bd-4607-85c2-65e141f040d6.png) -## Name der Coder:in +## Name der Coder:in {#name-der-coderin} Mehrere Coder:innen können denselben Text codieren und annotieren. Ihr aktueller Name wird oben im Einstellungsdialog angezeigt. ![Name der Coder:in](/images/gh-04951ae2-c5ab-41e7-854f-dad9819183f4.png) -Dieser Name kennzeichnet Ihre Beiträge zum Projekt. Über die Schaltfläche zum Ändern können Sie Ihre Identität wechseln sowie weitere Coder:innen im aktuellen Projekt anlegen, umbenennen oder zusammenführen. Weitere Informationen finden Sie unter [Hinweise zu den Namen der Coder:innen](2.4.-Working-in-a-Team.md#hinweise-zu-den-namen-der-coderinnen). +Dieser Name kennzeichnet Ihre Beiträge zum Projekt. Über die Schaltfläche zum Ändern können Sie Ihre Identität wechseln sowie weitere Coder:innen im aktuellen Projekt anlegen, umbenennen oder zusammenführen. Weitere Informationen finden Sie unter [Hinweise zu den Namen der Coder:innen](2.4.-Working-in-a-Team.md#important-considerations-regarding-coder-names). -## Allgemeine Einstellungen +## Allgemeine Einstellungen {#allgemeine-einstellungen} Die Standardsprache ist Englisch. Französisch, Deutsch und Spanisch werden regelmäßig aktualisiert. Andere Sprachen wurden nicht umfassend auf ihre Genauigkeit geprüft. Für weitere, von der Community gepflegte Sprachen [laden Sie die entsprechende ZIP-Datei herunter](/community/), legen sie im Ordner `.qualcoder/i18n` ab und wählen die Sprache in den Einstellungen aus. @@ -23,7 +23,7 @@ Mit der Option zum Anzeigen der IDs werden die numerischen Kennungen von Codes, Verschiedene Optionen ändern das Erscheinungsbild von QualCoder. Für die Transkription von Audio/Video können Sie das Zeitformat und die Art der Klammern festlegen. -## Sicherungskopien +## Sicherungskopien {#sicherungskopien} Sie können stündliche automatische Projektsicherungen aktivieren oder die Sicherung deaktivieren. Sicherungskopien erhalten einen Datums- und Stundenstempel im Format `_projektname_BKP_yyyymmdd_hh.qda`; `hh` bezeichnet die Stunde im 24-Stunden-Format. Innerhalb derselben Stunde wird keine weitere Sicherung angelegt, sodass diese eine vorhandene Sicherung nicht überschreiben kann. Sie können zwischen einer und zehn aufzubewahrenden Sicherungen wählen. **Ältere Sicherungen werden gelöscht.** @@ -33,6 +33,6 @@ Benennen Sie Sicherungen, die Sie dauerhaft behalten möchten, um oder verschieb In Ihrem persönlichen Ordner legt QualCoder den Ordner `.qualcoder` an. Er enthält die Protokolldatei `QualCoder.log` und die Datei `config.ini` mit Einstellungen wie dem Namen der Coder:in, Schriftarten, Sprache und Arbeitsverzeichnis. Speichern Sie darin keine Daten oder Projekte. Nur wenn Sie andere Stoppwörter für Wortwolken und Worthäufigkeiten verwenden möchten, legen Sie dort eine eigene `stopwords.txt` ab. Ansonsten ist dieser Ordner für die laufende Software vorgesehen. -## Erweiterte Optionen und Protokollierung +## Erweiterte Optionen und Protokollierung {#erweiterte-optionen-und-protokollierung} -Die **KI-Optionen** im unteren Bereich des Einstellungsdialogs werden unter [KI-Einrichtung](2.3.-AI-Setup.md) erläutert. +Die **KI-Optionen** im unteren Bereich des Einstellungsdialogs werden unter [KI-Einrichtung](2.3.-AI-Setup.md) erläutert. \ No newline at end of file diff --git a/docs/doc/de/2.3.-AI-Setup.md b/docs/doc/de/2.3.-AI-Setup.md index 9f2b9fb3..ef03f3d0 100644 --- a/docs/doc/de/2.3.-AI-Setup.md +++ b/docs/doc/de/2.3.-AI-Setup.md @@ -13,19 +13,19 @@ Alle KI-bezogenen Optionen befinden sich am unteren Ende des Einstellungsdialogs **Schritte des Einrichtungsassistenten:** 1. **Aktivieren Sie die KI-Integration**, indem Sie das Kontrollkästchen im Einstellungsdialog anklicken. -2. **[Wählen Sie das KI-Modell aus, das Sie verwenden möchten](#auswahl-des-ki-modells)**, und konfigurieren Sie es. -3. Der **[lokale KI-Speicher](#einrichtung-des-lokalen-ki-speichers)** wird anschließend automatisch eingerichtet und befüllt. Bitte haben Sie Geduld, da dies eine Weile dauern kann. +2. **[Wählen Sie das KI-Modell aus, das Sie verwenden möchten](#ai-model-selection)**, und konfigurieren Sie es. +3. Der **[lokale KI-Speicher](#the-local-ai-memory-setup)** wird anschließend automatisch eingerichtet und befüllt. Bitte haben Sie Geduld, da dies eine Weile dauern kann. 4. Danach ist der KI-Agent in QualCoder **einsatzbereit**. -Lesen Sie auch, [wie Sie Ihr Projekt bestmöglich für die KI-Nutzung vorbereiten](#ki-nutzung-im-projekt-verbessern), sowie unsere [Hinweise zu Datenschutz und Datensicherheit](#hinweise-zu-datenschutz-und-datensicherheit) weiter unten. +Lesen Sie auch, [wie Sie Ihr Projekt bestmöglich für die KI-Nutzung vorbereiten](#improve-ai-usability-in-your-project), sowie unsere [Hinweise zu Datenschutz und Datensicherheit](#some-notes-on-privacy-and-data-protection) weiter unten. -## Auswahl des KI-Modells +## Auswahl des KI-Modells {#ai-model-selection} In QualCoder können Sie aus einer breiten Palette kommerzieller und nicht-kommerzieller KI-Anbieter wählen und sogar lokale Modelle auf Ihrem eigenen Rechner verwenden. Wählen Sie dazu eine der Optionen im Dropdown-Menü "KI-Profil" im Einstellungsdialog aus. -### Führende Modelle von OpenAI, Anthropic oder Google +### Führende Modelle von OpenAI, Anthropic oder Google {#frontier-models-from-openai-anthropic-or-google} Diese großen KI Sprachmodelle liefern die nuancierteste Analyse Ihrer empirischen Daten; mit ihnen funktioniert der KI-Agent in QualCoder am besten. Sie haben mehrere Möglichkeiten, auf diese Modelle zuzugreifen: @@ -46,7 +46,7 @@ Diese großen KI Sprachmodelle liefern die nuancierteste Analyse Ihrer empirisch - Beachten Sie, dass QualCoder keinerlei Zugriff auf Informationen in Ihrem ChatGPT-Konto hat, außer auf die eigentlichen KI-Modelle. Das gilt auch umgekehrt: ChatGPT kann nicht auf Daten innerhalb von QualCoder zugreifen. - Es ist dennoch ratsam, in den Einstellungen zur "Datenkontrolle" Ihres ChatGPT-Profils die Option "Das Modell für alle verbessern" zu deaktivieren. Dadurch wird verhindert, dass Inhalte Ihrer Interaktionen mit ChatGPT für zukünftiges Modelltraining verwendet werden. - QualCoder verwendet dieselbe Kommunikationsschnittstelle wie OpenAIs Programmierassistent Codex. Falls Ihre Organisation Codex in Ihrem ChatGPT-Konto deaktiviert hat, können Sie dieses Konto mit QualCoder möglicherweise nicht nutzen. -- Für **Anthropic-Claude- oder Google-Gemini-Abonnements** ist die Anbindung an QualCoder nicht so einfach möglich. Wenn Sie technisch versiert sind, können Sie diese Konten möglicherweise dennoch über [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) als Verknüpfung einbinden. In diesem Fall [fügen Sie in QualCoder ein benutzerdefiniertes KI-Profil hinzu](#andere-modelle) und verwenden Sie `http://localhost:8317/v1` als Parameter für "API Basis URL". +- Für **Anthropic-Claude- oder Google-Gemini-Abonnements** ist die Anbindung an QualCoder nicht so einfach möglich. Wenn Sie technisch versiert sind, können Sie diese Konten möglicherweise dennoch über [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) als Verknüpfung einbinden. In diesem Fall [fügen Sie in QualCoder ein benutzerdefiniertes KI-Profil hinzu](#other-models) und verwenden Sie `http://localhost:8317/v1` als Parameter für "API Basis URL". **Microsoft Azure** @@ -63,7 +63,7 @@ Um fortzufahren, benötigen Sie die folgenden Informationen: Gehen Sie zu "Preojekt > Einstellungen > KI Integration", klicken Sie auf "Erweiterte KI-Optionen > Neues KI-Profil..." und geben Sie dem Profil einen Namen. Tragen Sie anschließend Ihren API-Schlüssel in das entsprechende Feld ein, den Namen Ihrer Azure-Bereitstellung in die Felder "Großes Modell" und "Schnelles Modell" (diese können identisch sein) sowie die Azure-Endpoint-URL in das Feld "API-Basis-URL". Je nach Modell sollten Sie auch die Größe des Kontextfensters anpassen. -### Akademische KI-Infrastruktur +### Akademische KI-Infrastruktur {#academic-ai-infrastructure} Nicht-kommerzielle akademische KI-Infrastrukturen geben Ihnen Zugriff auf mittelgroße Modelle und halten dabei sehr hohe Datenschutzstandards ein. Diese Dienste sind für berechtigte Personen in der Regel kostenlos. @@ -82,14 +82,14 @@ Deutschland: - **[hessian.AI Darmstadt](https://hessian.ai/):** Experimenteller Zugang, nur für berechtigte Personen an hessischen Hochschulen in Deutschland. Folgen Sie den obigen Schritten für GWDG, verwenden aber `https://llm-service.ai.tu-darmstadt.de` als API-Basis-URL. -### Mittelgroße Modelle wie Mistral, DeepSeek und andere +### Mittelgroße Modelle wie Mistral, DeepSeek und andere {#mid-size-models-like-mistral-deepseek-and-others} Das Dropdown-Menü "KI-Profil" im Einstellungsdialog bietet auch Optionen für [Mistral (Frankreich)](https://mistral.ai/), [DeepSeek (China)](https://deepseek.com/) und [OpenRouter](https://openrouter.ai/), eine Plattform, über die viele große Sprachmodelle auf unterschiedlichen Servern zugänglich sind. Für alle diese Optionen benötigen Sie einen API-Schlüssel und sehr wahrscheinlich auch ein kostenpflichtiges Konto, wenn Sie ernsthaft damit arbeiten möchten. Prüfen Sie die Datenschutzbedingungen sorgfältig, bevor Sie einen dieser Dienste verwenden. -### Lokale KI-Modelle auf Ihrem eigenen Rechner +### Lokale KI-Modelle auf Ihrem eigenen Rechner {#local-ai-models-on-your-own-machine} Lokale KI-Modelle bieten das höchste Maß an Datenschutz, erfordern aber auch recht leistungsfähige Hardware, um mit brauchbarer Geschwindigkeit und Qualität zu arbeiten. In meinen Tests funktionierte `Gemma-4-31B-it` recht gut. Das Modell benötigt mindestens 24 GB VRAM in 4-Bit-Quantisierung mit einem brauchbaren Kontextfenster. Für ernsthafte agentische Workflows in QualCoder würde ich nicht wesentlich unter diese Modellgröße gehen. [KI-gestütztes Coding](4.2.-AI-Assisted-Coding) kann jedoch auch mit etwas kleineren Modellen noch funktionieren. @@ -99,7 +99,7 @@ Lokale KI-Modelle bieten das höchste Maß an Datenschutz, erfordern aber auch r - Wählen Sie ein großes und ein schnelles Modell aus der Liste aus - typischerweise dasselbe Modell, da ja meist nur ein Modell gleichzeitig geladen ist. Je nach Ihren Ollama-Einstellungen sollten Sie auch die Größe des Kontextfensters anpassen. -### Andere Modelle +### Andere Modelle {#other-models} Wenn Sie Zugriff auf andere große Sprachmodelle auf Cloud-Plattformen, Universitätsservern oder Ihrem eigenen Rechner haben, können Sie versuchen, diese ebenfalls in QualCoder zu integrieren. @@ -125,7 +125,7 @@ Beachten Sie, dass der Abschnittsname immer mit dem Präfix `ai_model_` beginnen Wenn Sie andere Dienste in QualCoder zum Laufen bringen oder es versucht haben und gescheitert sind, würden wir uns über eine Rückmeldung zu Ihren Erfahrungen freuen. -## Erweiterte KI-Optionen +## Erweiterte KI-Optionen {#advanced-ai-options} Ganz unten im Einstellungsdialog finden Sie die Schaltfläche "Erweiterte KI-Optionen". Wenn Sie darauf klicken, werden einige zusätzliche Optionen eingeblendet. @@ -134,7 +134,7 @@ Ganz unten im Einstellungsdialog finden Sie die Schaltfläche "Erweiterte KI-Opt - Bei den übrigen erweiterten Optionen ist es in der Regel am besten, die Standardwerte beizubehalten, wenn Sie deren Bedeutung nicht kennen. Beachten Sie, dass die Parameter "temperature" und "top_p" von manchen Modellen stillschweigend ignoriert werden können, insbesondere im Reasoning-Modus. -## Einrichtung des lokalen KI-Speichers +## Einrichtung des lokalen KI-Speichers {#the-local-ai-memory-setup} * Der KI-Agent in QualCoder verwendet einen speziellen lokalen Speicher, um empirische Dokumente schnell zu durchsuchen und relevante Stellen zu finden. Dadurch wird die Menge der in die Cloud gesendeten Daten stark reduziert, was den Datenschutz verbessert, Ressourcen spart und die Geschwindigkeit erhöht. * Dieser Speicher basiert auf einem kleinen [lokalen Open-Source-KI-Modell](https://huggingface.co/intfloat/multilingual-e5-large) mit einer Größe von ungefähr 2,5 GB, das beim ersten Aktivieren der KI automatisch heruntergeladen wird. Speicherorte des Modells: @@ -150,7 +150,7 @@ Ganz unten im Einstellungsdialog finden Sie die Schaltfläche "Erweiterte KI-Opt Technischer Hinweis: Der lokale KI-Speicher von QualCoder ist ein Hybridsystem aus Embeddings des [E5 sentence encoder](https://huggingface.co/intfloat/multilingual-e5-large), die für semantische Suche in einem [FAISS vector store](https://github.com/facebookresearch/faiss) gespeichert werden, und einem [SQLite-BM25-Index](https://sqlite.org/fts5.html) für schnelle Stichwortsuche. Zusätzlich kann der KI-Agent selbst reguläre Ausdrücke generieren, um die Projektdaten zu durchsuchen. -## KI-Nutzung im Projekt verbessern +## KI-Nutzung im Projekt verbessern {#improve-ai-usability-in-your-project} Damit die Arbeit mit dem KI Agenten in QualCoder reibungslos funktioniert, sollte dieser die Struktur Ihres Projekts, Ihrer empirischen Dokumente, Codes und Memos gut lesen und verstehen können. Außerdem sollte er ein klares Bild von den Zielen, Forschungsfragen und Methoden Ihres Projekts haben. So kann er deutlich gezieltere Antworten geben. Deshalb ist zu empfehlen: @@ -160,7 +160,7 @@ Damit die Arbeit mit dem KI Agenten in QualCoder reibungslos funktioniert, sollt - Wenn Sie **Memos** für persönliche Notizen und sehr unfertige Ideen nutzen, die Sie nicht mit dem KI-Agenten teilen möchten, setzen Sie diese Inhalte hinter eine Markierung aus "#####". Alles, was in einem Memo unterhalb dieser Markierung steht, wird nicht an die KI gesendet. -## Hinweise zu Datenschutz und Datensicherheit +## Hinweise zu Datenschutz und Datensicherheit {#some-notes-on-privacy-and-data-protection} * Uns ist bewusst, dass die Nutzung cloudbasierter Dienste wie der von OpenAI Fragen zum Datenschutz und zur Datensicherheit aufwirft. @@ -176,6 +176,6 @@ QualCoder verfolgt einen **"Privacy by Design"**-Ansatz: * QualCoder ist nicht auf kommerzielle KI-Anbieter beschränkt. So kooperieren wir beispielsweise mit **"Blablador"**, einem Dienst, der große Sprachmodelle auf nicht-kommerzieller akademischer Hardware betreibt und hervorragenden Datenschutz bietet (siehe oben). -* Darüber hinaus können Sie [eigene Modelle zu QualCoder hinzufügen](#andere-modelle), einschließlich solcher, die [vollständig lokal auf Ihrem Rechner](#lokale-ki-modelle-auf-ihrem-eigenen-rechner) und ohne Netzwerkzugriff laufen. Der Qualitätsunterschied bei der Ausgabe ist derzeit jedoch noch so deutlich, dass lokale KI-Modelle nur in begrenzten Anwendungsfällen sinnvoll sind - es sei denn, Sie verfügen über sehr leistungsfähige Hardware. Hoffentlich wird sich diese Situation in Zukunft weiter verbessern. +* Darüber hinaus können Sie [eigene Modelle zu QualCoder hinzufügen](#other-models), einschließlich solcher, die [vollständig lokal auf Ihrem Rechner](#local-ai-models-on-your-own-machine) und ohne Netzwerkzugriff laufen. Der Qualitätsunterschied bei der Ausgabe ist derzeit jedoch noch so deutlich, dass lokale KI-Modelle nur in begrenzten Anwendungsfällen sinnvoll sind - es sei denn, Sie verfügen über sehr leistungsfähige Hardware. Hoffentlich wird sich diese Situation in Zukunft weiter verbessern. * Generell empfehlen wir, Ihre Daten sehr sorgfältig zu **anonymisieren**, bevor Sie einen cloudbasierten KI-Dienst zur Analyse verwenden. \ No newline at end of file diff --git a/docs/doc/de/2.4.-Working-in-a-Team.md b/docs/doc/de/2.4.-Working-in-a-Team.md index de88ee53..69432d2b 100644 --- a/docs/doc/de/2.4.-Working-in-a-Team.md +++ b/docs/doc/de/2.4.-Working-in-a-Team.md @@ -5,7 +5,7 @@ path: 2.4.-Working-in-a-Team Für die Zusammenarbeit an einem QualCoder-Projekt gibt es mehrere Vorgehensweisen. Wählen Sie diejenige, die zu Ihrem methodischen Ansatz und Ihrer Arbeitsumgebung passt. -## 1) Dasselbe Projekt nacheinander bearbeiten +## 1) Dasselbe Projekt nacheinander bearbeiten {#1-sequential-editing-of-the-same-project} Dieses Vorgehen eignet sich sowohl für induktives als auch für deduktives Codieren. Alle Teammitglieder arbeiten mit denselben Projektdateien, jedoch zu unterschiedlichen Zeiten. @@ -18,7 +18,7 @@ Dieses Vorgehen eignet sich sowohl für induktives als auch für deduktives Codi Gehen Sie sorgfältig mit den Namen der Coder:innen um; Hinweise dazu finden Sie weiter unten. -## 2) Getrennt codieren und in einem Hauptprojekt zusammenführen +## 2) Getrennt codieren und in einem Hauptprojekt zusammenführen {#2-using-a-master-project-the-coding-separately-then-merging-approach} Bei diesem Vorgehen kann Ihr Team teilweise gleichzeitig arbeiten. Es eignet sich besonders für deduktive Analysen, deren Codesystem sich wenig verändert. Bei induktivem Codieren sollten Sie Zeit einplanen, um beim Zusammenführen die Codesysteme der verschiedenen Teammitglieder abzugleichen und zu bereinigen. @@ -31,7 +31,7 @@ Gehen Sie wie folgt vor: - Jedes Teammitglied entpackt eine lokale Kopie und arbeitet unabhängig daran, ergänzt Codes, Codierungen, Memos usw. Verändern Sie dabei nicht die importierten Texte der empirischen Dokumente selbst, da dies später beim Zusammenführen Probleme verursachen kann. - Sammeln Sie die lokalen Kopien und [führen Sie sie nacheinander im Hauptprojekt zusammen](6.4.-Merge-Projects.md). -## Hinweise zu den Namen der Coder:innen +## Hinweise zu den Namen der Coder:innen {#important-considerations-regarding-coder-names} - Meist sollte jede Coder:in einen eindeutigen Namen haben, damit individuelle Beiträge auch nach dem Zusammenführen erkennbar bleiben. - Öffnen Sie unter **Projekt > Einstellungen** über die Schaltfläche neben Ihrem Namen den Dialog zum Wechseln Ihrer Identität sowie zum Anlegen, Umbenennen oder Zusammenführen anderer Coder:innen. @@ -47,8 +47,8 @@ Der Name „📌 Sprecher:innen-Codierung“ wird intern verwendet, um Redebeitr !!! warning Arbeiten Sie nicht direkt mit einem Projektordner auf einem Netzlaufwerk oder in einem Cloud-Ordner. Geht die Verbindung während einer Folge von Datenbankoperationen verloren, kann die Datenbank beschädigt werden. -## Sicherungskopien +## Sicherungskopien {#backups} Sichern Sie den Projektordner vor größeren Änderungen, etwa einer umfangreichen Neuorganisation von Codes und Kategorien oder dem Zusammenführen von Projekten oder Codes. Bei aktivierter Sicherung erstellt QualCoder stündliche Sicherungen und bewahrt standardmäßig bis zu fünf davon auf. Speichern Sie keine zusätzlichen Dateien oder Ausgaben im Projektordner. -Für eine gute Datenverwaltung sollten Sie Ihre Arbeit zusätzlich regelmäßig sichern und Sicherungskopien auf verschiedenen Geräten oder Laufwerken aufbewahren. +Für eine gute Datenverwaltung sollten Sie Ihre Arbeit zusätzlich regelmäßig sichern und Sicherungskopien auf verschiedenen Geräten oder Laufwerken aufbewahren. \ No newline at end of file diff --git a/docs/doc/de/3.1.-Creating-a-New-Project.md b/docs/doc/de/3.1.-Creating-a-New-Project.md index 038c4304..90951e05 100644 --- a/docs/doc/de/3.1.-Creating-a-New-Project.md +++ b/docs/doc/de/3.1.-Creating-a-New-Project.md @@ -7,7 +7,7 @@ Sie können **über das Menü „Projekt“ ein neues Projekt erstellen**. Wenn Sie es „Test“ nennen, wird es als `Test.qda` gespeichert. Dabei handelt es sich um einen Ordner mit Unterordnern für die Datenbank, empirische Dokumente und weitere Dateien. Um ein Projekt per E-Mail weiterzugeben, packen Sie den gesamten Ordner in eine ZIP-Datei. -## Hauptfenster +## Hauptfenster {#main-screen} Der Reiter für das Aktionsprotokoll zeigt verschiedene Änderungen an, die während der Arbeit mit QualCoder vorgenommen werden. Oben befindet sich die Menüleiste. Die fünf Reiter umfassen das Aktionsprotokoll, die Verwaltung, Berichte, Codierung und den KI-Chat. @@ -20,7 +20,7 @@ In der Regel können Sie direkt zwischen den Reitern wechseln. Wenn Sie jedoch u !!! tip "Gute Datenverwaltung" Erstellen Sie regelmäßig Sicherungskopien und bewahren Sie diese möglichst an verschiedenen Orten auf, etwa in der Cloud, in anderen Ordnern oder auf anderen Festplatten und USB-Sticks. -## Ein Projekt-Memo schreiben +## Ein Projekt-Memo schreiben {#write-a-project-memo} Das ist **besonders wichtig, wenn Sie die KI-Funktionen verwenden möchten**. Das Projekt-Memo liefert der KI Kontext zum aktuellen Projekt und zu den empirischen Dokumenten. Diese Informationen werden jeder Anfrage beigefügt und helfen, gezieltere und nützlichere Antworten zu erzeugen. Öffnen Sie es über **Projekt > Projekt-Memo**. @@ -30,4 +30,4 @@ QualCoder stellt eine Vorlage mit den wichtigsten Angaben bereit. Sie müssen ih Wenn Sie weitere Notizen hinzufügen möchten, die die KI nicht erhalten soll, fügen Sie eine Zeile mit `#####` ein. Alles darunter wird nicht an die KI gesendet. Das funktioniert in allen QualCoder-Memos. -Wenn das Projekt-Memo überhaupt nicht an die KI gesendet werden soll, deaktivieren Sie dies in den Einstellungen. +Wenn das Projekt-Memo überhaupt nicht an die KI gesendet werden soll, deaktivieren Sie dies in den Einstellungen. \ No newline at end of file diff --git a/docs/doc/de/3.2.-Files.md b/docs/doc/de/3.2.-Files.md index 6b72c1d9..ab3ed768 100644 --- a/docs/doc/de/3.2.-Files.md +++ b/docs/doc/de/3.2.-Files.md @@ -7,7 +7,7 @@ Ein Symbol vor jeder Datei kennzeichnet den Dateityp. Weitere Spalten zeigen den ![Dateiverwaltung](/images/71172904-3ae5-4eb3-9b04-350f036f1c9d.png) -## Dateien importieren +## Dateien importieren {#importing-files} QualCoder importiert Texte aus reinen Textdateien sowie DOCX, EPUB, Markdown, ODT, PDF, RTF und TEX. Bei LaTeX werden mit `\input` oder `\include` eingebundene Dateien nicht aufgelöst. Unterstützte Bildformate sind JPG, JPEG und PNG; für Audio/Video werden MP3, M4A, MP4, WAV, MOV und OGG unterstützt. PDFs können als Text oder als Bilder codiert werden. Statt Dateien in den Projektordner zu importieren, können Sie auch auf Dateien im lokalen Dateisystem verweisen. Das kann sinnvoll sein, wenn Ihre bestehende Ordnerstruktur für das Projekt wichtig ist. @@ -25,11 +25,11 @@ Verknüpfte Dateien lassen sich später in den Projektordner importieren. Umgeke Zum Einstieg importieren Sie aus dem Ordner `Examples` die Dateien `ID1.docx`, `ID2.odt` und `seascape.jpg`. Öffnen Sie anschließend jede Datei per Doppelklick oder über das Kontextmenü. Die Pseudonymisierung können Sie ausprobieren, indem Sie `ID2.odt` entfernen, über die entsprechende Schaltfläche einen Eintrag für `Joe Bloggs` anlegen und die Datei erneut importieren. -### PDFs +### PDFs {#pdfs} Beim Import von PDFs mit Hervorhebungen können die hervorgehobenen Segmente automatisch codiert werden. Ältere Projekte verwenden eine andere Textextraktion als Version 4.0. Beim Öffnen versucht Version 4.0, vorhandene Textsegmente möglichst genau zuzuordnen; eine identische Zuordnung ist jedoch nicht immer möglich. -### Pseudonymisierung +### Pseudonymisierung {#pseudonymisation-data-de-identification} Die Pseudonymisierung ersetzt Wörter oder Wortgruppen. Für viele Sprachen lassen sich deren Grenzen daran erkennen, dass unmittelbar davor und danach weder Buchstaben noch Ziffern stehen. Für Chinesisch, Japanisch und Koreanisch gilt dies möglicherweise nicht. Bei der Pseudonymisierung wird die Groß-/Kleinschreibung beachtet. Originalbegriffe müssen mindestens zwei, Pseudonyme mindestens drei Zeichen lang sein. Lassen Sie das Pseudonym leer, um einen zufällig erzeugten Ersatzbegriff zu verwenden. @@ -43,15 +43,15 @@ Die Liste wird als JSON-Datei im `.qda`-Projektordner gespeichert. Nach Abschlus Importierte Textdateien und qualitative Spalten importierter Umfragen werden pseudonymisiert. **PDF-Dateien werden nicht pseudonymisiert.** -## Redebeiträge automatisch codieren +## Redebeiträge automatisch codieren {#auto-speaker-codings} **Sprecher:innen markieren** erstellt für jede Sprecher:in eines Interviews oder einer Gruppendiskussion einen Code und ordnet die Redebeiträge automatisch zu. Die Funktion ist über das Kontextmenü der Datei oder diese Schaltfläche erreichbar: ![Sprecher:innen markieren](/images/c742fad3-f34b-471d-8794-1919b7f5935d.png) -Weitere Informationen finden Sie unter [Redebeiträge automatisch codieren](4.1.-Coding-Text.md#redebeitrage-automatisch-codieren). +Weitere Informationen finden Sie unter [Redebeiträge automatisch codieren](4.1.-Coding-Text.md#auto-speaker-codings). -## Allgemeine Funktionen +## Allgemeine Funktionen {#general-functions} Sie können Dateinamen in der Datenbank ändern; die Namen der Originaldateien bleiben dabei erhalten. Über das Kontextmenü können Sie eine Datei anzeigen, exportieren oder löschen. Die Papierkorb-Schaltfläche ermöglicht die Auswahl mehrerer Dateien zum Löschen. Das Fragezeichen öffnet diese Hilfeseite. Dateien lassen sich über das Kontextmenü oder das Lupensymbol anzeigen. In der Ansicht einer Audio/Video-Datei können Sie auch das Transkript eingeben. @@ -59,7 +59,7 @@ Sie können Dateinamen in der Datenbank ändern; die Namen der Originaldateien b Mit dieser Schaltfläche benennen Sie alle sichtbaren Dateizeilen gemeinsam um. Sie geben ein Präfix vor, dem eine laufende Nummer angefügt wird. Beschränken Sie bei Bedarf vorher die sichtbaren Zeilen, etwa über **Diesen Wert anzeigen** im Kontextmenü eines Attributs. -## Attribute +## Attribute {#attributes} Attribute beschreiben Dateien durch Text- oder Zahlenwerte. Sie können sie über `(x)` oder **Attribute verwalten** hinzufügen. Das erste Bildschirmfoto zeigt beispielsweise das Textattribut `origin` und die Literaturattributspalte `Ref-author`. @@ -67,41 +67,41 @@ Mit dieser Schaltfläche exportieren Sie die Attribute als Excel-Datei: ![Attribute exportieren](/images/ccf331d7-63b6-460b-96df-41edd7cfe63b.png) -## Zeilen und Spalten filtern +## Zeilen und Spalten filtern {#filtering-columns-and-rows} -### Zeilen filtern +### Zeilen filtern {#filtering-rows} Per Rechtsklick in der Namens- oder Datumsspalte können Sie Dateien nach Name, Datum oder Dateityp sortieren. Mit **Diesen Wert anzeigen** beschränken Sie die Anzeige auf einen Attributwert. **Zeige Werte wie** filtert nach ähnlichen Werten und lässt sich mehrfach anwenden, um die Liste weiter einzugrenzen. -### Spalten ein- und ausblenden +### Spalten ein- und ausblenden {#column-visibility} Viele Spalten können die Übersicht erschweren. Über das Kontextmenü der Tabellenkopfzeile können Sie einzelne Spalten oder alle Spalten mit einem bestimmten Namensanfang ausblenden. Ebenso können Sie Spalten mit einem bestimmten Namensanfang anzeigen. -### Zeilen- und Spaltenfilter speichern und laden +### Zeilen- und Spaltenfilter speichern und laden {#save-and-load-column-and-row-filters} Mit drei Schaltflächen speichern, laden oder löschen Sie Filtereinstellungen. So können Sie schnell zu einer gewünschten Tabellenansicht wechseln. ![Tabellenfilter speichern, laden und löschen](/images/96ae69f5-1493-4aa8-a3f5-31ee15c22fef.png) -## URLs in Attributen öffnen +## URLs in Attributen öffnen {#open-attribute-urls} Über das Kontextmenü einer URL in einem Attribut können Sie diese im Standardbrowser öffnen. Die Funktion steht nur zur Verfügung, wenn der Wert als gültige URL erkannt wird. -## Literaturangaben in die Zwischenablage kopieren +## Literaturangaben in die Zwischenablage kopieren {#copy-reference-to-clipboard} Das Kontextmenü der Literaturspalten `Ref_Authors`, `Ref_Title`, `Ref_Journal`, `Ref_Type` und `Ref_Year` bietet das Kopieren einer Literaturangabe im Vancouver- oder APA-Stil an. -## Eine Datei einem Fall zuordnen +## Eine Datei einem Fall zuordnen {#assign-a-selected-file-to-a-case} In der Fallspalte können Sie eine Datei über das Kontextmenü einem Fall zuweisen. -## Künstliche Intelligenz +## Künstliche Intelligenz {#artificial-intelligence} Bei aktivierter KI-Integration liest das lokale KI-Modell neu importierte Textdateien und nimmt sie in seinen lokalen Speicher auf. Dies geschieht im Hintergrund; die Statusleiste zeigt den Lesevorgang an. Sie können währenddessen weiterarbeiten, die KI-Funktionen sind aber erst nach Abschluss der Aktualisierung verfügbar. Dasselbe gilt, wenn Sie einen bereits importierten Text in QualCoder bearbeiten. Falls der Eindruck entsteht, dass der interne Speicher Änderungen an Ihren Daten nicht berücksichtigt hat, können Sie ihn über **KI > Lokalen KI-Speicher wiederherstellen** vollständig neu erstellen lassen. Unter normalen Umständen sollte dies nicht erforderlich sein. Dabei werden alle Dokumente erneut eingelesen, was einige Zeit dauern kann. -## Textdateien erstellen und bearbeiten +## Textdateien erstellen und bearbeiten {#text-file-creation-and-editing} Mit dem Stiftsymbol erstellen Sie einen Text direkt in der Datenbank: @@ -119,7 +119,7 @@ Nicht unterstrichene Passagen lassen sich problemlos auswählen, kopieren und er !!! info "Einschränkungen" Vermeiden Sie es, eine Auswahl mit sowohl unterstrichenen als auch nicht unterstrichenen Passagen zu löschen oder zu überschreiben. Dabei können die Positionen von Codierungen, Annotierungen und Fallzuordnungen falsch angepasst werden. Wenn eine Änderung diese Zuordnungen beeinträchtigt hat, verlassen Sie das Bearbeitungsfenster mit **Abbrechen**. -## Audio/Video-Dateien +## Audio/Video-Dateien {#audio-and-video-files} QualCoder importiert Videos in den Formaten MOV, MP4, WMV und OGG sowie Audio in WAV, MP3 und M4A. Beim Laden einer Audio/Video-Datei wird automatisch ein leeres Texttranskript mit demselben Namen und der Endung `.txt` angelegt. Sie können selbst transkribieren oder ein extern erstelltes Transkript hineinkopieren. @@ -134,7 +134,7 @@ Eine vorhandene `.srt`-Untertiteldatei können Sie neben das Video im Unterordne Bei installiertem ffmpeg wird eine Wellenform angezeigt. Enthält die Datei mehrere Audiospuren, wird dafür nur die erste verwendet. -### Audio/Video transkribieren +### Audio/Video transkribieren {#transcribing-audio-and-video} Öffnen Sie **Dateien verwalten** und zeigen Sie die Audio/Video-Datei an. Neben der Wiedergabe steht ein Textfeld zur Eingabe des Transkripts bereit. @@ -171,7 +171,7 @@ Die manuelle Transkription wird durch Tastenkürzel unterstützt. Solange der vo Die Wiedergabesteuerung ist auch über die Symbole der Werkzeugleiste verfügbar. -### Transkripte mit Codierungen, Annotierungen oder Fallzuordnungen +### Transkripte mit Codierungen, Annotierungen oder Fallzuordnungen {#transcriptions-that-have-codes-annotations-and-or-case-assigned} Wie bei anderen Textdateien werden Fallzuordnungen grün, Annotierungen gelb und Codierungen rot unterstrichen. Auch solche Transkripte können bearbeitet werden. @@ -180,14 +180,14 @@ Nicht unterstrichene Passagen können Sie auswählen, kopieren und ersetzen. An !!! warning "Einschränkungen" Löschen oder überschreiben Sie möglichst keine Auswahl, die unterstrichene und nicht unterstrichene Passagen kombiniert. Die Positionen der zugehörigen Codierungen, Annotierungen oder Fallzuordnungen könnten falsch angepasst werden. Verwerfen Sie problematische Änderungen über **Abbrechen**. -## Beispieldateien +## Beispieldateien {#example-files} Im Ordner `Examples` finden Sie Dateien zum Ausprobieren verschiedener Text- und Bildimporte sowie zum Import von Fallattributen und Umfragen. -## Ungültige Dateiverknüpfungen verwalten +## Ungültige Dateiverknüpfungen verwalten {#manage-bad-links-to-files} Extern verknüpfte Dateien können verschoben, umbenannt oder gelöscht werden. Über die Funktion zur Verwaltung ungültiger Verknüpfungen können Sie die richtige Datei suchen und den bisherigen Pfad ersetzen. Ungültige Verknüpfungen betreffen Bilder und Audio/Video-Dateien. Texte sind nur betroffen, wenn Sie das Originaldokument ansehen möchten: Der zum Codieren verwendete reine Text ist bereits in die QualCoder-Datenbank importiert. -Die automatische Suche durchsucht den persönlichen Ordner der Benutzer:in nach bis zu zwei übereinstimmenden Dateinamen. Dies kann einige Zeit dauern und hilft, verschobene Dateien wiederzufinden. +Die automatische Suche durchsucht den persönlichen Ordner der Benutzer:in nach bis zu zwei übereinstimmenden Dateinamen. Dies kann einige Zeit dauern und hilft, verschobene Dateien wiederzufinden. \ No newline at end of file diff --git a/docs/doc/de/3.3.-Cases.md b/docs/doc/de/3.3.-Cases.md index 95de1efe..81d5da62 100644 --- a/docs/doc/de/3.3.-Cases.md +++ b/docs/doc/de/3.3.-Cases.md @@ -11,14 +11,14 @@ Beim Import einer Umfrage kann jede Zeile einem Fall zugeordnet werden. Als Fall ![Fallverwaltung](/images/a2076cfb-da5e-486f-a443-6ef6a070fc9a.png) -## Zeilen und Spalten ein- und ausblenden +## Zeilen und Spalten ein- und ausblenden {#hiding-and-showing-rows-and-columns} Über das Kontextmenü der Tabellenkopfzeile können Sie einzelne Spalten oder Spalten mit einem bestimmten Namensanfang ausblenden beziehungsweise anzeigen. Im Kontextmenü einer Tabellenzelle können Sie die Zeilen auf einen bestimmten Wert oder ähnliche Textwerte beschränken. Außerdem lassen sich die Fälle nach Fallname oder Attributwert auf- oder absteigend sortieren. !!! example "Praktisches Beispiel" Legen Sie über das Symbol zum Hinzufügen eines Falls drei Fälle für Studierende an und nennen Sie diese `ID1`, `ID2` und `ID3`. -## Falldateien verwalten +## Falldateien verwalten {#case-file-manager} Ordnen Sie nun jeder Student:in die zugehörigen Dateien zu. Klicken Sie beispielsweise beim Fall `ID3` in die Spalte „Dateien“. Alternativ öffnen Sie die Verwaltung über das Dokumentensymbol. @@ -28,7 +28,7 @@ Wählen Sie einen Fall, etwa `ID3`, und klicken Sie auf die Schaltfläche zum Hi Sie können auch einen Fall auswählen, einzelne Passagen in einem längeren Text markieren und diese per Rechtsklick dem ausgewählten Fall zuweisen. -## Fälle und Fallattribute importieren +## Fälle und Fallattribute importieren {#importing-cases-and-case-attributes} Attribute lassen sich aus CSV- oder XLSX-Dateien über diese Schaltfläche importieren: @@ -38,8 +38,8 @@ Die erste Zeile muss die Attributnamen enthalten. In der ersten Spalte müssen d Löschen Sie für dieses Beispiel zunächst alle angezeigten Fälle. Importieren Sie anschließend `cases.csv` über den Dialog zum Attributimport. Danach müssen Sie die Dateien und Textpassagen erneut den Fällen zuordnen. -## Fallinformationen exportieren +## Fallinformationen exportieren {#exporting-case-information} Mit dieser Schaltfläche exportieren Sie die Falltabelle als Excel-Datei (`.xlsx`): -![Fallinformationen exportieren](/images/15d879be-bde6-4dfd-a1a7-baf5386ef8d9.png) +![Fallinformationen exportieren](/images/15d879be-bde6-4dfd-a1a7-baf5386ef8d9.png) \ No newline at end of file diff --git a/docs/doc/de/3.4.-Attributes.md b/docs/doc/de/3.4.-Attributes.md index 11f5795b..a46a8d83 100644 --- a/docs/doc/de/3.4.-Attributes.md +++ b/docs/doc/de/3.4.-Attributes.md @@ -15,4 +15,4 @@ Attribute lassen sich auch über **Verwalten > Attribute verwalten** hinzufügen ![Attribute verwalten](/images/513af5f1-a94e-4606-b4d0-54011a8607da.png) -Hier können Sie auch Attribute für Literaturangaben löschen. Tun Sie dies nur, wenn Sie sicher sind, dass Sie die Literaturangaben nicht mehr benötigen. Diese Attribute beginnen mit `Ref_` und verbinden Dateien mit importierten Literaturangaben. Informationen zum Import und zur Verknüpfung finden Sie unter [Literaturangaben](3.5.-References.md). +Hier können Sie auch Attribute für Literaturangaben löschen. Tun Sie dies nur, wenn Sie sicher sind, dass Sie die Literaturangaben nicht mehr benötigen. Diese Attribute beginnen mit `Ref_` und verbinden Dateien mit importierten Literaturangaben. Informationen zum Import und zur Verknüpfung finden Sie unter [Literaturangaben](3.5.-References.md). \ No newline at end of file diff --git a/docs/doc/de/3.5.-References.md b/docs/doc/de/3.5.-References.md index be3fa905..fc088cbc 100644 --- a/docs/doc/de/3.5.-References.md +++ b/docs/doc/de/3.5.-References.md @@ -19,4 +19,4 @@ Unter **Dateien verwalten** erscheinen vier zusätzliche Attributspalten: `Ref_A Bei verknüpften Dateien enthalten diese Spalten die entsprechenden Angaben. Literaturangaben können auch in Analysen angezeigt werden, beispielsweise unter **Analyse > Code-Retrieval**. -Mit der Exportschaltfläche exportieren Sie alle Literaturangaben im RIS-Format. +Mit der Exportschaltfläche exportieren Sie alle Literaturangaben im RIS-Format. \ No newline at end of file diff --git a/docs/doc/de/4.1.-Coding-Text.md b/docs/doc/de/4.1.-Coding-Text.md index 68b3d173..ba045c36 100644 --- a/docs/doc/de/4.1.-Coding-Text.md +++ b/docs/doc/de/4.1.-Coding-Text.md @@ -29,13 +29,13 @@ Besonders aussagekräftige Passagen, etwa Beispiele für einen Bericht, können **Überlappende Codes:** Überlappungen werden unterstrichen. Beim Bewegen der Maus darüber werden die beteiligten Codierungen angezeigt. Klicken Sie in die Überlappung und drücken Sie **O**, um zwischen den Codes an dieser Stelle zu wechseln. -## Annotierungen +## Annotierungen {#annotations} Eine Annotierung ist eine Notiz zu einer ausgewählten Textpassage, beispielsweise zur Erklärung von Abkürzungen oder Fachbegriffen. Annotierte Stellen erscheinen fett. Zum erneuten Öffnen wählen Sie einen Teil der fett gedruckten Passage und dann **Annotieren** im Kontextmenü. Alternativ verwenden Sie die linke Schaltfläche mit Notizblock und Stift oder die Taste **A**. Um eine Annotierung zu entfernen, öffnen Sie sie und löschen ihren gesamten Inhalt. ![Annotierung](/images/104526a8-1bba-4dae-8bcd-43d2ddc5f9c8.png) -## Automatisch kodieren +## Automatisch kodieren {#auto-code} Oben rechts stehen Schaltflächen zum automatischen Codieren bereit: @@ -59,7 +59,7 @@ Die Schaltflächen für exakte Treffer und Textfragmente bieten weitere Optionen ![Positionsverschiebung durch Emojis](/images/8ac5bcf5-fae4-4da3-a1dd-8dccf12d585b.png) -## Redebeiträge automatisch codieren +## Redebeiträge automatisch codieren {#auto-speaker-codings} **Sprecher:innen markieren** legt für jede Sprecher:in eines Interviews oder einer Gruppendiskussion einen Code an und ordnet die Redebeiträge automatisch zu. Damit können Sie Berichte auf bestimmte Sprecher:innen beschränken. Die Funktion ist über das Dateikontextmenü oder diese Schaltfläche verfügbar: @@ -74,17 +74,17 @@ Die Schaltflächen für exakte Treffer und Textfragmente bieten weitere Optionen - Um diese Codierungen bei der eigenen Analyse auszublenden, klicken Sie oben links neben dem Namen der Coder:in auf **…**. Setzen Sie im Dialog den Eintrag **📌 Sprecher:innen-Codierung** auf ausgeblendet. - Die Funktion steht auch unter **Dateien verwalten** bereit. -## Mehr Platz für den Text +## Mehr Platz für den Text {#maximise-screen-area} Klicken Sie in den Text und drücken Sie **H**, um die oberen Bedienelemente auszublenden. Erneutes Drücken blendet sie wieder ein. -## Schnell zwischen Dateien wechseln +## Schnell zwischen Dateien wechseln {#convenience-methods-for-loading-text-files-in-the-files-list-pane} Bei umfangreichen Projekten können Sie über das Kontextmenü der Dateiliste schnell die alphabetisch nächste Datei, die zuletzt codierte Datei oder die Datei mit dem Lesezeichen öffnen. Ein Lesezeichen setzen Sie über das Kontextmenü im Text. Es gilt jeweils nur für ein Projekt. Nach dem Wechsel zu einem anderen Projekt kann es deshalb an eine falsche Stelle führen oder nicht funktionieren. -### Schaltflächen unter der Dateiliste +### Schaltflächen unter der Dateiliste {#convenience-buttons-underneath-the-files-list} - Nächste Datei laden - Zuletzt codierte Datei laden @@ -94,7 +94,7 @@ Ein Lesezeichen setzen Sie über das Kontextmenü im Text. Es gilt jeweils nur f ![Dateifilter](/images/b3c32938-c1df-455c-be3e-3753c813535c.png) -## Grenzen codierter Segmente ändern +## Grenzen codierter Segmente ändern {#modifying-code-positions} Wählen Sie im Kontextmenü einer Codierung die Option zur Größenänderung. Die Griffe an beiden Enden des Segments lassen sich verschieben. @@ -114,7 +114,7 @@ Sichern Sie das Projekt vor Textänderungen, falls sich Codierungspositionen fal - **#** zeigt die Position des angeklickten Zeichens an. - **$** verschiebt die nachfolgenden Codierungspositionen um eine angegebene Zeichenzahl. Dies kann nötig sein, wenn Text hinzugefügt oder gelöscht wurde. -## Weitere Tastenkürzel +## Weitere Tastenkürzel {#other-shortcut-keys-for-text-coding} | Tastenkürzel | Funktion | | --- | --- | @@ -136,7 +136,7 @@ Sichern Sie das Projekt vor Textänderungen, falls sich Codierungspositionen fal | V | Auswahl mit einem neuen Code aus dem ausgewählten Text codieren (In-vivo-Codierung) | | Strg+Z | Zuletzt entfernte Codierung wiederherstellen | -## Text suchen +## Text suchen {#search-text} Oben in der Mitte befindet sich die Textsuche mit den Optionen **Groß-/Kleinschreibung beachten** und **Alle Dateien**. Wenn Sie Text markieren und **S** drücken, wird die Auswahl in das Suchfeld übernommen und die Schaltfläche für den nächsten Treffer fokussiert. @@ -150,28 +150,28 @@ Die Suche unterstützt reguläre Ausdrücke: - `\.` sucht einen Punkt, `\?` ein Fragezeichen und `\n` einen Zeilenumbruch. Weitere Beispiele bietet die [Regex-Kurzübersicht](https://www.rexegg.com/regex-quickstart.html). - `\b` kennzeichnet eine Wortgrenze; `\bbound\b` findet das ganze Wort `bound`, aber nicht `boundary`. -## Durch die Segmente eines Codes navigieren +## Durch die Segmente eines Codes navigieren {#moving-through-the-text-for-one-selected-code} Unter dem Codebaum befinden sich Vorwärts- und Rückwärtspfeile sowie eine Schaltfläche mit einem Rastersymbol. Wählen Sie einen Code und verwenden Sie die Pfeile, um seine Segmente im aktuellen Dokument durchzugehen. Andere Codierungen werden ausgeblendet. Mit der nun farbigen Rasterschaltfläche zeigen Sie wieder alle Codes an. !!! note Version 4.0 zeigt die gesamte Textdatei an. Frühere Versionen, etwa 3.8.2, konnten Texte in Abschnitten von 50.000 Zeichen laden. Wenn Sie diese Funktion benötigen, können Sie [Version 3.8.2](https://github.com/ccbogel/QualCoder/releases/tag/3.8.2) verwenden. Beachten Sie jedoch, dass sich die PDF-Textextraktion zwischen 3.8.2 und 4.0 geändert hat. Beim Öffnen neuerer Projekte in älteren Versionen können daher die Positionen codierter Segmente ungenau sein. -## Nur wichtige Codierungen anzeigen +## Nur wichtige Codierungen anzeigen {#show-only-important-coded-text} Die Sternschaltfläche unter dem Codebaum wechselt zwischen allen codierten Texten und den als **Wichtig** markierten Segmenten. -## Berichte exportieren +## Berichte exportieren {#export-reports} Sie können Berichte als ODT exportieren, kompatibel mit LibreOffice und Microsoft Word. Codes erscheinen entweder als Hervorhebungen oder als Kommentare am Rand. Der Bericht enthält die verwendeten Codes, Häufigkeiten, Annotierungen, Memos und codierten Texte. Weitere Optionen sind reiner Text, HTML und ein Codebuch-Export. -## Rechter Seitenbereich +## Rechter Seitenbereich {#right-hand-pane} Am rechten Fensterrand befindet sich ein zunächst verborgener Bereich. Ziehen Sie ihn vom Rand aus auf oder verwenden Sie die Schaltfläche neben der Hilfe. Eine Schaltfläche zeigt zu einem angeklickten Code dessen Namen, Codierregel beziehungsweise Memo und zufällig ausgewählte codierte Textbeispiele aus dem Projekt. Die andere zeigt das Projekt-Memo. ![Rechter Seitenbereich](/images/a6977ba3-bdf2-43c8-9097-562a252af815.png) -## Text im Codierbereich bearbeiten +## Text im Codierbereich bearbeiten {#editing-text-when-in-coding-code-text} Auch bereits codierte, annotierte oder vollständig beziehungsweise teilweise einem Fall zugeordnete Texte können bearbeitet werden. Im Bearbeitungsmodus kennzeichnen Unterstreichungen die Zuordnungen **aller Coder:innen**: grün für Fälle, gelb für Annotierungen und rot für Codierungen. @@ -191,6 +191,6 @@ Wenn eine Änderung die Zuordnungen beeinträchtigt hat, verlassen Sie den Bearb ![Text im Bearbeitungsmodus](/images/b02d740e-d561-4c3c-aff0-637d45740d03.png) -## Kategorien und Codes +## Kategorien und Codes {#categories-and-codes} -Siehe [Kategorien und Codes](4.7.-Codes-Tree.md). +Siehe [Kategorien und Codes](4.7.-Codes-Tree.md). \ No newline at end of file diff --git a/docs/doc/de/4.2.-AI-Assisted-Coding.md b/docs/doc/de/4.2.-AI-Assisted-Coding.md index fab17f93..7357f09f 100644 --- a/docs/doc/de/4.2.-AI-Assisted-Coding.md +++ b/docs/doc/de/4.2.-AI-Assisted-Coding.md @@ -3,7 +3,7 @@ path: 4.2.-AI-Assisted-Coding --- # KI-gestützte Codierung -## Einführung +## Einführung {#introduction} Die integrierten KI-Funktionen von QualCoder ab Version 3.6 unterstützen das Codieren auf verschiedene Weise: @@ -11,16 +11,16 @@ Die integrierten KI-Funktionen von QualCoder ab Version 3.6 unterstützen das Co - **Nach Konzepten statt nach Schlüsselwörtern suchen:** QualCoder kombiniert semantische Suche mit großen Sprachmodellen wie GPT-4. Sie können daher auch abstrakte Konzepte wie „veränderte Geschlechterrollen“ oder „Anerkennung am Arbeitsplatz“ suchen, ohne genaue Schlüsselwörter vorzugeben. - **Daten interaktiv interpretieren:** Die KI schlägt relevante Daten vor und liefert Interpretationen. Diese zusätzliche Perspektive kann Ihr Verständnis bereichern. - **An Ihre Methode anpassen:** Steuern Sie die Analyse durch vorgegebene oder eigene Prompts. -- **Unterstütztes Codieren:** Anders als beim schlüsselwortbasierten [automatischen Codieren](4.1.-Coding-Text.md#automatisch-kodieren) müssen Sie die Vorschläge der KI selbst prüfen. +- **Unterstütztes Codieren:** Anders als beim schlüsselwortbasierten [automatischen Codieren](4.1.-Coding-Text.md#auto-code) müssen Sie die Vorschläge der KI selbst prüfen. KI-gestützte Codierung ist keine eigenständige Methode, sondern umfasst Techniken, die sich an verschiedene codebasierte Methoden anpassen lassen, von Grounded Theory bis zur Inhaltsanalyse oder thematischen Analyse. Ein praktisches Beispiel zeigt dieses [Video-Tutorial](https://www.youtube.com/watch?v=FrQyTOTJhCc). -## Voraussetzungen +## Voraussetzungen {#preconditions} - Die KI muss aktiviert, vollständig geladen und für neue Anfragen bereit sein. Die Statusleiste zeigt ihren Zustand an. - Beschreiben Sie im **Projekt-Memo** kurz Ihre Forschungsthemen, Fragen, Ziele und empirischen Daten. Dies wird dringend empfohlen: Die Angaben begleiten jeden Prompt und helfen der KI, gezieltere Ergebnisse zu liefern. Das Memo erreichen Sie über **Projekt > Projekt-Memo**. -## KI-gestützte Codierung starten +## KI-gestützte Codierung starten {#start-ai-assisted-coding} Die Funktion ist in den Arbeitsbereich zum Textcodieren integriert. Öffnen Sie **Codierung > KI-unterstütztes Kodieren** oder wählen Sie im bestehenden Textcodierbereich links den Reiter **KI Unterstützung**. Klicken Sie anschließend auf **KI-Suche starten**. @@ -30,9 +30,9 @@ Im nächsten Fenster legen Sie (1) den Suchgegenstand fest, (2) geben der KI ein ![Dialog zur KI-Suche](/images/0d66baa1-6c60-423a-b4d6-742d387322dc.png) -### 1) Suchgegenstand: Code oder freies Thema +### 1) Suchgegenstand: Code oder freies Thema {#1-what-to-search-for-code-vs-free-topic-search} -#### Codesuche +#### Codesuche {#code-search} Verwenden Sie diese Option, um einen bestimmten Aspekt zu vertiefen und einem bestehenden Code weitere Daten aus dem gesamten Korpus hinzuzufügen. @@ -40,11 +40,11 @@ Verwenden Sie diese Option, um einen bestimmten Aspekt zu vertiefen und einem be - **Memo an die KI senden:** Wenn aktiviert, wird auch das Code-Memo übermittelt. Beschreiben oder definieren Sie darin den Code, um bessere Ergebnisse zu erhalten. Persönliche Notizen können Sie unter einer Zeile mit `#####` ergänzen; dieser Teil wird nicht an die KI gesendet. - **Codierte Segmente einschließen:** Standardmäßig ist diese Option deaktiviert. Die Suche liefert dann nur Daten, die noch nicht mit diesem Code codiert sind. Aktivieren Sie sie, wenn auch bereits codierte Daten berücksichtigt werden sollen. -#### Freie Themensuche +#### Freie Themensuche {#free-topic-search} Suchen Sie im gesamten Korpus nach einem Thema, Phänomen oder Konzept ohne vorgegebenen Code. Geben Sie einen Namen und eine Beschreibung ein, um der KI mitzuteilen, wonach Sie suchen. -### 2) Analyseanweisung: Der analytische Prompt +### 2) Analyseanweisung: Der analytische Prompt {#2-how-to-analyse-the-data-the-analytic-prompt-for-the-ai} Der analytische Prompt legt fest, wie die KI Ihre Daten untersuchen soll. Wählen Sie ihn unten links im Fenster aus. @@ -54,11 +54,11 @@ Der analytische Prompt legt fest, wie die KI Ihre Daten untersuchen soll. Wähle Bewegen Sie die Maus über die Einträge der Auswahlliste, um die Prompts kennenzulernen. Über die Bearbeitungsschaltfläche können Sie [Prompts ändern oder eigene erstellen](6.3.-AI-Prompt-Library.md); dies ist eine erweiterte Option. -### 3) Filter: Die Suche eingrenzen +### 3) Filter: Die Suche eingrenzen {#3-filter-narrow-your-search-down} Standardmäßig wird der gesamte Textkorpus des aktuellen Projekts durchsucht. Rechts im Fenster können Sie bestimmte **Dokumente** oder **Fälle** auswählen; mit **Strg+Klick** wählen Sie mehrere aus. Sie können auch anhand von **Attributvariablen** filtern. -## Ablauf der KI-gestützten Codierung +## Ablauf der KI-gestützten Codierung {#the-process-of-ai-assisted-coding} Starten Sie zuerst die KI-Suche. Sie verläuft in zwei Schritten: @@ -67,7 +67,7 @@ Starten Sie zuerst die KI-Suche. Sie verläuft in zwei Schritten: Bis zu den ersten Ergebnissen kann einige Zeit vergehen. Ein Klick auf einen Treffer lädt das Dokument im Hauptbereich und markiert das zugehörige Zitat. Lesen Sie auch den umgebenden Text, um den Kontext zu verstehen. -### Die Ergebnisse bearbeiten +### Die Ergebnisse bearbeiten {#working-through-the-results} Sie können den **ausgewählten Text wie gewohnt codieren**, wie unter [Text codieren](4.1.-Coding-Text.md) beschrieben. Erweitern oder verändern Sie die Auswahl bei Bedarf. @@ -81,9 +81,9 @@ QualCoder sortiert die Treffer nach geschätzter Relevanz. Dieser Algorithmus is Mit der Zeit entfernen sich die Treffer meist zunehmend vom ursprünglichen Thema. Wenn sie kaum noch relevant sind, können Sie die Suche beenden und zum nächsten Thema oder Code wechseln. Sie müssen nicht alle im ersten Schritt gefundenen Daten analysieren lassen – ebenso wenig, wie Sie bei einer Websuche jede Ergebnisseite lesen müssen. -### Wenn keine Ergebnisse erscheinen +### Wenn keine Ergebnisse erscheinen {#what-to-do-if-you-get-no-results} 1. **Schon der erste Schritt findet keine möglicherweise relevanten Daten:** Die Codesuche berücksichtigt standardmäßig nur neue Daten. Wenn Ihr Korpus bereits gründlich codiert ist, gibt es möglicherweise nichts Neues. Prüfen Sie außerdem, ob der Code- oder Themenname zu spezifisch oder unklar formuliert ist. 2. **Der zweite Schritt liefert keine Treffer:** Lassen Sie, sofern verfügbar, weitere Ergebnisse analysieren. Bleiben auch diese aus, beginnen Sie eine neue Suche mit einem offeneren Prompt. -Keine, sehr wenige oder überwiegend irrelevante Treffer deuten darauf hin, dass ein Thema in Ihren Daten wenig ausgeprägt ist. Dennoch ist nicht garantiert, dass die KI alle zu einem Code oder Thema passenden Passagen findet. +Keine, sehr wenige oder überwiegend irrelevante Treffer deuten darauf hin, dass ein Thema in Ihren Daten wenig ausgeprägt ist. Dennoch ist nicht garantiert, dass die KI alle zu einem Code oder Thema passenden Passagen findet. \ No newline at end of file diff --git a/docs/doc/de/4.3.-Coding-Text-on-PDFs.md b/docs/doc/de/4.3.-Coding-Text-on-PDFs.md index d593cedb..1a55f13e 100644 --- a/docs/doc/de/4.3.-Coding-Text-on-PDFs.md +++ b/docs/doc/de/4.3.-Coding-Text-on-PDFs.md @@ -7,7 +7,7 @@ Sie können sowohl Text als auch Bildbereiche eines PDFs codieren. ![PDF codieren](/images/ba02d9ee-24fe-4b67-84b0-4f62cd62a1c6.png) -## Tastenkürzel +## Tastenkürzel {#tastenkurzel} | Tastenkürzel | Funktion | | --- | --- | @@ -21,11 +21,11 @@ Sie können sowohl Text als auch Bildbereiche eines PDFs codieren. | Strg+9 | Anzeige auf wichtige codierte Segmente beschränken oder wieder alle anzeigen | | Strg+0 | Hilfeseite im Browser öffnen | -### In der PDF-Ansicht +### In der PDF-Ansicht {#in-der-pdf-ansicht} Klicken Sie in das PDF und drücken Sie **+** oder **−**, um die Ansicht zu vergrößern oder zu verkleinern. **Q** codiert die Auswahl mit dem zuletzt verwendeten Code. **R** bietet zuletzt verwendete Codes zur Auswahl an. -### Im Bereich für reinen Text +### Im Bereich für reinen Text {#im-bereich-fur-reinen-text} | Taste | Funktion | | --- | --- | @@ -38,11 +38,11 @@ Klicken Sie in das PDF und drücken Sie **+** oder **−**, um die Ansicht zu ve | U | Codierung an der ausgewählten Stelle entfernen | | V | Auswahl mit einem In-vivo-Code codieren | -## Berichte exportieren +## Berichte exportieren {#berichte-exportieren} Sie können Berichte als ODT exportieren, kompatibel mit LibreOffice und Microsoft Word, oder als PDF mit Hervorhebungen. -## Ältere Versionen bis einschließlich 3.8.2 +## Ältere Versionen bis einschließlich 3.8.2 {#altere-versionen-bis-einschlielich-382} Die Oberfläche besteht aus drei verstellbaren Bereichen: links Dateiliste und Codebaum, in der Mitte die PDF-Ansicht und rechts der extrahierte reine Text. In den Textfeldern der PDF-Darstellung werden nicht die Originalschriften, sondern die Standardschrift von QualCoder verwendet. Die Schriftgrößenkorrektur soll Überlappungen vermeiden. Sie steht standardmäßig auf `−2`; auch `−3` kann geeignet sein. @@ -50,6 +50,6 @@ Der rechte Bereich zeigt den reinen Text wie unter **Text codieren**. Dort könn Zum Codieren wählen Sie PDF-Textfelder durch Ziehen mit der linken Maustaste aus. Je nach Größe und Position der Felder kann dies schwierig sein. Klicken Sie anschließend auf einen Code. Im rechten Textbereich können Sie die Segmentgrenzen mit **Umschalt+Pfeil links/rechts** erweitern oder mit **Alt+Pfeil links/rechts** verkürzen. -## Kategorien und Codes +## Kategorien und Codes {#kategorien-und-codes} -Siehe [Kategorien und Codes](4.7.-Codes-Tree.md). +Siehe [Kategorien und Codes](4.7.-Codes-Tree.md). \ No newline at end of file diff --git a/docs/doc/de/4.4.-Coding-Images.md b/docs/doc/de/4.4.-Coding-Images.md index 897b7061..0b0efeb1 100644 --- a/docs/doc/de/4.4.-Coding-Images.md +++ b/docs/doc/de/4.4.-Coding-Images.md @@ -9,7 +9,7 @@ Oben rechts werden zum angeklickten codierten Bereich der Codename, die Pixelpos ![Bild codieren](/images/8e9e2ac8-61c0-4b4a-9d8b-31556da21fb2.png) -## Bildbereiche von PDFs codieren +## Bildbereiche von PDFs codieren {#pdf-image-coding} PDFs können hier oder im Arbeitsbereich **PDF codieren** als Bilder codiert werden. @@ -19,25 +19,25 @@ Schaltflächen zur Navigation im PDF: ![PDF-Navigation](/images/36effc9c-f0a2-4f02-9fe0-293abcd3060a.png) -## Wichtige codierte Bereiche +## Wichtige codierte Bereiche {#important-coded-areas} Besonders aussagekräftige Bereiche, etwa Beispiele für einen Bericht, können Sie im Kontextmenü als **Wichtig** markieren. Die Sternschaltfläche oben wechselt zwischen allen codierten Bereichen und den als wichtig markierten Bereichen. -## Tastenkürzel +## Tastenkürzel {#shortcuts} - **H** im Bildbereich blendet die oberen Bedienelemente aus oder wieder ein. - **L** filtert den Codebaum anhand von Namen. - **+** und **−** vergrößern beziehungsweise verkleinern das Bild. - **Strg+Z** stellt den zuletzt entfernten codierten Bereich wieder her. -## Schaltflächen unter der Dateiliste +## Schaltflächen unter der Dateiliste {#convenience-buttons-underneath-the-files-list} - Nächste Datei laden - Zuletzt codierte Datei laden - Memo der ausgewählten Datei öffnen - Dateien anhand von Attributen oder Fallzuordnungen filtern; die Schaltfläche zeigt ein Etikettensymbol -## Weitere Optionen im Bildkontextmenü +## Weitere Optionen im Bildkontextmenü {#right-click-on-the-image-area-for-more-options} Per Rechtsklick können Sie das Bild drehen oder einen bestimmten Code beziehungsweise codierten Bereich hervorheben. Die Optionen umfassen Ausgrauen, Weichzeichnen und Solarisieren. Das Ergebnis wird im Standardprogramm zur Bildanzeige geöffnet und kann dort gespeichert werden. @@ -47,10 +47,10 @@ Beispiel für hervorgehobene codierte Bereiche mit Beschriftungen: ![Hervorgehobene Bereiche mit Beschriftungen](/images/be991d7a-363b-4e5a-a93a-d02ccde42930.png) -## Export +## Export {#export} Ein codiertes Bild kann als HTML-Datei exportiert werden. Im Browser erscheinen Codenamen und Memos, wenn Sie die Maus über die codierten Bereiche bewegen. -## Kategorien und Codes +## Kategorien und Codes {#categories-and-codes} -Siehe [Kategorien und Codes](4.7.-Codes-Tree.md). +Siehe [Kategorien und Codes](4.7.-Codes-Tree.md). \ No newline at end of file diff --git a/docs/doc/de/4.5.-Coding-Audio-and-Video.md b/docs/doc/de/4.5.-Coding-Audio-and-Video.md index 7043c909..027fd2ed 100644 --- a/docs/doc/de/4.5.-Coding-Audio-and-Video.md +++ b/docs/doc/de/4.5.-Coding-Audio-and-Video.md @@ -9,7 +9,7 @@ Sie können auch den Transkripttext codieren und annotieren. Ein Rechtsklick auf ![Audio/Video codieren](/images/bac80f08-c719-4add-9878-104d3fbc084e.png) -## Tastenkürzel +## Tastenkürzel {#keyboard-shortcuts} | Tastenkürzel | Funktion | | --- | --- | @@ -31,7 +31,7 @@ Diese Funktionen stehen auch über die Werkzeugleiste bereit. Wenn der Textberei - **Q:** Ausgewählten Text mit dem zuletzt verwendeten Code codieren - **R:** Zuletzt verwendete Codes zur Codierung der Auswahl anbieten -## Audio/Video-Segmente +## Audio/Video-Segmente {#audio-video-segments} Erstellen Sie ein Segment mit der Schaltfläche zum Starten und Stoppen der Segmentauswahl. Ordnen Sie es anschließend über das Kontextmenü des gewünschten Codes zu. @@ -39,13 +39,13 @@ Im unteren Bereich erscheinen Codierungsstreifen. Beim Bewegen der Maus darüber Auch das Transkript kann in diesem Fenster codiert und annotiert werden. Bei aktiviertem automatischem Scrollen ist dies jedoch nicht möglich; dann folgt das Transkript anhand der Zeitstempel der Wiedergabe. -## Wichtige Texte und Segmente +## Wichtige Texte und Segmente {#important-coded-text-and-segments} Sie können codierte Textpassagen und Audio/Video-Segmente im Kontextmenü als **Wichtig** kennzeichnen, etwa als Beispiele für einen Bericht. Die Sternschaltfläche oben wechselt zwischen allen Codierungen und den als wichtig markierten Texten und Segmenten. **Text mit einem Segment verknüpfen:** Wählen Sie Text aus, vorzugsweise noch nicht codierten Text. Öffnen Sie anschließend das Kontextmenü des Segmentstreifens und wählen Sie die Option zur Verknüpfung des Textes mit dem Segment. -## Codierungsgrenzen im Text ändern +## Codierungsgrenzen im Text ändern {#modifying-code-positions-in-the-text-area} Klicken Sie auf eine Codierung, die an dieser Stelle nicht mit einer anderen überlappt, und verwenden Sie: @@ -58,17 +58,17 @@ Alternativ ändern Sie die Start- oder Endposition über das Kontextmenü und di Sie können ein Standbild exportieren. Es wird als `Frame_yyyymmdd_hh_mm_ss.jpg` gespeichert und kann anschließend im Projekt als Bild codiert werden. -## Schaltflächen unter der Dateiliste +## Schaltflächen unter der Dateiliste {#convenience-buttons-underneath-the-files-list} - Nächste Datei laden - Zuletzt codierte Datei laden - Memo der ausgewählten Datei öffnen - Dateien anhand von Attributen oder Fallzuordnungen filtern -## Probleme mit Audio/Video auf einzelnen Betriebssystemen +## Probleme mit Audio/Video auf einzelnen Betriebssystemen {#audio-and-video-problems-on-some-operating-systems} Unter Fedora funktioniert die Audio/Video-Unterstützung nicht. -## Kategorien und Codes +## Kategorien und Codes {#categories-and-codes} -Siehe [Kategorien und Codes](4.7.-Codes-Tree.md). +Siehe [Kategorien und Codes](4.7.-Codes-Tree.md). \ No newline at end of file diff --git a/docs/doc/de/4.6.-Code-Organiser.md b/docs/doc/de/4.6.-Code-Organiser.md index f791fd5e..e946a60a 100644 --- a/docs/doc/de/4.6.-Code-Organiser.md +++ b/docs/doc/de/4.6.-Code-Organiser.md @@ -25,4 +25,4 @@ Alle untergeordneten Kategorien und Codes Ihrer Auswahl werden angezeigt. Eine Schaltfläche exportiert die Darstellung als PNG-Datei. -Erst mit **Anwenden** werden die Änderungen in den Codebaum übernommen. Ohne diese Bestätigung bleibt die Projektstruktur unverändert. +Erst mit **Anwenden** werden die Änderungen in den Codebaum übernommen. Ohne diese Bestätigung bleibt die Projektstruktur unverändert. \ No newline at end of file diff --git a/docs/doc/de/4.7.-Codes-Tree.md b/docs/doc/de/4.7.-Codes-Tree.md index a449da7e..b0b01dd8 100644 --- a/docs/doc/de/4.7.-Codes-Tree.md +++ b/docs/doc/de/4.7.-Codes-Tree.md @@ -10,7 +10,7 @@ Codes und Kategorien können Memos erhalten. Darin sind auch Sonderzeichen mögl !!! note Ein Code kann nicht mehreren Kategorien zugeordnet werden. Diese häufig gewünschte Funktion würde statt des Codebaums eine [Graphstruktur](https://www.baeldung.com/cs/tree-vs-graph-data-structure) erfordern und die Umsetzung erheblich verkomplizieren. Sie können stattdessen ähnlich benannte Codes in verschiedenen Kategorien verwenden. -## Weniger Codes anzeigen +## Weniger Codes anzeigen {#reducing-the-amount-of-codes-displayed-in-the-codes-tree} Im Kontextmenü des Codebaums der Arbeitsbereiche zum Codieren von Text, Audio/Video oder Bildern können Sie Codes nach Namen filtern. Alternativ drücken Sie **F9**, wenn der Codebaum den Fokus hat. Geben Sie einen Text ein, um nur Codes anzuzeigen, deren Name diesen enthält. Ein leeres Suchfeld und **OK** zeigen wieder alle Codes. @@ -18,13 +18,13 @@ Sie können auch Codes nach Farbe filtern; dafür dient **F10**, wenn der Codeba Die Schaltfläche mit dem Suchsymbol unter dem Codebaum springt zum ersten Code, dessen Name den eingegebenen Text enthält. -## Kontextmenü des Codebaums +## Kontextmenü des Codebaums {#codes-tree-menu-options} Ein Rechtsklick auf einen Code im linken Codebaum öffnet Optionen zur Bearbeitung von Codes und Kategorien sowie zum Filtern und Sortieren. ![Kontextmenü des Codebaums](/images/4adaa97e-da9c-45bf-88f3-8e0110edf638.png) -### Codierte Dateien anzeigen +### Codierte Dateien anzeigen {#show-coded-files} Diese Option zeigt alle Stellen, die mit dem ausgewählten Code codiert wurden. Ein Klick auf ein Segment öffnet es im ursprünglichen Kontext. @@ -34,8 +34,8 @@ Diese Option zeigt alle Stellen, die mit dem ausgewählten Code codiert wurden. Mit **F11** sortieren Sie den Codebaum aufsteigend, mit **F12** absteigend. Der Codebaum muss dabei den Fokus haben. -## Barrierefreiheit und Codefarben +## Barrierefreiheit und Codefarben {#accessibility-and-code-colours} Im Menü **Codierung** finden Sie **Farbschema**. Damit weisen Sie mehreren ausgewählten Codes eine Farbpalette zu, statt Zufallsfarben zu verwenden oder jede Farbe einzeln zu ändern. -Sie können dort auch simulieren, wie die Codefarben für Menschen mit Rotsehschwäche, Rotblindheit, Grünsehschwäche oder Grünblindheit erscheinen. +Sie können dort auch simulieren, wie die Codefarben für Menschen mit Rotsehschwäche, Rotblindheit, Grünsehschwäche oder Grünblindheit erscheinen. \ No newline at end of file diff --git a/docs/doc/de/5.1.-AI-chat-based-analysis.md b/docs/doc/de/5.1.-AI-chat-based-analysis.md index c4596785..f8cac552 100644 --- a/docs/doc/de/5.1.-AI-chat-based-analysis.md +++ b/docs/doc/de/5.1.-AI-chat-based-analysis.md @@ -4,7 +4,7 @@ path: 5.1.-AI-chat-based-analysis # Mit dem KI-Agenten Daten analysieren -## Grundprinzipien der KI-Integration +## Grundprinzipien der KI-Integration {#core-principles-of-ai-integration} **1) KI-Vielfalt** @@ -22,7 +22,7 @@ Die Prompts, die die Arbeit des KI-Agenten steuern, sind einsehbar und können g Im Mittelpunkt steht ein dialogischer Umgang mit KI: zusätzliche Perspektiven entwickeln, eigene Deutungen hinterfragen und das Material besser verstehen. Auf Wunsch arbeitet der Agent auch längere Arbeitsaufträge semi-autonom ab. Großflächige Automatisierung war aber nie das primäre Ziel. -## Arbeit mit dem KI-Agenten +## Arbeit mit dem KI-Agenten {#working-with-the-ai-agent} - Der KI-Agent hat seinen **eigenen Tab** in QualCoder. Sie können ihn mit einem Klick auf den kleinen Pfeil-Button aber auch in eine **Seitenleiste** (s.u.) schieben, neben den Daten. ![Pfeil-Button zum Verschieben des KI-Agenten in die Seitenleiste](../../images/ai-agent-sidebar-button-de.png){ width="118" } @@ -33,20 +33,20 @@ Im Mittelpunkt steht ein dialogischer Umgang mit KI: zusätzliche Perspektiven e !!! note Die KI muss **vollständig geladen** und bereit für neue Abfragen sein, bevor ein Chat gestartet werden kann (Statusleiste: „KI: bereit“). -### Wozu dient der KI-Agent? +### Wozu dient der KI-Agent? {#what-is-the-ai-agent-for} - Der KI-Agent unterstützt Sie dabei, Ihr **empirisches Material zu erkunden,** Interpretationen und Analysen zu entwickeln, zu Codieren und Memos zu schreiben. - Sie können mit der KI über einzelne Textstellen diskutieren oder auch im gesamten Materialkorpus des Projekts nach Themen oder Kontrastfällen suchen. - Sie können Ihr Codesystem weiterentwickeln, Ideen und Analysestrategien brainstormen und direkt am empirischen Material überprüfen. - Im Unterschied zu generischen Chatbots macht der KI-Agent in QualCoder dabei **genau dort weiter, wo die bisherige Analyse aufgehört hat:** Er inspiziert das aktuelle Codesystem, kann Memos und Codierungen lesen, Fälle und deren Merkmale (Attribute) in die Analyse einbeziehen, etc. So erhalten Sie Feedback, das genau zum aktuellen Stand der Untersuchung passt. -### Welche Möglichkeiten hat der KI-Agent? +### Welche Möglichkeiten hat der KI-Agent? {#what-can-the-ai-agent-do} - Schon mit reinem **Lesezugriff** auf das Projekt ist der KI-Agent ein mächtiges Brainstorming-Tool. - Auf Wunsch kann er aber nicht nur Fragen beantworten, sondern die **Analyse auch aktiv vorantreiben.** Mit den entsprechenden Berechtigungen (s.u.) kann er neue Codes anlegen oder bestehende reorganisieren, neue Textpassagen suchen und codieren, Memos überarbeiten oder neue Fallattribute erstellen. - Im Gespräch mit dem Agenten können Sie Vorschläge prüfen, Rückfragen stellen und das weitere Vorgehen bestimmen. -### Welche Grenzen gibt es? +### Welche Grenzen gibt es? {#what-are-its-limitations} - Aktuell kann der KI-Agent nur mit **Textdaten** arbeiten, nicht mit Bildern, Audio oder Video – und auch nicht mit Notizbüchern. - Sie können zwischen drei Berechtigungsstufen wählen: @@ -60,7 +60,7 @@ Im Mittelpunkt steht ein dialogischer Umgang mit KI: zusätzliche Perspektiven e - Eine **strikte Grenze** gibt es jedoch immer: Die empirischen Daten selbst bilden die "ground truth" der gesamten Analyse. Sie können unter keinen Umständen durch KI verändert werden. - Außerdem hat der KI-Agent **keinen Zugriff auf externe Informationen,** etwa aus dem Internet. Er kann also nur mit den Daten arbeiten, die Sie bewusst in das Projekt aufgenommen haben. -### Wie sehe ich, welche Änderungen die KI vornimmt? +### Wie sehe ich, welche Änderungen die KI vornimmt? {#how-can-i-see-which-changes-the-ai-makes} - Der Agent **dokumentiert seine Arbeitsschritte im Chat,** macht Quellenangaben, und fragt bei größeren Eingriffen vorher nach. - Die letzten Änderungen des KI-Agenten lassen sich mit dem entsprechenden Button im Chatfenster leicht **rückgängig** machen: @@ -75,7 +75,7 @@ Im Mittelpunkt steht ein dialogischer Umgang mit KI: zusätzliche Perspektiven e ![Sichtbarkeit der Codierungen des AI Agent einstellen](../../images/ai-agent-code-visibility-de.png){ width="250" } -### Wie bereite ich mein Projekt vor? +### Wie bereite ich mein Projekt vor? {#how-should-i-prepare-my-project} - Wichtig ist ein aussagekräftiges **Projektmemo** (Menü "Projekt > Projektmemo"). Halten Sie dort fest: @@ -96,7 +96,7 @@ Im Mittelpunkt steht ein dialogischer Umgang mit KI: zusätzliche Perspektiven e !!! note **Persönliche Notizen in Memos:** Wenn Sie Memos auch für persönliche Notizen nutzen wollen, schreiben Sie diese hinter die Zeichenfolge `#####` als Trenner. Alles danach ist für die KI nicht lesbar. -### Wie arbeitet der KI-Agent? +### Wie arbeitet der KI-Agent? {#how-does-the-ai-agent-work} - Der KI-Agent wird nur tätig, wenn Sie ihm einen **Auftrag** geben, nicht von sich aus. - Der Agent bearbeitet einen Auftrag in einer sogenannten **ReAct loop** (Reflect + Act, [Shunyu et al. 2022](https://arxiv.org/abs/2210.03629)): @@ -110,13 +110,13 @@ Im Mittelpunkt steht ein dialogischer Umgang mit KI: zusätzliche Perspektiven e - Der Agent hat **mächtige Werkzeuge** zur Verfügung: Er kann bspw. eine semantische Ähnlichkeitssuche im gesamten Materialkorpus durchführen, mit regulären Ausdrücken oder in einem BM25-Stichwortindex suchen, sowie Tools aufrufen, um Codes zu erstellen oder zu ändern, wenn er Schreibrechte hat. -### Was passiert mit meinen Daten? +### Was passiert mit meinen Daten? {#what-happens-to-my-data} - Alle Daten bleiben grundsätzlich **lokal auf Ihrem Rechner** im aktuellen QualCoder-Projekt. Auch die genannten Suchoperationen laufen hier. - Das **KI-Modell sieht immer nur den Ausschnitt der Daten** (bspw. Suchergebnisse oder einzelnen Textpassagen), der für die aktuelle Analyse konkret gebraucht wird. Diese Datenfragmente werden zusammen mit dem jeweiligen Auftrag an das KI-Modell gesandt. - In seinen Antworten dokumentiert der KI-Agent ausführlich die Datenbasis seiner Analysen. QualCoder übersetzt das in **Quellenlinks mit Zeilennummern.** Ein Klick auf diese Quellenangabe öffnet die Passage im ursprünglichen Kontext. -## Vier Wege in die Konversation mit dem Agenten +## Vier Wege in die Konversation mit dem Agenten {#four-ways-to-start-a-conversation-with-the-agent} ![Vier Ausgangspunkte: offene Frage, Thema, Textstelle und Code oder Kategorie](../../images/ai-agent-conversation-paths-de.png) @@ -126,7 +126,7 @@ Unten links im Fenster des KI-Agenten können Sie eine neue Analyse in einer der Diese Varianten bilden lediglich **unterschiedliche Ausgangspunkte** für die Analyse. Anschließend können Sie das Gespräch in jede beliebige Richtung weiterentwickeln. -### 1) Neuer, offener Chat +### 1) Neuer, offener Chat {#1-new-open-chat} Das ist der flexibelste Weg, eine neue Analyse mit dem Agenten zu initiieren. Beginnen Sie mit einer Idee, einer offenen Frage, oder benennen Sie die Codes oder Textstellen, die Sie untersuchen wollen. @@ -153,7 +153,7 @@ Das ist der flexibelste Weg, eine neue Analyse mit dem Agenten zu initiieren. Be Wenn Sie **vorgefertigte oder eigene Prompts** aus der [KI-Prompt-Bibliothek](./6.3.-AI-Prompt-Library.md) in das Gespräch integrieren wollen, nutzen Sie die sogenannte 'Slash-Notation': "/in-vivo-coding" würde bspw. einen entsprechenden Prompt, den Sie zuvor in der Prompt-Bibliothek gespeichert haben, in das aktuelle Gespräch übernehmen. -### 2) Themenexploration +### 2) Themenexploration {#2-topic-exploration} Diese Analyse eignet sich vor allem, um eine **erste Übersicht** zu bekommen, wie ein bestimmtes Thema im empirischen Material verhandelt wird. Bei einfachen Fragestellungen mit klar eingrenzbaren Themen können Sie mit dieser Funktion auch zusammenfassende Analysen erstellen, die direkt in einem Bericht weiterverarbeitet werden können. @@ -170,7 +170,7 @@ Diese Analyse eignet sich vor allem, um eine **erste Übersicht** zu bekommen, w > > **Ergebnis:** Eine fallvergleichende Analyse von Ethel und Flora zum Thema "Kinder aufziehen im Krieg", strukturiert entlang der drei Unterfragen. -### 3) Textanalyse +### 3) Textanalyse {#3-text-analysis} - Ermöglicht die **textnahe Analyse einer ausgewählten Passage** mit dem KI-Agenten. - Entwickeln Sie gemeinsam neue Lesarten und Codevorschläge, oder diskutieren Sie Ambivalenzen, Unklarheiten sowie offene Fragen der Interpretation. @@ -191,7 +191,7 @@ Sie können auch eigene Instruktionen für die Textanalyse in der [KI-Prompt-Bib > d) Dann beginnt ein **Gespräch über das Material,** in dem gemeinsam verschiedene Deutungsmöglichkeiten durchgespielt und diskutiert werden. > e) **Ergebnisse sichern:** Wenn Sie fertig sind, instruieren Sie den KI-Agenten, eine Zusammenfassung der Ergebnisse als Textannotierung zu speichern. -### 4) Codeanalyse +### 4) Codeanalyse {#4-code-analysis} - Analysiert alle **Daten, die unter einem bestimmten Code oder einer Kategorie gesammelt wurden,** einschließlich der Untercodes. - Diskutieren Sie Ihre Codierungen mit dem KI-Agenten, vergleichen Sie verschiedene Codes, erzeugen Sie Untercodes oder erstellen Sie Berichte. @@ -210,14 +210,14 @@ Auch für diese Funktion können Sie eigene Prompts in der [KI-Prompt-Bibliothek > > **Ergebnis:** Ein ausführlicher Bericht zur "theoretischen Sättigung" des aktuellen Codes bzw. der ausgewählten Kategorie im Sinne der Grounded Theory. Dabei sucht der KI-Agent aktiv im Material nach bisher nicht codierten Varianten des im Code erfassten Phänomens, nach Grenzfällen und Gegenbeispielen, um die empirische sowie konzeptionell-theoretische Sättigung des Codes zu prüfen und Lücken aufzudecken. Dabei wird auch das Memo des Codes einbezogen. -## Abschließend: Zur Frage der Anthropomorphisierung +## Abschließend: Zur Frage der Anthropomorphisierung {#a-final-reflection-on-anthropomorphism} Wir haben uns bewusst dagegen entschieden, dem KI-Agenten in QualCoder einen Namen zu geben, wie bspw. "Claude" von Anthropic. Trotzdem ist es so, dass der dialogische Ansatz der KI-Integration in QualCoder eine Art Pseudo-Interaktion inszeniert, die sich in vieler Hinsicht an menschlichen Interaktionsmustern bspw. im Rahmen einer Forscher:innengruppe orientiert. In seinem [grundlegenden Systemprompt](https://github.com/ccbogel/QualCoder/blob/master/src/qualcoder/ai_prompts/_agent.md) wird dem KI-Agenten in QualCoder genau so eine Rolle als quasi Teammitglied zugewiesen. Anthropomorphisieren wir also eine Maschine, indem wir mit ihr interagieren, als sei sie eine menschliche Forscherin/ein Forscher? Zu einem gewissen Grad ist das tatsächlich der Fall. Aber mir scheint es am sinnvollsten, diese Interaktionen als eine Art "Rollenspiel" zu betrachten, wie es [Shanahan, McDonell & Reynolds 2023](https://www.nature.com/articles/s41586-023-06647-8) vorgeschlagen haben. Heutige KI-Sprachmodelle sind an menschlich-sprachlichen Interaktionen trainiert. Sie funktionieren deshalb am besten, wenn man sie in solche Interaktionssituationen integriert. Trotzdem ist für einen methodisch reflektierten Umgang mit KI in der qualitativen Sozialforschung sehr wichtig, nicht zu vergessen, dass wir es hier mit einem technologisch induzierten Rollenspiel zu tun haben und nicht mit einem menschlichen Gegenüber interagieren. -## Weitere Funktionen +## Weitere Funktionen {#further-functions} - In der **[KI-Prompt-Bibliothek](./6.3.-AI-Prompt-Library.md)** können Sie erfolgreiche Analysestrategien und methodische Vorgehensweisen als wiederverwendbare Instruktionen für später speichern. - **[KI-unterstütztes Codieren](./4.2.-AI-Assisted-Coding.md)** im Arbeitsbereich 'Text codieren'. Dort hilft eine KI-basierte Suche, passende Textstellen zu einem bestimmten Code im gesamten Materialkorpus zu finden. -- Wenn Sie **Fragen zur Bedienung von QualCoder** haben, kann der KI-Agent Sie auch dabei unterstützen und Antworten auf Basis der QualCoder-Dokumentation erstellen. Wählen Sie im Hauptmenü *Hilfe > Den KI-Agenten fragen* aus. +- Wenn Sie **Fragen zur Bedienung von QualCoder** haben, kann der KI-Agent Sie auch dabei unterstützen und Antworten auf Basis der QualCoder-Dokumentation erstellen. Wählen Sie im Hauptmenü *Hilfe > Den KI-Agenten fragen* aus. \ No newline at end of file diff --git a/docs/doc/de/5.2.-Journals.md b/docs/doc/de/5.2.-Journals.md index f5e0745e..f1043efd 100644 --- a/docs/doc/de/5.2.-Journals.md +++ b/docs/doc/de/5.2.-Journals.md @@ -21,8 +21,8 @@ Sie können Notizbücher nach Name oder Datum sortieren und Attribute ergänzen. Das Notizbuchfenster lässt sich unabhängig vom Hauptfenster bewegen, sodass Sie während des Codierens oder der Berichtserstellung Notizen eingeben können. -## Text mit Markdown hervorheben +## Text mit Markdown hervorheben {#highlight-journal-text-using-markdown} Einige Markdown-Auszeichnungen werden unterstützt: Ein bis drei Rautenzeichen am Zeilenanfang kennzeichnen Überschriften. Ein Sternchenpaar um Text erzeugt Kursivschrift, zwei Sternchen auf jeder Seite erzeugen Fettschrift. -URLs werden erkannt und können über das Kontextmenü geöffnet werden. +URLs werden erkannt und können über das Kontextmenü geöffnet werden. \ No newline at end of file diff --git a/docs/doc/de/5.3.-Analysis.md b/docs/doc/de/5.3.-Analysis.md index c1f82f2b..470c63e6 100644 --- a/docs/doc/de/5.3.-Analysis.md +++ b/docs/doc/de/5.3.-Analysis.md @@ -11,7 +11,7 @@ path: 5.3.-Analysis - **Graph:** Eine Mindmap mit Objekten und ihren Verbindungen erstellen. - **KI-gestützte Analyse:** Nach Thema, Text oder Code analysieren. -## Code-Retrieval { #code-retrieval } +## Code-Retrieval {#code-retrieval} Dieser Bericht stellt codierte Daten anhand Ihrer Auswahl als Liste oder Matrix zusammen. Wählen Sie mindestens einen Code. Bei Auswahl einer Kategorie werden alle enthaltenen Codes mit ausgewählt. Mit **Strg+Klick** können Sie mehrere Kategorien auswählen. Die Suchschaltfläche mit dem Wiedergabesymbol zeigt die Ergebnisse an. @@ -21,17 +21,17 @@ Dieser Bericht stellt codierte Daten anhand Ihrer Auswahl als Liste oder Matrix Geben Sie einen Text in das Suchfeld ein, erscheinen nur Codierungen mit passenden Textstellen. Die Suche berücksichtigt auch Memos zu codierten Bildbereichen und Audio/Video-Segmenten. Verwenden Sie die Textsuche zusammen mit einer Datei-, Fall- oder Attributauswahl. -## Wichtige Texte, Bilder und Segmente +## Wichtige Texte, Bilder und Segmente {#important-coded-text-images-segments} Mit der entsprechenden Option zeigen Sie nur als **Wichtig** markierte Codierungen an. So finden Sie schnell aussagekräftige Beispiele für einen schriftlichen Bericht. -## Attribute für Berichte auswählen +## Attribute für Berichte auswählen {#attribute-selection-in-reports} Die Attributauswahl öffnet einen Dialog für Datei- und Fallattribute, etwa zur Auswahl von Interviewdateien mit Personen über 60 Jahren. Attributfilter lassen sich speichern, laden und löschen. ![Attributauswahl](/images/8d349854-7e35-474b-8bba-119b23ed40b0.png) -## Codierungsmatrix +## Codierungsmatrix {#coding-matrix} Bei einer Matrixoption teilt sich der Ergebnisbereich: Links stehen die codierten Daten als Liste, rechts eine Matrix. Spalten können Codes, Kategorien oder Kategorien der obersten Ebene darstellen. Zeilen beziehen sich auf Dateien oder Fälle. Mit einer Option können Sie die Matrix transponieren. @@ -41,18 +41,18 @@ Die Größe der Bereiche verändern Sie durch Ziehen der Trennlinie. Berichte la Bei ausgewählten Fällen erscheint ein weiterer Bereich mit Fällen in den Zeilen und Kategorien oder Codes in den Spalten. -## Anzeigeoptionen +## Anzeigeoptionen {#check-boxes} - Nur als wichtig markierte codierte Segmente anzeigen - Zusammenfassende Statistiken ergänzen - Textkontext anzeigen: 100 bis 300 umgebende Zeichen, je nach Einstellung; das codierte Segment erscheint fett - Literaturangabe hinzufügen, sofern diese importiert und mit der Datei verknüpft ist -## Weitere Funktionen +## Weitere Funktionen {#other-functions} Mit **H** blenden Sie die oberen Bedienelemente aus oder wieder ein. -### Memos +### Memos {#memos} Eine Auswahlliste steuert, ob keine Memos, bestimmte Arten von Memos oder die Annotierungen der ausgewählten Textdateien angezeigt werden. @@ -60,7 +60,7 @@ Im Kontextmenü einer Codeüberschrift im Bericht können Sie das Segment im Kon ![Kontextmenü im Bericht](/images/a6d29ccf-2d9f-4faf-a1a6-5aaf3498e9a9.png) -### Berichte exportieren +### Berichte exportieren {#exporting-reports} Verfügbare Formate sind HTML, ODT, TXT, CSV, XLSX und ab Version 3.8 Iramuteq: @@ -73,7 +73,7 @@ Verfügbare Formate sind HTML, ODT, TXT, CSV, XLSX und ab Version 3.8 Iramuteq: ![HTML-Bericht und Medienordner](/images/998a1792-38b1-489e-a459-200819bbbf73.png) -## Kookkurrenz von Codes { #code-co-occurrence-report } +## Kookkurrenz von Codes {#code-co-occurrence-report} Dieser Bericht zeigt eine Tabelle mit Codenamen auf beiden Achsen. Jede Zelle enthält die Anzahl der Kookkurrenzen, also der Überlappungen oder direkt aneinandergrenzenden Codierungen. Ein Klick auf eine Zelle zeigt die entsprechenden Textstellen. @@ -91,7 +91,7 @@ Beispiele für einen Kookkurrenzgraphen und einen Clustergraphen: ![Kookkurrenz- und Clustergraph](/images/651896887-02b544ba-31f7-4ac8-b0f6-b6c017fd418d.png) -## Beziehungen zwischen Codes { #code-relations-report } +## Beziehungen zwischen Codes {#code-relations-report} Dieser Bericht untersucht Beziehungen zwischen mindestens zwei Codes und ist nur für Textdateien verfügbar. Wählen Sie die Codes und starten Sie die Berechnung. Anders als die Berichte zu Kookkurrenz und exakten Textübereinstimmungen liefert er detaillierte Angaben, etwa die Zeichenpositionen jeder Codierung. Ein CSV-Export ist möglich. @@ -108,22 +108,22 @@ Zusammenfassende Statistiken und Boxplots können erstellt werden. ![Statistiken und Boxplots](/images/a04d7b62-506b-4f05-ba62-5394e5f09748.png) -## Exakte Textübereinstimmungen { #code-text-by-exact-matches-report } +## Exakte Textübereinstimmungen {#code-text-by-exact-matches-report} Dieser Bericht zeigt Textsegmente, denen verschiedene Codes mit exakt denselben Grenzen zugewiesen wurden. Wählen Sie Textdokumente und mindestens zwei Codes aus. ![Exakte Textübereinstimmungen](/images/284f388e-f561-416e-accb-ec18ad509944.png) -## Codes nach Textsegmenten { #codes-by-text-segments-report } +## Codes nach Textsegmenten {#codes-by-text-segments-report} Die Zeilen dieser Tabelle enthalten codierte Textsegmente, die Spalten zeigen die zugewiesenen Codes. Dies ist beispielsweise für Benutzer:innen im juristischen Bereich hilfreich, die alle Codes derselben Passage überblicken möchten. Ein Excel-Export ist möglich. ![Codes nach Textsegmenten](/images/226f7c7d-f343-46d7-a2a7-49d86bfa3ef2.png) -## Graph beziehungsweise Mindmap +## Graph beziehungsweise Mindmap {#graph-mind-map} Siehe [Graph](5.5.-Graph.md). -## KI-gestützte Analyse +## KI-gestützte Analyse {#ai-assisted-analysis} -Siehe [Mit dem KI-Agenten Daten analysieren](5.1.-AI-chat-based-analysis.md). +Siehe [Mit dem KI-Agenten Daten analysieren](5.1.-AI-chat-based-analysis.md). \ No newline at end of file diff --git a/docs/doc/de/5.3.-legacy-reports-landing.md b/docs/doc/de/5.3.-legacy-reports-landing.md index acd5d696..d45e10c6 100644 --- a/docs/doc/de/5.3.-legacy-reports-landing.md +++ b/docs/doc/de/5.3.-legacy-reports-landing.md @@ -6,4 +6,4 @@ path: 5.3.-legacy-reports-landing Die Hilfeseite, auf die ältere QualCoder-Versionen verweisen, wurde auf zwei Seiten aufgeteilt. Wählen Sie den Abschnitt für das verwendete Werkzeug: - [Analyse](5.3.-Analysis.md): Code-Retrieval, Kookkurrenz, Beziehungen zwischen Codes, übereinstimmende Textsegmente, Codes nach Textsegmenten, Graphen und KI-gestützte Analyse. -- [Berichte](5.4.-Reports.md): Vergleich von Coder:innen, Codeanzahl und -häufigkeiten, Datei- und Codezusammenfassungen, Diagramme und Datenbankabfragen. +- [Berichte](5.4.-Reports.md): Vergleich von Coder:innen, Codeanzahl und -häufigkeiten, Datei- und Codezusammenfassungen, Diagramme und Datenbankabfragen. \ No newline at end of file diff --git a/docs/doc/de/5.4.-Reports.md b/docs/doc/de/5.4.-Reports.md index 65eb73ad..c8016ad3 100644 --- a/docs/doc/de/5.4.-Reports.md +++ b/docs/doc/de/5.4.-Reports.md @@ -12,7 +12,7 @@ path: 5.4.-Reports - Diagramme: Statistische und andere Darstellungen im Webbrowser - Datenbankabfragen: Eigene und vorgegebene Abfragen -## Codierungen vergleichen { #coding-comparison-report } +## Codierungen vergleichen {#coding-comparison-report} Dieser Bericht zeigt Gemeinsamkeiten und Unterschiede zwischen zwei Coder:innen über alle Textdateien hinweg. Wählen Sie zwei Coder:innen und starten Sie den Vergleich. Die Statistiken gelten nur für Textcodierungen, nicht für Bilder oder Audio/Video. @@ -33,7 +33,7 @@ Das Kontextmenü eines Codes bietet weitere Optionen: ![Kontextmenü des Vergleichsberichts](/images/gh-ad6903e9-1f1a-4901-92c4-9c7e00d174e4.png) -## Codierungen je Datei vergleichen { #coding-comparison-by-file-report } +## Codierungen je Datei vergleichen {#coding-comparison-by-file-report} Hier vergleichen Sie zwei Coder:innen in **einer ausgewählten Datei**. Wählen Sie eine Datei, einen Code und zwei Coder:innen und starten Sie den Vergleich. Statistiken und Vergleiche für Audio/Video-Segmente sind noch in Entwicklung. @@ -41,7 +41,7 @@ Für Texte und Bilder werden Gesamtübereinstimmung, Nichtübereinstimmung und C ![Vergleich je Datei](/images/cd5eff94-2cc0-4988-af48-da12f55bfc48.png) -## Codehäufigkeiten { #code-frequencies-report } +## Codehäufigkeiten {#code-frequencies-report} Dieser Bericht zeigt alle Codes und Kategorien sowie ihre Verwendungshäufigkeit je Coder:in. Sie können die Auswertung auf bestimmte Dateien beschränken. @@ -51,7 +51,7 @@ Weitere Optionen stehen im Kontextmenü eines Codes bereit: ![Kontextmenü eines Codes](/images/gh-2a499964-a0c6-4961-ae7e-d1851bf0d549.png) -## Dateizusammenfassung { #file-summary-report } +## Dateizusammenfassung {#file-summary-report} Klicken Sie auf eine Datei, um ihre Zusammenfassung anzuzeigen: Medienmetadaten, Zeichenanzahl, Worthäufigkeiten, Attribute und Anzahl der Codierungen. Für Texte wird die durchschnittliche Segmentlänge angegeben, für Bilder die durchschnittliche Fläche in Pixeln und für Audio/Video die durchschnittliche Segmentdauer. @@ -63,7 +63,7 @@ Weitere Optionen stehen im Dateikontextmenü bereit: ![Kontextmenü einer Datei](/images/gh-05dbe1fd-f4ae-4899-99c9-df274ae43f12.png) -## Codezusammenfassung { #code-summary-report } +## Codezusammenfassung {#code-summary-report} Klicken Sie auf einen Code, um zu sehen, welche Coder:innen ihn verwendet haben und wie viele Codierungen in Texten, Bildern und Audio/Video vorliegen. Für Texte erscheinen die durchschnittliche Segmentlänge und die häufigsten Wörter, für Bilder die durchschnittliche Pixelfläche und für Audio/Video die durchschnittliche Segmentdauer. @@ -75,7 +75,7 @@ Weitere Optionen stehen im Kontextmenü des Codes bereit: ![Kontextmenü der Codezusammenfassung](/images/gh-2a499964-a0c6-4961-ae7e-d1851bf0d549.png) -## Diagramme { #charts } +## Diagramme {#charts} Es gibt verschiedene Diagrammtypen und Filteroptionen. Die meisten Diagramme öffnen sich im Standardbrowser. Falls ein Diagramm nicht erscheint, wählen Sie einen anderen aktuellen Browser, etwa Firefox, Chrome, Edge oder Safari. JavaScript muss aktiviert sein. Die Option zum HTML-Export speichert alle Diagramme als HTML-Dateien im Standard-Exportordner. @@ -109,7 +109,7 @@ Eine Stoppwortliste schließt häufige Wörter aus. Eine eigene `stopwords.txt` ![Wortwolke](/images/wc.png) -## Datenbankabfragen { #database-queries } +## Datenbankabfragen {#database-queries} Sie können die Datenbank mit SQL-Anweisungen abfragen. Das Fenster besteht aus drei Bereichen: oben die SQL-Eingabe, unten die Ergebnisse und links Tabellen und Feldnamen. Ein Doppelklick auf einen Feldnamen fügt ihn in die Anweisung ein. Ergebnisse lassen sich als Datei mit Trennzeichen exportieren. Manche Unicode-Symbole werden bei der Umwandlung in reinen Text ausgelassen. @@ -131,4 +131,4 @@ Unten in der linken Liste stehen gespeicherte SQL-Abfragen und Standardabfragen. ![Datenbankabfragen](/images/18c552a3-b256-453a-80ec-5c2931016e12.png) -Bewahren Sie Sicherungskopien auf: Beliebige SQL-Anweisungen einschließlich Änderungen und dem Löschen von Tabellen können die Datenbank unwiederbringlich beschädigen. +Bewahren Sie Sicherungskopien auf: Beliebige SQL-Anweisungen einschließlich Änderungen und dem Löschen von Tabellen können die Datenbank unwiederbringlich beschädigen. \ No newline at end of file diff --git a/docs/doc/de/5.5.-Graph.md b/docs/doc/de/5.5.-Graph.md index 79af58b2..3b228387 100644 --- a/docs/doc/de/5.5.-Graph.md +++ b/docs/doc/de/5.5.-Graph.md @@ -17,7 +17,7 @@ Im Kontextmenü einer Linie ändern Sie Stärke, Farbe und durchgezogenen bezieh Codierte Texte, codierte Bilder und Audio/Video-Segmente lassen sich ebenso darstellen wie ihre Memos in Textfeldern. Hinweisfenster liefern zusätzliche Informationen. Dasselbe codierte Segment kann nicht mehrfach in einem Graphen angezeigt werden. -## Weitere Optionen im Kontextmenü +## Weitere Optionen im Kontextmenü {#right-click-on-items-for-more-options} **Bild:** @@ -35,6 +35,6 @@ Codierte Texte, codierte Bilder und Audio/Video-Segmente lassen sich ebenso dars ![Linienoptionen](/images/gh-baa778e1-e439-4727-bd42-b84e00a3f0a3.png) -## Export +## Export {#export-options} -Graphen können gespeichert, geladen und gelöscht werden. Als Exportformate stehen PNG, PDF, ODT für LibreOffice und Microsoft Office sowie [Draw.io](https://www.drawio.com/) bereit. +Graphen können gespeichert, geladen und gelöscht werden. Als Exportformate stehen PNG, PDF, ODT für LibreOffice und Microsoft Office sowie [Draw.io](https://www.drawio.com/) bereit. \ No newline at end of file diff --git a/docs/doc/de/6.1.-Imports-and-Exports.md b/docs/doc/de/6.1.-Imports-and-Exports.md index dc482f12..e5de2b09 100644 --- a/docs/doc/de/6.1.-Imports-and-Exports.md +++ b/docs/doc/de/6.1.-Imports-and-Exports.md @@ -13,15 +13,15 @@ Projekte und Codebücher lassen sich nach dem REFI-QDA-Standard exportieren. Cod Umfragen importieren Sie über eine Schaltfläche in **Dateien verwalten**; siehe [Umfragen importieren](6.2.-Survey-Imports.md). -## Codebuch exportieren +## Codebuch exportieren {#codebook-export} Die Funktion finden Sie unter **Projekt > Exporte**. Ein Codebuch ist eine Liste Ihrer Codes. Im Memo jedes Codes sollten dessen Zweck und Anwendungsregeln erläutert werden. Der Textexport zeigt auch die Häufigkeit jedes Codes über alle Coder:innen hinweg. Doppelte Minuszeichen kennzeichnen untergeordnete Codes und Kategorien in der Baumstruktur. -## Codebuch importieren +## Codebuch importieren {#codebook-import} Sie können ein Codebuch als reine Textdatei (`.txt`) oder CSV-Datei importieren. Zwei Größer-als-Zeichen `>>` trennen Kategorien und Codes. Drei Größer-als-Zeichen `>>>` kennzeichnen einen Untercode eines Codes. -### Import aus einer Textdatei +### Import aus einer Textdatei {#codebook-plain-text-import} Erstellen Sie eine reine Textdatei. Trennen Sie ein optionales Memo durch einen Tabulator vom Code: @@ -37,7 +37,7 @@ Kategorie3>>Code4 Code5>>>Code6>>>Code7 ``` -### Import aus einer CSV-Datei +### Import aus einer CSV-Datei {#codebook-csv-file} Erstellen Sie die CSV-Datei in LibreOffice Calc oder Microsoft Excel. Die erste Spalte enthält Kategorien und Codes im selben Format wie die Textdatei. Code-Memos stehen in der zweiten Spalte. @@ -49,7 +49,7 @@ Kategorie1>>Kategorie2>>Code2 Kategorie3>>Code3 ``` -## REFI-QDA +## REFI-QDA {#refi-qda} Die [Rotterdam Exchange Format Initiative (REFI)](https://www.qdasoftware.org) definiert einen offenen Standard für den Austausch von Codebüchern und Projekten zwischen Programmen zur qualitativen Datenanalyse. @@ -67,7 +67,7 @@ Wenn keine Codierungen sichtbar sind, wechseln Sie gegebenenfalls in den Einstel Ein älterer Test vom Februar 2021 untersuchte den Import eines von QualCoder erzeugten Projekts in MAXQDA, Quirkos und ATLAS.ti, beschränkt auf Texte und Bilder. Die Ergebnisse finden Sie in diesem [PDF zum REFI-QDA-Projektaustausch](https://qualcoder.files.wordpress.com/2021/02/refi-qda-project-import-quirkos-maxqda-atlas.pdf). -## Taguette importieren +## Taguette importieren {#taguette-import} Projekte aus [Taguette](https://www.taguette.org/) können aus der SQLite-Datei importiert werden. Die wesentlichen Codierungsdaten werden übertragen. @@ -75,11 +75,11 @@ Schließen Sie ein geöffnetes Projekt und wählen Sie im Menü **Projekt** den Falls keine Codierungen angezeigt werden, wechseln Sie gegebenenfalls in den Einstellungen die aktuelle Coder:in. -## Sonal π (Sonal Pi) importieren +## Sonal π (Sonal Pi) importieren {#sonal-sonal-pi-import} Projekte aus [Sonal Pi](https://www.sonal-info.com), einer in Frankreich entwickelten Software für qualitative Datenanalyse, können importiert werden. Wählen Sie dazu die Sonal-Korpusdatei aus. -## RQDA importieren +## RQDA importieren {#rqda-import} Projekte aus [RQDA](http://rqda.r-forge.r-project.org/) können direkt importiert werden. Alle Daten außer Dateikategorien werden übernommen. @@ -87,20 +87,20 @@ Schließen Sie ein geöffnetes Projekt und wählen Sie im Menü **Projekt** den Falls keine Codierungen angezeigt werden, wechseln Sie gegebenenfalls in den Einstellungen die aktuelle Coder:in. -## Umfragen importieren +## Umfragen importieren {#survey-import} Siehe [Umfragen importieren](6.2.-Survey-Imports.md). -## Literaturverzeichnisse importieren +## Literaturverzeichnisse importieren {#bibliography-import} Siehe [Literaturangaben](3.5.-References.md). -## Hilfe > Besondere Funktionen +## Hilfe > Besondere Funktionen {#help-special-functions} -### Textinhalte dynamisch aktualisieren +### Textinhalte dynamisch aktualisieren {#dynamic-update-text-content} Diese Funktion aktualisiert Textdateien, die sich im Laufe der Zeit ändern, etwa Auszüge aus Blogbeiträgen, und versucht dabei, vorhandene Codierungen zu erhalten. Wählen Sie die zu ersetzende Textdatei und anschließend die neue Datei aus. Starten Sie die Aktualisierung über die Zahnrad-Schaltfläche. Die Funktion sucht nach identischen Textpassagen in der Ersatzdatei. Dabei können fehlerhafte codierte Segmente entstehen. -### Projekte zusammenführen +### Projekte zusammenführen {#merge-projects} -Siehe [QualCoder-Projekte zusammenführen](6.4.-Merge-Projects.md). +Siehe [QualCoder-Projekte zusammenführen](6.4.-Merge-Projects.md). \ No newline at end of file diff --git a/docs/doc/de/6.2.-Survey-Imports.md b/docs/doc/de/6.2.-Survey-Imports.md index c86fa2f2..eaaa42f9 100644 --- a/docs/doc/de/6.2.-Survey-Imports.md +++ b/docs/doc/de/6.2.-Survey-Imports.md @@ -21,7 +21,7 @@ Inhalt von `survey789.xlsx`: ![Excel-Beispiel](/images/gh-64771e6b-b5a2-4ac9-910a-5836d34cfc9b.png) -## Die Datei survey456.csv importieren +## Die Datei survey456.csv importieren {#die-datei-survey456csv-importieren} Klicken Sie auf die Schaltfläche zum Umfrageimport und wählen Sie die Datei im Ordner `Examples`. @@ -49,7 +49,7 @@ Unter **Fälle verwalten** ist je Fall eine Textdatei zugeordnet: ![Importierte Fälle](/images/gh-a35b341a-40e6-4d38-9647-179f6bc25d5e.png) -### Weitere Daten ergänzen +### Weitere Daten ergänzen {#weitere-daten-erganzen} Importieren Sie nun `survey789.xlsx` über dieselbe Schaltfläche. Lassen Sie die Kontrollkästchen deaktiviert. @@ -79,4 +79,4 @@ Importieren Sie schließlich `survey789_replace_data.xlsx` mit denselben Einstel ![Attributwerte ersetzen](/images/gh-0dd5c404-0a5c-484c-84cf-2c89d04bebc9.png) -## Dieser Abschnitt wird weiterentwickelt +## Dieser Abschnitt wird weiterentwickelt {#dieser-abschnitt-wird-weiterentwickelt} \ No newline at end of file diff --git a/docs/doc/de/6.3.-AI-Prompt-Library.md b/docs/doc/de/6.3.-AI-Prompt-Library.md index a254120f..2ac730d8 100644 --- a/docs/doc/de/6.3.-AI-Prompt-Library.md +++ b/docs/doc/de/6.3.-AI-Prompt-Library.md @@ -7,7 +7,7 @@ path: 6.3.-AI-Prompt-Library - In QualCoder sind die Prompts der KI-Funktionen über die Oberfläche zugänglich. Sie können sie an Ihren methodischen Ansatz und Ihre Forschungsfragen anpassen. - Einige mitgelieferte Prompts stammen aus Veröffentlichungen anderer qualitativ arbeitender Forscher:innen. Wir hoffen, dass mit der KI-Nutzung auch eine Kultur des Entwickelns, Teilens und Diskutierens anspruchsvoller Prompts in der wissenschaftlichen Community wächst. So können wir voneinander lernen und die neuen Methoden gemeinsam verbessern. -## Aufbau eines Prompts +## Aufbau eines Prompts {#the-structure-of-a-prompt} Ein Prompt ähnelt zunächst der Frage, die Sie in ChatGPT eingeben. Tatsächlich ist der Aufbau komplexer: Im Hintergrund ergänzt ChatGPT Ihre Frage durch einen unsichtbaren Systemprompt, der die KI beispielsweise zu hilfreichem und unterstützendem Verhalten anweist und Grenzen für medizinische oder rechtliche Ratschläge festlegt. @@ -22,7 +22,7 @@ Der grundlegende Aufbau: - **Empirische Daten** (gelb) werden auf unterschiedliche Weise ausgewählt. - Den **analytischen Prompt** (orange) können Sie bearbeiten und an Ihre Bedürfnisse anpassen. -## Analytische Prompts +## Analytische Prompts {#analytic-prompts} Analytische Prompts bilden den **Kern der KI-Funktionen**. Sie geben vor, wie die KI Daten analysieren soll. Das können kurze Anweisungen oder komplexe Leitlinien mit einzelnen Analyseschritten und methodischem Hintergrund sein; siehe Lieder und Schäffer (2024).1 @@ -44,4 +44,4 @@ Prompts werden anhand folgender Angaben organisiert: *** -1Lieder, F. R. & Schäffer, B. (2024). *Reconstructive Social Research Prompting (RSRP). Distributed Interpretation between AI and Researchers in Qualitative Research.* https://doi.org/10.31235/osf.io/d6e9m +1Lieder, F. R. & Schäffer, B. (2024). *Reconstructive Social Research Prompting (RSRP). Distributed Interpretation between AI and Researchers in Qualitative Research.* https://doi.org/10.31235/osf.io/d6e9m \ No newline at end of file diff --git a/docs/doc/de/6.4.-Merge-Projects.md b/docs/doc/de/6.4.-Merge-Projects.md index e8912539..fb8e7c2e 100644 --- a/docs/doc/de/6.4.-Merge-Projects.md +++ b/docs/doc/de/6.4.-Merge-Projects.md @@ -33,4 +33,4 @@ Beim Zusammenführen werden: Idealerweise verwenden alle Teammitglieder identische Dateien und dieselben Codenamen. Abweichende Codes können Sie nach dem Zusammenführen umbenennen oder zusammenführen. Eindeutige Namen der Coder:innen erhalten die Zuordnung der individuellen Beiträge. Gleiche Namen können sinnvoll sein, wenn jede Person andere Dateien bearbeitet und Sie alle Beiträge unter einem Namen bündeln möchten. Entscheidend ist Ihr Analyseziel. !!! warning "Veränderte Texte" - Enthalten beide Projekte dieselbe Textdatei, muss deren Inhalt übereinstimmen. Wurde der Text im Quellprojekt verändert, verlängert oder verkürzt, stimmen die importierten Codierungs- und Annotierungspositionen möglicherweise nicht mehr. Der Text in der Zieldatenbank wird beim Zusammenführen nicht durch die veränderte Quelldatei ersetzt. + Enthalten beide Projekte dieselbe Textdatei, muss deren Inhalt übereinstimmen. Wurde der Text im Quellprojekt verändert, verlängert oder verkürzt, stimmen die importierten Codierungs- und Annotierungspositionen möglicherweise nicht mehr. Der Text in der Zieldatenbank wird beim Zusammenführen nicht durch die veränderte Quelldatei ersetzt. \ No newline at end of file diff --git a/docs/doc/de/7.1.-About-The-Developers.md b/docs/doc/de/7.1.-About-The-Developers.md index 89f9a182..02d54cbe 100644 --- a/docs/doc/de/7.1.-About-The-Developers.md +++ b/docs/doc/de/7.1.-About-The-Developers.md @@ -2,4 +2,4 @@ path: 7.1.-About-The-Developers --- -[Informationen zum Entwicklungsteam](../../about.md) +[Informationen zum Entwicklungsteam](../../about.md) \ No newline at end of file diff --git a/docs/doc/de/7.2.-QualCoder-Video-Tutorials.md b/docs/doc/de/7.2.-QualCoder-Video-Tutorials.md index 7b342be5..6921a007 100644 --- a/docs/doc/de/7.2.-QualCoder-Video-Tutorials.md +++ b/docs/doc/de/7.2.-QualCoder-Video-Tutorials.md @@ -3,7 +3,7 @@ path: 7.2.-QualCoder-Video-Tutorials --- # Videoanleitungen zur Nutzung von QualCoder -## QualCoder 3.7 +## QualCoder 3.7 {#qualcoder-37} [QualCoder 3.7, Teil 1 – Colin Curtain](https://www.youtube.com/watch?v=TCLCT893JcM) @@ -19,13 +19,13 @@ path: 7.2.-QualCoder-Video-Tutorials [Alphaversion 3.7 im Vergleich mit anderer qualitativer Analysesoftware – Van Tran](https://www.youtube.com/watch?v=Cqwu3mjJJHg) -## QualCoder 3.6 +## QualCoder 3.6 {#qualcoder-36} [Webinar: KI-unterstützte Datenanalyse in QualCoder 3.6 (Deutsch)](https://www.youtube.com/watch?v=JF64vbngedA) [Qualitativ Forschen: KI-gestütztes horizontales Codieren](https://www.youtube.com/watch?v=FrQyTOTJhCc) -## QualCoder 3.5 +## QualCoder 3.5 {#qualcoder-35} [Tutorial von Colin Curtain](https://www.youtube.com/watch?v=wj5fY4F5Jxo) @@ -35,6 +35,6 @@ path: 7.2.-QualCoder-Video-Tutorials [QualCoder: Data Hub Tool Talk – University of Idaho](https://www.youtube.com/watch?v=119k-jNOl8I) -## Ältere Anleitungen +## Ältere Anleitungen {#older-tutorials} -Weitere ältere Anleitungen finden Sie auf YouTube. +Weitere ältere Anleitungen finden Sie auf YouTube. \ No newline at end of file diff --git a/docs/doc/de/7.3.-QualCoder-Development.md b/docs/doc/de/7.3.-QualCoder-Development.md index c2448b00..5b7ab3c8 100644 --- a/docs/doc/de/7.3.-QualCoder-Development.md +++ b/docs/doc/de/7.3.-QualCoder-Development.md @@ -7,14 +7,14 @@ QualCoder wird derzeit unter Windows 11 entwickelt. Die Software ist in Python 3 Nach Version 4.0 soll unter anderem die Benutzeroberfläche überarbeitet werden, um sie moderner und ansprechender zu gestalten. Außerdem soll zusätzliche Dokumentation zu Governance und organisatorischen Rahmenbedingungen entstehen, die den Einsatz in großen Institutionen unterstützt. -## Verwendete Betriebssysteme +## Verwendete Betriebssysteme {#operating-systems-used} QualCoder wird unter Windows 11, macOS, Ubuntu 24, Lubuntu, Fedora, Linux Mint, Arch Linux, NixOS und ZorinOS eingesetzt. - Unter Fedora führt die Nutzung von Audio/Video zu Abstürzen. - Unter Debian mit GNOME kann die Kacheloption die Fenstergröße von QualCoder verkleinern. Deaktivieren Sie in diesem Fall die Fensterkachelung in den GNOME-Einstellungen. -## Danksagung +## Danksagung {#acknowledgements} - Ronggui Huang und Zhang Gehao: Entwicklung von RQDA als Inspiration für QualCoder. - Mike MacCana: Quellcode des DOCX-Moduls. @@ -26,19 +26,19 @@ QualCoder wird unter Windows 11, macOS, Ubuntu 24, Lubuntu, Fedora, Linux Mint, - Van Tran: Viele hilfreiche Vorschläge und langjährige Unterstützung. - Den vielen Mitwirkenden auf GitHub: Rückmeldungen, Ideen und Unterstützung des Projekts. -## Zitierempfehlung +## Zitierempfehlung {#citation} Curtain C, Dröge K, Missaghieh--Poncet J, Salomón L. (2026) QualCoder 4.0 [Computer software]. Retrieved from https://github.com/ccbogel/QualCoder/releases/tag/4.0 -## Datenstrukturen +## Datenstrukturen {#data-structures} **Der QDA-Projektordner** enthält Ordner für importierte Dokumente und die SQLite-Datenbank mit den Codierungsdaten. Bei aktivierter KI gibt es zusätzlich den Ordner `ai_data` mit einer SQLite-Datenbank für den Chatverlauf und einem Vektorspeicher. Dieser enthält numerische Darstellungen von Wörtern, Wortgruppen und Sätzen, die für die KI verwendet werden. **Der Arbeitsordner `.qualcoder`** liegt in Ihrem persönlichen Ordner. QualCoder legt dort `QualCoder.log` und Konfigurationsdateien an. Legen Sie darin keine sonstigen Dateien ab; er dient der Anwendung als Arbeitsbereich für Einstellungen und gespeicherte Zustände. **Der Ordner `.qualcoder_ai`** im persönlichen Ordner enthält die KI-Konfiguration. -## Lizenzen +## Lizenzen {#licenses} -### LGPL-3.0-Lizenz +### LGPL-3.0-Lizenz {#lgpl-30-license} QualCoder ist freie Software. Sie dürfen sie unter den Bedingungen der GNU Lesser General Public License weitergeben und verändern, wie sie von der Free Software Foundation veröffentlicht wurde: entweder Version 3 oder nach Ihrer Wahl eine spätere Version. @@ -46,7 +46,7 @@ QualCoder wird in der Hoffnung verbreitet, dass es nützlich ist, jedoch **ohne Sie sollten zusammen mit QualCoder eine Kopie der GNU Lesser General Public License erhalten haben. Andernfalls finden Sie sie unter [GNU-Lizenzen](https://www.gnu.org/licenses). -### Lizenz des Codes in highlighter.py +### Lizenz des Codes in highlighter.py {#license-for-highlighterpy-code} Copyright (C) 2013 Riverbank Computing Limited. @@ -66,7 +66,7 @@ Die Weitergabe und Nutzung in Quell- oder Binärform, mit oder ohne Änderungen, Die Software wird von den Rechteinhaber:innen und Mitwirkenden **wie vorliegend** bereitgestellt. Ausdrückliche oder stillschweigende Gewährleistungen, insbesondere für Marktgängigkeit oder Eignung für einen bestimmten Zweck, sind ausgeschlossen. Die Rechteinhaber:innen und Mitwirkenden haften nicht für direkte, indirekte, zufällige, besondere, exemplarische oder Folgeschäden. Dazu gehören insbesondere die Beschaffung von Ersatzgütern oder -diensten, Nutzungs-, Daten- oder Gewinnverluste und Betriebsunterbrechungen. Dies gilt unabhängig von Ursache und Haftungsgrundlage, einschließlich Vertrag, verschuldensunabhängiger Haftung oder unerlaubter Handlung einschließlich Fahrlässigkeit, auch wenn auf die Möglichkeit solcher Schäden hingewiesen wurde. -### Lizenz des Codes in docx.py +### Lizenz des Codes in docx.py {#license-for-docxpy-code} Copyright (c) 2009–2010 Mike MacCana. @@ -76,8 +76,8 @@ Der obige Urheberrechtshinweis und dieser Genehmigungshinweis müssen in allen K Die Software wird **wie vorliegend** und ohne ausdrückliche oder stillschweigende Gewährleistung bereitgestellt, insbesondere ohne Gewährleistung für Marktgängigkeit, Eignung für einen bestimmten Zweck oder Nichtverletzung von Rechten. Die Autor:innen und Rechteinhaber:innen haften nicht für Ansprüche, Schäden oder andere Verpflichtungen, unabhängig davon, ob sie auf Vertrag, unerlaubter Handlung oder anderem beruhen und aus der Software, ihrer Nutzung oder sonstigem Umgang mit ihr entstehen. -### Lizenzen der Abhängigkeiten +### Lizenzen der Abhängigkeiten {#dependency-licenses} Abhängigkeiten sind zusätzliche Python-Module, die QualCoder zur Ausführung benötigt. Ihre Lizenzen finden Sie im Ordner `docs` des QualCoder-Quellcodes. Stand: 8. Oktober 2026. -[Lizenzen der Abhängigkeiten](https://github.com/ccbogel/QualCoder/blob/master/docs/DEPENDENCY_LICENSES.md) +[Lizenzen der Abhängigkeiten](https://github.com/ccbogel/QualCoder/blob/master/docs/DEPENDENCY_LICENSES.md) \ No newline at end of file diff --git a/docs/doc/de/7.4.-SQlite-Data-Structure.md b/docs/doc/de/7.4.-SQlite-Data-Structure.md index edcc21e0..a0fd61b7 100644 --- a/docs/doc/de/7.4.-SQlite-Data-Structure.md +++ b/docs/doc/de/7.4.-SQlite-Data-Structure.md @@ -7,7 +7,7 @@ Diese Beschreibung der Datenstruktur v8 soll beim Erstellen von SQL-Abfragen hel Die Tabellen sind zunächst alphabetisch aufgeführt. Tabellen- und Feldnamen bleiben unverändert. Die Datentypen `integer`, `real` und `text` bezeichnen Ganzzahlen, Fließkommazahlen und Text. `NULL` steht für einen nicht gesetzten Wert. -## Tabelle: annotation +## Tabelle: annotation {#table-annotation} | Feld | Typ | Bedeutung | | --- | --- | --- | @@ -19,7 +19,7 @@ Die Tabellen sind zunächst alphabetisch aufgeführt. Tabellen- und Feldnamen bl | `owner` | text | Coder:in, die den Eintrag erstellt hat | | `date` | text | Erstellungsdatum und -zeit im Format `yyyy-mm-dd hh:mm:ss` | -## Tabelle: attribute +## Tabelle: attribute {#table-attribute} | Feld | Typ | Bedeutung | | --- | --- | --- | @@ -31,7 +31,7 @@ Die Tabellen sind zunächst alphabetisch aufgeführt. Tabellen- und Feldnamen bl | `owner` | text | Coder:in, die den Eintrag erstellt hat | | `date` | text | Erstellungsdatum und -zeit im Format `yyyy-mm-dd hh:mm:ss` | -## Tabelle: attribute_type +## Tabelle: attribute_type {#table-attribute-type} | Feld | Typ | Bedeutung | | --- | --- | --- | @@ -42,7 +42,7 @@ Die Tabellen sind zunächst alphabetisch aufgeführt. Tabellen- und Feldnamen bl | `caseOrFile` | text | `case` oder `file` | | `valuetype` | text | `character` oder `numeric` | -## Tabelle: case_text +## Tabelle: case_text {#table-case-text} | Feld | Typ | Bedeutung | | --- | --- | --- | @@ -55,7 +55,7 @@ Die Tabellen sind zunächst alphabetisch aufgeführt. Tabellen- und Feldnamen bl | `owner` | text | Coder:in, die den Eintrag erstellt hat | | `date` | text | Erstellungsdatum und -zeit im Format `yyyy-mm-dd hh:mm:ss` | -## Tabelle: cases +## Tabelle: cases {#table-cases} | Feld | Typ | Bedeutung | | --- | --- | --- | @@ -65,7 +65,7 @@ Die Tabellen sind zunächst alphabetisch aufgeführt. Tabellen- und Feldnamen bl | `owner` | text | Coder:in, die den Eintrag erstellt hat | | `date` | text | Erstellungsdatum und -zeit im Format `yyyy-mm-dd hh:mm:ss` | -## Tabelle: code_av +## Tabelle: code_av {#table-code-av} | Feld | Typ | Bedeutung | | --- | --- | --- | @@ -79,7 +79,7 @@ Die Tabellen sind zunächst alphabetisch aufgeführt. Tabellen- und Feldnamen bl | `date` | text | Erstellungsdatum und -zeit im Format `yyyy-mm-dd hh:mm:ss` | | `important` | integer | `1` kennzeichnet eine wichtige Codierung | -## Tabelle: code_cat +## Tabelle: code_cat {#table-code-cat} | Feld | Typ | Bedeutung | | --- | --- | --- | @@ -90,7 +90,7 @@ Die Tabellen sind zunächst alphabetisch aufgeführt. Tabellen- und Feldnamen bl | `date` | text | Erstellungsdatum und -zeit im Format `yyyy-mm-dd hh:mm:ss` | | `supercatid` | integer | ID der übergeordneten Kategorie; `NULL` bei einer Kategorie der obersten Ebene | -## Tabelle: code_image +## Tabelle: code_image {#table-code-image} | Feld | Typ | Bedeutung | | --- | --- | --- | @@ -107,7 +107,7 @@ Die Tabellen sind zunächst alphabetisch aufgeführt. Tabellen- und Feldnamen bl | `important` | integer | `1` kennzeichnet eine wichtige Codierung | | `pdf_page` | integer | PDF-Seitennummer oder `NULL` | -## Tabelle: code_name +## Tabelle: code_name {#table-code-name} | Feld | Typ | Bedeutung | | --- | --- | --- | @@ -119,7 +119,7 @@ Die Tabellen sind zunächst alphabetisch aufgeführt. Tabellen- und Feldnamen bl | `date` | text | Erstellungsdatum und -zeit im Format `yyyy-mm-dd hh:mm:ss` | | `color` | text | Hexadezimaler Farbwert zwischen `#000000` und `#FFFFFF`; QualCoder erkennt 120 Farben, um darüber helle oder dunkle Schrift darzustellen | -## Tabelle: code_text +## Tabelle: code_text {#table-code-text} | Feld | Typ | Bedeutung | | --- | --- | --- | @@ -135,7 +135,7 @@ Die Tabellen sind zunächst alphabetisch aufgeführt. Tabellen- und Feldnamen bl | `avid` | integer | Verknüpfung zur Zeitposition eines codierten Audio/Video-Segments in `code_av` | | `important` | integer | `1` kennzeichnet eine wichtige Codierung | -## Tabelle: journal +## Tabelle: journal {#table-journal} | Feld | Typ | Bedeutung | | --- | --- | --- | @@ -145,7 +145,7 @@ Die Tabellen sind zunächst alphabetisch aufgeführt. Tabellen- und Feldnamen bl | `owner` | text | Coder:in, die den Eintrag erstellt hat | | `date` | text | Erstellungsdatum und -zeit im Format `yyyy-mm-dd hh:mm:ss` | -## Tabelle: project +## Tabelle: project {#table-project} Diese Tabelle sollte genau eine Zeile enthalten. @@ -160,7 +160,7 @@ Diese Tabelle sollte genau eine Zeile enthalten. | `codername` | text | Name der aktuellen Coder:in | | `recently_used_codes` | text | IDs zuletzt verwendeter Textcodes, durch Leerzeichen getrennt | -## Tabelle: source +## Tabelle: source {#table-source} | Feld | Typ | Bedeutung | | --- | --- | --- | @@ -177,7 +177,7 @@ Ein leerer `mediapath` kennzeichnet einen intern gespeicherten Text. Bei einem P Pfade mit `/images/`, `/audio/` oder `/video/` kennzeichnen Dateien im Projektordner. Präfixe `images:`, `audio:` und `video:` kennzeichnen dagegen externe Verknüpfungen mit vollständigem Dateipfad. -## Tabelle: stored_sql +## Tabelle: stored_sql {#table-stored-sql} | Feld | Typ | Bedeutung | | --- | --- | --- | @@ -186,7 +186,7 @@ Pfade mit `/images/`, `/audio/` oder `/video/` kennzeichnen Dateien im Projektor | `grouper` | text | Mögliche Gruppierung von Abfragen | | `ssql` | text | Von Benutzer:innen erstellte SQL-Anweisung | -## Tabelle: ris +## Tabelle: ris {#table-ris} Diese Tabelle enthält Daten aus RIS-Literaturverzeichnissen. @@ -197,11 +197,11 @@ Diese Tabelle enthält Daten aus RIS-Literaturverzeichnissen. | `longtag` | text | Ausführliche Bezeichnung des RIS-Felds | | `value` | text | Textwert des Felds | -## Tabellen für die Graphdarstellung +## Tabellen für die Graphdarstellung {#graph-visualisation-tables} Die folgenden Tabellen speichern Graphen und die darin enthaltenen Elemente. Nicht näher erläuterte Felder werden mit ihrem dokumentierten Datentyp aufgeführt. -## Tabelle: graph +## Tabelle: graph {#table-graph} | Feld | Typ | Bedeutung | | --- | --- | --- | @@ -212,7 +212,7 @@ Die folgenden Tabellen speichern Graphen und die darin enthaltenen Elemente. Nic | `scene_width` | integer | Breite der Zeichenfläche beim Laden | | `scene_height` | integer | Höhe der Zeichenfläche beim Laden | -## Tabelle: gr_av_item +## Tabelle: gr_av_item {#table-gr-av-item} Stellt ein Pfeilsymbol für ein abspielbares codiertes Audio/Video-Segment dar. @@ -229,7 +229,7 @@ Stellt ein Pfeilsymbol für ein abspielbares codiertes Audio/Video-Segment dar. | `tooltip` | text | | `color` | text | -## Tabelle: gr_case_text_item +## Tabelle: gr_case_text_item {#table-gr-case-text-item} Stellt Fallinformationen mit Formatierungsparametern dar. `grid` verweist auf `graph`. @@ -245,7 +245,7 @@ Stellt Fallinformationen mit Formatierungsparametern dar. `grid` verweist auf `g | `color` | text | | `displaytext` | text | -## Tabelle: gr_cdct_line_item +## Tabelle: gr_cdct_line_item {#table-gr-cdct-line-item} Stellt Verbindungslinien zwischen Codes und Kategorien dar. @@ -262,7 +262,7 @@ Stellt Verbindungslinien zwischen Codes und Kategorien dar. | `linetype` | text | | `isvisible` | integer | -## Tabelle: gr_cdct_text_item +## Tabelle: gr_cdct_text_item {#table-gr-cdct-text-item} Stellt codierten Text mit Formatierungsparametern dar. `grid` verweist auf `graph`. @@ -280,7 +280,7 @@ Stellt codierten Text mit Formatierungsparametern dar. `grid` verweist auf `grap | `isvisible` | integer | | `displaytext` | text | -## Tabelle: gr_file_text_item +## Tabelle: gr_file_text_item {#table-gr-file-text-item} Stellt Dateiinformationen mit Formatierungsparametern dar. `fid` verweist auf `source`. @@ -296,7 +296,7 @@ Stellt Dateiinformationen mit Formatierungsparametern dar. `fid` verweist auf `s | `color` | text | | `displaytext` | text | -## Tabelle: gr_free_line_item +## Tabelle: gr_free_line_item {#table-gr-free-line-item} Stellt von Benutzer:innen angelegte Verbindungslinien zwischen Objekten dar. @@ -313,7 +313,7 @@ Stellt von Benutzer:innen angelegte Verbindungslinien zwischen Objekten dar. | `linetype` | text | | `isvisible` | integer | -## Tabelle: gr_free_text_item +## Tabelle: gr_free_text_item {#table-gr-free-text-item} Stellt freien Text oder Memos mit Formatierungsparametern dar. @@ -334,7 +334,7 @@ Stellt freien Text oder Memos mit Formatierungsparametern dar. | `memo_imid` | integer | | `memo_avid` | integer | -## Tabelle: gr_pix_item +## Tabelle: gr_pix_item {#table-gr-pix-item} Stellt ein codiertes Bild dar. @@ -351,4 +351,4 @@ Stellt ein codiertes Bild dar. | `h` | integer | Höhe im Originalbild | | `filepath` | text | | | `tooltip` | text | | -| `pdf_page` | integer | Seite, falls es sich um das Bild einer PDF-Seite handelt | +| `pdf_page` | integer | Seite, falls es sich um das Bild einer PDF-Seite handelt | \ No newline at end of file diff --git a/docs/doc/de/7.5.-AI-Technical-Information.md b/docs/doc/de/7.5.-AI-Technical-Information.md index 251cd4d9..ba4b12de 100644 --- a/docs/doc/de/7.5.-AI-Technical-Information.md +++ b/docs/doc/de/7.5.-AI-Technical-Information.md @@ -3,4 +3,4 @@ path: 7.5.-AI-Technical-Information --- # Technische Informationen zur KI -Dieser Abschnitt wird später aktualisiert. +Dieser Abschnitt wird später aktualisiert. \ No newline at end of file diff --git a/docs/doc/de/7.6.-How-to-contribute.md b/docs/doc/de/7.6.-How-to-contribute.md index 10b55e43..628b29fb 100644 --- a/docs/doc/de/7.6.-How-to-contribute.md +++ b/docs/doc/de/7.6.-How-to-contribute.md @@ -3,18 +3,18 @@ path: 7.6.-How-to-contribute --- # Mitwirken -## Am Quellcode mitarbeiten +## Am Quellcode mitarbeiten {#contributing-to-the-code} Lesen Sie die [Hinweise für Mitwirkende](https://github.com/ccbogel/QualCoder/blob/master/docs/CONTRIBUTING.md). -### Wichtigste Regeln im Überblick +### Wichtigste Regeln im Überblick {#key-rules-at-a-glance} - **Wähle zuerst ein Issue.** Suche ein bestehendes Issue oder erstelle eines und kommentiere es, bevor du einen Pull Request eröffnest. Warte, bis das Issue dir zugewiesen wurde, bevor du mit der Arbeit beginnst. - **Ein Pull Request, ein Commit.** Fasse deine Arbeit in einem einzigen Commit mit einer aussagekräftigen Beschreibung deiner Änderungen zusammen. - **Benennung.** Erstelle einen eigenen Branch, benannt nach dem Issue, das du bearbeitest. - **Lizenz.** Mit dem Einreichen eines Pull Requests stellst du deinen Beitrag unter die LGPLv3-Lizenz des Projekts („Inbound = Outbound“). -### KI-gestützte Beiträge +### KI-gestützte Beiträge {#ai-assisted-contributions} Du darfst KI-Tools zur Unterstützung deiner Beiträge verwenden, bleibst aber vollverantwortlich für alles, was du einreichst. @@ -25,13 +25,13 @@ Du darfst KI-Tools zur Unterstützung deiner Beiträge verwenden, bleibst aber v KI-Tools dürfen **nicht** zur Bearbeitung von Issues mit dem Label `good first issue` verwendet werden. Diese existieren zum Lernen für Menschen. -## Zu Übersetzungen beitragen +## Zu Übersetzungen beitragen {#contribute-to-the-translation} -### Die Dokumentation übersetzen +### Die Dokumentation übersetzen {#translate-the-documentation} Erstellen oder bearbeiten Sie die Markdown-Dateien unter `docs/doc` im [Repository der Website](https://github.com/QualCoder-Org/qualcoder-org.github.io). -### Die Software übersetzen +### Die Software übersetzen {#translate-the-software} QualCoder verwendet zwei Arten von Sprachdateien: @@ -43,4 +43,4 @@ Gehen Sie wie folgt vor: 1. Falls noch keine Sprachdatei vorhanden ist, erstellen Sie diese mit `python rebuild_lang.py --create --lang LANGUAGE_CODE`. Ersetzen Sie `LANGUAGE_CODE` durch den Sprachcode gemäß [ISO 639-1](https://de.wikipedia.org/wiki/Liste_der_ISO-639-Sprachcodes). 2. Aktualisieren Sie bestehende Sprachdateien mit `python rebuild_lang.py --update --lang LANGUAGE_CODE`. 3. Bearbeiten Sie die Übersetzungen in den `.po`- und `.ts`-Dateien im Sprachdateiordner `src/qualcoder/i18n`. Für PO-Dateien können Sie beispielsweise [Poedit](https://poedit.net/) verwenden. -4. Kompilieren Sie nach Abschluss die maschinenlesbaren Dateien mit `python rebuild_lang.py --compile --lang LANGUAGE_CODE`. +4. Kompilieren Sie nach Abschluss die maschinenlesbaren Dateien mit `python rebuild_lang.py --compile --lang LANGUAGE_CODE`. \ No newline at end of file diff --git a/docs/doc/de/index.md b/docs/doc/de/index.md index c1848597..dfbc0773 100644 --- a/docs/doc/de/index.md +++ b/docs/doc/de/index.md @@ -22,13 +22,13 @@ QualCoder bietet KI-Funktionen, die große Sprachmodelle einsetzen, um Daten zu - **QualCoder unterstützt offene Wissenschaft.** Siehe die [UNESCO-Empfehlungen zu Open Science](https://www.unesco.org/en/open-science?hub=686). - **Barrierefreiheit.** QualCoder kann simulieren, wie Codefarben für Menschen mit verschiedenen Formen von Farbfehlsichtigkeit aussehen. Laut dem [Erfahrungsbericht einer Benutzer:in mit Sehbehinderung](https://www.linkedin.com/posts/reda-grich-911632239_worth-sharing-finally-found-a-qualitative-share-7425490644418224128-VDd9/?utm_source=share&utm_medium=member_desktop&rcm=ACoAABD4PqcBUo9og1pXa34wBIyLtnyMxs5qJTM) ist QualCoder mit dem Screenreader NVDA vollständig bedienbar. -## Aktuelle Veröffentlichung +## Aktuelle Veröffentlichung {#current-release} [:octicons-archive-24: Neueste Version auf GitHub herunterladen](https://github.com/ccbogel/QualCoder/releases/latest){ .md-button .md-button--primary } Den aktuellen Entwicklungsstand finden Sie auf [GitHub](https://github.com/ccbogel/QualCoder). -## QualCoder unterstützen +## QualCoder unterstützen {#support-qualcoder} Wenn QualCoder Ihnen bei Ihrer Arbeit hilft, schreiben Sie eine Bewertung, etwa auf [Saashub](https://www.saashub.com/qualcoder-alternatives) oder [AlternativeTo](https://alternativeto.net/software/qualcoder). @@ -40,12 +40,12 @@ In dieser kostenlos nutzbaren Software stecken viele Arbeitsstunden. **Wenn Sie QualCoder ist in Python geschrieben und verwendet Qt6 für die grafische Oberfläche. Es wird unter Windows 11, macOS und verschiedenen Linux-Distributionen eingesetzt, darunter Ubuntu, Lubuntu, ZorinOS, Arch und Fedora. -## Zitierempfehlung +## Zitierempfehlung {#citation} Curtain, C. Dröge, K. Missaghieh--Poncet, J. Salomón, L. (2026) QualCoder 4.0 [Computer software]. Retrieved from https://github.com/ccbogel/QualCoder/releases/tag/4.0 Ersetzen Sie die Versionsnummer (4.0) durch die von Ihnen verwendete Version. -## Lizenz +## Lizenz {#license} -QualCoder steht unter der LGPL-v3-Lizenz. +QualCoder steht unter der LGPL-v3-Lizenz. \ No newline at end of file diff --git a/docs/doc/en/1.-Overview.md b/docs/doc/en/1.-Overview.md index 5241b606..d936dc24 100644 --- a/docs/doc/en/1.-Overview.md +++ b/docs/doc/en/1.-Overview.md @@ -5,20 +5,20 @@ path: 1.-Overview.md The instructions describe how to install and use QualCoder. The information here refers to the most recent version of QualCoder. -## What is QualCoder? +## What is QualCoder? {#what-is-qualcoder} QualCoder is free, open source software for qualitative data analysis. With QualCoder you can code text, images, audio and video, write journal notes and memos. You can organise codes in a tree-like categorisation scheme. Various reports can be generated. Most reports can be exported as html, open document text (ODT), plain text or Excel files. -Recent versions contain optional AI-assisted features that use GPT-4 or other Large Language Models to help explore, analyse, and interact with data in innovative ways. Familiarise yourself with new data by [exploring broad topics or concepts](5.1.-AI-chat-based-analysis#topic-analysis-chat) in an interactive chat with the AI. Dive deeper into specific aspects with [AI-assisted coding](4.2.-AI-Assisted-Coding) and [text analysis](5.1.-AI-chat-based-analysis#text-analysis-chat). And if you reach the point where you must synthesise and consolidate your results, [discuss them in a code chat](5.1.-AI-chat-based-analysis#code-analysis-chat) with the AI. +Recent versions contain optional AI-assisted features that use GPT-4 or other Large Language Models to help explore, analyse, and interact with data in innovative ways. Familiarise yourself with new data by [exploring broad topics or concepts](5.1.-AI-chat-based-analysis#2-topic-exploration) in an interactive chat with the AI. Dive deeper into specific aspects with [AI-assisted coding](4.2.-AI-Assisted-Coding) and [text analysis](5.1.-AI-chat-based-analysis#3-text-analysis). And if you reach the point where you must synthesise and consolidate your results, [discuss them in a code chat](5.1.-AI-chat-based-analysis#4-code-analysis) with the AI. QualCoder is designed to be used as client-based software to be used by one person at a time. (A second coder can use the same project on the same computer, or the project folder can be transferred to the second coder's computer). QualCoder is not designed to be multi-accessed at the same time. Accessing the project in a cloud location is not recommended, it may corrupt the database if a database connection is lost during any database updating processes. -## Collaboration on a QualCoder project +## Collaboration on a QualCoder project {#collaboration-on-a-qualcoder-project} [Page on how to work as a team with QualCoder](2.4.-Working-in-a-Team) -## Latest release +## Latest release {#latest-release} [:octicons-archive-24: Download latest version available on GitHub](https://github.com/ccbogel/QualCoder/releases/latest){ .md-button .md-button--primary } @@ -27,7 +27,7 @@ QualCoder is designed to be used as client-based software to be used by one pers ![image](/images/12d00e05-3844-4b48-9dc9-ff657aa7382f.png) -## Latest code - software under development +## Latest code - software under development {#latest-code-software-under-development} [Download the development version](https://github.com/ccbogel/QualCoder/archive/refs/heads/master.zip), unzip and follow the install instructions in the README document. diff --git a/docs/doc/en/2.1.-Installation.md b/docs/doc/en/2.1.-Installation.md index e92fad9c..47fd30d8 100644 --- a/docs/doc/en/2.1.-Installation.md +++ b/docs/doc/en/2.1.-Installation.md @@ -5,11 +5,11 @@ icon: lucide/package-open # Installation and running -## INSTALLATION +## INSTALLATION {#installation} For the manual installations (using the command line or terminal) A specific release version may be mentioned, for example version 4.0. Please check on the [releases page](https://github.com/ccbogel/QualCoder/releases) for the most current version, as it may be newer. -### Prerequisites +### Prerequisites {#prerequisites} VLC is optional for audio/video coding.Optionally, install ffmpeg for waveform display, see [phoenixnap.com/kb/ffmpeg-windows](https://phoenixnap.com/kb/ffmpeg-windows). Note, QualCoder crashes on Linux Fedora Fedora when attempting to show or code audio/video. === "Windows" diff --git a/docs/doc/en/2.2.-Settings.md b/docs/doc/en/2.2.-Settings.md index c05d724c..3d111b2b 100644 --- a/docs/doc/en/2.2.-Settings.md +++ b/docs/doc/en/2.2.-Settings.md @@ -9,7 +9,7 @@ The settings screen allows you to change several features including language, co ![image](/images/baec9b31-e0bd-4607-85c2-65e141f040d6.png) -### Coder name +### Coder name {#coder-name} Multiple coders can code and annotate the same text. Your current coder name is displayed at the top of the settings dialog. @@ -17,7 +17,7 @@ Multiple coders can code and annotate the same text. Your current coder name is This name will be used to identify your contributions to the project. Click the "Change" button to alter your identity or to create, rename, or merge other coders within the current project. Read [Working in a Team](2.4.-Working-in-a-Team#important-considerations-regarding-coder-names) for more information. -### General settings +### General settings {#general-settings} The default language of QualCoder is English. French, German and Spanish are alternative regularly updated languages. Other languages have not been thoroughly reviewed for accuracy. For other community-maintained languages, [download the relevant.zip](/community) file and place it in the `.qualcoder/i18n` folder, then select your language in the settings. @@ -27,7 +27,7 @@ There area few options to change the overall look of QualCoder. For transcribing audio and video, the time format and bracket type can be selected. -### Backups +### Backups {#backups} Project backup can be set to automatically backup every hour, or no backup. QualCoder keeps the most recent backups with a date and hour time stamp. The backup name is: _projectname_BKP_yyyymmdd_hh.qda_ Where _hh_ is 24 hour time. This also means multiple backups are not done within an hour. So a new backup cannot overwrite another backup created within the same hour. A limited number of backups are kept, **older backups are deleted**. Setting option allows you to choose from 1 to 10 backups. @@ -37,6 +37,6 @@ Rename or move to another location particular backups that you need to keep. Whe In your home folder QualCoder will create a .qualcoder folder with a QualCoder.log file for logging events and a config.ini file which will contain a lot of settings such as the current coder’s name, preferred fonts, language and a preferred working directory. Do not store any data or project inside the .qualcoder folder. The only file that you should put in here is a stopwords.txt file, only if you need to apply a different set of stopwords for word cloud and word count functions. This folder is only for the QualCoder software to use as it is running. -## Advanced options and logging +## Advanced options and logging {#advanced-options-and-logging} The **AI related options** at the bottom of the Settings dialog are described here: [AI Setup](2.3.-AI-Setup) \ No newline at end of file diff --git a/docs/doc/en/2.3.-AI-Setup.md b/docs/doc/en/2.3.-AI-Setup.md index 61acc01e..b5387366 100644 --- a/docs/doc/en/2.3.-AI-Setup.md +++ b/docs/doc/en/2.3.-AI-Setup.md @@ -20,12 +20,12 @@ All AI-related options are located at the bottom of the settings dialog. Scroll You might also want to read [how to best prepare your project for AI use](#improve-ai-usability-in-your-project) and our [notes on data privacy](#some-notes-on-privacy-and-data-protection) below. -## AI Model Selection +## AI Model Selection {#ai-model-selection} With QualCoder, you can choose from a wide range of commercial and non-commercial AI providers, and even use local models hosted on your own machine. Select one of the options in the "AI profile" drop-down in the Settings dialog. -### Frontier Models from OpenAI, Anthropic, or Google +### Frontier Models from OpenAI, Anthropic, or Google {#frontier-models-from-openai-anthropic-or-google} These large models deliver the most nuanced analysis of your empirical data and provide the smoothest overall experience. You have several options: @@ -62,7 +62,7 @@ To proceed, you will need the following information: Go to "Project > Settings > AI Integration", click on "Advanced AI Options > New AI Profile", and give it a name. Then enter your API key in the corresponding field, your Azure deployment name in the fields "Large Model" and "Fast Model" (these can be identical), and the Azure endpoint URL in the field "api_base". You may also want to adjust the context window size depending on the model. -### Academic AI Infrastructure +### Academic AI Infrastructure {#academic-ai-infrastructure} Non-profit academic AI infrastructure gives you access to medium-sized models while maintaining very high data privacy standards. These services are usually free of charge for eligible personnel. The output quality of such mid-size models has improved a lot lately and is good enough for most tasks in QualCoder. However, it is still not on the same level as the large commercial offerings. You may also encounter more hiccups when interacting with the AI agent, such as operational errors or malformed source references. @@ -80,14 +80,14 @@ Germany: - **[hessian.AI Darmstadt](https://hessian.ai/):** Experimental access, only for eligible people from Hessian universities in Germany. Follow the instructions for GWDG above, but use `https://llm-service.ai.tu-darmstadt.de` as the API base URL. -### Mid-size Models like Mistral, DeepSeek, and Others +### Mid-size Models like Mistral, DeepSeek, and Others {#mid-size-models-like-mistral-deepseek-and-others} The "AI profile" drop-down in the settings dialog also offers options for [Mistral (France)](https://mistral.ai/), [DeepSeek (China)](https://deepseek.com/), and [OpenRouter](https://openrouter.ai/), a platform through which many large language models on different servers can be accessed. For all of these options, you will need an API key and most likely also a paid account for serious work. Check the data privacy conditions carefully before using any of these services. -### Local AI Models on Your Own Machine +### Local AI Models on Your Own Machine {#local-ai-models-on-your-own-machine} Local AI models offer the highest level of data protection, but they also require fairly powerful hardware to run at a reasonable speed and quality. In my testing, `Gemma-4-31B-it` worked quite well. It needs at least 24 GB of VRAM in 4-bit quantisation with an acceptable context window size. For any serious agentic work in QualCoder, I would not go much smaller than that. [AI-assisted coding](4.2.-AI-Assisted-Coding), however, may still work with slightly smaller models. @@ -99,7 +99,7 @@ Local AI models offer the highest level of data protection, but they also requir - Select a large and fast model from the list, most likely the same one for both, as you will usually have only one model loaded at a time. You may also want to adjust the context window size depending on your Ollama settings. -### Other Models +### Other Models {#other-models} If you have access to other large language models on cloud platforms, university servers, or your own machine, you can try integrating them into QualCoder as well. - The service you wish to use must provide an interface compatible with the OpenAI API. This is often the case, since this API has become a de facto standard in recent years. @@ -123,7 +123,7 @@ Note that the section name must always start with the prefix 'ai_model_'. If you get other services running in QualCoder, or if you tried and failed, we would like to hear about your experience. -## Advanced AI Options +## Advanced AI Options {#advanced-ai-options} At the very bottom of the Settings dialog, you will find an "Advanced AI Options" button. Clicking it reveals a few more options. @@ -132,7 +132,7 @@ At the very bottom of the Settings dialog, you will find an "Advanced AI Options - When it comes to the other advanced options, it is probably best to leave them at their default values if you don't know what they mean. Note that the "temperature" and "top_p" parameters might be silently ignored by some models, especially in reasoning mode. -## The Local AI Memory Setup +## The Local AI Memory Setup {#the-local-ai-memory-setup} * The AI agent in QualCoder uses a special local memory to search empirical documents quickly and find relevant passages. This greatly reduces the amount of data sent to the cloud, thereby enhancing privacy, saving resources, and increasing speed. * The memory is powered by a small [local open-source AI model](https://huggingface.co/intfloat/multilingual-e5-large), approximately 2.5 GB in size, which is downloaded automatically the first time you activate the AI. Model storage locations: @@ -148,7 +148,7 @@ At the very bottom of the Settings dialog, you will find an "Advanced AI Options Technical note: The QualCoder local AI memory is a hybrid system based on [E5 sentence encoder](https://huggingface.co/intfloat/multilingual-e5-large) embeddings stored in a [FAISS vector store](https://github.com/facebookresearch/faiss) for semantic search, and a [SQLite BM25 index](https://sqlite.org/fts5.html) for fast keyword retrieval. In addition, the AI agent can use regular expressions to search the project data. -## Improve AI Usability in Your Project +## Improve AI Usability in Your Project {#improve-ai-usability-in-your-project} The AI agent in QualCoder should be able to read and understand the structure of your project, your empirical documents, codes, and memos. It should also have a clear picture of the goals, research questions, and methods that drive your research. This allows it to provide much more targeted answers. Some suggestions: @@ -158,7 +158,7 @@ The AI agent in QualCoder should be able to read and understand the structure of - If you use **memos** to record personal notes and unfinished brainstorming ideas that you do not want to share with the AI agent, put these notes behind a "#####" mark. Any memo content below this mark will not be sent to the AI. -## Some Notes on Privacy and Data Protection +## Some Notes on Privacy and Data Protection {#some-notes-on-privacy-and-data-protection} * We understand that using cloud-based services like those from OpenAI raises questions regarding data privacy and protection. diff --git a/docs/doc/en/2.4.-Working-in-a-Team.md b/docs/doc/en/2.4.-Working-in-a-Team.md index 02d68039..a05c145e 100644 --- a/docs/doc/en/2.4.-Working-in-a-Team.md +++ b/docs/doc/en/2.4.-Working-in-a-Team.md @@ -5,7 +5,7 @@ path: 2.4.-Working-in-a-Team # Working Together in a Team There are several strategies for organising collaborative work on the same project in QualCoder. Choose whichever best fits your methodological approach and specific working environment. -## 1) Sequential Editing of the Same Project +## 1) Sequential Editing of the Same Project {#1-sequential-editing-of-the-same-project} This approach can be applied to both inductive and deductive coding. It is based on the principle that all team members work on the same project files, albeit not simultaneously. **Coordinating the Sequence of Work:** @@ -17,7 +17,7 @@ This approach can be applied to both inductive and deductive coding. It is based Handle coder-names carefully (see below). -## 2) Using a Master Project: The 'Coding Separately Then Merging' Approach +## 2) Using a Master Project: The 'Coding Separately Then Merging' Approach {#2-using-a-master-project-the-coding-separately-then-merging-approach} This strategy allows your team to work simultaneously to some extent. It is most effective if you use a deductive coding approach, where the code system doesn't change much during the analysis. If you use it with inductive coding, be prepared to spend some time cleaning up and consolidating the code system when merging the work of different team members. @@ -29,9 +29,9 @@ Follow these steps: * Zip your project folder, including all subfolders and files, and send it to your collaborators (email, file transfer, or USB-stick). * Decide on a strategy for handling coder names in your team, as explained in the notes below. * Now, each team member can unzip their local copy of the project and work on it independently, adding codes, codings, memos, etc. However, do not edit the imported text of the empirical documents themselves, since this will potentially cause problems during the merging process later. -* Finally, gather all the local copies and sequentially merge them into your master project, using the [process described here](6.1.-Imports-and-Exports#merge-qualcoder-projects). +* Finally, gather all the local copies and sequentially merge them into your master project, using the [process described here](6.1.-Imports-and-Exports#merge-projects). -## Important Considerations Regarding Coder Names +## Important Considerations Regarding Coder Names {#important-considerations-regarding-coder-names} * In most cases, you want to have a unique name for each coder on your team so that individual contributions can be identified even after merging the project together. * In Project > Settings, click the "Change" button next to the coder name to open a window where you can alter your own identity or create, rename, or merge other coders within the current project. @@ -47,7 +47,7 @@ Follow these steps: !!! warning Do not keep the project folder on a network drive or in a cloud location, and access that location whilst running Qualcoder. If the database connection is lost, it would corrupt the database while QualCoder is performing a series of database operations. -## Backups +## Backups {#backups} Make a backup of the project folder before making any substantial changes, such as a substantial reorganisation of codes and categories, merging projects, or merging codes. QualCoder does perform hourly backups (keeping up to the most recent five, if backups are set in the settings). Also, do not store extra files or outputs within the project folder. diff --git a/docs/doc/en/3.1.-Creating-a-New-Project.md b/docs/doc/en/3.1.-Creating-a-New-Project.md index dc4babdf..6ece7d0e 100644 --- a/docs/doc/en/3.1.-Creating-a-New-Project.md +++ b/docs/doc/en/3.1.-Creating-a-New-Project.md @@ -8,7 +8,7 @@ You can **create a new project from the ‘Project’ menu.** If you name it "Test", the project will be saved as Test.qda. Test.qda is actually a folder with subfolders containing the database, empirical documents, and other files. If you want to email the project to someone else, zip the entire folder. -## Main screen +## Main screen {#main-screen} The Action Log tab in the main window displays various changes that are made when using QualCoder. The main window has a menu bar at the top full of options. There are five tabs for: _action log_, _manage_, _reports_, _coding_ and _AI chat_. Switching directly between tabs is generally OK. But if you are adding, renaming, deleting files in Manage Files or changing codes or code categories in the coding area, it is better to refresh each tab by selecting the relevant option in the Menu bar at the top of the screen. For example, changing files in Manage files, then doing coding or reports - select an option in the Menu for coding or report, rather than clicking directly on the tab for coding or reports. This is because some management changes may not refresh. @@ -20,7 +20,7 @@ The Action Log tab in the main window displays various changes that are made whe !!! tip "Good data management practices" For any project, maintain good data management practices, such as having backups stored regularly, and ideally backups stored in different locations (e.g., cloud, different computer folders, hard drives, USB sticks). -## Write a project memo +## Write a project memo {#write-a-project-memo} This is **especially important if you want to use the AI-based features** in QualCoder. The project memo is used to provide some contextual information about the current project and the type of empirical documents we are dealing with. This information, which is included in every query, helps the AI to produce much more targeted and useful responses. You can access the Project Memo from the Project > Project Memo menu. diff --git a/docs/doc/en/3.2.-Files.md b/docs/doc/en/3.2.-Files.md index 338f1dc0..65bda3e5 100644 --- a/docs/doc/en/3.2.-Files.md +++ b/docs/doc/en/3.2.-Files.md @@ -9,7 +9,7 @@ Each file is preceded by an icon that describes the type of file. Other columns ![image](/images/71172904-3ae5-4eb3-9b04-350f036f1c9d.png) -## Importing files +## Importing files {#importing-files} Import text from plain text documents, docx, epub, md, odt, pdf, rtf and tex (LaTex.tex, note |input and |include files are not resolved). Import images from: jpg, jpeg, and png. Import audio/video formats: mp3, m4a, mp4, wav, mov, ogg. PDFs can be coded as text or as images. Alternatively, rather than importing files into the project folder, you can link to files locally in your computer's file system. This may be a good option if you have a specific folder structure that is important to your project. @@ -27,12 +27,12 @@ If you are beginning with QualCoder, open the `Examples` folder and import `ID1. After import, open each file by double-clicking it or by using the right-click menu. You can test pseudonymisation (see below) by removing `ID2.odt`, adding `Joe Bloggs` through the Pseudonymise button, and then importing the file again. -### PDFs +### PDFs {#pdfs} PDFs with highlights can be imported and their highlighted segments coded automatically. Older projects extracted text differently from version 4.0. So when opening an older project, version 4.0 will try to match the text segments as best as possible. However, it may not be identical. -### Pseudonymisation (data de-identification) +### Pseudonymisation (data de-identification) {#pseudonymisation-data-de-identification} Pseudonymisation is available to replace words or phrases. For many languages (possibly except Chinese, Japanese, Korean), providing the character before the phrase and the character after the phrase are non-alphabetical and non-numerical, this is an easy cut-off to enact. Pseudonymisation is case-sensitive. Original words must be at least 2 characters long, and pseudonyms must be at least 3 characters long. Alternatively, leave the pseudonym entry blank for a randomly generated term. @@ -47,7 +47,7 @@ Imported text files and qualitative columns in imported surveys will be pseudony PDF files are not pseudonymised. -## Auto speaker codings +## Auto speaker codings {#auto-speaker-codings} "Mark speakers" creates codes for every speaker in an interview or group discussion, and assigns utterances automatically. You can reach it via the file context menu or the following toolbar button: @@ -55,55 +55,55 @@ PDF files are not pseudonymised. [See this section](4.1.-Coding-Text#auto-speaker-codings) for more details. -## General functions +## General functions {#general-functions} Filename entries can be changed in the database. The file names of the original files will not be changed. A right-click context menu allows you to view, export, delete a current file. The trashcan button is an option to select multiple files for deletion. The question mark '?' opens this help page. Files can be viewed either by right-click menu on the file, or by clicking the magnifying glass icon. This is where transcripts for audio and video can be entered, when viewing an audio or video file. ![button](/images/f03c0a5d-29ea-40c7-a5a1-917aeb894f9b.png)Bulk rename of all file rows. You provide a prefix and then a numbered suffix is added. This applies to all visible rows in the table. You can pre-select visible rows by right click and 'show this value' for example on an attribute. This button allows you to bulk rename files: -## Attributes +## Attributes {#attributes} Attributes are variables to describe the files. These can be added using the (x) button or through the Manage Attributes menu option. They can be character or numeric. The above image shows an added character attribute called _origin_ as well as one of several reference attribute columns _Ref-author_. Attributes can be exported to an Excel file via a button: ![image](/images/ccf331d7-63b6-460b-96df-41edd7cfe63b.png) -## Filtering columns and rows +## Filtering columns and rows {#filtering-columns-and-rows} -### Filtering rows +### Filtering rows {#filtering-rows} The right-click context menu also allows you to re-order the files according to name, date, and file-type and when right clicking in the name or date columns. You can show only selected attribute types: Choose Show this value option You can also select Show values like. Show values like can be applied multiple times to further shorten the list of displayed rows. -### Column visibility +### Column visibility {#column-visibility} Sometimes, a lot of columns can be displayed, which can be overwhelming. You can hide columns by right-clicking on the table header row for options to hide that column or to hide columns beginning with specific text. Or to show columns where the column name starts with specific text. -### Save and load column and row filters +### Save and load column and row filters {#save-and-load-column-and-row-filters} There are three buttons to save, load and delete filter settings, so that you can view the manage files table in ways that you want, quickly. ![Buttons to save, load and delete table filters](/images/96ae69f5-1493-4aa8-a3f5-31ee15c22fef.png) -## Open attribute URLs +## Open attribute URLs {#open-attribute-urls} Right-click on a URL in an attribute and open the URL with the default web browser. This is only if the attribute is a URL and it passes URL validation. -## Copy reference to clipboard +## Copy reference to clipboard {#copy-reference-to-clipboard} Use the right-click menu option for reference columns (Ref_Authors, Ref_Title, Ref_Journal, Ref_Type, Ref_Year). This allows copying reference to the clipboard as a Vancouver or APA style reference. -## Assign a selected file to a case +## Assign a selected file to a case {#assign-a-selected-file-to-a-case} You can assign a file to a case via right-click menu when in the cases column. -## Artificial Intelligence +## Artificial Intelligence {#artificial-intelligence} If you have enabled AI integration in QualCoder, newly imported text files will be read by the local AI model and stored in its local memory. This happens in the background (status bar shows "AI: reading"). You can continue to use QualCoder, but the AI-enhanced features will not be available until the AI has finished updating its memory. This also happens if you edit an already imported text file in QualCoder. If you ever get the impression that the AI memory is out of sync and has missed some updates to your data (which should not happen under normal circumstances), you can rebuild the memory from scratch by selecting "AI > Rebuild Internal Memory". This will reread all documents, which may take a while. -## Text file creation and editing +## Text file creation and editing {#text-file-creation-and-editing} You can create and enter text into text in the database by pressing the pencil icon. @@ -121,7 +121,7 @@ You can select text that is not underlined and copy/replace without problems. Yo !!! info There are some limitations: It is best to avoid selecting sections of text to delete (or to type or paste over) if those sections have a combination of not underlined (not coded/annotated/case-assigned) and underlined (coded, annotated, case-assigned). The reason is that the positions of the underlying codes/annotations/case-assigned may not correctly match as intended. If you have made a change that you think has affected these coded/annotated/case-assigned positions badly, exit the text editing window by pressing the Cancel button. -## Audio and Video files +## Audio and Video files {#audio-and-video-files} Video (mov, mp4, wmv, ogg) and audio files (wav, mp3, m4a) can be imported. Loading an audio or video file will also automatically create a blank text transcribed file. This file will have the same name as the audio or video file, but have a '.txt' suffix. Initially, this text transcription will be empty. You can transcribe the file yourself or get the file professionally transcribed and copy and paste the text into this file. @@ -138,7 +138,7 @@ If you have a .srt file (a transcript file that is read by VLC) you can place th If you have ffmpeg installed a waveform is shown. If the audio files has multiple audio tracks, only the first track is shown for the waveform. -### Transcribing audio and video +### Transcribing audio and video {#transcribing-audio-and-video} To transcribe open the Manage files menu option, then view the audio or video file. The audio/video will load and there will be a text area to enter transcribed text. @@ -187,7 +187,7 @@ Ctrl D Delete one or more speaker names. Ctrl 1 to 8 Insert speaker name in this format: [name] -### Transcriptions that have codes, annotations and / or case-assigned +### Transcriptions that have codes, annotations and / or case-assigned {#transcriptions-that-have-codes-annotations-and-or-case-assigned} Sections of the text file or audio/video transcribed file will have sections of text underlined in green (case assigned), yellow (annotation) or red (coded). Text can be edited even after the text is coded or annotated or assigned (fully or partially) to a case. @@ -196,11 +196,11 @@ You can select text that is not underlined and copy/replace without problems. Yo !!!! "There are some limitations" There are some limitations: It is best to avoid selecting sections of text to delete (or to type or paste over) if those sections have a combination of not underlined (not coded/annotated/case-assigned) and underlined (coded, annotated, case-assigned). The reason is that the positions of the underlying codes/annotations/case-assigned may not correctly match as intended. If you have made a change that you think has affected these coded/annotated/case-assigned positions badly, exit the text editing window by pressing the Cancel button. -## Example files +## Example files {#example-files} There are sample files in the Examples folder. These can be used to test importing files of different document formats and of importing an image. There are also example files to test importing case attributes, and for importing a survey. -## Manage Bad Links to Files +## Manage Bad Links to Files {#manage-bad-links-to-files} If your project contains externally linked files, these files can be moved, renamed, or deleted. diff --git a/docs/doc/en/3.3.-Cases.md b/docs/doc/en/3.3.-Cases.md index 5fa30f55..dad4469d 100644 --- a/docs/doc/en/3.3.-Cases.md +++ b/docs/doc/en/3.3.-Cases.md @@ -12,14 +12,14 @@ When a survey is imported, each survey row can be assigned to a case. The case n ![image](/images/a2076cfb-da5e-486f-a443-6ef6a070fc9a.png) -## Hiding and showing rows and columns +## Hiding and showing rows and columns {#hiding-and-showing-rows-and-columns} Hide columns by right-click on the table header row for options to hide that column or to hide columns beginning with specific text. Or to show columns starting with a text value. Hide rows by right-click menu and selecting a text value that equals or 'is like' some chosen text. Right click to order by case name or by attribute value, ascending or descending. !!! example "Pratical example" Add the three students (or cases) by clicking the Add case icon. Name each student: ID1, ID2 and ID3. -## Case file manager +## Case file manager {#case-file-manager} Now, add each student’s file to each student. Click on the cell in the Files column for case ID3 for example. This opens the _case file manager dialog_. Alternatively, click on the documents icon which will also open the case file manager. @@ -29,7 +29,7 @@ In the _case file manager_, click on a case, say ID3, then click the Add selecte You can also select a case, manually highlight text portions within a larger text document, and right-click to mark – or assign -the text to the selected case. -## Importing cases and case attributes +## Importing cases and case attributes {#importing-cases-and-case-attributes} You can import attributes from a CSV or XLSX file using this button: ![image](/images/0b9d8a34-33ff-4591-ae6d-c6f43bfb9625.png) @@ -38,7 +38,7 @@ The first row must contain the attribute headings. The first column must contain For this example – delete all the cases shown. Then, import the attributes from the cases.csv file through the Import Attributes dialog. You will again need to link the files and file text to each case. -## Exporting case information +## Exporting case information {#exporting-case-information} You can export the Cases table to an Excel (xlsx) file, using this button: ![image](/images/15d879be-bde6-4dfd-a1a7-baf5386ef8d9.png) \ No newline at end of file diff --git a/docs/doc/en/4.1.-Coding-Text.md b/docs/doc/en/4.1.-Coding-Text.md index 971ed328..93e74d74 100644 --- a/docs/doc/en/4.1.-Coding-Text.md +++ b/docs/doc/en/4.1.-Coding-Text.md @@ -39,12 +39,12 @@ _Overlapping codes_ Overlapping codes can be difficult to view clearly. Overlapping sections are underlined. Mouse hover will show overlapped coded text. You can press 'O' after clicking on an overlapping section to cycle through the codes at that location. -## Annotations +## Annotations {#annotations} Add an annotation (a memo for a text segment) to a text selection. These are useful for explaining acronyms and jargon. The text will become bold to mark the position of the annotation. To re-open an annotation, select some of the bolded-text and right-click to get the Annotate option. Alternatively, click the leftmost notepad and pencil button, or press the 'A' key. To remove an annotation, open the annotation and delete all the text. ![image](/images/104526a8-1bba-4dae-8bcd-43d2ddc5f9c8.png) -## Auto-code +## Auto-code {#auto-code} The top right of the screen has buttons for auto-coding text: ![auto-code buttons](/images/d689c833-505f-49e4-938c-e392d4a2cc14.png) @@ -79,7 +79,7 @@ There is an undo button to remove the auto-codings that were last applied. ![image](/images/8ac5bcf5-fae4-4da3-a1dd-8dccf12d585b.png) -## Auto speaker codings +## Auto speaker codings {#auto-speaker-codings} The function "mark speakers" creates codes for every speaker in an interview or group discussion, and assigns utterances automatically. This allows for more focussed reports, only looking at certain speakers at a time. You can reach the function via the file context menu or the following toolbar button: @@ -94,10 +94,10 @@ The function "mark speakers" creates codes for every speaker in an interview or - However, you can still choose to hide these codings in the text window, so that they don't distract you in your own analytic coding. To do this, click on the "..." button right next to the coder name in the top left of the toolbar. In the following dialog, select the "📌 Speaker coding" entry and set the visibility to "hidden". - The function "mark speakers" is also available in the "manage files"workspace. -## Maximise screen area +## Maximise screen area {#maximise-screen-area} To hide the top control panel, click in the text area and press the 'H' key. To show the top panel, press 'H' again. -## Convenience methods for loading text files in the files list pane. +## Convenience methods for loading text files in the files list pane. {#convenience-methods-for-loading-text-files-in-the-files-list-pane} Some projects may have many text files and the view file dialog may present too many files to open. Right-click on the files in the file tree button to go to the next file, go to the bookmarked file or go to the file with the latest codings: @@ -106,7 +106,7 @@ Some projects may have many text files and the view file dialog may present too * Select the file which was most recently coded, * Go to a bookmarked location in a file. To create a bookmark, right click in some text when coding and select the bookmark option. The bookmark works for only one project at a time, so if you opened a different project, the bookmark would be incorrect or might not work at all. -### Convenience buttons underneath the files list +### Convenience buttons underneath the files list {#convenience-buttons-underneath-the-files-list} * Load the next file * Load the file with the latest coding @@ -117,7 +117,7 @@ Some projects may have many text files and the view file dialog may present too ![image](/images/b3c32938-c1df-455c-be3e-3753c813535c.png) -## Modifying code positions +## Modifying code positions {#modifying-code-positions} Right click on a code and select Resize. Handles at each end of the coded segment can be repositioned. @@ -136,7 +136,7 @@ It is always best to save a copy of the project before editing the text, to avoi * Dollar symbol $ Shift code positions, after the clicked character position. May be needed after the text is edited (added or deleted) to shift subsequent coding segments by a number of characters. -## Other shortcut keys for text coding +## Other shortcut keys for text coding {#other-shortcut-keys-for-text-coding} * A. Annotate selected text @@ -174,7 +174,7 @@ It is always best to save a copy of the project before editing the text, to avoi * Ctrl Z. Restores the last coding that was unmarked. -## Search text +## Search text {#search-text} The coding text dialogue contains a search for text function at the top middle, with tick boxes for searching case sensitive and for searching through all text files. When in the text area, selecting some text and pressing the shortcut key ‘s’ will fill the search text box and focus on the ‘next’ arrow button for quickly looking through the document for the selected text. The search requires a minimum of 3 characters as a default. Right-click to change the default to 5 characters, or to search only after Enter is pressed. The Case sensitive check box will limit to case sensitive searching. The All files check box will continue the search through other text files. @@ -186,7 +186,7 @@ The search uses Regex functions. * ‘\. will match the dot symbol, ‘\?’ will match the question mark. ‘\n’ will match the line ending symbol. This [Regex cheatsheet](www.rexegg.com/regex-quickstart.html) might assist. * \b word boundary, ‘\bbound\b’ will search for the full word ‘bound’, but not ‘boundary’ -## Moving through the text for one selected code +## Moving through the text for one selected code {#moving-through-the-text-for-one-selected-code} Underneath the codes tree are the buttons: forward, back and a grid icon button (to exit the function). @@ -195,21 +195,21 @@ Select a code and then click on the forward and back arrows. These now traverse !!! note In the 4.0 version, the entire text file is dispayed. In the previous versions e.g. 3.8.2 there was an option to load a text file in chunks of 50,000 characters. If you need to load text in chunks, then we recommend you use the previous [QualCoder version 3.8.2](https://github.com/ccbogel/QualCoder/releases/tag/3.8.2). However note that PDF text loading changed from 3.8.2 to 4.0 which may cause inaccuracy with coding segment positions when opening a newer project (e.g. 4.0) in the older release (3.8.2 or earlier). -## Show only important coded text +## Show only important coded text {#show-only-important-coded-text} Under the codes tree is a button with a star symbol. This button toggles between showing all coded text and the coded text flagged as Important. -## Export reports +## Export reports {#export-reports} Export in odt format - compatible with LibreOffice and Microsoft Word. Either ewith code highlights, or comments on the side. Odt report contains details of codes used, frequencies, annotations, memos and coded text. Other options include plain text, html, and a codebook export. -## Right-hand pane +## Right-hand pane {#right-hand-pane} The right-hand side of the coding text pane has another pane tucked away. To open click and drag from the right-hand side of the window, or press the button next to the Help button. This pane contains options useful when coding. One button is when clicking on a code, the code name, code rule (memo) and random coded text examples from the project are displayed. The other button displays the project memo. ![image](/images/a6977ba3-bdf2-43c8-9097-562a252af815.png) -## Editing text when in Coding - Code text +## Editing text when in Coding - Code text {#editing-text-when-in-coding-code-text} Text can be edited even after the text is coded or annotated or assigned (fully or partially) to a case. Sections of the text file or audio/video transcribed file will have sections of text underlined in green (case assigned), yellow (annotation) or red (coded) by ALL coders. @@ -233,6 +233,6 @@ Below is how the edit text screen looks. ![image](/images/b02d740e-d561-4c3c-aff0-637d45740d03.png) -## Categories and codes +## Categories and codes {#categories-and-codes} See [Categories and Codes](4.7.-Codes-Tree/) \ No newline at end of file diff --git a/docs/doc/en/4.2.-AI-Assisted-Coding.md b/docs/doc/en/4.2.-AI-Assisted-Coding.md index 64abdfc3..051a7ab1 100644 --- a/docs/doc/en/4.2.-AI-Assisted-Coding.md +++ b/docs/doc/en/4.2.-AI-Assisted-Coding.md @@ -3,7 +3,7 @@ path: 4.2.-AI-Assisted-Coding --- # AI Assisted Coding -## Introduction +## Introduction {#introduction} QualCoder’s built-in AI features (version 3.6 and up) can assist the coding process in various ways: @@ -15,11 +15,11 @@ QualCoder’s built-in AI features (version 3.6 and up) can assist the coding pr Note that "AI Assisted Coding" is not a method in its own right; it's a set of techniques that can be adapted to many methods working with codes, from grounded theory to content or thematic analysis. See this [video tutorial]( https://www.youtube.com/watch?v=FrQyTOTJhCc) for a practical example. -## Preconditions +## Preconditions {#preconditions} - The AI must be enabled, fully loaded, and ready for new queries (see the status bar for current state). - It is **highly recommended** to use the project memo (Menu "AI > Project Memo") to include a short description of your project's research topics, questions, objectives, and the empirical data collected. This information will accompany every prompt sent to the AI, resulting in much more targeted results. -## Start AI-Assisted Coding +## Start AI-Assisted Coding {#start-ai-assisted-coding} AI-assisted coding is integrated into the text coding workspace. Start it by clicking on "Coding > AI-assisted coding" or, if you are already in the text coding workspace, select the "AI Assistance" tab on the left. Then click on "Start AI Search." ![Screenshot AI Assistance Tab](/images/1eeca42f-2e4e-48a6-aca7-68e4b13df6c4.png) @@ -28,9 +28,9 @@ In the next window, you have to (1) define the object of your search (code or fr ![Screenshot AI Search Dialog](/images/0d66baa1-6c60-423a-b4d6-742d387322dc.png) -### 1) What to Search For: Code vs. Free Topic Search +### 1) What to Search For: Code vs. Free Topic Search {#1-what-to-search-for-code-vs-free-topic-search} -#### Code Search +#### Code Search {#code-search} Use this to dive deeper into a particular aspect and add more data from your entire corpus to an already existing code. @@ -40,10 +40,10 @@ Use this to dive deeper into a particular aspect and add more data from your ent - **Send memo to AI:** If selected, the code memo will also be shared with the AI. Use this to describe or define your code and help the AI generate better results. If you also want to add personal notes to the code memo, you can do so by inserting "#####" into the text. Anything below this mark will not be sent to the AI. - **Include coded segments:** Defaulted to off, meaning the AI search will return only new data not yet coded with this particular code. Activate this option to include previously coded data also. -#### Free Topic Search +#### Free Topic Search {#free-topic-search} Search for any topic, phenomenon, or concept in your entire corpus of data without a predefined code. Enter a name and a description to communicate to the AI what you are looking for. -### 2) How to Analyse the Data: The Analytic Prompt for the AI +### 2) How to Analyse the Data: The Analytic Prompt for the AI {#2-how-to-analyse-the-data-the-analytic-prompt-for-the-ai} The analytic prompt instructs the AI how to examine your data. Select it in the bottom left of the window. @@ -54,10 +54,10 @@ The analytic prompt instructs the AI how to examine your data. Select it in the **Explore these prompts** by hovering your mouse over the items in the drop-down list. Click on "Edit" to [edit the analytic prompts or define your own](6.2.-AI-Prompt-Library) (advanced option). -### 3) Filter: Narrow Your Search Down +### 3) Filter: Narrow Your Search Down {#3-filter-narrow-your-search-down} By default, the complete corpus of textual data in the current project is explored. If you want to limit the search to certain **documents** or **cases**, you can select them on the right side of the window (Ctrl + Click to select multiple). You can also define a filter based on selected **attribute variables.** -## The Process of AI-Assisted Coding +## The Process of AI-Assisted Coding {#the-process-of-ai-assisted-coding} First, perform the AI Search. This is a two-step process: **Step 1:** The AI queries its local database for potentially relevant data in your corpus. @@ -66,7 +66,7 @@ First, perform the AI Search. This is a two-step process: Please be patient as it might take some time for the initial results to appear. Clicking on a result loads the document in the main window and highlights the relevant quote. Also make sure to look at the text surrounding the quote to understand its context. -### Working through the Results +### Working through the Results {#working-through-the-results} You can **code the selected text** as you would any other text in the [code-text workspace](4.1.-Coding-Text). Expand or modify the selection as needed. @@ -80,7 +80,7 @@ QualCoder uses a **ranking algorithm** to display the most relevant results at t Over time, however, the results returned by the AI will begin to **diverge from the original topic** and become less and less relevant. This is the point where you should stop the investigation and move on to the next topic or code. You don't need to click "find more" until there is absolutely no data left to analyse from step one of the search. Compare this to a Google search: There's no need to click through every single page of results if you already understand what you want to know. -### What to Do If You Get No Results +### What to Do If You Get No Results {#what-to-do-if-you-get-no-results} 1) **If step one does not return any potentially relevant data:** Remember that by default, the code search only extracts new data. If you have already thoroughly coded your documents, there may simply be nothing new to explore on a particular topic. Also, think about your search query, especially the name of the code or search topic: Is it too specific or not clear enough? 2) **If step two does not yield any results:** Click on "find more" (if available) to analyse more data. If this does not produce any results either, you may want to start a new search with a more open, inclusive prompt (e.g., "open search"). diff --git a/docs/doc/en/4.3.-Coding-Text-on-PDFs.md b/docs/doc/en/4.3.-Coding-Text-on-PDFs.md index 87c9908d..e508c633 100644 --- a/docs/doc/en/4.3.-Coding-Text-on-PDFs.md +++ b/docs/doc/en/4.3.-Coding-Text-on-PDFs.md @@ -9,7 +9,7 @@ The text and image areas on the PDF can be coded. ![image](/images/ba02d9ee-24fe-4b67-84b0-4f62cd62a1c6.png) -### Key presses +### Key presses {#key-presses} * H Show or hide the top sections of the screen. * Ctrl F jumps to the text search box. @@ -21,13 +21,13 @@ The text and image areas on the PDF can be coded. * Ctrl 9 Show important coded segments. Toggles on and off. * Ctrl 0 Show Help page in browser. -#### In the PDF display area: +#### In the PDF display area: {#in-the-pdf-display-area} You can zoom in and out by clicking on the shown PDF and pressing the + or - keys. Press Q to quickly mark selection with the recent code. Press R to quickly mark selection with a choice of recently used codes. -#### In the plain text area: +#### In the plain text area: {#in-the-plain-text-area} * A annotate - for current selection - text edit only * Q Quick Mark with code - for current selection @@ -38,10 +38,10 @@ Press R to quickly mark selection with a choice of recently used codes. * U Unmark at the selected location * V assign 'in vivo' code to selected text -## Export reports +## Export reports {#export-reports} Export in odt format - compatible with LibreOffice and Microsoft Word. Or as a PDF with highlighting applied. -## Older versions 3.8.2 and earlier +## Older versions 3.8.2 and earlier {#older-versions-382-and-earlier} The screen is split into 3 adjustable panes. The left-hand side pane contains the file list and code tree. The middle pane shows the PDF representation. The right-hand pane shows the plain text extracted from the PDF. The original fonts for the text are not used. Instead, the standard font within QualCoder is used in the displayed PDF text boxes. There is a Font size adjuster to shrink the font size, to try to avoid text overlapping. It is set at -2, and -3 may be quite good also. @@ -49,6 +49,6 @@ The right-hand side pane shows the plain text in the same way the text would be To code, left-click and drag the mouse to select PDF text boxes. This can be tricky depending on the size and positions of the boxes. Then click a code to assign the selection to it. Further adjustments can be made on the right-hand plain-text pane using the shift left or right arrows to extend, or the alt left and right arrows to shrink the coded text section. -## Categories and codes +## Categories and codes {#categories-and-codes} See [Categories and Codes](4.7.-Codes-Tree/) \ No newline at end of file diff --git a/docs/doc/en/4.4.-Coding-Images.md b/docs/doc/en/4.4.-Coding-Images.md index d61be40c..c4936fd1 100644 --- a/docs/doc/en/4.4.-Coding-Images.md +++ b/docs/doc/en/4.4.-Coding-Images.md @@ -10,7 +10,7 @@ The top right of the dialogue shows some details of a clicked on coded area - by ![image](/images/8e9e2ac8-61c0-4b4a-9d8b-31556da21fb2.png) -## PDF image coding +## PDF image coding {#pdf-image-coding} PDFs can be image coded here or in the Code PDF section. @@ -19,17 +19,17 @@ PDFs can be image coded here or in the Code PDF section. PDF navigation buttons: ![PDF navigation buttons](/images/36effc9c-f0a2-4f02-9fe0-293abcd3060a.png) -## Important coded areas +## Important coded areas {#important-coded-areas} Important coded areas, such as exemplars for a report, can be flagged as Important by using the right-click menu when on the coded areas and selecting Important. At the top of the screen is a button with a star symbol. This button toggles between showing all coded areas and the coded areas flagged as Important. -## Shortcuts +## Shortcuts {#shortcuts} * Shortcut H. Press h when on the image to hide and unhide the top controls section of the screen. * Shortcut L. Press L to 'Show codes like', to show a shortlist in the codes tree. * Press + or - buttons to enlarge or shrink the image. * Ctrl Z to restore the last unmarked coding area. -## Convenience buttons underneath the files list +## Convenience buttons underneath the files list {#convenience-buttons-underneath-the-files-list} * Load the next file * Load the file with the latest coding @@ -37,7 +37,7 @@ Important coded areas, such as exemplars for a report, can be flagged as Importa * Use a filter function show only those files that meet certain criteria. These can be from file attributes or if files are associated with certain cases. (Button that displays a tag) -## Right-click on the image area for more options +## Right-click on the image area for more options {#right-click-on-the-image-area-for-more-options} Options include rotation and highlighting a specific code or coded area. These highlight options are: greyed out, blur, solarise, and they open in your default image viewing program to view and save. @@ -50,10 +50,10 @@ Highlight coded areas example, with captions: ![image](/images/be991d7a-363b-4e5a-a93a-d02ccde42930.png) -## Export +## Export {#export} The image with coded areas can be exported to an HTML file. After opening the file in a browser, mouse hovering over the coded areas shows the code name and memos. -## Categories and codes +## Categories and codes {#categories-and-codes} See [Categories and Codes](4.7.-Codes-Tree/) \ No newline at end of file diff --git a/docs/doc/en/4.5.-Coding-Audio-and-Video.md b/docs/doc/en/4.5.-Coding-Audio-and-Video.md index e708f29b..9cfb2f27 100644 --- a/docs/doc/en/4.5.-Coding-Audio-and-Video.md +++ b/docs/doc/en/4.5.-Coding-Audio-and-Video.md @@ -10,7 +10,7 @@ The transcription text can also be coded and annotated in this window. Right-cli ![image](/images/bac80f08-c719-4add-9878-104d3fbc084e.png) -## Keyboard shortcuts +## Keyboard shortcuts {#keyboard-shortcuts} * Ctrl R Rewind 5 seconds * Alt R or Alt Minus Rewind 30 seconds @@ -32,7 +32,7 @@ When the text area has focus: * Press Q to Quick code with the most recent code. (Must have a text selection) * Press R to select Recent codes. (Must have a text selection) -## Audio Video segments +## Audio Video segments {#audio-video-segments} Once a segment is made using the _Start segment/Stop segment_ button, this can be assigned to a code by right-clicking on the relevant code and assigning the segment. @@ -40,7 +40,7 @@ Coding stripes for the coded segments are shown in the lower area. Hovering the The transcript text can also be coded and annotated in this dialog. However, when the Scroll transcript check box is checked, this cannot be performed. Playing the video when this is checked will scroll the transcript using the timestamps in time with the video. -## Important coded text and segments +## Important coded text and segments {#important-coded-text-and-segments} Important coded texts, such as exemplars for a report, can be flagged Important by using the right-click menu when on the coded text and selecting Important. Similarly, code segments can be flagged Important. At the top of the screen is a button with a star symbol. This toggles between showing all coded text and segments or Important coded text and segments. @@ -48,7 +48,7 @@ Important coded texts, such as exemplars for a report, can be flagged Important Select text (it can be coded or preferably uncoded), then assign it to a segment. First, select the text. Then right-click the segment stripe to open the menu. Choose Link text to segment, to assign the text. -## Modifying code positions in the text area +## Modifying code positions in the text area {#modifying-code-positions-in-the-text-area} When in the text area, click on a code with the mouse (Note: the code must not overlap with another code at that position). Press the following key combinations to extend or shrink the coded text segment. @@ -61,17 +61,17 @@ You can also right-click on a code and select change start position or change en You can also export a screenshot. The screenshot will be saved as Frame_yyyymmdd_hh_mm_ss.jpg. You can save a screenshot for image coding within the project. -## Convenience buttons underneath the files list +## Convenience buttons underneath the files list {#convenience-buttons-underneath-the-files-list} * Load the next file * Load the file with the latest coding * Open the file memo of the selected file * Use a filter function show only those files that meet certain criteria. These can be from file attributes or if files are associated with certain cases. -## Audio and video problems on some operating systems +## Audio and video problems on some operating systems {#audio-and-video-problems-on-some-operating-systems} Fedora does not work with the audio and video. -## Categories and Codes +## Categories and Codes {#categories-and-codes} See [Categories and Codes](4.7.-Codes-Tree/) \ No newline at end of file diff --git a/docs/doc/en/4.7.-Codes-Tree.md b/docs/doc/en/4.7.-Codes-Tree.md index 3f8e42ab..fb88cf93 100644 --- a/docs/doc/en/4.7.-Codes-Tree.md +++ b/docs/doc/en/4.7.-Codes-Tree.md @@ -11,7 +11,7 @@ Categories and codes can be assigned memos. Memos can contain symbols such as th !!! note The ability to assign a single code to multiple categories is a frequently requested feature. However, we have decided against implementing this functionality, as it would be overly complicated. This is due to QualCoder’s use of a tree structure, while the requested feature requires a [graph data structure](https://www.baeldung.com/cs/tree-vs-graph-data-structure). As an alternative, you can use codes with similar names across your different categories. -## Reducing the amount of codes displayed in the codes tree +## Reducing the amount of codes displayed in the codes tree {#reducing-the-amount-of-codes-displayed-in-the-codes-tree} To reduce the number of codes shown in the code tree. In the coding windows (code text, code, a/v or code image), right-click on the code tree and select _Show codes like_ from the menu, or when the codes tree is in focus key press F9.. Then enter text in the text box. This will then only show codes that contain that text. To show all the codes again, enter nothing into the text box and press OK to show all the codes. @@ -19,13 +19,13 @@ A second option is to _Show codes of colour_. Key press F10 when codes tree is i Another button under the code tree - with a search icon - on clicking will search for the first code that contains matching text that you enter. -## Codes tree menu options +## Codes tree menu options {#codes-tree-menu-options} In the codes tree on the left, right clicking on a code opens a context menu for various options. Sub-menus include modifying a code or category, filtering and sorting. ![image](/images/4adaa97e-da9c-45bf-88f3-8e0110edf638.png) -### Show coded files +### Show coded files {#show-coded-files} One option is Show coded files - this shows everywhere you have coded with the selected code. Clicking on a particular coded section will open that code in the original context for further insight. @@ -35,7 +35,7 @@ With show coded files, you can right-click on the coloured header section for mo Sort the codes tree acending (key F11 when codes tree in focus), or descending (key F12 when tree in focus). -## Accessibility and code colours +## Accessibility and code colours {#accessibility-and-code-colours} In the Coding menu there is an option called **Colour scheme**. diff --git a/docs/doc/en/5.1.-AI-chat-based-analysis.md b/docs/doc/en/5.1.-AI-chat-based-analysis.md index 03bd5f9a..399f8281 100644 --- a/docs/doc/en/5.1.-AI-chat-based-analysis.md +++ b/docs/doc/en/5.1.-AI-chat-based-analysis.md @@ -4,7 +4,7 @@ path: 5.1.-AI-chat-based-analysis # Analysing data with the AI agent -## Core principles of AI integration +## Core principles of AI integration {#core-principles-of-ai-integration} **1) Choice of AI models** @@ -22,7 +22,7 @@ The prompts that guide the AI agent's work are accessible and can, in principle, The focus is on working with AI through dialogue: developing additional perspectives, questioning your own interpretations, and gaining a better understanding of the material. On request, the agent can also carry out longer tasks semi-autonomously. Large-scale automation, however, has never been the primary goal. -## Working with the AI agent +## Working with the AI agent {#working-with-the-ai-agent} - The AI agent has its **own tab** in QualCoder. You can also move it into a **sidebar** (see below), alongside your data, by clicking the small arrow button. ![Arrow button for moving the AI agent into the sidebar](../../images/ai-agent-sidebar-button-de.png){ width="118" } @@ -33,20 +33,20 @@ The focus is on working with AI through dialogue: developing additional perspect !!! note The AI must be **fully loaded** and ready for new queries before you can start a chat (status bar: "AI: ready"). -### What is the AI agent for? +### What is the AI agent for? {#what-is-the-ai-agent-for} - The AI agent helps you **explore your empirical material,** develop interpretations and analyses, code data, and write memos. - You can discuss individual passages with the AI or search the project's entire corpus for themes or contrasting cases. - You can develop your code system, brainstorm ideas and analytic strategies, and check them directly against the empirical data. - Unlike generic chatbots, the AI agent in QualCoder **picks up exactly where your analysis has left off:** it examines the current code system, can read memos and coded passages, incorporate cases and their characteristics (attributes) into the analysis, and more. This gives you feedback tailored to the current stage of your research. -### What can the AI agent do? +### What can the AI agent do? {#what-can-the-ai-agent-do} - Even with only **read access** to the project, the AI agent is already a powerful brainstorming tool. - On request, it can also **actively advance the analysis**. With the appropriate permissions (see below), it can create new codes or reorganise existing ones, find and code new text passages, revise memos, or create new case attributes. - In conversation with the agent, you can review suggestions, ask follow-up questions, and decide how to proceed. -### What are its limitations? +### What are its limitations? {#what-are-its-limitations} - Currently, the AI agent can only work with **text data**, not with images, audio, or video. QualCoder's journals are also excluded for now. - You can choose between three permission levels: @@ -60,7 +60,7 @@ The focus is on working with AI through dialogue: developing additional perspect - One **strict limit** always applies: the empirical documents form the "ground truth" of the entire analysis. Under no circumstances can the AI modify them. - The AI agent also has **no access to external information,** such as information from the internet. It can therefore only work with data you have deliberately included in the project. -### How can I see which changes the AI makes? +### How can I see which changes the AI makes? {#how-can-i-see-which-changes-the-ai-makes} - The agent **documents its steps in the chat,** provides source references, and asks before making major changes. - You can easily **undo** the AI agent's latest changes using the corresponding button in the chat window: @@ -75,7 +75,7 @@ The focus is on working with AI through dialogue: developing additional perspect ![Adjusting the visibility of the AI Agent's codings](../../images/ai-agent-code-visibility-de.png){ width="250" } -### How should I prepare my project? +### How should I prepare my project? {#how-should-i-prepare-my-project} - A good **project memo** is very important (menu: "Project > Project memo"). It should contain: @@ -96,7 +96,7 @@ The focus is on working with AI through dialogue: developing additional perspect !!! note **Personal notes in memos:** If you also want to use memos for personal notes, write them after the separator `#####`. Everything after it is inaccessible to the AI. -### How does the AI agent work? +### How does the AI agent work? {#how-does-the-ai-agent-work} - The AI agent only acts when you give it a **task**, not on its own initiative. - The agent works through a task in a **ReAct loop** (Reflect + Act, [Shunyu et al. 2022](https://arxiv.org/abs/2210.03629)): @@ -110,13 +110,13 @@ The focus is on working with AI through dialogue: developing additional perspect - The agent has **powerful tools** at its disposal: for example, it can perform a semantic similarity search across the entire corpus, search using regular expressions or a BM25 keyword index, and call tools to create or modify codes if it has write permissions. -### What happens to my data? +### What happens to my data? {#what-happens-to-my-data} - All data are kept **locally on your computer** in the current QualCoder project. The search operations mentioned above also run locally. - The **AI model only sees the portion of the data** (e.g. search results or individual passages) specifically needed for the current analysis. These data fragments are sent to the AI model along with the relevant task. - In its answers, the AI agent documents in detail the data on which its analyses are based. QualCoder turns these references into **source links with line numbers.** Clicking a reference opens the passage in its original context. -## Four ways to start a conversation with the agent +## Four ways to start a conversation with the agent {#four-ways-to-start-a-conversation-with-the-agent} ![Four starting points: an open question, a topic, a text passage, and a code or category](../../images/ai-agent-conversation-paths-en.png) @@ -126,7 +126,7 @@ At the bottom left of the AI agent's window, you can start a new analysis in one These options simply provide **different starting points** for the analysis. You can then take the conversation in any direction you choose, using the full toolset available to the agent. -### 1) New, open chat +### 1) New, open chat {#1-new-open-chat} This is the most flexible way to start a new analysis with the agent. Begin with an idea or an open question, or name the codes or passages you would like to investigate. @@ -152,7 +152,7 @@ This is the most flexible way to start a new analysis with the agent. Begin with To incorporate **predefined prompts or your own prompts** from the [AI Prompt Library](./6.3.-AI-Prompt-Library.md) into the conversation, use 'slash notation': for example, "/in-vivo-coding" would insert the corresponding prompt you previously created in the Prompt Library into the current conversation. -### 2) Topic exploration +### 2) Topic exploration {#2-topic-exploration} This type of analysis is particularly useful for gaining an **initial overview** of how a particular topic is discussed in the empirical material. For straightforward research questions with clearly defined topics, you can also use this function to produce summary analyses that can be developed directly into a report. @@ -169,7 +169,7 @@ This type of analysis is particularly useful for gaining an **initial overview** > > **Result:** A comparative analysis of Ethel and Flora on the topic "Raising children during wartime", structured around the three subquestions. -### 3) Text analysis +### 3) Text analysis {#3-text-analysis} - Enables **close analysis of a selected passage** with the AI agent. - Develop new readings and code suggestions together, or discuss ambiguities, uncertainties, and unresolved questions of interpretation. @@ -190,7 +190,7 @@ You can also save your own text analysis instructions in the [AI Prompt Library] > d) A **conversation about the material** then begins, in which you explore and discuss different possible interpretations together. > e) **Save the results:** When you have finished, instruct the AI agent to save a summary of the results as a text annotation. -### 4) Code analysis +### 4) Code analysis {#4-code-analysis} - Analyses all **data collected under a particular code or category,** including subcodes. - Discuss your codings with the AI agent, compare different codes, create subcodes, or produce reports. @@ -209,14 +209,14 @@ You can create your own prompts for this function in the [AI Prompt Library](./6 > > **Result:** A detailed report on the "theoretical saturation" of the current code or selected category in the sense of grounded theory. The AI agent actively searches the material for yet uncoded variations of the phenomenon captured by the code, for borderline cases, and counterexamples, to assess the code's empirical and conceptual/theoretical saturation and to identify gaps. The code memo is also taken into account. -## A final reflection on anthropomorphism +## A final reflection on anthropomorphism {#a-final-reflection-on-anthropomorphism} We deliberately decided against giving the AI agent in QualCoder a name, such as Anthropic's "Claude". Nevertheless, QualCoder's approach to AI integration through dialogue stages a kind of pseudo-interaction that in many respects follows patterns of human interaction, for example within a research team. In its [core system prompt](https://github.com/ccbogel/QualCoder/blob/master/src/qualcoder/ai_prompts/_agent.md), the AI agent in QualCoder is assigned precisely this role as a kind of team member. Are we therefore anthropomorphising a machine by interacting with it as if it were a human researcher? To some extent, we are. But it seems to me most useful to view these interactions as a kind of "role play", as proposed by [Shanahan, McDonell & Reynolds 2023](https://www.nature.com/articles/s41586-023-06647-8). Today's AI language models are trained on human linguistic interactions. They therefore work best when incorporated into such interaction settings. Nevertheless, a methodologically reflective approach to AI in qualitative social research requires us to remember that we are engaging in technologically induced role play, rather than interacting with a human counterpart. -## Further functions +## Further functions {#further-functions} - In the **[AI Prompt Library](./6.3.-AI-Prompt-Library.md)**, you can save successful analytic strategies and methodological approaches as reusable instructions for later. - **[AI Assisted Coding](./4.2.-AI-Assisted-Coding.md)** in the 'Code text' workspace uses an AI-based search to help you find passages relevant to a particular code across the entire corpus. -- If you have **questions about using QualCoder**, the AI agent can help with these too, providing answers based on the QualCoder documentation. Select *Help > Ask the AI agent* from the main menu. +- If you have **questions about using QualCoder**, the AI agent can help with these too, providing answers based on the QualCoder documentation. Select *Help > Ask the AI agent* from the main menu. \ No newline at end of file diff --git a/docs/doc/en/5.2.-Journals.md b/docs/doc/en/5.2.-Journals.md index 498beb7b..c2f69557 100644 --- a/docs/doc/en/5.2.-Journals.md +++ b/docs/doc/en/5.2.-Journals.md @@ -23,7 +23,7 @@ You can sort journals by name or date. You can add attributes to journals. You c The journal window will be free-floating, so that you can enter notes while coding or generating reports. -## Highlight journal text using markdown +## Highlight journal text using markdown {#highlight-journal-text-using-markdown} Some markdown is available to highlight wording in a journal. Use one to three hash symbols for heading levels. Single asterisk surrounding words for italic text. Double asterix surround text for bold text. diff --git a/docs/doc/en/5.3.-Analysis.md b/docs/doc/en/5.3.-Analysis.md index 08356b05..488be181 100644 --- a/docs/doc/en/5.3.-Analysis.md +++ b/docs/doc/en/5.3.-Analysis.md @@ -27,16 +27,16 @@ Coding results can be narrowed down by using the File selection, Case selection If text is entered into the Search text field, only codings that contain the matching text will be presented. The search text also looks for matching text in memos for coded image areas and coded audio/video segments. The search text function must be used in combination with File selection, Case selection or Attribute selection. -## Important coded text, images, segments +## Important coded text, images, segments {#important-coded-text-images-segments} There is a tick box to select only the Important codings. This is useful for quickly finding those important exemplars that you may use in a written report. -## Attribute selection in reports +## Attribute selection in reports {#attribute-selection-in-reports} The Attribute selection button opens a window where you can select attributes for files and cases, for example: only interview files for people aged > 60. Additionally, attribute settings can be saved, loaded and deleted. ![Attribute selection](/images/8d349854-7e35-474b-8bba-119b23ed40b0.png) -## Coding matrix +## Coding matrix {#coding-matrix} If you are creating a report and selecting one of the matrix options, then the results pane will be split into two panes. The left pane shows the coded data in a list, and the right pane shows a matrix of rows and columns. The column types can be codes, categories, or top-level categories. Matrix options: have codes/categories by file or by case. The matrix can be transposed, using the check box. @@ -49,18 +49,18 @@ Reports can be exported to text, OpenDocument (ODT), HTML, or csv files. _When cases are selected, another pane is displayed showing a table of cases (in rows) and categories or codes in columns_ -## Check boxes +## Check boxes {#check-boxes} * Check box to show only coded segments that have been marked important. * Check box to add summary statistics to the report. * Check box for text context for coded text segments. This shows the surrounding 100 to 300 characters of text (set in Settings) to help put the coded section in context in the results. The coded text segment is shown in bold. * Check box to add a reference to the coded result. This is if a reference has been imported and linked to the specific file. -## Other functions +## Other functions {#other-functions} * Shortcut H. Pressing h will hide and unhide the top controls section of the window. -### Memos +### Memos {#memos} * Memo display. A drop-down box gives options to include no memos, various memo options, or to display text file annotations for selected text files. @@ -68,7 +68,7 @@ Right-click on a code heading in the generated report for more menu options: Vie ![image](/images/a6d29ccf-2d9f-4faf-a1a6-5aaf3498e9a9.png) -### Exporting reports +### Exporting reports {#exporting-reports} Reports can be exported as html, odt, txt, csv, xlsx, (in 3.8+) iramuteq. @@ -141,10 +141,10 @@ An Excel file can be exported. ![image](/images/226f7c7d-f343-46d7-a2a7-49d86bfa3ef2.png) -## Graph (Mind-map) +## Graph (Mind-map) {#graph-mind-map} [See page](5.5.-Graph) -## AI assisted analysis +## AI assisted analysis {#ai-assisted-analysis} -[See page](5.1.-AI-chat-based-analysis) +[See page](5.1.-AI-chat-based-analysis) \ No newline at end of file diff --git a/docs/doc/en/5.5.-Graph.md b/docs/doc/en/5.5.-Graph.md index aac64612..0959b64b 100644 --- a/docs/doc/en/5.5.-Graph.md +++ b/docs/doc/en/5.5.-Graph.md @@ -18,7 +18,7 @@ Right-clicking on a line allows you to change the thickness, change to dotted li Coded text, coded images and coded A/V segments can be shown. Memos of coded text, coded image and coded A/V segments can be shown in text boxes. Each of these has tooltips to give more information. You cannot display the same coded segment multiple times in the graph. -## Right-click on items for more options +## Right-click on items for more options {#right-click-on-items-for-more-options} Image: @@ -37,6 +37,6 @@ Line style: ![image](/images/gh-baa778e1-e439-4727-bd42-b84e00a3f0a3.png) -## Export options +## Export options {#export-options} Graphs can be saved, loaded and deleted. Graphs can be exported as: PNG, PDF, ODT (for LibreOffice and MS Office), [Draw.io](https://www.drawio.com/). \ No newline at end of file diff --git a/docs/doc/en/6.1.-Imports-and-Exports.md b/docs/doc/en/6.1.-Imports-and-Exports.md index b1fcd073..293c93bb 100644 --- a/docs/doc/en/6.1.-Imports-and-Exports.md +++ b/docs/doc/en/6.1.-Imports-and-Exports.md @@ -13,17 +13,17 @@ Projects and codebooks can be exported using the REFI-QDA standard. Codebooks ca Surveys are imported via a button in the Manage Files window. [See Survey Imports](6.2.-Survey-Imports) -## Codebook export +## Codebook export {#codebook-export} This is an option under the Project Menu > Exports. A codebook is a list of your codes. Each code memo should detail the reasons for the purpose of each code. The codebook can be exported to a text file. The codebook also shows the frequency of the codes used (from all coders). As codes and categories are put in a tree like structure the double minus ‘–‘ indicates the subordinate codes and categories within a category. -## Codebook import +## Codebook import {#codebook-import} Import a codebook as a plain text (.txt) file or as a .csv file. Use two greater than symbols to separate category and code. Use three greater than symbols to define a code under a code. -### Codebook - Plain text import +### Codebook - Plain text import {#codebook-plain-text-import} Create a plain text (.txt) file. Use the tab to then add a memo. @@ -39,7 +39,7 @@ category3>>code4 code5>>>code6>>>code7 ``` -### Codebook - CSV file +### Codebook - CSV file {#codebook-csv-file} Create a CSV file in LibreOffice Calc or MicrosoftOffice Excel. The categories and codes are in the first column, and set up in the same way as for a plain text file. Any code memos are in the second column. ``` @@ -50,7 +50,7 @@ category1>>category2>>code2 category3>>code3 ``` -## REFI-QDA +## REFI-QDA {#refi-qda} [Rotterdam Exchange Format Initiative (REFI)](https://www.qdasoftware.org) is an open standard for exporting and importing codebooks and projects from and to different computer-aided qualitative data analysis software. Currently, QualCoder is able to import a codebook provided it is using the "urn:QDA-XML:codebook:1.0" version. QualCoder exports in this version also. @@ -67,38 +67,38 @@ If no coded data is visible, you may need to change the current coder's name in This is now old (Feb 2021), but a user tested the importation of a REFI-QDA project file generated by QualCoder and imported into MAXQDA, Quirkos, Atlas.ti. Only text and Images were tested. A PDF of the test results is here: [Testing importation of REFI-QDA Project files into Atlas, MAXQDA, Quirkos PDF](https://qualcoder.files.wordpress.com/2021/02/refi-qda-project-import-quirkos-maxqda-atlas.pdf) -## Taguette import +## Taguette import {#taguette-import} Projects created with [Taguette](https://www.taguette.org/) can be imported from the sqlite file. All your core coding data will be transferred. Close any open project. Then, in the Main Menu under Project, click on Taguette Project import. You will be asked to create a new project, so enter a name. Then, you will be prompted to select the Taguette project file (usually with a .sqlite3 extension). QualCoder will then proceed to import the data. If you do not see any coded data, you may need to change the current coder's name in the Settings. Try using the coder name drop-down box. -## Sonal π (Sonal Pi) import +## Sonal π (Sonal Pi) import {#sonal-sonal-pi-import} Projects created with [Sonal Pi](https://www.sonal-info.com) a French developed qualitative Data Analysis Software can be imported. -## RQDA import +## RQDA import {#rqda-import} Projects made with [RQDA](http://rqda.r-forge.r-project.org/) can be directly imported. All data except for file categories are imported. Close any opened project. Then in the Main Menu under Project click on RQDA Project import. You will be asked to create a new project- so enter a name. Then you will be asked to select the RQDA project file. QualCoder will then import the data. If no coded data is visible, you may need to change the current coder's name in Settings. Try the drop down coder name box. -## Survey import +## Survey import {#survey-import} See page [Survey Imports](6.3.-Survey-Imports) -## Bibliography import +## Bibliography import {#bibliography-import} See page [Managing Data - References](3.5.-References) -## Help - Special Functions +## Help - Special Functions {#help-special-functions} -### Dynamic update text content +### Dynamic update text content {#dynamic-update-text-content} This is useful for updating text files, such as blog post extracts, that change over time. Update a text file while attempting to keep the existing coded text segments. Select the text file that needs to be replaced and select the replacement file. Click the cogs button to run the update. This function works by finding the identical matching text in the replacement file as it parses through the file text. It may produce erroneously coded segments. -### Merge Projects +### Merge Projects {#merge-projects} -See page: [Merge QualCoder projects](6.4.-Merge-Projects) +See page: [Merge QualCoder projects](6.4.-Merge-Projects) \ No newline at end of file diff --git a/docs/doc/en/6.2.-Survey-Imports.md b/docs/doc/en/6.2.-Survey-Imports.md index 9c6490c4..9bcf55e0 100644 --- a/docs/doc/en/6.2.-Survey-Imports.md +++ b/docs/doc/en/6.2.-Survey-Imports.md @@ -24,7 +24,7 @@ Above is the data in _survey456.csv_ Above is the data in _survey789.xlsx_ -## Importing the file survey456.csv +## Importing the file survey456.csv {#importing-the-file-survey456csv} Press the import survey button and select the file from the Examples folder. @@ -50,7 +50,7 @@ In the Manage > Cases screen it is shown like this, with one text file assigned ![image](/images/gh-a35b341a-40e6-4d38-9647-179f6bc25d5e.png) -### Adding more data +### Adding more data {#adding-more-data} Using the survey import button, select and import the survey789.xlsx file. Leave the checkboxes unchecked. ![image](/images/gh-03a07b75-d7bf-496d-952c-cb397ebab8f7.png) @@ -81,4 +81,3 @@ From the Examples folder, import survey789_replace_data.xlsx, using the same imp ![image](/images/gh-0dd5c404-0a5c-484c-84cf-2c89d04bebc9.png) - diff --git a/docs/doc/en/6.3.-AI-Prompt-Library.md b/docs/doc/en/6.3.-AI-Prompt-Library.md index 593d51b9..a7e26bbe 100644 --- a/docs/doc/en/6.3.-AI-Prompt-Library.md +++ b/docs/doc/en/6.3.-AI-Prompt-Library.md @@ -1,60 +1,60 @@ ---- -path: 6.3.-AI-Prompt-Library ---- - -# AI Prompt Library - -- Prompts play an important role in any type of qualitative data analysis working with large language models. Prompts tell the AI how to analyse your data and respond to your queries. They are written in natural language and are easy for non-programmers to understand. - -- In QualCoder, the prompts underlying the AI features are accessible in the user interface. They can be customised to fit your methodological approach and research questions. - -- We have already included some interesting prompts from other qualitative researchers that have been published in various places. We hope that the growing use of AI in qualitative research will be accompanied by a culture of developing, sharing, and discussing sophisticated prompts in the scientific community, so that we can all learn from each other and improve the emerging new methods in the field. - -## The Structure of a Prompt - -In a very basic sense, a "prompt" is like the question you type into the web interface of ChatGPT. But even in this case it's a bit more complex. In the background, ChatGPT will accompany your question with an invisible "system prompt" that instructs the AI to be a helpful and supportive assistant, not to give medical or legal advice, etc. - -Similarly, the prompts in QualCoder are **modular** and consist of several different elements, some of which you can change and some of which you cannot. - -This is the basic structure: - -![](/images/b77df95d-f5b3-4ffa-8d3a-a511c82ef9ab.png) - -This structure consists of - -- **fixed elements** (shown here in white on blue) that are defined in the source code of the application, -- **contextual information** (here in green) that you enter at various places in QualCoder's user interface, such as code names and memos, or the project memo with important information about your research, -- **empirical data** (here in yellow), selected in various ways, and -- the **analytic prompt** (shown in orange), which you can modify and adapt to your needs. - -## Analytic prompts - -Analytic prompts are the **core of QualCoder's AI features**. They instruct the AI on how to analyse your data. These instructions can be quite simple, but can also grow into complex guidelines with detailed descriptions of each step the AI should perform during the analysis, including methodological background, etc. (see Lieder & Schäffer, 2024).1 - -QualCoder comes with a set of predefined analytic prompts. But you can also define your own - either by clicking on the "Edit" button next to the prompt selection or by navigating to the "Prompt library" located in the "AI" menu. This will open the following window: - -![](/images/530f0c1e-f1c3-4827-9dad-1295ea70c18b.png) - -The prompts are divided into several categories: - -1) **Type** - - **Search** prompts are used in the [AI assisted coding](4.2.-AI-Assisted-Coding), - - **Code, Topic and Text Analysis** prompts are used in the AI Chat window. - -2) **Scope** - - **System** prompts are defined on the application level and cannot be altered directly. If you want to change a system prompt, you must duplicate it first. - - **User** prompts are defined by the user and stored on their computer. They are available to any project opened on that computer. - - **Project** specific prompts are stored with the project files. If you or someone else opens the same project on a different computer, these prompts will be available there as well. - -3) **Prompt name and description**: These are displayed in several places in the user interface where you can select an analytic prompt. The names must be unique within each scope. - -4) **Prompt text**: These are the actual instructions that will be sent to the AI (the orange box in the image above). If you want to share your prompt with someone else, this is the most important information you will need to send over. - - -!!! note " Note About Languages" - All predefined prompts in QualCoder are written in English. However, they can be applied to data in other languages as well. It is also no problem to write analytic prompts in languages other than English and use them with QualCoder. Most large language models are quite flexible when it comes to mixing different languages. - - -  -*** +--- +path: 6.3.-AI-Prompt-Library +--- + +# AI Prompt Library + +- Prompts play an important role in any type of qualitative data analysis working with large language models. Prompts tell the AI how to analyse your data and respond to your queries. They are written in natural language and are easy for non-programmers to understand. + +- In QualCoder, the prompts underlying the AI features are accessible in the user interface. They can be customised to fit your methodological approach and research questions. + +- We have already included some interesting prompts from other qualitative researchers that have been published in various places. We hope that the growing use of AI in qualitative research will be accompanied by a culture of developing, sharing, and discussing sophisticated prompts in the scientific community, so that we can all learn from each other and improve the emerging new methods in the field. + +## The Structure of a Prompt {#the-structure-of-a-prompt} + +In a very basic sense, a "prompt" is like the question you type into the web interface of ChatGPT. But even in this case it's a bit more complex. In the background, ChatGPT will accompany your question with an invisible "system prompt" that instructs the AI to be a helpful and supportive assistant, not to give medical or legal advice, etc. + +Similarly, the prompts in QualCoder are **modular** and consist of several different elements, some of which you can change and some of which you cannot. + +This is the basic structure: + +![](/images/b77df95d-f5b3-4ffa-8d3a-a511c82ef9ab.png) + +This structure consists of + +- **fixed elements** (shown here in white on blue) that are defined in the source code of the application, +- **contextual information** (here in green) that you enter at various places in QualCoder's user interface, such as code names and memos, or the project memo with important information about your research, +- **empirical data** (here in yellow), selected in various ways, and +- the **analytic prompt** (shown in orange), which you can modify and adapt to your needs. + +## Analytic prompts {#analytic-prompts} + +Analytic prompts are the **core of QualCoder's AI features**. They instruct the AI on how to analyse your data. These instructions can be quite simple, but can also grow into complex guidelines with detailed descriptions of each step the AI should perform during the analysis, including methodological background, etc. (see Lieder & Schäffer, 2024).1 + +QualCoder comes with a set of predefined analytic prompts. But you can also define your own - either by clicking on the "Edit" button next to the prompt selection or by navigating to the "Prompt library" located in the "AI" menu. This will open the following window: + +![](/images/530f0c1e-f1c3-4827-9dad-1295ea70c18b.png) + +The prompts are divided into several categories: + +1) **Type** + - **Search** prompts are used in the [AI assisted coding](4.2.-AI-Assisted-Coding), + - **Code, Topic and Text Analysis** prompts are used in the AI Chat window. + +2) **Scope** + - **System** prompts are defined on the application level and cannot be altered directly. If you want to change a system prompt, you must duplicate it first. + - **User** prompts are defined by the user and stored on their computer. They are available to any project opened on that computer. + - **Project** specific prompts are stored with the project files. If you or someone else opens the same project on a different computer, these prompts will be available there as well. + +3) **Prompt name and description**: These are displayed in several places in the user interface where you can select an analytic prompt. The names must be unique within each scope. + +4) **Prompt text**: These are the actual instructions that will be sent to the AI (the orange box in the image above). If you want to share your prompt with someone else, this is the most important information you will need to send over. + + +!!! note " Note About Languages" + All predefined prompts in QualCoder are written in English. However, they can be applied to data in other languages as well. It is also no problem to write analytic prompts in languages other than English and use them with QualCoder. Most large language models are quite flexible when it comes to mixing different languages. + + +  +*** 1Lieder, F. R. & Schäffer, B. (2024). *Reconstructive Social Research Prompting (RSRP). Distributed Interpretation between AI and Researchers in Qualitative Research.* https://doi.org/10.31235/osf.io/d6e9m \ No newline at end of file diff --git a/docs/doc/en/7.2.-QualCoder-Video-Tutorials.md b/docs/doc/en/7.2.-QualCoder-Video-Tutorials.md index 070bcdb8..0e57f8af 100644 --- a/docs/doc/en/7.2.-QualCoder-Video-Tutorials.md +++ b/docs/doc/en/7.2.-QualCoder-Video-Tutorials.md @@ -4,7 +4,7 @@ path: 7.2.-QualCoder-Video-Tutorials # Videos showing how to use QualCoder -## QualCoder 3.7 +## QualCoder 3.7 {#qualcoder-37} [QualCoder 3.7 part 1 - Colin Curtain](https://www.youtube.com/watch?v=TCLCT893JcM) @@ -20,13 +20,13 @@ path: 7.2.-QualCoder-Video-Tutorials [Alpha version of 3.7 compared with other qualitative software - Van Tran](https://www.youtube.com/watch?v=Cqwu3mjJJHg) -## QualCoder 3.6 +## QualCoder 3.6 {#qualcoder-36} [Webinar: KI-unterstütze Datenanalyse in QualCoder 3 .6 - In German](https://www.youtube.com/watch?v=JF64vbngedA) [Qualitativ Forschen - AI-based horizontal coding](https://www.youtube.com/watch?v=FrQyTOTJhCc) -## QualCoder 3.5 +## QualCoder 3.5 {#qualcoder-35} [Tutorial, by the Colin Curtain](https://www.youtube.com/watch?v=wj5fY4F5Jxo) @@ -37,6 +37,6 @@ path: 7.2.-QualCoder-Video-Tutorials [Qualcoder - Data Hub Tool Talk - University of Idaho](https://www.youtube.com/watch?v=119k-jNOl8I) -## Older tutorials +## Older tutorials {#older-tutorials} Older tutorials can be found on YouTube. \ No newline at end of file diff --git a/docs/doc/en/7.3.-QualCoder-Development.md b/docs/doc/en/7.3.-QualCoder-Development.md index 200b2a95..82950b6b 100644 --- a/docs/doc/en/7.3.-QualCoder-Development.md +++ b/docs/doc/en/7.3.-QualCoder-Development.md @@ -8,14 +8,14 @@ Currently QualCoder is developed on Windows 11. QualCoder is written in python 3 After the 4.0 version, one area of development will be to review the visual presence, the user interface, of QualCoder. The aim is to make the interface more modern and appealing. Another area of improvement will be to provide more governance documentation, to support QualCoder's use in large institutions. -## Operating systems used +## Operating systems used {#operating-systems-used} QualCoder has been used on Windows 11, macOS, Ubuntu 24, Lubuntu, Fedora, Linux Mint, Arch Linux, Fedora, NixOS and ZorinOS. * Using audio or video with QualCoder on Fedora crashes QualCoder. * Debian with Gnome and the tiled window option - shrinks the QualCoder window size. The best option is to turn off window tiling in the Gnome settings. -## Acknowledgements +## Acknowledgements {#acknowledgements} Ronggui Huang, Zhang Gehao - Created RQDA - inspiration for QualCoder. Mike MacCana - Source code for the docx module. @@ -27,23 +27,23 @@ Jofen Kihlstrom for past Swedish translations. Van Tran for providing many useful suggestions and support over the past years. To the many members on GitHub for feedback, ideas and supporting this project. -## Citation +## Citation {#citation} Citation: Curtain C, Dröge K, Missaghieh--Poncet J, Salomón L. (2026) QualCoder 4.0 [Computer software]. Retrieved from https://github.com/ccbogel/QualCoder/releases/tag/4.0 -## Data structures +## Data structures {#data-structures} **The qda project folder** Contains folders for imported documents and the sqlite database to store coding data. When AI is enabled, there is an ai_data folder containing a chat history sqlite database and a vectorstore. A vector store is a numerical representation of words, phrases and sentences used by the AI language model. **The .qualcoder working folder** in your home folder. QualCoder creates QualCoder.log and configuration files. Do not put any files inside this folder, as it is used as a working settings and storage area for QualCoder. The **.qualcoder_ai folder** in the home folder contains configuration details for AI use. -## Licenses +## Licenses {#licenses} -### LGPL-3.0 License +### LGPL-3.0 License {#lgpl-30-license} QualCoder is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. QualCoder is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with QualCoder. If not, see [https://www.gnu.org/licenses ](https://www.gnu.org/licenses) -### License for highlighter.py code +### License for highlighter.py code {#license-for-highlighterpy-code} Copyright (C) 2013 Riverbank Computing Limited. Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). @@ -74,7 +74,7 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." -### License for docx.py code +### License for docx.py code {#license-for-docxpy-code} Copyright (c) 2009-2010 Mike MacCana Permission is hereby granted, free of charge, to any person @@ -98,7 +98,7 @@ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -### Dependency Licenses +### Dependency Licenses {#dependency-licenses} Dependencies are extra python modules that Qualcoder needs to run. Dependency licences are found in the QualCoder/docs folder. Last update 8 october 2026. [DEPENDENCY_LICENSES.txt](https://github.com/ccbogel/QualCoder/blob/master/docs/DEPENDENCY_LICENSES.md) \ No newline at end of file diff --git a/docs/doc/en/7.4.-SQlite-Data-Structure.md b/docs/doc/en/7.4.-SQlite-Data-Structure.md index 38f47a82..478ed407 100644 --- a/docs/doc/en/7.4.-SQlite-Data-Structure.md +++ b/docs/doc/en/7.4.-SQlite-Data-Structure.md @@ -8,7 +8,7 @@ The current v8 data structure is described to assist with developing sql queries Tables are listed alphabetically. -## Table: annotation +## Table: annotation {#table-annotation} **anid** _integer_ A unique auto-number @@ -24,7 +24,7 @@ Tables are listed alphabetically. **date** _text_ The date and time the entry was created, format `yyyy-mm-dd hh:mm:ss` -## Table: attribute +## Table: attribute {#table-attribute} **attrid** _integer_ A unique auto-number. @@ -40,7 +40,7 @@ Tables are listed alphabetically. **date** _text_ The date and time the entry was created, format `yyyy-mm-dd hh:mm:ss` -## Table: attribute_type +## Table: attribute_type {#table-attribute-type} **name** _text_ The unique name of the attribute. @@ -54,7 +54,7 @@ Tables are listed alphabetically. **valuetype** _text_ This is either 'character' or 'numeric' -## Table: case_text +## Table: case_text {#table-case-text} **id** _integer_ Unique autonumber. @@ -72,7 +72,7 @@ Tables are listed alphabetically. **date** _text_ The date and time the entry was created, format `yyyy-mm-dd hh:mm:ss` -## Table: cases +## Table: cases {#table-cases} **caseid** _integer_ A unique auto-number. @@ -84,7 +84,7 @@ Tables are listed alphabetically. **date** _text_ The date and time the entry was created, format `yyyy-mm-dd hh:mm:ss` -## Table: code_av +## Table: code_av {#table-code-av} **avid** _integer_ A unique auto-number. @@ -104,7 +104,7 @@ Tables are listed alphabetically. **important** _integer_ If assigned 1 it is an important code. -## Table: code_cat +## Table: code_cat {#table-code-cat} **catid** _integer_ A unique auto-number. @@ -118,7 +118,7 @@ Tables are listed alphabetically. **supercatid** _integer_ This represents the parent category of this category. It is Null if it is a top category. -## Table: code_image +## Table: code_image {#table-code-image} **imgid** _integer_ A unique auto-number. @@ -144,7 +144,7 @@ Tables are listed alphabetically. **pdf_page** _integer_ Null or a number representing the page of the pdf -## Table: code_name +## Table: code_name {#table-code-name} **cid** _integer_ A unique auto-number. @@ -160,7 +160,7 @@ Tables are listed alphabetically. **color** _text_ A hex value ranging from '#000000' to '#FFFFFF' QualCoder recognises 120 colours so can apply light or dark text over the top. -## Table: code_text +## Table: code_text {#table-code-text} **ctid** _integer_ A unique auto-number. (added in v3). @@ -184,7 +184,7 @@ Tables are listed alphabetically. **important** _integer_ If assigned 1 it is an important code. -## Table: journal +## Table: journal {#table-journal} **jid** _integer_ A unique auto-number. @@ -196,7 +196,7 @@ Tables are listed alphabetically. **date** _text_ The date and time the entry was created, format `yyyy-mm-dd hh:mm:ss` -## Table: project +## Table: project {#table-project} Should contain one row. @@ -216,7 +216,7 @@ Should contain one row. **recently_used_codes** _text_ Contained code_ids of recently used text codes, space delimited. -## Table: source +## Table: source {#table-source} **id** _integer_ A unique auto-number. @@ -244,7 +244,7 @@ If the mediapath begins with: '/images/' , '/audio/', '/video/' the image, audio If the mediapath begins with: 'images:' , 'audio:', 'video:' the image, audio or video file is linked to externally. The full path to the file is stored. -## Table: stored_sql +## Table: stored_sql {#table-stored-sql} **title** _text_ The title of the sql. @@ -254,7 +254,7 @@ If the mediapath begins with: 'images:' , 'audio:', 'video:' the image, audio or **ssql** _text_ The user generated sql. -## Table: ris +## Table: ris {#table-ris} Used for RIS bibliography @@ -266,11 +266,11 @@ Used for RIS bibliography **value** _text_ text data for the tag. -## Graph visualisation tables +## Graph visualisation tables {#graph-visualisation-tables} Several tables to store details of save graphs then the items within the graphs. -## Table: graph +## Table: graph {#table-graph} **grid** _integer_ Unique identifier. @@ -284,7 +284,7 @@ Several tables to store details of save graphs then the items within the graphs. **scene_height** _integer_ Used to set scene size on load. -## Table: gr_av_item +## Table: gr_av_item {#table-gr-av-item} Displays an arrow icon for a playable A/V coded segment. @@ -308,7 +308,7 @@ Displays an arrow icon for a playable A/V coded segment. **color** text -## Table: gr_case_text_item +## Table: gr_case_text_item {#table-gr-case-text-item} Displays details of the case, with formatting parameters. @@ -330,7 +330,7 @@ Displays details of the case, with formatting parameters. **displaytext** text -## Table: gr_cdct_line_item +## Table: gr_cdct_line_item {#table-gr-cdct-line-item} Display line linking codes and categories @@ -354,7 +354,7 @@ Display line linking codes and categories **isvisible** integer -## Table: gr_cdct_text_item +## Table: gr_cdct_text_item {#table-gr-cdct-text-item} Displays coded text with some formatting parameters. @@ -380,7 +380,7 @@ Displays coded text with some formatting parameters. **displaytext** text -## Table: gr_file_text_item +## Table: gr_file_text_item {#table-gr-file-text-item} Displays file details with formatting parameters. @@ -402,7 +402,7 @@ Displays file details with formatting parameters. **displaytext** text -## Table: gr_free_line_item +## Table: gr_free_line_item {#table-gr-free-line-item} Displays user defined line link between objects @@ -426,7 +426,7 @@ Displays user defined line link between objects **isvisible** integer -## Table: gr_free_text_item +## Table: gr_free_text_item {#table-gr-free-text-item} Displays free text, or memos with formatting parameters. @@ -458,7 +458,7 @@ Displays free text, or memos with formatting parameters. **memo_avid** integer -## Table: gr_pix_item +## Table: gr_pix_item {#table-gr-pix-item} Displays coded image. @@ -484,4 +484,4 @@ Displays coded image. **tooltip** text -**pdf_page** integer - if an image of a pdf +**pdf_page** integer - if an image of a pdf \ No newline at end of file diff --git a/docs/doc/en/7.6.-How-to-contribute.md b/docs/doc/en/7.6.-How-to-contribute.md index a1cefae8..c19e2ebd 100644 --- a/docs/doc/en/7.6.-How-to-contribute.md +++ b/docs/doc/en/7.6.-How-to-contribute.md @@ -4,18 +4,18 @@ path: 7.6.-How-to-contribute.md # How to contribute -## Contributing to the code +## Contributing to the code {#contributing-to-the-code} Please read the [contribution guidelines](https://github.com/ccbogel/QualCoder/blob/master/docs/CONTRIBUTING.md) -### Key rules at a glance +### Key rules at a glance {#key-rules-at-a-glance} - **Pick an issue first.** Look for an existing issue or create one, and comment on it before opening a Pull Request. Wait until the issue is assigned to you before starting work. - **One Pull Request, one commit.** Squash your work into a single commit with a descriptive message that reflects your changes. - **Naming.** Create a dedicated branch named after the issue you are addressing. - **License.** By submitting a Pull Request, you license your contribution under the project's LGPLv3 license ("Inbound = Outbound"). -### AI-assisted contributions +### AI-assisted contributions {#ai-assisted-contributions} You may use AI tools to assist your contributions, but you remain fully responsible for everything you submit. @@ -27,12 +27,12 @@ You may use AI tools to assist your contributions, but you remain fully responsi AI tools must **not** be used to fix issues labelled `good first issue`. These exist for human learning. -## Contribute to the translation -### Translate the documentation +## Contribute to the translation {#contribute-to-the-translation} +### Translate the documentation {#translate-the-documentation} You can translate the documentation by creating/modifying the markdown files in docs/doc in [the website repository](https://github.com/QualCoder-Org/qualcoder-org.github.io). -### Translate the software +### Translate the software {#translate-the-software} QualCoder supports multilingual functionality using two types of translation files: @@ -44,4 +44,4 @@ To translate: 1. Create a language file (if one does not already exist) using this command: ```python rebuild_lang.py --create --lang LANGUAGE_CODE``` Please note that the names of your language files must comply with the [ISO 639-1](https://fr.wikipedia.org/wiki/Liste_des_codes_ISO_639-1) format. 2. If a language file already exists, you can update the translations using ```python rebuild_lang.py --update --lang LANGUAGE_CODE```. 3. You can edit the translations of the .po and .ts files in the src/i18n folder using the [Poedit](https://poedit.net/) software. - 4. Once the work is complete, compile to machine format using this command: ```python rebuild_lang.py --compile --lang LANGUAGE_CODE```. + 4. Once the work is complete, compile to machine format using this command: ```python rebuild_lang.py --compile --lang LANGUAGE_CODE```. \ No newline at end of file diff --git a/docs/doc/en/index.md b/docs/doc/en/index.md index aac67f55..b0ef0b6f 100644 --- a/docs/doc/en/index.md +++ b/docs/doc/en/index.md @@ -24,13 +24,13 @@ QualCoder includes a set of AI-assisted features that utilise Large Language Mod - **QualCoder is a software option to support open science**. [UNESCO recommendations on open science](https://www.unesco.org/en/open-science?hub=686) - **Accessibility**. Qualcoder allows you to see what coding colours may look like for people with various colour-blindness. According to a vision-impaired user of QualCoder, QualCoder is fully functional with the NVDA screen reader [LinkedIn Post](https://www.linkedin.com/posts/reda-grich-911632239_worth-sharing-finally-found-a-qualitative-share-7425490644418224128-VDd9/?utm_source=share&utm_medium=member_desktop&rcm=ACoAABD4PqcBUo9og1pXa34wBIyLtnyMxs5qJTM). -## Current release +## Current release {#current-release} [:octicons-archive-24: Download latest version available on GitHub](https://github.com/ccbogel/QualCoder/releases/latest){ .md-button .md-button--primary } The in development code is available here: [https://github.com/ccbogel/QualCoder](https://github.com/ccbogel/QualCoder) -## Support QualCoder +## Support QualCoder {#support-qualcoder} If you like QualCoder and found it useful for your work. Please leave a review on these sites, like [Saashub](https://www.saashub.com/qualcoder-alternatives) or [AlternativeTo](https://alternativeto.net/software/qualcoder). @@ -42,12 +42,12 @@ It has taken many, many hours of work to create this software that is provided f QualCoder is written in python using Qt6 for the graphical interface. QualCoder has been used on Windows 11, macOS and various Linux distros: Ubuntu, Lubuntu, ZorinOS, Arch, Fedora. -## Citation +## Citation {#citation} Curtain, C. Dröge, K. Missaghieh--Poncet, J. Salomón, L. (2026) QualCoder 4.0 [Computer software]. Retrieved from https://github.com/ccbogel/QualCoder/releases/tag/4.0 Replace the version number (4.0) as needed for the version you are using. -## License +## License {#license} -QualCoder is licensed under the LGPL v3 licence. +QualCoder is licensed under the LGPL v3 licence. \ No newline at end of file diff --git a/docs/doc/es/1.-Overview.md b/docs/doc/es/1.-Overview.md index 1738d010..21899ebb 100644 --- a/docs/doc/es/1.-Overview.md +++ b/docs/doc/es/1.-Overview.md @@ -4,20 +4,20 @@ path: 1.-Overview.md Las instrucciones describen cómo instalar y usar QualCoder. La información aquí presentada corresponde a la versión más reciente de QualCoder. -## ¿Qué es QualCoder? +## ¿Qué es QualCoder? {#what-is-qualcoder} QualCoder es un software libre y de código abierto para el análisis de datos cualitativos. Con QualCoder puede codificar texto, imágenes, audio y video, escribir notas de diario y memos. Puede organizar los códigos en un esquema de categorización en forma de árbol. Se pueden generar diversos informes. La mayoría de los informes se pueden exportar como archivos html, texto de documento abierto (ODT), texto plano o Excel. -Las versiones recientes incluyen funciones opcionales asistidas por IA que utilizan GPT-4 u otros grandes modelos de lenguaje para ayudar a explorar, analizar e interactuar con los datos de maneras innovadoras. Familiarícese con datos nuevos [explorando temas o conceptos amplios](5.1.-AI-chat-based-analysis#topic-analysis-chat) en un chat interactivo con la IA. Profundice en aspectos específicos con la [codificación asistida por IA](4.2.-AI-Assisted-Coding) y el [análisis de texto](5.1.-AI-chat-based-analysis#text-analysis-chat). Y si llega al punto en el que debe sintetizar y consolidar sus resultados, [discútalos en un chat de códigos](5.1.-AI-chat-based-analysis#code-analysis-chat) con la IA. +Las versiones recientes incluyen funciones opcionales asistidas por IA que utilizan GPT-4 u otros grandes modelos de lenguaje para ayudar a explorar, analizar e interactuar con los datos de maneras innovadoras. Familiarícese con datos nuevos [explorando temas o conceptos amplios](5.1.-AI-chat-based-analysis#2-topic-exploration) en un chat interactivo con la IA. Profundice en aspectos específicos con la [codificación asistida por IA](4.2.-AI-Assisted-Coding) y el [análisis de texto](5.1.-AI-chat-based-analysis#3-text-analysis). Y si llega al punto en el que debe sintetizar y consolidar sus resultados, [discútalos en un chat de códigos](5.1.-AI-chat-based-analysis#4-code-analysis) con la IA. QualCoder está diseñado para usarse como software de cliente, para ser utilizado por una persona a la vez. (Un segundo codificador puede usar el mismo proyecto en la misma computadora, o la carpeta del proyecto puede transferirse a la computadora del segundo codificador). QualCoder no está diseñado para el acceso múltiple simultáneo. No se recomienda acceder al proyecto en una ubicación en la nube, ya que puede corromper la base de datos si se pierde la conexión con ella durante algún proceso de actualización. -## Colaboración en un proyecto de QualCoder +## Colaboración en un proyecto de QualCoder {#collaboration-on-a-qualcoder-project} [Página sobre cómo trabajar en equipo con QualCoder](2.4.-Working-in-a-Team) -## Última versión +## Última versión {#latest-release} La última versión es QualCoder 3.8.2. Al final de la página hay ejecutables para Windows 11, macOS y Linux Ubuntu. @@ -27,7 +27,7 @@ La última versión es QualCoder 3.8.2. Al final de la página hay ejecutables p Tenga en cuenta que los ejecutables de QualCoder no están firmados ni con Microsoft ni con macOS, por lo que aparecerá una advertencia al usar por primera vez el archivo ejecutable (la razón es que representa un costo económico considerable y continuo). Haga clic en más información y permita la ejecución. ![image](/images/12d00e05-3844-4b48-9dc9-ff657aa7382f.png) -## Código más reciente: software en desarrollo +## Código más reciente: software en desarrollo {#latest-code-software-under-development} [Descargue la versión en desarrollo](https://github.com/ccbogel/QualCoder/archive/refs/heads/master.zip), descomprímala y siga las instrucciones de instalación del documento README. diff --git a/docs/doc/es/2.1.-Installation.md b/docs/doc/es/2.1.-Installation.md index f52fc885..10ee9c37 100644 --- a/docs/doc/es/2.1.-Installation.md +++ b/docs/doc/es/2.1.-Installation.md @@ -5,11 +5,11 @@ icon: lucide/package-open # Instrucciones de instalación y ejecución de QualCoder -## INSTALACIÓN +## INSTALACIÓN {#installation} Para las instalaciones manuales (mediante la línea de comandos o la terminal) puede mencionarse una versión concreta, por ejemplo la 3.8.2. Consulte la [página de versiones](https://github.com/ccbogel/QualCoder/releases) para conocer la más actual, ya que puede ser más reciente. -### Requisitos previos +### Requisitos previos {#prerequisites} VLC es opcional, pero necesitará tenerlo instalado si va a realizar cualquier codificación de audio o video. En ocasiones, en algunos sistemas operativos (por ejemplo Fedora) QualCoder no logra encontrar VLC para utilizarlo. De forma opcional, instale ffmpeg para la visualización de la forma de onda, vea [phoenixnap.com/kb/ffmpeg-windows](https://phoenixnap.com/kb/ffmpeg-windows). === "Windows" diff --git a/docs/doc/es/2.2.-Settings.md b/docs/doc/es/2.2.-Settings.md index 6a26af4d..65e15f27 100644 --- a/docs/doc/es/2.2.-Settings.md +++ b/docs/doc/es/2.2.-Settings.md @@ -7,15 +7,15 @@ path: 2.2.-Settings La pantalla de configuración le permite cambiar varias características, entre ellas el idioma, el nombre del codificador y el tipo y tamaño de fuente, así como las opciones de la integración de IA. -### Nombre del codificador +### Nombre del codificador {#coder-name} Varios codificadores pueden codificar y anotar el mismo texto. Su nombre de codificador actual se muestra en la parte superior del diálogo de configuración. ![grafik](/images/cd0aab19-5f2b-43de-b6f0-08ab171fbb91.png) -Este nombre se usará para identificar sus aportaciones al proyecto. Haga clic en el botón "Change" para modificar su identidad o para crear, renombrar o fusionar otros codificadores dentro del proyecto actual. [Vea aquí para más información.](2.4.-Working-in-a-Team#consideraciones-importantes-sobre-los-nombres-de-codificador) +Este nombre se usará para identificar sus aportaciones al proyecto. Haga clic en el botón "Change" para modificar su identidad o para crear, renombrar o fusionar otros codificadores dentro del proyecto actual. [Vea aquí para más información.](2.4.-Working-in-a-Team#important-considerations-regarding-coder-names) -### Configuración general +### Configuración general {#general-settings} El idioma predeterminado de QualCoder es el inglés. El francés, el alemán y el español son idiomas alternativos que se actualizan con regularidad. Otros idiomas no se han revisado a fondo para comprobar la exactitud de sus traducciones (chino, japonés, portugués, rumano, sueco). @@ -29,7 +29,7 @@ Los archivos de texto muy grandes pueden ralentizar el modo de codificación en ![settings dialog](/images/ff9c27a9-180d-41eb-aa60-877e1ff7cfb9.png) -### Copias de seguridad +### Copias de seguridad {#backups} La copia de seguridad del proyecto puede configurarse para realizarse automáticamente cada hora, o para no realizarse. QualCoder conserva las copias de seguridad más recientes con una marca de fecha y hora. El nombre de la copia de seguridad es: _projectname_BKP_yyyymmdd_hh.qda_ donde _hh_ es la hora en formato de 24 horas. Esto también significa que no se realizan varias copias de seguridad dentro de una misma hora. Por lo tanto, una nueva copia de seguridad no puede sobrescribir otra creada dentro de la misma hora. Se conserva un número limitado de copias de seguridad, **las copias más antiguas se eliminan**. La opción de configuración le permite elegir entre 1 y 10 copias de seguridad. @@ -39,6 +39,6 @@ Renombre o mueva a otra ubicación aquellas copias de seguridad concretas que ne En su carpeta de usuario QualCoder creará una carpeta .qualcoder con un archivo QualCoder.log para el registro de eventos y un archivo config.ini que contendrá muchos ajustes, como el nombre del codificador actual, las fuentes preferidas, el idioma y un directorio de trabajo preferido. No guarde ningún dato ni proyecto dentro de la carpeta .qualcoder. El único archivo que debería colocar aquí es un archivo stopwords.txt, únicamente si necesita aplicar un conjunto distinto de palabras vacías para las funciones de nube de palabras y conteo de palabras. Esta carpeta es solo para uso del software QualCoder mientras se ejecuta. -## Opciones avanzadas y registro +## Opciones avanzadas y registro {#advanced-options-and-logging} Las **opciones relacionadas con la IA** que están al final del diálogo de Configuración se describen aquí: [Configuración de la IA](2.3.-AI-Setup) \ No newline at end of file diff --git a/docs/doc/es/2.3.-AI-Setup.md b/docs/doc/es/2.3.-AI-Setup.md index 31031ebf..a24341b5 100644 --- a/docs/doc/es/2.3.-AI-Setup.md +++ b/docs/doc/es/2.3.-AI-Setup.md @@ -13,19 +13,19 @@ Todas las opciones relacionadas con la IA se encuentran al final del diálogo de **Pasos del asistente de configuración:** 1. **Active la integración de IA** marcando la casilla en el diálogo de Configuración. -2. **[Elija el modelo de IA que desea usar](#seleccion-del-modelo-de-ia)** y configúrelo. -3. A continuación se configura y construye automáticamente la **[memoria local de IA](#configuracion-de-la-memoria-local-de-ia)**. Tenga paciencia, ya que esto puede tardar un rato. +2. **[Elija el modelo de IA que desea usar](#ai-model-selection)** y configúrelo. +3. A continuación se configura y construye automáticamente la **[memoria local de IA](#the-local-ai-memory-setup)**. Tenga paciencia, ya que esto puede tardar un rato. 4. Después de eso, el agente de IA en QualCoder está **listo** para usarse. -Quizá también quiera leer [cómo preparar mejor su proyecto para el uso de IA](#mejore-la-utilidad-de-la-ia-en-su-proyecto) y nuestras [notas sobre privacidad de datos](#algunas-notas-sobre-privacidad-y-proteccion-de-datos) más abajo. +Quizá también quiera leer [cómo preparar mejor su proyecto para el uso de IA](#improve-ai-usability-in-your-project) y nuestras [notas sobre privacidad de datos](#some-notes-on-privacy-and-data-protection) más abajo. -## Selección del modelo de IA +## Selección del modelo de IA {#ai-model-selection} Con QualCoder puede elegir entre una amplia gama de proveedores de IA comerciales y no comerciales, e incluso usar modelos locales alojados en su propia máquina. Seleccione una de las opciones de la lista desplegable "AI profile" en el diálogo de Configuración. -### Modelos de frontera de OpenAI, Anthropic o Google +### Modelos de frontera de OpenAI, Anthropic o Google {#frontier-models-from-openai-anthropic-or-google} Estos grandes modelos ofrecen el análisis más matizado de sus datos empíricos y proporcionan la experiencia general más fluida. Tiene varias opciones: @@ -46,7 +46,7 @@ Estos grandes modelos ofrecen el análisis más matizado de sus datos empíricos - Tenga en cuenta que QualCoder no tiene acceso a ninguna información de su cuenta de ChatGPT más allá de los modelos de IA en bruto. Esto también es cierto en el sentido contrario, ya que ChatGPT no puede acceder a ningún dato dentro de QualCoder. - Aun así, es buena práctica desactivar la opción "Improve the model for everyone" en los ajustes de "Data Controls" de su perfil de ChatGPT. Esto evita que el contenido de sus interacciones con ChatGPT se use para el entrenamiento futuro de modelos de IA. - QualCoder usa la misma interfaz de comunicación que Codex, el asistente de programación de OpenAI. Si su organización ha desactivado Codex en su cuenta de ChatGPT, es posible que no pueda usar esta integración con QualCoder. -- Para las **suscripciones a Anthropic Claude o Google Gemini**, conectarlas a QualCoder es menos directo. Si tiene inclinación técnica, todavía puede lograr que funcionen usando [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) como puente. Si sigue esta vía, [añada un perfil de IA personalizado](#otros-modelos) en QualCoder y use `http://localhost:8317/v1` como parámetro "API Base URL". +- Para las **suscripciones a Anthropic Claude o Google Gemini**, conectarlas a QualCoder es menos directo. Si tiene inclinación técnica, todavía puede lograr que funcionen usando [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) como puente. Si sigue esta vía, [añada un perfil de IA personalizado](#other-models) en QualCoder y use `http://localhost:8317/v1` como parámetro "API Base URL". **Microsoft Azure** @@ -62,7 +62,7 @@ Para continuar, necesitará la siguiente información: Vaya a "Project > Settings > AI Integration", haga clic en "Advanced AI Options > New AI Profile" y asígnele un nombre. Luego introduzca su clave de API en el campo correspondiente, el nombre de su despliegue de Azure en los campos "Large Model" y "Fast Model" (pueden ser idénticos) y la URL del punto de conexión de Azure en el campo "api_base". Quizá también quiera ajustar el tamaño de la ventana de contexto según el modelo. -### Infraestructura académica de IA +### Infraestructura académica de IA {#academic-ai-infrastructure} La infraestructura académica de IA sin fines de lucro le da acceso a modelos de tamaño medio manteniendo estándares muy altos de privacidad de datos. Estos servicios suelen ser gratuitos para el personal que reúne los requisitos. La calidad de salida de estos modelos de tamaño medio ha mejorado mucho últimamente y es suficiente para la mayoría de las tareas en QualCoder. No obstante, todavía no está al mismo nivel que las grandes ofertas comerciales. También puede encontrar más contratiempos al interactuar con el agente de IA, como errores de funcionamiento o referencias a las fuentes mal formadas. @@ -80,14 +80,14 @@ Alemania: - **[hessian.AI Darmstadt](https://hessian.ai/):** acceso experimental, solo para personas elegibles de universidades de Hesse, en Alemania. Siga las instrucciones para GWDG anteriores, pero use `https://llm-service.ai.tu-darmstadt.de` como URL de la API base. -### Modelos de tamaño medio como Mistral, DeepSeek y otros +### Modelos de tamaño medio como Mistral, DeepSeek y otros {#mid-size-models-like-mistral-deepseek-and-others} La lista desplegable "AI profile" del diálogo de configuración también ofrece opciones para [Mistral (Francia)](https://mistral.ai/), [DeepSeek (China)](https://deepseek.com/) y [OpenRouter](https://openrouter.ai/), una plataforma a través de la cual se puede acceder a muchos grandes modelos de lenguaje alojados en distintos servidores. Para todas estas opciones necesitará una clave de API y, muy probablemente, también una cuenta de pago para un trabajo serio. Revise cuidadosamente las condiciones de privacidad de datos antes de usar cualquiera de estos servicios. -### Modelos de IA locales en su propia máquina +### Modelos de IA locales en su propia máquina {#local-ai-models-on-your-own-machine} Los modelos de IA locales ofrecen el mayor nivel de protección de datos, pero también requieren hardware bastante potente para funcionar a una velocidad y calidad razonables. En mis pruebas, `Gemma-4-31B-it` funcionó bastante bien. Necesita al menos 24 GB de VRAM en cuantización de 4 bits con un tamaño de ventana de contexto aceptable. Para cualquier trabajo agéntico serio en QualCoder, yo no bajaría mucho de eso. Sin embargo, la [codificación asistida por IA](4.2.-AI-Assisted-Coding) todavía puede funcionar con modelos algo más pequeños. @@ -97,7 +97,7 @@ Los modelos de IA locales ofrecen el mayor nivel de protección de datos, pero t - Seleccione un modelo grande y uno rápido de la lista, muy probablemente el mismo para ambos, ya que normalmente solo tendrá un modelo cargado a la vez. Quizá también quiera ajustar el tamaño de la ventana de contexto según su configuración de Ollama. -### Otros modelos +### Otros modelos {#other-models} Si tiene acceso a otros grandes modelos de lenguaje en plataformas en la nube, servidores universitarios o su propia máquina, también puede intentar integrarlos en QualCoder. - El servicio que desee usar debe proporcionar una interfaz compatible con la API de OpenAI. Suele ser el caso, ya que esta API se ha convertido en un estándar de facto en los últimos años. @@ -121,7 +121,7 @@ Tenga en cuenta que el nombre de la sección debe empezar siempre con el prefijo Si logra poner en marcha otros servicios en QualCoder, o si lo intentó y no lo consiguió, nos gustaría conocer su experiencia. -## Opciones avanzadas de IA +## Opciones avanzadas de IA {#advanced-ai-options} Al final del todo del diálogo de Configuración encontrará un botón "Advanced AI Options". Al hacer clic en él se muestran algunas opciones más. @@ -130,7 +130,7 @@ Al final del todo del diálogo de Configuración encontrará un botón "Advanced - En cuanto a las demás opciones avanzadas, probablemente lo mejor sea dejarlas en sus valores predeterminados si no sabe qué significan. Tenga en cuenta que los parámetros "temperature" y "top_p" podrían ser ignorados silenciosamente por algunos modelos, especialmente en modo de razonamiento. -## Configuración de la memoria local de IA +## Configuración de la memoria local de IA {#the-local-ai-memory-setup} * El agente de IA en QualCoder usa una memoria local especial para buscar rápidamente en los documentos empíricos y encontrar pasajes relevantes. Esto reduce enormemente la cantidad de datos enviados a la nube, lo que mejora la privacidad, ahorra recursos y aumenta la velocidad. * La memoria funciona con un pequeño [modelo de IA local de código abierto](https://huggingface.co/intfloat/multilingual-e5-large), de aproximadamente 2,5 GB, que se descarga automáticamente la primera vez que activa la IA. Ubicaciones de almacenamiento del modelo: @@ -146,7 +146,7 @@ Al final del todo del diálogo de Configuración encontrará un botón "Advanced Nota técnica: la memoria local de IA de QualCoder es un sistema híbrido basado en incrustaciones del [codificador de oraciones E5](https://huggingface.co/intfloat/multilingual-e5-large) almacenadas en un [almacén vectorial FAISS](https://github.com/facebookresearch/faiss) para la búsqueda semántica, y un [índice BM25 de SQLite](https://sqlite.org/fts5.html) para la recuperación rápida por palabras clave. Además, el agente de IA puede usar expresiones regulares para buscar en los datos del proyecto. -## Mejore la utilidad de la IA en su proyecto +## Mejore la utilidad de la IA en su proyecto {#improve-ai-usability-in-your-project} El agente de IA en QualCoder debería poder leer y comprender la estructura de su proyecto, sus documentos empíricos, códigos y memos. También debería tener una imagen clara de los objetivos, las preguntas de investigación y los métodos que orientan su investigación. Esto le permite ofrecer respuestas mucho más precisas. Algunas sugerencias: @@ -156,7 +156,7 @@ El agente de IA en QualCoder debería poder leer y comprender la estructura de s - Si usa **memos** para registrar notas personales e ideas de lluvia de ideas sin terminar que no desea compartir con el agente de IA, coloque esas notas detrás de una marca "#####". Todo el contenido del memo por debajo de esta marca no se enviará a la IA. -## Algunas notas sobre privacidad y protección de datos +## Algunas notas sobre privacidad y protección de datos {#some-notes-on-privacy-and-data-protection} * Entendemos que el uso de servicios en la nube como los de OpenAI plantea interrogantes en materia de privacidad y protección de datos. @@ -172,6 +172,6 @@ QualCoder sigue un enfoque de **"privacidad desde el diseño"**: * QualCoder no se limita a proveedores comerciales de IA. Por ejemplo, nos hemos asociado con **"Blablador,"** un servicio que ejecuta grandes modelos de lenguaje en hardware académico no comercial y que ofrece una privacidad excelente (vea más arriba). -* Además, es posible [añadir sus propios modelos a QualCoder](#otros-modelos), incluidos aquellos que se ejecutan enteramente en local en su máquina sin ningún acceso a la red. Hoy por hoy, sin embargo, el compromiso en calidad de salida es tan significativo que los modelos de IA locales tienen casos de uso limitados, a menos que disponga de hardware muy potente. Es de esperar que esta situación cambie en el futuro. +* Además, es posible [añadir sus propios modelos a QualCoder](#other-models), incluidos aquellos que se ejecutan enteramente en local en su máquina sin ningún acceso a la red. Hoy por hoy, sin embargo, el compromiso en calidad de salida es tan significativo que los modelos de IA locales tienen casos de uso limitados, a menos que disponga de hardware muy potente. Es de esperar que esta situación cambie en el futuro. * En general, recomendamos que **anonimice sus datos** con mucho cuidado antes de usar cualquier servicio de IA en la nube para el análisis. \ No newline at end of file diff --git a/docs/doc/es/2.4.-Working-in-a-Team.md b/docs/doc/es/2.4.-Working-in-a-Team.md index 1b2cbdf0..81c95192 100644 --- a/docs/doc/es/2.4.-Working-in-a-Team.md +++ b/docs/doc/es/2.4.-Working-in-a-Team.md @@ -5,7 +5,7 @@ path: 2.4.-Working-in-a-Team # Trabajar juntos en equipo Existen varias estrategias para organizar el trabajo colaborativo sobre un mismo proyecto en QualCoder. Elija la que mejor se ajuste a su enfoque metodológico y a su entorno de trabajo concreto. -## 1) Edición secuencial del mismo proyecto +## 1) Edición secuencial del mismo proyecto {#1-sequential-editing-of-the-same-project} Este enfoque puede aplicarse tanto a la codificación inductiva como a la deductiva. Se basa en el principio de que todos los miembros del equipo trabajan sobre los mismos archivos del proyecto, aunque no de forma simultánea. **Coordinar la secuencia de trabajo:** @@ -17,7 +17,7 @@ Este enfoque puede aplicarse tanto a la codificación inductiva como a la deduct Maneje con cuidado los nombres de codificador (vea más abajo). -## 2) Uso de un proyecto maestro: el enfoque de 'codificar por separado y luego fusionar' +## 2) Uso de un proyecto maestro: el enfoque de 'codificar por separado y luego fusionar' {#2-using-a-master-project-the-coding-separately-then-merging-approach} Esta estrategia permite a su equipo trabajar de forma simultánea hasta cierto punto. Es más eficaz si emplea un enfoque de codificación deductiva, en el que el sistema de códigos no cambia mucho durante el análisis. Si la usa con codificación inductiva, prepárese para dedicar algo de tiempo a limpiar y consolidar el sistema de códigos al fusionar el trabajo de los distintos miembros del equipo. @@ -29,9 +29,9 @@ Siga estos pasos: * Comprima la carpeta de su proyecto, incluidas todas las subcarpetas y archivos, y envíela a sus colaboradores (correo electrónico, transferencia de archivos o memoria USB). * Decida una estrategia para manejar los nombres de codificador en su equipo, como se explica en las notas siguientes. * Ahora cada miembro del equipo puede descomprimir su copia local del proyecto y trabajar en ella de forma independiente, añadiendo códigos, codificaciones, memos, etc. Sin embargo, no edite el texto importado de los propios documentos empíricos, ya que esto puede causar problemas durante el proceso de fusión posterior. -* Por último, reúna todas las copias locales y fusiónelas secuencialmente en su proyecto maestro, siguiendo el [proceso descrito aquí](/doc/es/6.1.-Imports-and-Exports#merge-qualcoder-projects). +* Por último, reúna todas las copias locales y fusiónelas secuencialmente en su proyecto maestro, siguiendo el [proceso descrito aquí](/doc/es/6.1.-Imports-and-Exports#merge-projects). -## Consideraciones importantes sobre los nombres de codificador +## Consideraciones importantes sobre los nombres de codificador {#important-considerations-regarding-coder-names} * En la mayoría de los casos, conviene tener un nombre único para cada codificador de su equipo, de modo que las aportaciones individuales puedan identificarse incluso después de fusionar el proyecto. * En Project > Settings, haga clic en el botón "Change" junto al nombre del codificador para abrir una ventana donde puede modificar su propia identidad o crear, renombrar o fusionar otros codificadores dentro del proyecto actual. @@ -47,7 +47,7 @@ Siga estos pasos: !!! warning No mantenga la carpeta del proyecto en una unidad de red ni en una ubicación en la nube, ni acceda a esa ubicación mientras ejecuta Qualcoder. Si se pierde la conexión con la base de datos, esta se corrompería mientras QualCoder realiza una serie de operaciones sobre ella. -## Copias de seguridad +## Copias de seguridad {#backups} Haga una copia de seguridad de la carpeta del proyecto antes de realizar cualquier cambio sustancial, como una reorganización importante de códigos y categorías, la fusión de proyectos o la fusión de códigos. QualCoder sí realiza copias de seguridad cada hora (conservando hasta las cinco más recientes, si las copias de seguridad están activadas en la configuración). Tampoco almacene archivos adicionales ni salidas dentro de la carpeta del proyecto. diff --git a/docs/doc/es/3.1.-Creating-a-New-Project.md b/docs/doc/es/3.1.-Creating-a-New-Project.md index bcb186ca..a84843f8 100644 --- a/docs/doc/es/3.1.-Creating-a-New-Project.md +++ b/docs/doc/es/3.1.-Creating-a-New-Project.md @@ -8,7 +8,7 @@ Puede **crear un proyecto nuevo desde el menú 'Project'.** Si lo llama "Test", el proyecto se guardará como Test.qda. Test.qda es en realidad una carpeta con subcarpetas que contienen la base de datos, los documentos empíricos y otros archivos. Si quiere enviar el proyecto por correo a otra persona, comprima la carpeta completa. -## Pantalla principal +## Pantalla principal {#main-screen} La pestaña Action Log de la ventana principal muestra diversos cambios realizados al usar QualCoder. La ventana principal tiene en la parte superior una barra de menú llena de opciones. Hay cinco pestañas: _action log_, _manage_, _reports_, _coding_ y _AI chat_. Cambiar directamente entre pestañas suele estar bien. Pero si está añadiendo, renombrando o eliminando archivos en Manage Files, o cambiando códigos o categorías de códigos en el área de codificación, es mejor actualizar cada pestaña seleccionando la opción correspondiente en la barra de menú de la parte superior de la pantalla. Por ejemplo, si cambia archivos en Manage files y luego va a codificar o a los informes, seleccione una opción del Menú para codificación o informes, en lugar de hacer clic directamente en la pestaña de codificación o de informes. Esto se debe a que algunos cambios de gestión pueden no actualizarse. @@ -19,7 +19,7 @@ La pestaña Action Log de la ventana principal muestra diversos cambios realizad !!! tip "Buenas prácticas de gestión de datos" Para cualquier proyecto, mantenga buenas prácticas de gestión de datos, como conservar copias de seguridad de forma regular y, en lo posible, almacenadas en distintas ubicaciones (por ejemplo, la nube, distintas carpetas de la computadora, discos duros, memorias USB). -## Escribir un memo del proyecto +## Escribir un memo del proyecto {#write-a-project-memo} Esto es **especialmente importante si desea usar las funciones basadas en IA** de QualCoder. El memo del proyecto se usa para aportar información contextual sobre el proyecto actual y el tipo de documentos empíricos con los que estamos trabajando. Esta información, que se incluye en cada consulta, ayuda a la IA a producir respuestas mucho más precisas y útiles. Puede acceder al memo del proyecto desde el menú Project > Project Memo. diff --git a/docs/doc/es/3.2.-Files.md b/docs/doc/es/3.2.-Files.md index 74e6cce2..1d49c172 100644 --- a/docs/doc/es/3.2.-Files.md +++ b/docs/doc/es/3.2.-Files.md @@ -4,7 +4,7 @@ path: 3.2.-Files # Gestionar archivos -## Importar archivos +## Importar archivos {#importar-archivos} Importe texto desde documentos de texto plano, docx, epub, md, odt, pdf y rtf (3.8+). Importe imágenes desde: jpg, jpeg y png. Importe formatos de audio y video: mp3, m4a, mp4, wav, mov, ogg. Los PDF pueden codificarse como texto o como imágenes. Como alternativa, puede vincular archivos ubicados localmente en el sistema de archivos de su computadora. Esta puede ser una buena opción si tiene una estructura de carpetas concreta que es importante para su proyecto. @@ -23,11 +23,11 @@ Si está empezando con QualCoder, abra la carpeta `Examples` e importe `ID1.docx Tras la importación, abra cada archivo haciendo doble clic en él o mediante el menú contextual. Puede probar la seudonimización (vea más abajo) eliminando `ID2.odt`, añadiendo `Joe Bloggs` mediante el botón Pseudonymise y volviendo a importar el archivo. -### PDF: extracción de texto plano +### PDF: extracción de texto plano {#pdf-extraccion-de-texto-plano} La importación de PDF puede ser problemática y quizá requiera edición, ya que se pierde el formato. Los archivos PDF grandes tardan mucho en importarse. QualCoder extrae el texto de los archivos PDF usando pdfminer.six, pero usted puede optar por usar otro programa de extracción para el texto plano; algunas sugerencias son: [PDF2Go](https://www.pdf2go.com), [PDFMate](https://www.pdfmate.com/pdf-converter-free.html), [Pandoc](https://pandoc.org) y luego copiar el texto plano. Sin embargo, si quiere usar la función _Code Pdf_ dentro de QualCoder, que permite codificar texto con el texto del PDF mostrado en su lugar como en el PDF original, debe usar la extracción de texto plano de QualCoder y no editar el texto plano extraído. -### Seudonimización (desidentificación de datos) +### Seudonimización (desidentificación de datos) {#seudonimizacion-desidentificacion-de-datos} En la versión 3.8+ está disponible la seudonimización para reemplazar palabras o frases. Para muchos idiomas (posiblemente salvo el chino, el japonés y el coreano), siempre que el carácter anterior y el posterior a la frase no sean alfabéticos ni numéricos, este es un corte fácil de aplicar. La seudonimización distingue entre mayúsculas y minúsculas. Las palabras originales deben tener al menos 2 caracteres y los seudónimos al menos 3 caracteres. Como alternativa, deje en blanco la entrada del seudónimo para obtener un término generado aleatoriamente. @@ -43,7 +43,7 @@ Se seudonimizarán los archivos de texto importados y las columnas cualitativas Los archivos PDF no se seudonimizan por dos razones. La página del PDF puede visualizarse tal cual en _Code Images_. Además, se necesita el texto exacto para la correspondencia entre el texto plano y el texto del PDF en el área Code PDF. -## Codificación automática de hablantes +## Codificación automática de hablantes {#codificacion-automatica-de-hablantes} "Mark speakers" crea códigos para cada hablante en una entrevista o discusión grupal y asigna las intervenciones automáticamente. Puede acceder a esta función mediante el menú contextual del archivo o con el siguiente botón de la barra de herramientas: @@ -52,13 +52,13 @@ Los archivos PDF no se seudonimizan por dos razones. La página del PDF puede vi [Vea esta sección](4.1.-Coding-Text#auto-speaker-codings) para más detalles. -## Tabla de gestión de archivos +## Tabla de gestión de archivos {#tabla-de-gestion-de-archivos} ![image](/images/9a514f32-0bc1-43e4-a757-a551f1496b80.png) Cada archivo va precedido de un icono que describe el tipo de archivo. Otras columnas muestran el nombre del archivo, la fecha de creación o carga, la asociación con casos y otros atributos. La captura anterior muestra un atributo creado por el usuario llamado 'origin' y columnas de referencia (donde un archivo está vinculado a una referencia). -## Funciones generales +## Funciones generales {#funciones-generales} Las entradas de nombre de archivo pueden cambiarse en la base de datos. Los nombres originales de los archivos reales no se modificarán. @@ -69,11 +69,11 @@ Los archivos pueden visualizarse con el menú contextual sobre el archivo o haci ![button](/images/f03c0a5d-29ea-40c7-a5a1-917aeb894f9b.png)Renombrado masivo de todas las filas de archivos. Usted proporciona un prefijo y luego se añade un sufijo numerado. Esto se aplica a todas las filas visibles de la tabla. Puede preseleccionar las filas visibles con el menú contextual y 'show this value', por ejemplo sobre un atributo. Este botón le permite renombrar archivos de forma masiva: -## Archivos de texto grandes +## Archivos de texto grandes {#archivos-de-texto-grandes} Al codificar archivos de texto realmente grandes, QualCoder se vuelve lento. En _Code Text_, QualCoder puede dividir los archivos en fragmentos de 50 000 caracteres para reducir la lentitud del programa. Sin embargo, la mejor opción al importar archivos de texto grandes es dividirlos en secciones separadas y cargar esas secciones más pequeñas como archivos independientes. Dé también a cada nombre de archivo alguna lógica ordenada, por ejemplo, book_chap01.txt, book_chap02.txt. -## Atributos +## Atributos {#atributos} Los atributos son variables para describir los archivos. Pueden añadirse con el botón (x) o mediante la opción de menú Manage Attributes. Pueden ser de tipo carácter o numérico. @@ -81,42 +81,42 @@ La imagen anterior muestra un atributo de tipo carácter añadido llamado _origi Los atributos pueden exportarse a un archivo de Excel mediante un botón: ![image](/images/ccf331d7-63b6-460b-96df-41edd7cfe63b.png) -## Filtrar columnas y filas +## Filtrar columnas y filas {#filtrar-columnas-y-filas} -### Filtrar filas +### Filtrar filas {#filtrar-filas} El menú contextual con el botón derecho también le permite reordenar los archivos por nombre, fecha y tipo de archivo, al hacer clic derecho en las columnas de nombre o de fecha. Puede mostrar solo determinados tipos de atributo: elija la opción Show this value También puede seleccionar Show values like. Show values like puede aplicarse varias veces para acortar aún más la lista de filas mostradas. -### Visibilidad de columnas +### Visibilidad de columnas {#visibilidad-de-columnas} A veces pueden mostrarse muchas columnas, lo que puede resultar abrumador. Puede ocultar columnas haciendo clic derecho en la fila de encabezado de la tabla para obtener opciones para ocultar esa columna u ocultar las columnas que comiencen con un texto concreto. O para mostrar las columnas cuyo nombre comience con un texto concreto. -### Guardar y cargar filtros de columnas y filas +### Guardar y cargar filtros de columnas y filas {#guardar-y-cargar-filtros-de-columnas-y-filas} Hay tres botones para guardar, cargar y eliminar configuraciones de filtro, de modo que pueda ver la tabla de gestión de archivos de la manera que desee, con rapidez. ![Buttons to save, load and delete table filters](/images/96ae69f5-1493-4aa8-a3f5-31ee15c22fef.png) -## Abrir URL de atributos +## Abrir URL de atributos {#abrir-url-de-atributos} Haga clic derecho en una URL dentro de un atributo y abra la URL con el navegador web predeterminado. Esto solo funciona si el atributo es una URL y supera la validación de URL. -## Copiar referencia al portapapeles +## Copiar referencia al portapapeles {#copiar-referencia-al-portapapeles} Use la opción del menú contextual para las columnas de referencia (Ref_Authors, Ref_Title, Ref_Journal, Ref_Type, Ref_Year). Esto permite copiar la referencia al portapapeles en estilo Vancouver o APA. -## Asignar un archivo seleccionado a un caso +## Asignar un archivo seleccionado a un caso {#asignar-un-archivo-seleccionado-a-un-caso} Puede asignar un archivo a un caso mediante el menú contextual cuando esté en la columna de casos. -## Inteligencia artificial +## Inteligencia artificial {#inteligencia-artificial} Si ha activado la integración de IA en QualCoder, los archivos de texto recién importados serán leídos por el modelo de IA local y almacenados en su memoria local. Esto ocurre en segundo plano (la barra de estado muestra "AI: reading"). Puede seguir usando QualCoder, pero las funciones mejoradas con IA no estarán disponibles hasta que la IA termine de actualizar su memoria. Esto también sucede si edita en QualCoder un archivo de texto ya importado. Si alguna vez tiene la impresión de que la memoria de la IA está desincronizada y ha pasado por alto alguna actualización de sus datos (lo que no debería ocurrir en circunstancias normales), puede reconstruir la memoria desde cero seleccionando "AI > Rebuild Internal Memory". Esto releerá todos los documentos, lo que puede tardar un rato. -## Creación y edición de archivos de texto +## Creación y edición de archivos de texto {#creacion-y-edicion-de-archivos-de-texto} Puede crear e introducir texto en la base de datos presionando el icono del lápiz. @@ -134,7 +134,7 @@ Puede seleccionar texto que no esté subrayado y copiarlo o reemplazarlo sin pro !!! info Existen algunas limitaciones: es mejor evitar seleccionar secciones de texto para eliminarlas (o para escribir o pegar encima) si esas secciones combinan partes no subrayadas (no codificadas, no anotadas, no asignadas a caso) y subrayadas (codificadas, anotadas, asignadas a caso). La razón es que las posiciones de los códigos, anotaciones o asignaciones de caso subyacentes pueden no coincidir correctamente con lo previsto. Si ha hecho un cambio que cree que ha afectado gravemente a esas posiciones codificadas, anotadas o asignadas a caso, salga de la ventana de edición de texto presionando el botón Cancel. -## Archivos de audio y video +## Archivos de audio y video {#archivos-de-audio-y-video} Pueden importarse archivos de video (mov, mp4, wmv, ogg) y de audio (wav, mp3, m4a). Al cargar un archivo de audio o de video también se creará automáticamente un archivo de texto transcrito en blanco. Este archivo tendrá el mismo nombre que el archivo de audio o video, pero con el sufijo '.txt'. Inicialmente, esta transcripción de texto estará vacía. Puede transcribir el archivo usted mismo o encargar la transcripción profesional y copiar y pegar el texto en este archivo. @@ -151,7 +151,7 @@ Si tiene un archivo .srt (un archivo de transcripción que lee VLC), puede coloc Si tiene ffmpeg instalado se muestra una forma de onda. Si los archivos de audio tienen varias pistas de audio, solo se muestra la primera pista en la forma de onda. -### Transcribir audio y video +### Transcribir audio y video {#transcribir-audio-y-video} Para transcribir, abra la opción de menú Manage files y luego visualice el archivo de audio o de video. El audio o video se cargará y habrá un área de texto para introducir el texto transcrito. @@ -200,7 +200,7 @@ Ctrl D Eliminar uno o más nombres de hablante. Ctrl 1 a 8 Insertar nombre de hablante con este formato: [name] -### Transcripciones con códigos, anotaciones o asignación a casos +### Transcripciones con códigos, anotaciones o asignación a casos {#transcripciones-con-codigos-anotaciones-o-asignacion-a-casos} Las secciones del archivo de texto o del archivo transcrito de audio o video tendrán fragmentos de texto subrayados en verde (asignado a caso), amarillo (anotación) o rojo (codificado). El texto puede editarse incluso después de haber sido codificado, anotado o asignado (total o parcialmente) a un caso. @@ -209,11 +209,11 @@ Puede seleccionar texto que no esté subrayado y copiarlo o reemplazarlo sin pro !!!! "Existen algunas limitaciones" Existen algunas limitaciones: es mejor evitar seleccionar secciones de texto para eliminarlas (o para escribir o pegar encima) si esas secciones combinan partes no subrayadas (no codificadas, no anotadas, no asignadas a caso) y subrayadas (codificadas, anotadas, asignadas a caso). La razón es que las posiciones de los códigos, anotaciones o asignaciones de caso subyacentes pueden no coincidir correctamente con lo previsto. Si ha hecho un cambio que cree que ha afectado gravemente a esas posiciones codificadas, anotadas o asignadas a caso, salga de la ventana de edición de texto presionando el botón Cancel. -## Archivos de ejemplo +## Archivos de ejemplo {#archivos-de-ejemplo} Hay algunos archivos de muestra en la carpeta Examples. Pueden usarse para probar la importación de archivos de distintos formatos de documento y la importación de una imagen. También hay archivos de ejemplo para probar la importación de atributos de caso y la importación de una encuesta. -## Gestionar vínculos rotos a archivos +## Gestionar vínculos rotos a archivos {#gestionar-vinculos-rotos-a-archivos} Si su proyecto contiene archivos vinculados externamente, esos archivos pueden moverse, renombrarse o eliminarse. diff --git a/docs/doc/es/3.3.-Cases.md b/docs/doc/es/3.3.-Cases.md index 3bccc97a..00a8a352 100644 --- a/docs/doc/es/3.3.-Cases.md +++ b/docs/doc/es/3.3.-Cases.md @@ -22,14 +22,14 @@ Los botones aquí: ![image](/images/8a7b19c6-6343-4065-a459-3878aa22128a.png) -## Ocultar y mostrar filas y columnas +## Ocultar y mostrar filas y columnas {#hiding-and-showing-rows-and-columns} Oculte columnas haciendo clic derecho en la fila de encabezado de la tabla para obtener opciones para ocultar esa columna u ocultar las columnas que comiencen con un texto concreto. O para mostrar las columnas que comiencen con un valor de texto. Oculte filas mediante el menú contextual seleccionando un valor de texto que sea igual o 'is like' respecto de un texto elegido. Haga clic derecho para ordenar por nombre de caso o por valor de atributo, de forma ascendente o descendente. !!! example "Ejemplo práctico" Añada los tres estudiantes (o casos) haciendo clic en el icono Add case. Nombre a cada estudiante: ID1, ID2 e ID3. -## Gestor de archivos del caso +## Gestor de archivos del caso {#case-file-manager} Ahora, añada el archivo de cada estudiante a cada estudiante. Haga clic en la celda de la columna Files del caso ID3, por ejemplo. Esto abre el _diálogo del gestor de archivos del caso_. Como alternativa, haga clic en el icono de documentos, que también abrirá el gestor de archivos del caso. @@ -39,7 +39,7 @@ En el _gestor de archivos del caso_, haga clic en un caso, por ejemplo ID3, y lu También puede seleccionar un caso, resaltar manualmente porciones de texto dentro de un documento de texto más extenso y hacer clic derecho para marcar, o asignar, el texto al caso seleccionado. -## Importar casos y atributos de caso +## Importar casos y atributos de caso {#importing-cases-and-case-attributes} Puede importar atributos desde un archivo CSV o XLSX con este botón: ![image](/images/0b9d8a34-33ff-4591-ae6d-c6f43bfb9625.png) @@ -48,7 +48,7 @@ La primera fila debe contener los encabezados de los atributos. La primera colum Para este ejemplo, elimine todos los casos mostrados. Luego, importe los atributos desde el archivo cases.csv mediante el diálogo Import Attributes. Nuevamente tendrá que vincular los archivos y el texto de los archivos a cada caso. -## Exportar información de los casos +## Exportar información de los casos {#exporting-case-information} Puede exportar la tabla de Casos a un archivo de Excel (xlsx) con este botón: ![image](/images/15d879be-bde6-4dfd-a1a7-baf5386ef8d9.png) \ No newline at end of file diff --git a/docs/doc/es/4.1.-Coding-Text.md b/docs/doc/es/4.1.-Coding-Text.md index 70b94c81..e04ec9ad 100644 --- a/docs/doc/es/4.1.-Coding-Text.md +++ b/docs/doc/es/4.1.-Coding-Text.md @@ -32,12 +32,12 @@ _Códigos solapados_ Los códigos solapados pueden ser difíciles de visualizar con claridad. Las secciones solapadas aparecen subrayadas. Al pasar el ratón se mostrará el texto codificado solapado. Puede presionar 'O' tras hacer clic en una sección solapada para recorrer los códigos de esa ubicación. -## Anotaciones +## Anotaciones {#anotaciones} Añada una anotación (un memo para un segmento de texto) a una selección de texto. Son útiles para explicar siglas y jerga. El texto pasará a negrita para marcar la posición de la anotación. Para volver a abrir una anotación, seleccione parte del texto en negrita y haga clic derecho para obtener la opción Annotate. Como alternativa, haga clic en el botón de bloc de notas y lápiz situado más a la izquierda, o presione la tecla 'A'. Para eliminar una anotación, ábrala y borre todo el texto. ![annotation](/images/annotation.png) -## Autocodificar +## Autocodificar {#autocodificar} En la parte superior derecha de la pantalla hay botones para autocodificar texto: ![auto-code buttons](/images/d689c833-505f-49e4-938c-e392d4a2cc14.png) @@ -82,7 +82,7 @@ _____________ ``` Otra alternativa es actualizar de la 3.8 a la 3.8.2, eliminar todas las regex incorrectas y volver a ejecutar la regex. -## Codificación automática de hablantes +## Codificación automática de hablantes {#codificacion-automatica-de-hablantes} La función "mark speakers" crea códigos para cada hablante en una entrevista o discusión grupal y asigna las intervenciones automáticamente. Esto permite informes más focalizados, examinando solo determinados hablantes cada vez. Puede acceder a la función mediante el menú contextual del archivo o con el siguiente botón de la barra de herramientas: @@ -97,10 +97,10 @@ La función "mark speakers" crea códigos para cada hablante en una entrevista o - No obstante, puede optar por ocultar estas codificaciones en la ventana de texto, de modo que no le distraigan en su propia codificación analítica. Para ello, haga clic en el botón "..." situado junto al nombre del codificador en la parte superior izquierda de la barra de herramientas. En el diálogo siguiente, seleccione la entrada "📌 Speaker coding" y establezca la visibilidad en "hidden". - La función "mark speakers" también está disponible en el espacio de trabajo "manage files". -## Maximizar el área de pantalla +## Maximizar el área de pantalla {#maximizar-el-area-de-pantalla} Para ocultar el panel de control superior, haga clic en el área de texto y presione la tecla 'H'. Para mostrar el panel superior, presione 'H' de nuevo. -## Métodos prácticos para cargar archivos de texto en el panel de la lista de archivos. +## Métodos prácticos para cargar archivos de texto en el panel de la lista de archivos. {#metodos-practicos-para-cargar-archivos-de-texto-en-el-panel-de-la-lista-de-archivos} Algunos proyectos pueden tener muchos archivos de texto y el diálogo de ver archivo puede presentar demasiados archivos para abrir. Haga clic derecho en los archivos del árbol de archivos para pasar al archivo siguiente, ir al archivo marcado o ir al archivo con las codificaciones más recientes: @@ -109,7 +109,7 @@ Algunos proyectos pueden tener muchos archivos de texto y el diálogo de ver arc * Seleccionar el archivo codificado más recientemente, * Ir a una ubicación marcada en un archivo. Para crear un marcador, haga clic derecho en algún texto mientras codifica y seleccione la opción de marcador. El marcador funciona solo para un proyecto a la vez, así que si abrió un proyecto distinto, el marcador sería incorrecto o podría no funcionar en absoluto. -### Botones prácticos debajo de la lista de archivos +### Botones prácticos debajo de la lista de archivos {#botones-practicos-debajo-de-la-lista-de-archivos} * Cargar el archivo siguiente * Cargar el archivo con la codificación más reciente @@ -119,10 +119,10 @@ Algunos proyectos pueden tener muchos archivos de texto y el diálogo de ver arc ![image](/images/b3c32938-c1df-455c-be3e-3753c813535c.png) -## Archivos de texto grandes +## Archivos de texto grandes {#archivos-de-texto-grandes} Los archivos de texto grandes ralentizan QualCoder. Al abrir un archivo de texto grande (de más de 50 000 caracteres), haga clic derecho en el archivo. Una opción del menú le permite obtener los primeros 50 000 caracteres aproximadamente; los clics posteriores abrirán los siguientes 50 000 aproximadamente, y así sucesivamente. Aproximadamente, porque QualCoder busca un fin de línea (como el final de un párrafo o de una oración) para segmentar de forma más adecuada el inicio y el final de los fragmentos de texto. Si el fragmento de 50 000 sigue ralentizando Qualcoder, en la Configuración puede reducir aún más este tamaño de caracteres. -## Modificar las posiciones de los códigos +## Modificar las posiciones de los códigos {#modificar-las-posiciones-de-los-codigos} Cuando esté en el área de texto, haga clic con el ratón sobre un código (tenga en cuenta que el código no debe solaparse con otro código en esa posición). Presione las siguientes combinaciones de teclas para ampliar o reducir el segmento de texto codificado. @@ -137,7 +137,7 @@ Siempre es mejor guardar una copia del proyecto antes de editar el texto, para e * Símbolo de acento circunflejo ^ Shift + 6 Desplaza las posiciones de los códigos posteriores a la posición del carácter en el que se hizo clic. Puede ser necesario tras editar el texto (añadir o eliminar) para desplazar los segmentos de codificación subsiguientes un número determinado de caracteres. -## Otras teclas de acceso rápido para la codificación de texto +## Otras teclas de acceso rápido para la codificación de texto {#otras-teclas-de-acceso-rapido-para-la-codificacion-de-texto} * Atajo A. Presione a para anotar el texto seleccionado @@ -163,7 +163,7 @@ Siempre es mejor guardar una copia del proyecto antes de editar el texto, para e * Ctrl Z. Restaura la última codificación que se desmarcó. -## Buscar texto +## Buscar texto {#buscar-texto} El diálogo de codificación de texto contiene una función de búsqueda de texto en la parte superior central, con casillas para buscar distinguiendo mayúsculas y minúsculas y para buscar en todos los archivos de texto. Cuando esté en el área de texto, si selecciona un fragmento de texto y presiona la tecla de atajo 's' se rellenará el cuadro de búsqueda y el foco pasará al botón de flecha 'next' para recorrer rápidamente el documento en busca del texto seleccionado. La búsqueda requiere un mínimo de 3 caracteres de forma predeterminada. Haga clic derecho para cambiar el valor predeterminado a 5 caracteres, o para buscar solo después de presionar Enter. La casilla Case sensitive limitará la búsqueda a coincidencias que distingan mayúsculas y minúsculas. La casilla All files continuará la búsqueda en los demás archivos de texto. @@ -175,23 +175,23 @@ La búsqueda usa funciones de Regex. * '\. coincidirá con el símbolo de punto, '\?' coincidirá con el signo de interrogación. '\n' coincidirá con el símbolo de fin de línea. Esta [chuleta de Regex](www.rexegg.com/regex-quickstart.html) puede ayudar. * \b límite de palabra, '\bbound\b' buscará la palabra completa 'bound', pero no 'boundary' -## Desplazarse por el texto de un código seleccionado +## Desplazarse por el texto de un código seleccionado {#desplazarse-por-el-texto-de-un-codigo-seleccionado} Debajo del árbol de códigos están los botones: adelante, atrás y un botón con icono de cuadrícula (para salir de la función). Seleccione un código y luego haga clic en las flechas de adelante y atrás. Estas recorren el documento de texto mostrando el texto codificado seleccionado. Todo el demás texto codificado queda oculto. Para restaurar y mostrar todos los códigos, haga clic en el botón de cuadrícula, ahora coloreado. -## Mostrar solo el texto codificado importante +## Mostrar solo el texto codificado importante {#mostrar-solo-el-texto-codificado-importante} Debajo del árbol de códigos hay un botón con un símbolo de estrella. Este botón alterna entre mostrar todo el texto codificado y el texto codificado marcado como Important. -## Panel oculto de la derecha +## Panel oculto de la derecha {#panel-oculto-de-la-derecha} El lado derecho del panel de codificación de texto tiene otro panel replegado. Para abrirlo, haga clic y arrastre desde el lado derecho de la ventana, o presione el botón junto al botón de Ayuda. Este panel contiene opciones útiles al codificar. Uno de los botones hace que, al hacer clic en un código, se muestren el nombre del código, la regla del código (memo) y ejemplos aleatorios de texto codificado del proyecto. El otro botón muestra el memo del proyecto. ![image](/images/a6977ba3-bdf2-43c8-9097-562a252af815.png) -## Editar texto cuando se está en Coding - Code text +## Editar texto cuando se está en Coding - Code text {#editar-texto-cuando-se-esta-en-coding-code-text} El texto puede editarse incluso después de haber sido codificado, anotado o asignado (total o parcialmente) a un caso. Las secciones del archivo de texto o del archivo transcrito de audio o video tendrán fragmentos de texto subrayados en verde (asignado a caso), amarillo (anotación) o rojo (codificado) por TODOS los codificadores. @@ -215,7 +215,7 @@ A continuación se muestra el aspecto de la pantalla de edición de texto. ![image](/images/b02d740e-d561-4c3c-aff0-637d45740d03.png) -## Categorías y códigos +## Categorías y códigos {#categorias-y-codigos} Las categorías se usan para organizar los códigos. Las categorías se organizan jerárquicamente en una estructura de árbol. Puede mover códigos dentro de categorías y mover categorías dentro de categorías mayores. Puede sacar categorías y códigos de su posición actual. Los códigos y las categorías pueden fusionarse soltando un código sobre otro código o una categoría sobre otra categoría. Haga clic derecho en una categoría o código para renombrarlo. Haga clic derecho en un código para cambiar su color. @@ -224,7 +224,7 @@ A las categorías y códigos se les pueden asignar memos. Los memos pueden conte !!! note La posibilidad de asignar un mismo código a varias categorías es una función solicitada con frecuencia. Sin embargo, hemos decidido no implementar esta funcionalidad, ya que sería excesivamente complicada. Esto se debe a que QualCoder usa una estructura de árbol, mientras que la función solicitada requiere una [estructura de datos de grafo](https://www.baeldung.com/cs/tree-vs-graph-data-structure). Como alternativa, puede usar códigos con nombres similares en sus distintas categorías. -## Reducir la cantidad de códigos mostrados en el árbol de códigos +## Reducir la cantidad de códigos mostrados en el árbol de códigos {#reducir-la-cantidad-de-codigos-mostrados-en-el-arbol-de-codigos} Para reducir el número de códigos mostrados en el árbol de códigos. En las ventanas de codificación (code text, code a/v o code image), haga clic derecho en el árbol de códigos y seleccione _Show codes like_ en el menú. Luego introduzca texto en el cuadro de texto. Así solo se mostrarán los códigos que contengan ese texto. Para volver a mostrar todos los códigos, no introduzca nada en el cuadro de texto y presione OK. @@ -232,13 +232,13 @@ Una segunda opción es _Show codes of colour_. Otro botón bajo el árbol de códigos, con un icono de búsqueda, al hacer clic buscará el primer código que contenga el texto coincidente que introduzca. -## Opciones del menú del árbol de códigos +## Opciones del menú del árbol de códigos {#opciones-del-menu-del-arbol-de-codigos} En el árbol de códigos de la izquierda, al hacer clic derecho en un código se abre un menú contextual con diversas opciones. ![image](/images/0c0c97fb-a316-4076-a5c1-1fddd575e1f1.png) -### Mostrar archivos codificados +### Mostrar archivos codificados {#mostrar-archivos-codificados} Una de las opciones es Show coded files: muestra todos los lugares donde ha codificado con el código seleccionado. Al hacer clic en una sección codificada concreta se abrirá ese código en su contexto original para profundizar en su comprensión. @@ -247,7 +247,7 @@ Con show coded files, puede hacer clic derecho en la sección coloreada del enca ![image](/images/7f0d079d-c0a8-4966-87bd-a6723f541d8d.png) -## Accesibilidad y colores de los códigos +## Accesibilidad y colores de los códigos {#accesibilidad-y-colores-de-los-codigos} En el menú Coding hay una opción llamada **Colour scheme**. diff --git a/docs/doc/es/4.2.-AI-Assisted-Coding.md b/docs/doc/es/4.2.-AI-Assisted-Coding.md index 48bd981b..53c3d35f 100644 --- a/docs/doc/es/4.2.-AI-Assisted-Coding.md +++ b/docs/doc/es/4.2.-AI-Assisted-Coding.md @@ -3,7 +3,7 @@ path: 4.2.-AI-Assisted-Coding --- # Codificación asistida por IA -## Introducción +## Introducción {#introduction} Las funciones de IA integradas en QualCoder (versión 3.6 en adelante) pueden asistir el proceso de codificación de diversas maneras: @@ -15,11 +15,11 @@ Las funciones de IA integradas en QualCoder (versión 3.6 en adelante) pueden as Tenga en cuenta que la "codificación asistida por IA" no es un método por derecho propio; es un conjunto de técnicas que pueden adaptarse a muchos métodos que trabajan con códigos, desde la teoría fundamentada hasta el análisis de contenido o temático. Vea este [videotutorial]( https://www.youtube.com/watch?v=FrQyTOTJhCc) para un ejemplo práctico. -## Condiciones previas +## Condiciones previas {#preconditions} - La IA debe estar activada, completamente cargada y lista para nuevas consultas (vea la barra de estado para conocer el estado actual). - Es **muy recomendable** usar el memo del proyecto (menú "AI > Project Memo") para incluir una breve descripción de los temas de investigación, preguntas y objetivos de su proyecto, así como de los datos empíricos recogidos. Esta información acompañará a cada prompt enviado a la IA, lo que dará resultados mucho más precisos. -## Iniciar la codificación asistida por IA +## Iniciar la codificación asistida por IA {#start-ai-assisted-coding} La codificación asistida por IA está integrada en el espacio de trabajo de codificación de texto. Iníciela haciendo clic en "Coding > AI-assisted coding" o, si ya está en el espacio de trabajo de codificación de texto, seleccione la pestaña "AI Assistance" a la izquierda. Luego haga clic en "Start AI Search." ![Screenshot AI Assistance Tab](/images/1eeca42f-2e4e-48a6-aca7-68e4b13df6c4.png) @@ -28,9 +28,9 @@ En la ventana siguiente debe (1) definir el objeto de su búsqueda (código o te ![Screenshot AI Search Dialog](/images/0d66baa1-6c60-423a-b4d6-742d387322dc.png) -### 1) Qué buscar: búsqueda por código frente a búsqueda por tema libre +### 1) Qué buscar: búsqueda por código frente a búsqueda por tema libre {#1-what-to-search-for-code-vs-free-topic-search} -#### Búsqueda por código +#### Búsqueda por código {#code-search} Úsela para profundizar en un aspecto concreto y añadir más datos de todo su corpus a un código ya existente. @@ -40,10 +40,10 @@ En la ventana siguiente debe (1) definir el objeto de su búsqueda (código o te - **Enviar el memo a la IA:** si se selecciona, el memo del código también se compartirá con la IA. Úselo para describir o definir su código y ayudar a la IA a generar mejores resultados. Si además quiere añadir notas personales al memo del código, puede hacerlo insertando "#####" en el texto. Todo lo que esté por debajo de esa marca no se enviará a la IA. - **Incluir segmentos codificados:** desactivado de forma predeterminada, lo que significa que la búsqueda con IA devolverá solo datos nuevos aún no codificados con ese código concreto. Active esta opción para incluir también los datos previamente codificados. -#### Búsqueda por tema libre +#### Búsqueda por tema libre {#free-topic-search} Busque cualquier tema, fenómeno o concepto en todo su corpus de datos sin un código predefinido. Introduzca un nombre y una descripción para comunicar a la IA qué está buscando. -### 2) Cómo analizar los datos: el prompt analítico para la IA +### 2) Cómo analizar los datos: el prompt analítico para la IA {#2-how-to-analyse-the-data-the-analytic-prompt-for-the-ai} El prompt analítico indica a la IA cómo examinar sus datos. Selecciónelo en la parte inferior izquierda de la ventana. @@ -54,10 +54,10 @@ El prompt analítico indica a la IA cómo examinar sus datos. Selecciónelo en l **Explore estos prompts** pasando el ratón sobre los elementos de la lista desplegable. Haga clic en "Edit" para [editar los prompts analíticos o definir los suyos propios](6.2.-AI-Prompt-Library) (opción avanzada). -### 3) Filtro: acote su búsqueda +### 3) Filtro: acote su búsqueda {#3-filter-narrow-your-search-down} De forma predeterminada se explora todo el corpus de datos textuales del proyecto actual. Si quiere limitar la búsqueda a determinados **documentos** o **casos**, puede seleccionarlos en el lado derecho de la ventana (Ctrl + clic para seleccionar varios). También puede definir un filtro basado en determinadas **variables de atributo.** -## El proceso de codificación asistida por IA +## El proceso de codificación asistida por IA {#the-process-of-ai-assisted-coding} Primero, realice la búsqueda con IA. Es un proceso de dos pasos: **Paso 1:** la IA consulta su base de datos local en busca de datos potencialmente relevantes en su corpus. @@ -66,7 +66,7 @@ Primero, realice la búsqueda con IA. Es un proceso de dos pasos: Tenga paciencia, ya que los primeros resultados pueden tardar en aparecer. Al hacer clic en un resultado se carga el documento en la ventana principal y se resalta la cita relevante. Asegúrese también de mirar el texto que rodea a la cita para entender su contexto. -### Trabajar con los resultados +### Trabajar con los resultados {#working-through-the-results} Puede **codificar el texto seleccionado** igual que cualquier otro texto en el [espacio de trabajo de codificación de texto](4.1.-Coding-Text). Amplíe o modifique la selección según sea necesario. @@ -80,7 +80,7 @@ QualCoder usa un **algoritmo de clasificación** para mostrar los resultados má Con el tiempo, sin embargo, los resultados devueltos por la IA empezarán a **alejarse del tema original** y a ser cada vez menos relevantes. Ese es el punto en el que debería detener la indagación y pasar al siguiente tema o código. No necesita hacer clic en "find more" hasta que no quede absolutamente ningún dato por analizar del primer paso de la búsqueda. Compárelo con una búsqueda en Google: no hay necesidad de recorrer todas y cada una de las páginas de resultados si ya comprende lo que quería saber. -### Qué hacer si no obtiene resultados +### Qué hacer si no obtiene resultados {#what-to-do-if-you-get-no-results} 1) **Si el primer paso no devuelve datos potencialmente relevantes:** recuerde que, de forma predeterminada, la búsqueda por código solo extrae datos nuevos. Si ya ha codificado a fondo sus documentos, puede que sencillamente no haya nada nuevo que explorar sobre un tema concreto. Piense también en su consulta de búsqueda, especialmente en el nombre del código o del tema de búsqueda: ¿es demasiado específico o no lo bastante claro? 2) **Si el segundo paso no arroja ningún resultado:** haga clic en "find more" (si está disponible) para analizar más datos. Si esto tampoco produce resultados, quizá le convenga iniciar una nueva búsqueda con un prompt más abierto e inclusivo (por ejemplo, "open search"). diff --git a/docs/doc/es/4.3.-Coding-Text-on-PDFs.md b/docs/doc/es/4.3.-Coding-Text-on-PDFs.md index 3b6b0c34..e8ff433f 100644 --- a/docs/doc/es/4.3.-Coding-Text-on-PDFs.md +++ b/docs/doc/es/4.3.-Coding-Text-on-PDFs.md @@ -10,37 +10,37 @@ La pantalla se divide en 3 paneles ajustables. El panel del lado izquierdo conti ![Code PDF window](/images/4e13a708-ca8d-4c27-a736-60be5c132fcd.png) -## Tamaño de fuente y zoom +## Tamaño de fuente y zoom {#tamano-de-fuente-y-zoom} No se usan las fuentes originales del texto; es demasiado difícil extraerlas y aplicarlas desde el PDF. En su lugar, se utiliza la fuente estándar de QualCoder en los cuadros de texto del PDF mostrado. Hay un ajustador del tamaño de fuente para reducirlo y tratar de evitar el solapamiento del texto. Está establecido en -2, y -3 también puede resultar bastante bueno. Se puede acercar y alejar el PDF mediante botones o pulsaciones de teclas: Ctrl - y Shift + ![font and zoom buttons](/images/87079c0f-a6e9-4b0f-b5ba-8f15bcd55411.png) -## El extracto de texto plano debe coincidir +## El extracto de texto plano debe coincidir {#el-extracto-de-texto-plano-debe-coincidir} El texto plano cargado al importar un PDF mediante Manage files debe coincidir exactamente con el texto plano que se vuelve a cargar cuando el PDF se abre para mostrarse aquí. Esto significa que los PDF cargados antes de la versión 3.4 no harán coincidir el texto correctamente, y la codificación mediante la selección de cuadros de texto queda desactivada si las longitudes del texto no coinciden. De igual modo, si el texto plano se edita de cualquier manera y las longitudes del texto no coinciden, la codificación mediante la selección de cuadros de texto del PDF queda desactivada. La visualización de las franjas de codificación dentro de la página del PDF presentada también puede verse incorrecta. -## Navegación +## Navegación {#navegacion} Desplácese por las páginas del PDF haciendo clic en las flechas de subir y bajar página, o escribiendo un número de página, usando los botones: ![page buttons](/images/58b64602-bf7a-421b-9da0-041893ba88db.png) -## Funciones adicionales +## Funciones adicionales {#funciones-adicionales} En la parte superior de la ventana hay varios botones. Uno exporta una imagen de la página del PDF. El botón de la lupa abre una ventana que muestra los elementos del PDF usados en la página. También en la parte superior de la ventana hay varias casillas para mostrar u ocultar elementos del PDF de Texto e Imágenes. Una casilla mostrará todo el texto en negro, lo que puede ser útil cuando se muestra texto de color claro sobre un fondo claro. -## Panel derecho +## Panel derecho {#panel-derecho} El panel del lado derecho muestra el texto plano del mismo modo en que se mostraría en Code text. Aquí puede marcar, desmarcar, poner memos al texto codificado, marcar la codificación como importante y anotar texto. -## Panel central +## Panel central {#panel-central} Para codificar, haga clic izquierdo y arrastre el ratón para seleccionar cuadros de texto del PDF. Esto puede resultar complicado según el tamaño y la posición de los cuadros. Luego haga clic en un código para asignarle la selección. Se pueden hacer más ajustes en el panel de texto plano de la derecha usando las flechas shift izquierda o derecha para ampliar, o alt izquierda y derecha para reducir la sección de texto codificado. Haga clic derecho para abrir el menú contextual sobre un segmento codificado. Este menú le permite añadir un memo, marcar como importante o desmarcar el segmento codificado. -### Pulsaciones de teclas +### Pulsaciones de teclas {#pulsaciones-de-teclas} H Mostrar u ocultar las secciones superiores de la pantalla. @@ -62,13 +62,13 @@ Ctrl 9 Mostrar los segmentos codificados importantes. Se activa y desactiva. Ctrl 0 Mostrar la página de Ayuda en el navegador. -#### En el área de visualización del PDF: +#### En el área de visualización del PDF: {#en-el-area-de-visualizacion-del-pdf} Puede acercar y alejar haciendo clic en el PDF mostrado y presionando las teclas + o -. Presione Q para marcar rápidamente la selección con el código reciente. Presione R para marcar rápidamente la selección eligiendo entre los códigos usados recientemente. -#### En el área de texto plano: +#### En el área de texto plano: {#en-el-area-de-texto-plano} A anotar, para la selección actual, solo edición de texto diff --git a/docs/doc/es/4.4.-Coding-Images.md b/docs/doc/es/4.4.-Coding-Images.md index 9771fe3e..bc111dc8 100644 --- a/docs/doc/es/4.4.-Coding-Images.md +++ b/docs/doc/es/4.4.-Coding-Images.md @@ -10,7 +10,7 @@ La parte superior derecha del diálogo muestra algunos detalles de un área codi ![Code image](/images/c1dc9413-23ce-4491-84f6-eb3bb94a735b.png) -## Codificación de imágenes de PDF +## Codificación de imágenes de PDF {#codificacion-de-imagenes-de-pdf} Los PDF pueden codificarse como imagen. La representación de la imagen en QualCoder no es nítida, pero es utilizable. La imagen puede exportarse y tiene mayor calidad. @@ -19,10 +19,10 @@ Los PDF pueden codificarse como imagen. La representación de la imagen en QualC Botones de navegación del PDF: ![PDF navigation buttons](/images/36effc9c-f0a2-4f02-9fe0-293abcd3060a.png) -## Áreas codificadas importantes +## Áreas codificadas importantes {#areas-codificadas-importantes} Las áreas codificadas importantes, como los ejemplos ilustrativos para un informe, pueden marcarse como Important usando el menú contextual sobre las áreas codificadas y seleccionando Important. En la parte superior de la pantalla hay un botón con un símbolo de estrella. Este botón alterna entre mostrar todas las áreas codificadas y las áreas codificadas marcadas como Important. -## Atajos +## Atajos {#atajos} * Atajo H. Presione h cuando esté sobre la imagen para ocultar y volver a mostrar la sección superior de controles de la pantalla. @@ -32,7 +32,7 @@ Las áreas codificadas importantes, como los ejemplos ilustrativos para un infor * Ctrl Z para restaurar la última área de codificación desmarcada. -## Botones prácticos debajo de la lista de archivos +## Botones prácticos debajo de la lista de archivos {#botones-practicos-debajo-de-la-lista-de-archivos} * Cargar el archivo siguiente * Cargar el archivo con la codificación más reciente @@ -40,7 +40,7 @@ Las áreas codificadas importantes, como los ejemplos ilustrativos para un infor * Usar una función de filtro para mostrar solo aquellos archivos que cumplan ciertos criterios. Estos pueden provenir de atributos de archivo o de si los archivos están asociados a determinados casos. (Botón que muestra una etiqueta) -## Haga clic derecho en el área de la imagen para más opciones +## Haga clic derecho en el área de la imagen para más opciones {#haga-clic-derecho-en-el-area-de-la-imagen-para-mas-opciones} Las opciones incluyen la rotación y el resaltado de un código o área codificada concretos. Estas opciones de resaltado son: en escala de grises, desenfoque, solarizar, y se abren en su programa predeterminado de visualización de imágenes para verlas y guardarlas. @@ -52,11 +52,11 @@ Presione una vez para añadir el nombre del código. Presione de nuevo para aña ![Coded image with captions](/images/58c67c4a-942f-4a46-a803-0f7b0f6f5c36.png) -## Exportar +## Exportar {#exportar} La imagen con las áreas codificadas puede exportarse a un archivo HTML. Tras abrir el archivo en un navegador, al pasar el ratón sobre las áreas codificadas se muestran el nombre del código y los memos. -## Categorías y códigos +## Categorías y códigos {#categorias-y-codigos} Las categorías se usan para organizar los códigos. Las categorías se organizan jerárquicamente en una estructura de árbol. Puede mover códigos dentro de categorías y mover categorías dentro de categorías mayores. Puede sacar categorías y códigos de su posición actual. Los códigos y las categorías pueden fusionarse soltando un código sobre otro código o una categoría sobre otra categoría. A las categorías y códigos se les pueden asignar memos. Haga clic derecho en una categoría o código para renombrarlo. Haga clic derecho en un código para cambiar su color. @@ -68,7 +68,7 @@ Con show coded files, puede hacer clic derecho en la sección coloreada del enca ![image](/images/7f0d079d-c0a8-4966-87bd-a6723f541d8d.png) -## Accesibilidad y colores de los códigos +## Accesibilidad y colores de los códigos {#accesibilidad-y-colores-de-los-codigos} En el menú Coding hay una opción llamada **Colour scheme**. diff --git a/docs/doc/es/4.5.-Coding-Audio-and-Video.md b/docs/doc/es/4.5.-Coding-Audio-and-Video.md index 6d14e882..ce3b6706 100644 --- a/docs/doc/es/4.5.-Coding-Audio-and-Video.md +++ b/docs/doc/es/4.5.-Coding-Audio-and-Video.md @@ -10,7 +10,7 @@ El texto de la transcripción también puede codificarse y anotarse en esta vent ![Code audio/video screen](/images/1c24c6b3-2e58-4d0c-9363-6b64f06408a3.png) -## Atajos de teclado +## Atajos de teclado {#atajos-de-teclado} * Ctrl R Retroceder 5 segundos * Alt R o Alt Menos Retroceder 30 segundos @@ -37,7 +37,7 @@ Cuando el área de texto tiene el foco: * Atajo R. Presione R para seleccionar códigos recientes. (Debe haber una selección de texto) -## Segmentos de audio y video +## Segmentos de audio y video {#segmentos-de-audio-y-video} Una vez creado un segmento con el botón _Start segment/Stop segment_, este puede asignarse a un código haciendo clic derecho en el código correspondiente y asignando el segmento. @@ -45,7 +45,7 @@ Las franjas de codificación de los segmentos codificados se muestran en el pane El texto de la transcripción también puede codificarse y anotarse en este diálogo. Sin embargo, cuando la casilla Scroll transcript está marcada, esto no puede hacerse. Reproducir el video con esta casilla marcada desplazará la transcripción usando las marcas de tiempo al ritmo del video. -## Texto y segmentos codificados importantes +## Texto y segmentos codificados importantes {#texto-y-segmentos-codificados-importantes} Los textos codificados importantes, como los ejemplos ilustrativos para un informe, pueden marcarse como Important usando el menú contextual sobre el texto codificado y seleccionando Important. De igual modo, los segmentos de código pueden marcarse como Important. En la parte superior de la pantalla hay un botón con un símbolo de estrella. Este alterna entre mostrar todo el texto y los segmentos codificados o solo el texto y los segmentos codificados marcados como Important. @@ -53,7 +53,7 @@ Los textos codificados importantes, como los ejemplos ilustrativos para un infor Seleccione texto (puede estar codificado o, preferiblemente, sin codificar) y luego asígnelo a un segmento. Primero, seleccione el texto. Luego haga clic derecho en la franja del segmento para abrir el menú. Elija Link text to segment para asignar el texto. -## Modificar las posiciones de los códigos en el área de texto +## Modificar las posiciones de los códigos en el área de texto {#modificar-las-posiciones-de-los-codigos-en-el-area-de-texto} Cuando esté en el área de texto, haga clic con el ratón sobre un código (nota: el código no debe solaparse con otro código en esa posición). Presione las siguientes combinaciones de teclas para ampliar o reducir el segmento de texto codificado. @@ -64,25 +64,25 @@ Cuando esté en el área de texto, haga clic con el ratón sobre un código (not También puede hacer clic derecho en un código y seleccionar cambiar la posición de inicio o cambiar la posición de fin en un número determinado de caracteres. -## La ventana de video +## La ventana de video {#la-ventana-de-video} En la ventana de video puede hacer clic derecho y disponer de opciones para cambiar el tamaño de la ventana, en píxeles. También puede exportar una captura de pantalla. La captura se guardará como Frame_yyyymmdd_hh_mm_ss.jpg. -## Botones prácticos debajo de la lista de archivos +## Botones prácticos debajo de la lista de archivos {#botones-practicos-debajo-de-la-lista-de-archivos} * Cargar el archivo siguiente * Cargar el archivo con la codificación más reciente * Abrir el memo del archivo seleccionado * Usar una función de filtro para mostrar solo aquellos archivos que cumplan ciertos criterios. Estos pueden provenir de atributos de archivo o de si los archivos están asociados a determinados casos. -## Problemas de audio y video en algunos sistemas operativos +## Problemas de audio y video en algunos sistemas operativos {#problemas-de-audio-y-video-en-algunos-sistemas-operativos} Algunos sistemas operativos no funcionan bien con el audio y el video en QualCoder. Un ejemplo es Fedora Linux. Sí necesita tener instalada una versión actual de VLC de 64 bits, ya que QualCoder la busca y utiliza VLC para la reproducción de audio y video. -## Categorías y códigos +## Categorías y códigos {#categorias-y-codigos} Las categorías se usan para organizar los códigos. Las categorías se organizan jerárquicamente en una estructura de árbol. Puede mover códigos dentro de categorías y mover categorías dentro de categorías mayores. Puede sacar categorías y códigos de su posición actual. Los códigos y las categorías pueden fusionarse soltando un código sobre otro código o una categoría sobre otra categoría. A las categorías y códigos se les pueden asignar memos. Haga clic derecho en una categoría o código para renombrarlo. Haga clic derecho en un código para cambiar su color. @@ -95,7 +95,7 @@ Con show coded files, puede hacer clic derecho en la sección coloreada del enca ![image](/images/7f0d079d-c0a8-4966-87bd-a6723f541d8d.png) -## Accesibilidad y colores de los códigos +## Accesibilidad y colores de los códigos {#accesibilidad-y-colores-de-los-codigos} En el menú Coding hay una opción llamada **Colour scheme**. diff --git a/docs/doc/es/5.1.-AI-chat-based-analysis.md b/docs/doc/es/5.1.-AI-chat-based-analysis.md index 1e978e38..83420371 100644 --- a/docs/doc/es/5.1.-AI-chat-based-analysis.md +++ b/docs/doc/es/5.1.-AI-chat-based-analysis.md @@ -4,7 +4,7 @@ path: 5.1.-AI-chat-based-analysis # Analizar datos con el agente de IA -## Principios fundamentales de la integración de IA +## Principios fundamentales de la integración de IA {#core-principles-of-ai-integration} **1) Diversidad de modelos de IA** @@ -22,7 +22,7 @@ Los prompts que guían el trabajo del agente de IA se pueden consultar y, en pri El enfoque se centra en el diálogo con la IA: desarrollar perspectivas adicionales, cuestionar las propias interpretaciones y comprender mejor el material. Si se lo solicita, el agente también puede realizar tareas más largas de forma semiautónoma. Sin embargo, la automatización a gran escala nunca ha sido el objetivo principal. -## Trabajar con el agente de IA +## Trabajar con el agente de IA {#working-with-the-ai-agent} - El agente de IA tiene su **propia pestaña** en QualCoder. También puede desplazarlo a una **barra lateral** (véase más abajo), junto a los datos, haciendo clic en el pequeño botón con una flecha. ![Botón con una flecha para desplazar el agente de IA a la barra lateral](../../images/ai-agent-sidebar-button-de.png){ width="118" } @@ -33,20 +33,20 @@ El enfoque se centra en el diálogo con la IA: desarrollar perspectivas adiciona !!! note La IA debe estar **completamente cargada** y lista para nuevas consultas antes de poder iniciar un chat (barra de estado: «IA: lista»). -### ¿Para qué sirve el agente de IA? +### ¿Para qué sirve el agente de IA? {#what-is-the-ai-agent-for} - El agente de IA le ayuda a **explorar su material empírico,** desarrollar interpretaciones y análisis, codificar datos y redactar memos. - Puede conversar con la IA sobre pasajes concretos o buscar temas y casos contrastantes en todo el corpus del proyecto. - Puede desarrollar su sistema de códigos, generar ideas y estrategias de análisis y contrastarlas directamente con el material empírico. - A diferencia de los chatbots genéricos, el agente de IA de QualCoder **retoma el trabajo exactamente donde se ha quedado su análisis:** examina el sistema de códigos actual, puede leer memos y pasajes codificados, incorporar los casos y sus características (atributos) al análisis, etc. Así obtiene comentarios adaptados al estado actual de su investigación. -### ¿Qué puede hacer el agente de IA? +### ¿Qué puede hacer el agente de IA? {#what-can-the-ai-agent-do} - Incluso con un simple **acceso de lectura** al proyecto, el agente de IA es una herramienta potente para generar ideas. - Si se lo solicita, además de responder preguntas, puede **hacer avanzar activamente el análisis.** Con los permisos adecuados (véase más abajo), puede crear nuevos códigos o reorganizar los existentes, buscar y codificar nuevos pasajes, revisar memos o crear nuevos atributos de casos. - Durante la conversación con el agente, puede revisar sus propuestas, hacer preguntas de seguimiento y decidir cómo continuar. -### ¿Cuáles son sus limitaciones? +### ¿Cuáles son sus limitaciones? {#what-are-its-limitations} - Actualmente, el agente de IA solo puede trabajar con **datos textuales**, no con imágenes, audio ni vídeo. Los diarios también quedan excluidos. - Puede elegir entre tres niveles de permisos: @@ -60,7 +60,7 @@ El enfoque se centra en el diálogo con la IA: desarrollar perspectivas adiciona - Siempre se aplica un **límite estricto:** los propios datos empíricos constituyen la «verdad de referencia» de todo el análisis. La IA no puede modificarlos bajo ninguna circunstancia. - Además, el agente de IA **no tiene acceso a información externa,** por ejemplo, de Internet. Por tanto, solo puede trabajar con los datos que usted haya incorporado deliberadamente al proyecto. -### ¿Cómo puedo ver qué cambios realiza la IA? +### ¿Cómo puedo ver qué cambios realiza la IA? {#how-can-i-see-which-changes-the-ai-makes} - El agente **documenta sus pasos en el chat,** cita sus fuentes y pide autorización antes de realizar cambios importantes. - Puede **deshacer** fácilmente los últimos cambios del agente de IA mediante el botón correspondiente en la ventana de chat: @@ -75,7 +75,7 @@ El enfoque se centra en el diálogo con la IA: desarrollar perspectivas adiciona ![Ajustar la visibilidad de las codificaciones de AI Agent](../../images/ai-agent-code-visibility-de.png){ width="250" } -### ¿Cómo debo preparar mi proyecto? +### ¿Cómo debo preparar mi proyecto? {#how-should-i-prepare-my-project} - Es importante disponer de un **memo de proyecto** informativo (menú «Proyecto > Memo de proyecto»). Incluya lo siguiente: @@ -96,7 +96,7 @@ El enfoque se centra en el diálogo con la IA: desarrollar perspectivas adiciona !!! note **Notas personales en los memos:** Si también desea utilizar los memos para notas personales, escríbalas después del separador `#####`. Todo lo que aparezca después es inaccesible para la IA. -### ¿Cómo funciona el agente de IA? +### ¿Cómo funciona el agente de IA? {#how-does-the-ai-agent-work} - El agente de IA solo actúa cuando usted le asigna una **tarea**, no por iniciativa propia. - El agente procesa una tarea mediante un **bucle ReAct** (Reflect + Act, [Shunyu et al. 2022](https://arxiv.org/abs/2210.03629)): @@ -110,13 +110,13 @@ El enfoque se centra en el diálogo con la IA: desarrollar perspectivas adiciona - El agente dispone de **herramientas potentes:** por ejemplo, puede realizar búsquedas por similitud semántica en todo el corpus, buscar mediante expresiones regulares o en un índice de palabras clave BM25 y utilizar herramientas para crear o modificar códigos si tiene permisos de escritura. -### ¿Qué ocurre con mis datos? +### ¿Qué ocurre con mis datos? {#what-happens-to-my-data} - Todos los datos permanecen **almacenados localmente en su ordenador**, en el proyecto QualCoder actual. Las operaciones de búsqueda mencionadas también se ejecutan localmente. - El **modelo de IA solo ve la parte de los datos** (por ejemplo, resultados de búsqueda o pasajes concretos) necesaria para el análisis en curso. Estos fragmentos de datos se envían al modelo de IA junto con la tarea correspondiente. - En sus respuestas, el agente de IA documenta detalladamente los datos en los que basa sus análisis. QualCoder convierte estas referencias en **enlaces a las fuentes con números de línea.** Al hacer clic en una referencia, se abre el pasaje en su contexto original. -## Cuatro formas de iniciar una conversación con el agente +## Cuatro formas de iniciar una conversación con el agente {#four-ways-to-start-a-conversation-with-the-agent} ![Cuatro puntos de partida: una pregunta abierta, un tema, un fragmento de texto y un código o una categoría](../../images/ai-agent-conversation-paths-es.png) @@ -126,7 +126,7 @@ En la esquina inferior izquierda de la ventana del agente de IA, puede iniciar u Estas opciones simplemente ofrecen **distintos puntos de partida** para el análisis. Después puede orientar la conversación en cualquier dirección que desee. -### 1) Nuevo chat abierto +### 1) Nuevo chat abierto {#1-new-open-chat} Esta es la forma más flexible de iniciar un nuevo análisis con el agente. Comience con una idea o una pregunta abierta, o indique los códigos o pasajes que desea investigar. @@ -152,7 +152,7 @@ Esta es la forma más flexible de iniciar un nuevo análisis con el agente. Comi Para incorporar **prompts predefinidos o sus propios prompts** de la [Biblioteca de prompts de IA](./6.2.-AI-Prompt-Library.md) a la conversación, utilice la notación con barra: por ejemplo, «/in-vivo-coding» insertaría en la conversación actual el prompt correspondiente que haya guardado previamente en la biblioteca. -### 2) Exploración temática +### 2) Exploración temática {#2-topic-exploration} Este análisis resulta especialmente útil para obtener una **primera visión de conjunto** de cómo se aborda un tema concreto en el material empírico. Para preguntas sencillas con temas bien delimitados, esta función también permite elaborar análisis de síntesis que pueden utilizarse directamente como base para un informe. @@ -169,7 +169,7 @@ Este análisis resulta especialmente útil para obtener una **primera visión de > > **Resultado:** Un análisis comparativo de Ethel y Flora sobre el tema «Criar hijos en tiempos de guerra», estructurado en torno a las tres subpreguntas. -### 3) Análisis de texto +### 3) Análisis de texto {#3-text-analysis} - Permite un **análisis detallado de un pasaje seleccionado, centrado en el texto,** con el agente de IA. - Desarrolle conjuntamente nuevas lecturas y propuestas de códigos, o discuta ambivalencias, incertidumbres y cuestiones de interpretación pendientes. @@ -190,7 +190,7 @@ También puede guardar sus propias instrucciones para el análisis de texto en l > d) A continuación comienza una **conversación sobre el material**, en la que exploran y discuten conjuntamente distintas interpretaciones posibles. > e) **Guarde los resultados:** Cuando termine, indique al agente de IA que guarde un resumen de los resultados como anotación de texto. -### 4) Análisis de códigos +### 4) Análisis de códigos {#4-code-analysis} - Analiza todos los **datos reunidos bajo un código o una categoría concretos,** incluidos los subcódigos. - Discuta sus codificaciones con el agente de IA, compare distintos códigos, cree subcódigos o elabore informes. @@ -209,14 +209,14 @@ También puede crear sus propios prompts para esta función en la [Biblioteca de > > **Resultado:** Un informe detallado sobre la «saturación teórica» del código actual o de la categoría seleccionada en el sentido de la teoría fundamentada. El agente de IA busca activamente en el material variantes aún no codificadas del fenómeno recogido por el código, casos límite y contraejemplos, para evaluar la saturación empírica y conceptual/teórica del código y detectar lagunas. También se tiene en cuenta el memo del código. -## Reflexión final: la cuestión de la antropomorfización +## Reflexión final: la cuestión de la antropomorfización {#a-final-reflection-on-anthropomorphism} Decidimos deliberadamente no dar un nombre al agente de IA de QualCoder, como «Claude» de Anthropic. Sin embargo, el enfoque de integración de IA mediante el diálogo en QualCoder escenifica una especie de pseudointeracción que, en muchos aspectos, sigue patrones de interacción humana, por ejemplo, dentro de un equipo de investigación. En su [prompt de sistema fundamental](https://github.com/ccbogel/QualCoder/blob/master/src/qualcoder/ai_prompts/_agent.md), al agente de IA de QualCoder se le asigna precisamente ese papel de una especie de miembro del equipo. ¿Estamos, por tanto, antropomorfizando una máquina al interactuar con ella como si fuera una persona que investiga? En cierta medida, sí. Pero me parece más útil considerar estas interacciones como una especie de «juego de rol», tal como propusieron [Shanahan, McDonell & Reynolds 2023](https://www.nature.com/articles/s41586-023-06647-8). Los modelos de lenguaje actuales se entrenan con interacciones lingüísticas humanas. Por eso funcionan mejor cuando se integran en ese tipo de situaciones de interacción. No obstante, un uso de la IA basado en la reflexión metodológica dentro de la investigación social cualitativa exige recordar que estamos participando en un juego de rol inducido por la tecnología, no interactuando con un interlocutor humano. -## Otras funciones +## Otras funciones {#further-functions} - En la **[Biblioteca de prompts de IA](./6.2.-AI-Prompt-Library.md)**, puede guardar estrategias de análisis y enfoques metodológicos que hayan demostrado su utilidad como instrucciones reutilizables. - La **[Codificación asistida por IA](./4.2.-AI-Assisted-Coding.md)**, en el espacio «Codificar texto», utiliza una búsqueda basada en IA para ayudarle a encontrar pasajes relevantes para un código concreto en todo el corpus. -- Si tiene **preguntas sobre el uso de QualCoder**, el agente de IA también puede ayudarle, ofreciendo respuestas basadas en la documentación de QualCoder. Seleccione *Ayuda > Preguntar al agente de IA* en el menú principal. +- Si tiene **preguntas sobre el uso de QualCoder**, el agente de IA también puede ayudarle, ofreciendo respuestas basadas en la documentación de QualCoder. Seleccione *Ayuda > Preguntar al agente de IA* en el menú principal. \ No newline at end of file diff --git a/docs/doc/es/5.2.-Journals.md b/docs/doc/es/5.2.-Journals.md index e2f0ce51..c06db614 100644 --- a/docs/doc/es/5.2.-Journals.md +++ b/docs/doc/es/5.2.-Journals.md @@ -21,7 +21,7 @@ Puede ordenar los diarios por nombre o por fecha. Puede añadir atributos a los La ventana de diarios será flotante, de modo que pueda introducir notas mientras codifica o genera informes. -## Resaltar el texto del diario con markdown +## Resaltar el texto del diario con markdown {#highlight-journal-text-using-markdown} Hay algo de markdown disponible para resaltar palabras en un diario. Use de uno a tres símbolos de almohadilla para los niveles de encabezado. Un asterisco simple rodeando las palabras para texto en cursiva. Doble asterisco rodeando el texto para texto en negrita. diff --git a/docs/doc/es/5.3.-Reports.md b/docs/doc/es/5.3.-Reports.md index 9349c7f1..1f8219bc 100644 --- a/docs/doc/es/5.3.-Reports.md +++ b/docs/doc/es/5.3.-Reports.md @@ -19,7 +19,7 @@ path: 5.3.-Reports * Gráficos (mostrar gráficos estadísticos y de otro tipo en un navegador web) * Consultas de base de datos (consulta de la base de datos, incluidas las consultas predeterminadas) -## Informes de codificación +## Informes de codificación {#informes-de-codificacion} Este informe ofrece una lista, o matriz, de datos codificados según sus selecciones. Es necesario seleccionar uno o más códigos. Si se selecciona una categoría, también se seleccionan todos los códigos de esa categoría. Se pueden seleccionar varias categorías usando el ratón y la tecla 'ctrl'. @@ -32,16 +32,16 @@ Los resultados de codificación pueden acotarse usando los botones de selección Si se introduce texto en el campo Search text, solo se presentarán las codificaciones que contengan el texto coincidente. El texto de búsqueda también busca coincidencias en los memos de las áreas de imagen codificadas y de los segmentos de audio o video codificados. La función de texto de búsqueda debe usarse en combinación con la selección de archivos, la selección de casos o la selección de atributos. -## Texto, imágenes y segmentos codificados importantes +## Texto, imágenes y segmentos codificados importantes {#texto-imagenes-y-segmentos-codificados-importantes} Hay una casilla para seleccionar únicamente las codificaciones marcadas como Important. Esto resulta útil para encontrar rápidamente aquellos ejemplos ilustrativos importantes que pueda usar en un informe escrito. -## Selección de atributos en los informes +## Selección de atributos en los informes {#seleccion-de-atributos-en-los-informes} El botón de selección de atributos abre una ventana donde puede seleccionar atributos de archivos y casos, por ejemplo: solo los archivos de entrevistas de personas de más de 60 años. Además, la configuración de atributos puede guardarse, cargarse y eliminarse. ![Attribute selection](/images/8d349854-7e35-474b-8bba-119b23ed40b0.png) -## Matriz de codificación +## Matriz de codificación {#matriz-de-codificacion} Si está creando un informe y selecciona una de las opciones de matriz, el panel de resultados se dividirá en dos paneles. El panel izquierdo muestra los datos codificados en una lista y el panel derecho muestra una matriz de filas y columnas. Los tipos de columna pueden ser códigos, categorías o categorías de nivel superior. Opciones de matriz: tener códigos o categorías por archivo o por caso. La matriz puede transponerse usando la casilla correspondiente. @@ -54,18 +54,18 @@ Los informes pueden exportarse a archivos de texto, OpenDocument (ODT), HTML o c _Cuando se seleccionan casos, se muestra otro panel con una tabla de casos (en las filas) y categorías o códigos en las columnas_ -## Casillas de verificación +## Casillas de verificación {#casillas-de-verificacion} * Casilla para mostrar solo los segmentos codificados que se han marcado como importantes. * Casilla para añadir estadísticas de resumen al informe. * Casilla para el contexto textual de los segmentos de texto codificados. Esto muestra los 100 a 300 caracteres de texto circundantes (definidos en la Configuración) para ayudar a situar en contexto la sección codificada en los resultados. El segmento de texto codificado se muestra en negrita. * Casilla para añadir una referencia al resultado codificado. Esto es válido si se ha importado una referencia y se ha vinculado al archivo concreto. -## Otras funciones +## Otras funciones {#otras-funciones} * Atajo H. Presionar h ocultará y volverá a mostrar la sección superior de controles de la ventana. -### Memos +### Memos {#memos} * Visualización de memos. Una lista desplegable ofrece opciones para no incluir memos, para incluir diversas opciones de memo, o para mostrar las anotaciones de los archivos de texto seleccionados. @@ -73,7 +73,7 @@ Haga clic derecho en un encabezado de código del informe generado para obtener ![image](/images/a6d29ccf-2d9f-4faf-a1a6-5aaf3498e9a9.png) -### Exportar informes +### Exportar informes {#exportar-informes} Los informes pueden exportarse como html, odt, txt, csv, xlsx y (en 3.8+) iramuteq. @@ -92,7 +92,7 @@ Los informes pueden exportarse como html, odt, txt, csv, xlsx y (en 3.8+) iramut ![image](/images/998a1792-38b1-489e-a459-200819bbbf73.png) -## Informe de comparación de codificación +## Informe de comparación de codificación {#informe-de-comparacion-de-codificacion} Esta opción muestra las similitudes y diferencias generales entre dos codificadores en todos los archivos de texto. Seleccione dos codificadores y haga clic en el botón de ejecutar comparaciones. Las estadísticas que se generan aquí son solo para texto codificado, no para imágenes ni archivos multimedia codificados. Para cada código: @@ -113,7 +113,7 @@ El Kappa de Cohen se calcula con base en la información de [Wikipedia](https:// Botones para ejecutar las comparaciones, para borrar los codificadores seleccionados, para exportar a Excel y para abrir una ventana de ayuda sobre las estadísticas. -## Informe de comparación de codificación por archivo +## Informe de comparación de codificación por archivo {#informe-de-comparacion-de-codificacion-por-archivo} Esta opción muestra las similitudes y diferencias generales entre dos codificadores en UN archivo seleccionado. Seleccione un archivo, un código y dos codificadores. Luego haga clic en el botón de ejecutar comparaciones. Las estadísticas y comparaciones para segmentos codificados de audio y video están en desarrollo. El acuerdo general, el desacuerdo y el Kappa de Cohen se calculan para texto e imágenes. Un archivo de imagen se muestra en una ventana aparte, presentando las selecciones de los dos codificadores en áreas enmarcadas en amarillo o azul. El texto en verde indica dónde ambos codificadores codificaron la misma sección de texto. Al pasar el ratón se proporciona información adicional. @@ -121,13 +121,13 @@ El acuerdo general, el desacuerdo y el Kappa de Cohen se calculan para texto e i ![image](/images/cd5eff94-2cc0-4988-af48-da12f55bfc48.png) -## Informe de frecuencias de códigos +## Informe de frecuencias de códigos {#informe-de-frecuencias-de-codigos} Esta ventana muestra todos los códigos y categorías y la frecuencia de uso de cada codificador. Las frecuencias de códigos pueden seleccionarse para archivos concretos. ![Code frequencies](/images/19a1170f-4b46-4055-be79-027e824e3277.png) -## Informe de relaciones entre códigos +## Informe de relaciones entre códigos {#informe-de-relaciones-entre-codigos} Este diálogo muestra las relaciones entre dos o más códigos. Solo puede aplicarse a archivos de texto. Seleccione dos o más códigos y presione el botón Calculate. @@ -151,7 +151,7 @@ Pueden generarse estadísticas de resumen y diagramas de caja. ![image](/images/a04d7b62-506b-4f05-ba62-5394e5f09748.png) -## Informe de coocurrencia de códigos +## Informe de coocurrencia de códigos {#informe-de-coocurrencia-de-codigos} Este informe muestra una tabla con los nombres de los códigos en los ejes x e y. Las celdas de la tabla muestran el conteo de coocurrencias de codificación. Esto ocurre cuando dos códigos se solapan o colindan directamente. Haga clic en la celda para mostrar los detalles de la codificación del texto. @@ -164,7 +164,7 @@ Al hacer clic en una celda se muestran los detalles del texto. En la versión 3.8 y posteriores, puede hacer clic derecho en una celda que contenga texto codificado en coocurrencia para crear un código fusionado nuevo que combine los dos códigos solapados. -## Informe de resumen de archivo +## Informe de resumen de archivo {#informe-de-resumen-de-archivo} Haga clic en un archivo para obtener un resumen de ese archivo. Describe los metadatos multimedia, los caracteres y la frecuencia de palabras. Los atributos. Resume el conteo de códigos de ese archivo. Las codificaciones de texto resumen la longitud media del texto. Para las codificaciones de imagen resume el área media en píxeles. Para las codificaciones de audio y video resume la duración media del segmento. @@ -172,7 +172,7 @@ A las 100 palabras más frecuentes se les aplican palabras vacías, de modo que ![File summary report](/images/73d17c0b-2dd4-4df8-ae16-abc8683ca171.png) -## Informe de resumen de código +## Informe de resumen de código {#informe-de-resumen-de-codigo} Haga clic en un código para obtener un resumen de ese código. Los codificadores que han usado el código. El número de codificaciones en texto, imagen y audio o video. Las codificaciones de texto resumen la longitud media del texto y las palabras más comunes. Para las codificaciones de imagen resume el área media en píxeles. Para las codificaciones de audio y video resume la duración media del segmento. @@ -180,14 +180,14 @@ A las 100 palabras más frecuentes se les aplican palabras vacías, de modo que ![Code summary report](/images/9a303fb2-bdfe-43a3-aa35-2034bd8c0abb.png) -## Informe de coincidencias exactas de texto codificado +## Informe de coincidencias exactas de texto codificado {#informe-de-coincidencias-exactas-de-texto-codificado} Este informe detalla todos los segmentos de texto codificados que coinciden exactamente, donde se han aplicado códigos distintos al mismo texto exacto. Seleccione documentos de texto y dos o más códigos. ![image](/images/284f388e-f561-416e-accb-ec18ad509944.png) -## Informe de códigos por segmentos de texto +## Informe de códigos por segmentos de texto {#informe-de-codigos-por-segmentos-de-texto} Este informe muestra filas de segmentos de texto codificados y columnas con el código que se ha aplicado. Para algunos usuarios, por ejemplo del ámbito jurídico, resulta conveniente ver qué códigos se han aplicado al mismo segmento de texto. @@ -196,7 +196,7 @@ Se puede exportar un archivo de Excel. ![image](/images/226f7c7d-f343-46d7-a2a7-49d86bfa3ef2.png) -## Gráficos +## Gráficos {#graficos} Hay disponibles diversos tipos de gráficos y opciones de filtro. @@ -245,7 +245,7 @@ Las palabras vacías que se usan actualmente están en stopwords.txt, en la carp ![Word Cloud](/images/wc.png) -## Consultas de base de datos +## Consultas de base de datos {#consultas-de-base-de-datos} Aplique sentencias SQL para consultar los datos. diff --git a/docs/doc/es/5.4.-Graph.md b/docs/doc/es/5.4.-Graph.md index ca178a9a..a603c57a 100644 --- a/docs/doc/es/5.4.-Graph.md +++ b/docs/doc/es/5.4.-Graph.md @@ -12,4 +12,4 @@ Al hacer clic derecho en una línea puede cambiar su grosor, pasar a un estilo d Se pueden mostrar texto codificado, imágenes codificadas y segmentos de A/V codificados. Los memos del texto codificado, las imágenes codificadas y los segmentos de A/V codificados pueden mostrarse en cuadros de texto. Cada uno de estos dispone de información sobre herramientas para ofrecer más detalles. No puede mostrar el mismo segmento codificado varias veces en el grafo. -Los grafos pueden guardarse, cargarse y eliminarse. Los grafos pueden exportarse como archivos PNG. +Los grafos pueden guardarse, cargarse y eliminarse. Los grafos pueden exportarse como archivos PNG. \ No newline at end of file diff --git a/docs/doc/es/6.1.-Imports-and-Exports.md b/docs/doc/es/6.1.-Imports-and-Exports.md index 62798387..b536fb9a 100644 --- a/docs/doc/es/6.1.-Imports-and-Exports.md +++ b/docs/doc/es/6.1.-Imports-and-Exports.md @@ -8,17 +8,17 @@ Menú Project * Exports * Imports -## Exportar el libro de códigos +## Exportar el libro de códigos {#exportar-el-libro-de-codigos} Esta es una opción del menú Project > Exports. Un libro de códigos es una lista de sus códigos. El memo de cada código debería detallar las razones de la finalidad de cada código. El libro de códigos puede exportarse a un archivo de texto. El libro de códigos también muestra la frecuencia de uso de los códigos (de todos los codificadores). Como los códigos y las categorías se disponen en una estructura de árbol, el doble guion '–' indica los códigos y categorías subordinados dentro de una categoría. -## Importar el libro de códigos +## Importar el libro de códigos {#importar-el-libro-de-codigos} Importe un libro de códigos como archivo de texto plano (.txt) o como archivo .csv. Use dos símbolos de mayor que para separar categoría y código. -### Texto plano +### Texto plano {#texto-plano} Use el tabulador para añadir luego un memo. ``` @@ -31,7 +31,7 @@ category1>>code3 category3>>code4 ``` -### CSV +### CSV {#csv} Las categorías y los códigos van en la primera columna. Los memos de los códigos, si los hay, van en la segunda columna. ``` @@ -42,7 +42,7 @@ category1>>category2>>code2 category3>>code3 ``` -## REFI-QDA +## REFI-QDA {#refi-qda} [Rotterdam Exchange Format Initiative (REFI)](https://www.qdasoftware.org) es un estándar abierto para exportar e importar libros de códigos y proyectos desde y hacia distintos programas de análisis cualitativo de datos asistido por computadora. Actualmente, QualCoder puede importar un libro de códigos siempre que use la versión "urn:QDA-XML:codebook:1.0". QualCoder exporta también en esta versión. @@ -59,21 +59,21 @@ Si no se ve ningún dato codificado, puede que necesite cambiar el nombre del co Esto ya es antiguo (febrero de 2021), pero un usuario probó la importación de un archivo de proyecto REFI-QDA generado por QualCoder e importado en MAXQDA, Quirkos y Atlas.ti. Solo se probaron texto e imágenes. Aquí hay un PDF con los resultados de la prueba: [Testing importation of REFI-QDA Project files into Atlas, MAXQDA, Quirkos PDF](https://qualcoder.files.wordpress.com/2021/02/refi-qda-project-import-quirkos-maxqda-atlas.pdf) -## RQDA +## RQDA {#rqda} Los proyectos creados con [RQDA](http://rqda.r-forge.r-project.org/) pueden importarse directamente. Se importan todos los datos salvo las categorías de archivos. Cierre cualquier proyecto abierto. Luego, en el menú principal, en Project, haga clic en RQDA Project import. Se le pedirá crear un proyecto nuevo, así que introduzca un nombre. Después se le pedirá seleccionar el archivo de proyecto de RQDA. QualCoder importará entonces los datos. Si no se ve ningún dato codificado, puede que necesite cambiar el nombre del codificador actual en la Configuración. Pruebe con la lista desplegable de nombres de codificador. -## Taguette +## Taguette {#taguette} Los proyectos creados con [Taguette](https://www.taguette.org/) pueden importarse directamente. Todos sus datos básicos de codificación se transferirán. Cierre cualquier proyecto abierto. Luego, en el menú principal, en Project, haga clic en Taguette Project import. Se le pedirá crear un proyecto nuevo, así que introduzca un nombre. Después se le pedirá seleccionar el archivo de proyecto de Taguette (normalmente con extensión .sqlite3). QualCoder procederá entonces a importar los datos. Si no ve ningún dato codificado, puede que necesite cambiar el nombre del codificador actual en la Configuración. Pruebe usando la lista desplegable de nombres de codificador. -## Importar una encuesta +## Importar una encuesta {#importar-una-encuesta} Esto requiere un archivo CSV o de Excel (formato xlsx). Puede probar a importar el archivo survey.csv de la carpeta Examples. @@ -105,7 +105,7 @@ La opción predeterminada es que cada respuesta cualitativa de cada fila se alma Al hacer clic en el botón OK, se añadirán los casos y sus atributos. -### Versiones anteriores de QualCoder, por ejemplo QualCoder 3.5. +### Versiones anteriores de QualCoder, por ejemplo QualCoder 3.5. {#versiones-anteriores-de-qualcoder-por-ejemplo-qualcoder-35} Cada respuesta a una pregunta cualitativa se añadía a UN único archivo de texto. Antes de la respuesta había texto adicional añadido por QualCoder para indicar a qué caso correspondía la respuesta. Con este formato: _[unique id] The qualitative text._ @@ -115,7 +115,7 @@ Abra Manage Files, luego visualice ese archivo y verá el texto de asignación a ![image](/images/5c05347a-731b-40d8-943f-921409447403.png) -## Importar bibliografía +## Importar bibliografía {#importar-bibliografia} Importe una bibliografía. Debe estar en texto plano con formato RIS. El archivo puede tener extensión .txt o .ris @@ -134,13 +134,13 @@ Aquí habrá cuatro columnas de atributos nuevas: Ref_Authors, Ref_Title, Ref_Ty Los archivos vinculados a referencias tendrán detalles en esas columnas. -## Ayuda - Funciones especiales +## Ayuda - Funciones especiales {#ayuda-funciones-especiales} -### Actualización dinámica del contenido de texto +### Actualización dinámica del contenido de texto {#actualizacion-dinamica-del-contenido-de-texto} Esto es útil para actualizar archivos de texto, como extractos de entradas de blog, que cambian con el tiempo. Actualiza un archivo de texto intentando conservar los segmentos de texto codificados existentes. Seleccione el archivo de texto que debe reemplazarse y seleccione el archivo de reemplazo. Haga clic en el botón de los engranajes para ejecutar la actualización. Esta función opera localizando el texto idéntico coincidente en el archivo de reemplazo a medida que recorre el texto del archivo. Puede producir segmentos codificados de forma errónea. -### Fusionar proyectos de QualCoder +### Fusionar proyectos de QualCoder {#fusionar-proyectos-de-qualcoder} Seleccione un proyecto de QualCoder para fusionarlo (proyecto de origen) en el proyecto actualmente abierto (proyecto de destino), y luego haga clic en el botón de engranajes _Run merge projects_. **Antes de realizar la fusión, haga una copia de seguridad del proyecto de destino.** diff --git a/docs/doc/es/6.2.-AI-Prompt-Library.md b/docs/doc/es/6.2.-AI-Prompt-Library.md index 10f13583..c51a1431 100644 --- a/docs/doc/es/6.2.-AI-Prompt-Library.md +++ b/docs/doc/es/6.2.-AI-Prompt-Library.md @@ -10,7 +10,7 @@ path: 6.2.-AI-Prompt-Library - Ya hemos incluido algunos prompts interesantes de otros investigadores cualitativos que se han publicado en distintos lugares. Esperamos que el uso creciente de la IA en la investigación cualitativa vaya acompañado de una cultura de desarrollo, intercambio y discusión de prompts sofisticados en la comunidad científica, para que todos podamos aprender unos de otros y mejorar los nuevos métodos emergentes en el campo. -## La estructura de un prompt +## La estructura de un prompt {#la-estructura-de-un-prompt} En un sentido muy básico, un "prompt" es como la pregunta que se escribe en la interfaz web de ChatGPT. Pero incluso en ese caso es algo más complejo. En segundo plano, ChatGPT acompañará su pregunta con un "prompt de sistema" invisible que indica a la IA que sea un asistente útil y servicial, que no dé consejos médicos ni legales, etc. @@ -27,7 +27,7 @@ Esta estructura consta de - **datos empíricos** (aquí en amarillo), seleccionados de diversas maneras, y - el **prompt analítico** (mostrado en naranja), que usted puede modificar y adaptar a sus necesidades. -## Prompts analíticos +## Prompts analíticos {#prompts-analiticos} Los prompts analíticos son el **núcleo de las funciones de IA de QualCoder.** Indican a la IA cómo analizar sus datos. Estas instrucciones pueden ser bastante simples, pero también pueden convertirse en directrices complejas con descripciones detalladas de cada paso que la IA debe realizar durante el análisis, incluido el trasfondo metodológico, etc. (vea Lieder & Schäffer, 2024).1 diff --git a/docs/doc/es/7.2.-QualCoder-Video-Tutorials.md b/docs/doc/es/7.2.-QualCoder-Video-Tutorials.md index fb29e10e..3d7cea3c 100644 --- a/docs/doc/es/7.2.-QualCoder-Video-Tutorials.md +++ b/docs/doc/es/7.2.-QualCoder-Video-Tutorials.md @@ -4,7 +4,7 @@ path: 7.2.-QualCoder-Video-Tutorials # Videos que muestran cómo usar QualCoder -## QualCoder 3.7 +## QualCoder 3.7 {#qualcoder-37} [QualCoder 3.7 parte 1 - Colin Curtain](https://www.youtube.com/watch?v=TCLCT893JcM) @@ -20,13 +20,13 @@ path: 7.2.-QualCoder-Video-Tutorials [Alpha version of 3.7 compared with other qualitative software - Van Tran](https://www.youtube.com/watch?v=Cqwu3mjJJHg) -## QualCoder 3.6 +## QualCoder 3.6 {#qualcoder-36} [Webinar: KI-unterstütze Datenanalyse in QualCoder 3 .6 - En alemán](https://www.youtube.com/watch?v=JF64vbngedA) [Qualitativ Forschen - AI-based horizontal coding](https://www.youtube.com/watch?v=FrQyTOTJhCc) -## QualCoder 3.5 +## QualCoder 3.5 {#qualcoder-35} [Tutorial, por Colin Curtain](https://www.youtube.com/watch?v=wj5fY4F5Jxo) @@ -37,6 +37,6 @@ path: 7.2.-QualCoder-Video-Tutorials [Qualcoder - Data Hub Tool Talk - University of Idaho](https://www.youtube.com/watch?v=119k-jNOl8I) -## Tutoriales más antiguos +## Tutoriales más antiguos {#older-tutorials} Los tutoriales más antiguos pueden encontrarse en YouTube. \ No newline at end of file diff --git a/docs/doc/es/7.3.-QualCoder-Development.md b/docs/doc/es/7.3.-QualCoder-Development.md index 2326c4a0..cafa4190 100644 --- a/docs/doc/es/7.3.-QualCoder-Development.md +++ b/docs/doc/es/7.3.-QualCoder-Development.md @@ -4,7 +4,7 @@ path: 7.3.-QualCoder-Development # Desarrollo de QualCoder -## Estructuras de datos +## Estructuras de datos {#estructuras-de-datos} La carpeta de datos qda contiene carpetas para los documentos, imágenes y audio y video importados. También contiene la base de datos sqlite, llamada data.qda, para almacenar los datos de codificación. @@ -15,7 +15,7 @@ Cuando la IA está activada: hay una carpeta ai_data que contiene una base de da QualCoder está escrito en python 3 usando Qt6 para la interfaz gráfica. -## Uso +## Uso {#uso} Actualmente QualCoder se desarrolla en Windows 11. @@ -23,7 +23,7 @@ Actualmente QualCoder se desarrolla en Windows 11. Algunos planes posibles para el futuro consisten en añadir funcionalidad: -### Informes: +### Informes: {#informes} **Estudiar formas alternativas de visualizar los códigos:** @@ -33,7 +33,7 @@ Algunos planes posibles para el futuro consisten en añadir funcionalidad: * Quizá añadir una forma de mostrar la codificación de los documentos en una línea de tiempo, a partir de un atributo de datos del archivo creado por el usuario final. -### General: +### General: {#general} * Soporte multilingüe: se necesita revisar las traducciones al chino y al japonés @@ -53,4 +53,4 @@ Se recomienda una resolución mínima de pantalla de 1024x600 píxeles. QualCoder se ha utilizado en Ubuntu 24, Fedora, Linux Mint, Arch Linux, Fedora, Windows 10, Windows 11 y MacOS. El desarrollo se realiza en Windows 11. Fedora puede tener problemas con el uso de audio y video: esto aún no se ha resuelto. -A veces, para las distintas distribuciones de Linux, pueden ser necesarias instrucciones de instalación diferentes. No tenemos capacidad para identificarlas y corregirlas, y dependemos de los usuarios finales para obtener comentarios o instrucciones mejoradas que resuelvan estos problemas. +A veces, para las distintas distribuciones de Linux, pueden ser necesarias instrucciones de instalación diferentes. No tenemos capacidad para identificarlas y corregirlas, y dependemos de los usuarios finales para obtener comentarios o instrucciones mejoradas que resuelvan estos problemas. \ No newline at end of file diff --git a/docs/doc/es/7.4.-SQlite-Data-Structure.md b/docs/doc/es/7.4.-SQlite-Data-Structure.md index 982b3ef6..a4e968f3 100644 --- a/docs/doc/es/7.4.-SQlite-Data-Structure.md +++ b/docs/doc/es/7.4.-SQlite-Data-Structure.md @@ -8,7 +8,7 @@ Se describe la estructura de datos actual v8 para ayudar en el desarrollo de con Las tablas se listan alfabéticamente. -## Tabla: annotation +## Tabla: annotation {#table-annotation} **anid** _integer_ Autonumeración única @@ -24,7 +24,7 @@ Las tablas se listan alfabéticamente. **date** _text_ La fecha y hora en que se creó la entrada, formato `yyyy-mm-dd hh:mm:ss` -## Tabla: attribute +## Tabla: attribute {#table-attribute} **attrid** _integer_ Autonumeración única. @@ -40,7 +40,7 @@ Las tablas se listan alfabéticamente. **date** _text_ La fecha y hora en que se creó la entrada, formato `yyyy-mm-dd hh:mm:ss` -## Tabla: attribute_type +## Tabla: attribute_type {#table-attribute-type} **name** _text_ El nombre único del atributo. @@ -54,7 +54,7 @@ Las tablas se listan alfabéticamente. **valuetype** _text_ Es 'character' o 'numeric' -## Tabla: case_text +## Tabla: case_text {#table-case-text} **id** _integer_ Autonumeración única. @@ -72,7 +72,7 @@ Las tablas se listan alfabéticamente. **date** _text_ La fecha y hora en que se creó la entrada, formato `yyyy-mm-dd hh:mm:ss` -## Tabla: cases +## Tabla: cases {#table-cases} **caseid** _integer_ Autonumeración única. @@ -84,7 +84,7 @@ Las tablas se listan alfabéticamente. **date** _text_ La fecha y hora en que se creó la entrada, formato `yyyy-mm-dd hh:mm:ss` -## Tabla: code_av +## Tabla: code_av {#table-code-av} **avid** _integer_ Autonumeración única. @@ -104,7 +104,7 @@ Las tablas se listan alfabéticamente. **important** _integer_ Si tiene asignado 1 es un código importante. -## Tabla: code_cat +## Tabla: code_cat {#table-code-cat} **catid** _integer_ Autonumeración única. @@ -118,7 +118,7 @@ Las tablas se listan alfabéticamente. **supercatid** _integer_ Representa la categoría madre de esta categoría. Es Null si es una categoría de nivel superior. -## Tabla: code_image +## Tabla: code_image {#table-code-image} **imgid** _integer_ Autonumeración única. @@ -144,7 +144,7 @@ Las tablas se listan alfabéticamente. **pdf_page** _integer_ Null o un número que representa la página del pdf -## Tabla: code_name +## Tabla: code_name {#table-code-name} **cid** _integer_ Autonumeración única. @@ -160,7 +160,7 @@ Las tablas se listan alfabéticamente. **color** _text_ Un valor hexadecimal que va de '#000000' a '#FFFFFF' QualCoder reconoce 120 colores, de modo que puede aplicar texto claro u oscuro encima. -## Tabla: code_text +## Tabla: code_text {#table-code-text} **ctid** _integer_ Autonumeración única. (añadido en v3). @@ -184,7 +184,7 @@ Las tablas se listan alfabéticamente. **important** _integer_ Si tiene asignado 1 es un código importante. -## Tabla: journal +## Tabla: journal {#table-journal} **jid** _integer_ Autonumeración única. @@ -196,7 +196,7 @@ Las tablas se listan alfabéticamente. **date** _text_ La fecha y hora en que se creó la entrada, formato `yyyy-mm-dd hh:mm:ss` -## Tabla: project +## Tabla: project {#table-project} Debería contener una sola fila. @@ -216,7 +216,7 @@ Debería contener una sola fila. **recently_used_codes** _text_ Contiene los code_ids de los códigos de texto usados recientemente, delimitados por espacios. -## Tabla: source +## Tabla: source {#table-source} **id** _integer_ Autonumeración única. @@ -244,7 +244,7 @@ Si mediapath comienza con: '/images/' , '/audio/', '/video/' el archivo de image Si mediapath comienza con: 'images:' , 'audio:', 'video:' el archivo de imagen, audio o video está vinculado externamente. Se almacena la ruta completa al archivo. -## Tabla: stored_sql +## Tabla: stored_sql {#table-stored-sql} **title** _text_ El título de la sql. @@ -254,7 +254,7 @@ Si mediapath comienza con: 'images:' , 'audio:', 'video:' el archivo de imagen, **ssql** _text_ La sql generada por el usuario. -## Tabla: ris +## Tabla: ris {#table-ris} Se usa para la bibliografía RIS @@ -266,11 +266,11 @@ Se usa para la bibliografía RIS **value** _text_ datos de texto de la etiqueta. -## Tablas de visualización del grafo +## Tablas de visualización del grafo {#graph-visualisation-tables} Varias tablas para almacenar los detalles de los grafos guardados y luego los elementos dentro de los grafos. -## Tabla: graph +## Tabla: graph {#table-graph} **grid** _integer_ Identificador único. @@ -284,7 +284,7 @@ Varias tablas para almacenar los detalles de los grafos guardados y luego los el **scene_height** _integer_ Se usa para establecer el tamaño de la escena al cargar. -## Tabla: gr_av_item +## Tabla: gr_av_item {#table-gr-av-item} Muestra un icono de flecha para un segmento de A/V codificado reproducible. @@ -308,7 +308,7 @@ Muestra un icono de flecha para un segmento de A/V codificado reproducible. **color** text -## Tabla: gr_case_text_item +## Tabla: gr_case_text_item {#table-gr-case-text-item} Muestra los detalles del caso, con parámetros de formato. @@ -330,7 +330,7 @@ Muestra los detalles del caso, con parámetros de formato. **displaytext** text -## Tabla: gr_cdct_line_item +## Tabla: gr_cdct_line_item {#table-gr-cdct-line-item} Muestra la línea que enlaza códigos y categorías @@ -354,7 +354,7 @@ Muestra la línea que enlaza códigos y categorías **isvisible** integer -## Tabla: gr_cdct_text_item +## Tabla: gr_cdct_text_item {#table-gr-cdct-text-item} Muestra texto codificado con algunos parámetros de formato. @@ -380,7 +380,7 @@ Muestra texto codificado con algunos parámetros de formato. **displaytext** text -## Tabla: gr_file_text_item +## Tabla: gr_file_text_item {#table-gr-file-text-item} Muestra los detalles del archivo con parámetros de formato. @@ -402,7 +402,7 @@ Muestra los detalles del archivo con parámetros de formato. **displaytext** text -## Tabla: gr_free_line_item +## Tabla: gr_free_line_item {#table-gr-free-line-item} Muestra un enlace de línea definido por el usuario entre objetos @@ -426,7 +426,7 @@ Muestra un enlace de línea definido por el usuario entre objetos **isvisible** integer -## Tabla: gr_free_text_item +## Tabla: gr_free_text_item {#table-gr-free-text-item} Muestra texto libre, o memos, con parámetros de formato. @@ -458,7 +458,7 @@ Muestra texto libre, o memos, con parámetros de formato. **memo_avid** integer -## Tabla: gr_pix_item +## Tabla: gr_pix_item {#table-gr-pix-item} Muestra la imagen codificada. @@ -484,4 +484,4 @@ Muestra la imagen codificada. **tooltip** text -**pdf_page** integer - si es una imagen de un pdf +**pdf_page** integer - si es una imagen de un pdf \ No newline at end of file diff --git a/docs/doc/es/7.5.-AI-Technical-Information.md b/docs/doc/es/7.5.-AI-Technical-Information.md index a64e85df..792621f5 100644 --- a/docs/doc/es/7.5.-AI-Technical-Information.md +++ b/docs/doc/es/7.5.-AI-Technical-Information.md @@ -4,4 +4,4 @@ path: 7.5.-AI-Technical-Information # Información técnica sobre la IA -(Se actualizará más adelante). +(Se actualizará más adelante). \ No newline at end of file diff --git a/docs/doc/es/7.6.-How-to-contribute.md b/docs/doc/es/7.6.-How-to-contribute.md index 63deca51..94666b97 100644 --- a/docs/doc/es/7.6.-How-to-contribute.md +++ b/docs/doc/es/7.6.-How-to-contribute.md @@ -4,18 +4,18 @@ path: 7.6.-How-to-contribute.md # Cómo contribuir -## Contribuir al código +## Contribuir al código {#contributing-to-the-code} Por favor, lea las [pautas de contribución](https://github.com/ccbogel/QualCoder/blob/master/docs/CONTRIBUTING.md). -### Reglas clave en resumen +### Reglas clave en resumen {#key-rules-at-a-glance} - **Elige primero una incidencia (issue).** Busca una incidencia existente o crea una, y comenta en ella antes de abrir una Pull Request. Espera a que la incidencia te sea asignada antes de empezar a trabajar. - **Una Pull Request, un solo commit.** Reúne tu trabajo en un único commit con un mensaje descriptivo que refleje tus cambios. - **Nomenclatura.** Crea una rama dedicada, con un nombre relacionado con la incidencia que abordes. - **Licencia.** Al enviar una Pull Request, tu contribución se publica bajo la licencia LGPLv3 del proyecto («Inbound = Outbound»). -### Contribuciones asistidas por IA +### Contribuciones asistidas por IA {#ai-assisted-contributions} Puedes usar herramientas de IA para asistir tus contribuciones, pero sigues siendo el único responsable de todo lo que envíes. @@ -27,12 +27,12 @@ Puedes usar herramientas de IA para asistir tus contribuciones, pero sigues sien Las herramientas de IA **no** deben usarse para corregir incidencias etiquetadas como `good first issue`. Existen para el aprendizaje humano. -## Contribuir a la traducción -### Traducir la documentación +## Contribuir a la traducción {#contribute-to-the-translation} +### Traducir la documentación {#translate-the-documentation} Puede traducir la documentación creando o modificando los archivos markdown en docs/doc del [repositorio del sitio web](https://github.com/QualCoder-Org/qualcoder-org.github.io). -### Traducir el software +### Traducir el software {#translate-the-software} QualCoder admite funcionalidad multilingüe mediante dos tipos de archivos de traducción: @@ -100,4 +100,4 @@ Para traducir: xgettext -d de -j de.po __main__.py add_attribute.py add_item_name.py ai_chat.py ai_llm.py ai_prompts.py ai_search_dialog.py ai_vectorstore.py attributes.py case_file_manager.py cases.py code_color_scheme.py code_text.py code_in_all_files.py code_organiser.py code_pdf.py codebook.py color_selector.py confirm_delete.py edit_textfile.py helpers.py import_survey.py import_twitter_data.py information.py journals.py manage_files.py manage_links.py manage_references.py memo.py merge_projects.py move_resize_rectangle.py pseudonyms.py refi.py report_attributes.py report_codes.py report_code_summary.py report_codes_by_segments.py report_compare_coder_file.py report_cooccurrence.py report_exact_matches.py report_file_summary.py report_relations.py reports.py report_sql.py rqda.py save_sql_query.py select_items.py settings.py special_functions.py text_mining.py view_av.py view_charts.py view_graph.py view_image.py After translating, save will produce a name.po and a name.mo file - ``` + ``` \ No newline at end of file diff --git a/docs/doc/es/index.md b/docs/doc/es/index.md index 7733b051..88517d8a 100644 --- a/docs/doc/es/index.md +++ b/docs/doc/es/index.md @@ -21,7 +21,7 @@ QualCoder incluye un conjunto de funciones asistidas por IA que utilizan grandes - **QualCoder puede modificarse**. Usted puede modificar y adaptar QualCoder a sus necesidades, siempre que publique sus cambios para todos. Esto también significa que puede copiar el software y entregárselo a sus colegas o estudiantes de forma gratuita. - **QualCoder es una opción de software para apoyar la ciencia abierta**. [Recomendaciones de la UNESCO sobre ciencia abierta](https://www.unesco.org/en/open-science?hub=686) -## Versión actual +## Versión actual {#current-release} Las versiones del software están disponibles en [Github](https://github.com/ccbogel/QualCoder/releases). Estas contienen el código fuente y los ejecutables. Los ejecutables son una forma sencilla de ejecutar QualCoder, haga doble clic para ejecutarlo, solo tenga en cuenta que puede tardar hasta 20 segundos en abrirse. @@ -37,7 +37,7 @@ Las versiones del software están disponibles en [Github](https://github.com/ccb El código en desarrollo está disponible aquí: [https://github.com/ccbogel/QualCoder](https://github.com/ccbogel/QualCoder) -## Apoye a QualCoder +## Apoye a QualCoder {#support-qualcoder} Si le gusta QualCoder y le resultó útil para su trabajo. Por favor deje una reseña en sitios como [Saashub](https://www.saashub.com/qualcoder-alternatives) o [AlternativeTo](https://alternativeto.net/software/qualcoder). @@ -49,12 +49,12 @@ Ha tomado muchísimas horas de trabajo crear este software que se ofrece de form QualCoder está escrito en python usando Qt6 para la interfaz gráfica. QualCoder se ha utilizado en Windows 11, macOS y varias distribuciones de Linux: Ubuntu, Lubuntu, ZorinOS, Arch, Fedora. -## Cita +## Cita {#citation} Curtain, C. Dröge, K. Missaghieh--Poncet, J. Salomón, L. (2025) QualCoder 3.8.2 [Computer software]. Recuperado de https://github.com/ccbogel/QualCoder/releases/tag/3.8.2 Reemplace el número de versión (3.8.2) según corresponda a la versión que esté utilizando. -## Licencia +## Licencia {#license} QualCoder se distribuye bajo la licencia LGPL v3. \ No newline at end of file diff --git a/docs/doc/fr/1.-Overview.md b/docs/doc/fr/1.-Overview.md index 46a49326..a09c5edc 100644 --- a/docs/doc/fr/1.-Overview.md +++ b/docs/doc/fr/1.-Overview.md @@ -5,20 +5,20 @@ path: 1.-Overview.md Les instructions décrivent comment installer et utiliser QualCoder. Les informations font référence à la version la plus récente de QualCoder. -## Qu’est-ce que QualCoder ? +## Qu’est-ce que QualCoder ? {#what-is-qualcoder} QualCoder est un logiciel gratuit et open source d’analyse de données qualitatives. Avec QualCoder, vous pouvez coder du texte, des images, de l’audio et de la vidéo, rédiger des notes de journal et des mémos. Vous pouvez organiser les codes dans un schéma hiérarchique en forme d’arbre. Vous pouvez produire de nombreux rapports. La plupart des rapports peuvent être exportés au format HTML, en OpenDocument Text (ODT), en texte brut ou en fichier Excel. -Dans les versions récentes, QualCoder inclut un ensemble de fonctionnalités assistées par IA utilisant GPT-4 ou d’autres grands modèles de langage pour explorer, analyser et interagir avec les données de manière innovante. Familiarisez-vous avec de nouvelles données en [explorant des sujets ou concepts larges](5.1.-AI-chat-based-analysis#topic-analysis-chat) via un chat interactif avec l’IA. Approfondissez des aspects spécifiques grâce au [codage assisté par IA](4.2.-AI-Assisted-Coding) et à [l’analyse de texte](5.1.-AI-chat-based-analysis#text-analysis-chat). Et si vous en arrivez au point où vous devez synthétiser et consolider vos résultats, [discutez-en dans un chat de codage](5.1.-AI-chat-based-analysis#code-analysis-chat) avec l’IA. +Dans les versions récentes, QualCoder inclut un ensemble de fonctionnalités assistées par IA utilisant GPT-4 ou d’autres grands modèles de langage pour explorer, analyser et interagir avec les données de manière innovante. Familiarisez-vous avec de nouvelles données en [explorant des sujets ou concepts larges](5.1.-AI-chat-based-analysis#2-topic-exploration) via un chat interactif avec l’IA. Approfondissez des aspects spécifiques grâce au [codage assisté par IA](4.2.-AI-Assisted-Coding) et à [l’analyse de texte](5.1.-AI-chat-based-analysis#3-text-analysis). Et si vous en arrivez au point où vous devez synthétiser et consolider vos résultats, [discutez-en dans un chat de codage](5.1.-AI-chat-based-analysis#4-code-analysis) avec l’IA. QualCoder est conçu pour être utilisé comme un logiciel client, par une seule personne à la fois (un deuxième codeur peut utiliser le même projet sur le même ordinateur, ou le dossier du projet peut être transféré sur l’ordinateur du deuxième codeur). QualCoder n’est pas conçu pour être utilisé simultanément par plusieurs personnes. L’accès au projet dans un espace cloud n’est pas recommandé, car cela peut corrompre la base de données si la connexion est perdue pendant une mise à jour de la base. -## Collaboration sur un projet QualCoder +## Collaboration sur un projet QualCoder {#collaboration-on-a-qualcoder-project} [Page sur le travail en équipe avec QualCoder](2.4.-Working-in-a-Team/) -## Dernière version +## Dernière version {#latest-release} [:octicons-archive-24: Télécharger la dernière version disponible sur GitHub](https://github.com/ccbogel/QualCoder/releases/latest){ .md-button .md-button--primary } @@ -26,7 +26,7 @@ QualCoder est conçu pour être utilisé comme un logiciel client, par une seule Veuillez noter que les fichiers exécutables QualCoder ne sont signés ni par Microsoft ni par macOS ; un message d’avertissement s’affichera donc lors de la première utilisation du fichier exécutable (cette procédure implique en effet des coûts financiers importants sur le long terme). Cliquez sur « Plus d’informations » et autorisez l’exécution. ![image](/images/12d00e05-3844-4b48-9dc9-ff657aa7382f.png) -## Logiciel en cours de développement +## Logiciel en cours de développement {#latest-code-software-under-development} [Télécharger la dernière version](https://github.com/ccbogel/QualCoder/archive/refs/heads/master.zip), dézipper et suivre les instructions d’installation dans le README. @@ -34,4 +34,4 @@ Le code est également disponible sur [Codeberg](https://codeberg.org/qualcoder) **Si vous utilisez et appréciez QualCoder, soutenez son développement.** -[![Buy Me A Coffee](/images/buymeacoffee-default-orange.png)](https://www.buymeacoffee.com/ccbogelB) +[![Buy Me A Coffee](/images/buymeacoffee-default-orange.png)](https://www.buymeacoffee.com/ccbogelB) \ No newline at end of file diff --git a/docs/doc/fr/2.1.-Installation.md b/docs/doc/fr/2.1.-Installation.md index 2082fde8..bec00743 100644 --- a/docs/doc/fr/2.1.-Installation.md +++ b/docs/doc/fr/2.1.-Installation.md @@ -4,11 +4,11 @@ path: 2.1.-Installation # Instructions d’installation et d’exécution -## Installation +## Installation {#installation} Pour les installations manuelles (via la ligne de commande ou le terminal), nous mentionnons la dernière version à jour. Veuillez vérifier sur la [page des versions](https://github.com/ccbogel/QualCoder/releases) pour obtenir la version la plus récente, qui peut être plus à jour. -### Prérequis +### Prérequis {#prerequisites} VLC est optionnel pour le codage audio/vidéo. De manière facultative, installez ffmpeg pour la visualisation du signal, voir [phoenixnap.com/kb/ffmpeg-windows](https://phoenixnap.com/kb/ffmpeg-windows). À noter que QualCoder plante sur Linux Fedora lorsqu'on tente d'afficher ou de coder du contenu audio/vidéo. === "Windows" @@ -248,4 +248,4 @@ VLC est optionnel pour le codage audio/vidéo. De manière facultative, installe Créez un fichier .desktop pour le lancement, entrez cette commande (adaptez-la en fonction de l’emplacement du dossier du code source) : - `bash -c 'cd ~/.local/share/qualcoder/src/ && ~/.local/share/qualcoder/env/bin/python3.12 -m qualcoder'` + `bash -c 'cd ~/.local/share/qualcoder/src/ && ~/.local/share/qualcoder/env/bin/python3.12 -m qualcoder'` \ No newline at end of file diff --git a/docs/doc/fr/2.2.-Settings.md b/docs/doc/fr/2.2.-Settings.md index d41d2646..47fd86df 100644 --- a/docs/doc/fr/2.2.-Settings.md +++ b/docs/doc/fr/2.2.-Settings.md @@ -9,14 +9,14 @@ La boîte de dialogue des paramètres permet de modifier plusieurs fonctionnalit ![image](/images/baec9b31-e0bd-4607-85c2-65e141f040d6.png) -### Nom de codeur⋅euse +### Nom de codeur⋅euse {#coder-name} Plusieurs codeur⋅euses peuvent coder et annoter le même texte. Votre nom de codeur⋅euse est affiché au-dessus de la fenêtre de configuration. ![image](/images/gh-04951ae2-c5ab-41e7-854f-dad9819183f4.png) Votre nom est utilisé pour identifier vos contributions au projet. Cliquez sur le bouton « Modifier » pour changer votre identité ou créer, renommer ou fusionner d’autres codeur⋅euses au sein du projet courant. Voir [Travailler en équipe](2.4.-Working-in-a-Team#important-considerations-regarding-coder-names) pour plus d’information. -### Configuration générale +### Configuration générale {#general-settings} La langue par défaut de QualCoder est l’anglais. Le français, l’allemand et l’espagnol sont des traductions régulièrement mises à jour. L’exactitude des traductions dans les autres langues n’a pas été vérifiée de manière approfondie. Pour les autres langues gérées par la communauté, [téléchargez le fichier .zip correspondant](/community) et placez-le dans le dossier `.qualcoder/i18n`, puis sélectionnez votre langue dans les paramètres. @@ -26,7 +26,7 @@ Il existe quelques options permettant de modifier l’apparence générale de Qu Pour la transcription audio et vidéo, vous pouvez sélectionner le format horaire et le type de parenthèses. -### Sauvegardes +### Sauvegardes {#backups} La sauvegarde du projet peut être configurée pour s’effectuer automatiquement toutes les heures, ou pas du tout. QualCoder conserve les sauvegardes les plus récentes avec un horodatage (date et heure). Le nom de la sauvegarde est : _nomduprojet_BKP_aaaammjj_hh.qda_, où _hh_ correspond à l’heure au format 24 heures. Cela signifie également qu’aucune sauvegarde supplémentaire n’est effectuée dans la même heure. Seul un nombre limité de sauvegardes est conservé, **les sauvegardes les plus anciennes sont supprimées**. L’option de paramétrage permet de choisir entre 1 et 10 sauvegardes. @@ -36,6 +36,6 @@ Renommez ou déplacez vers un autre emplacement les sauvegardes spécifiques que Dans votre dossier personnel, QualCoder créera un dossier .qualcoder contenant un fichier QualCoder.log destiné à consigner les événements, ainsi qu’un fichier config.ini qui contiendra de nombreux paramètres, tels que le nom de l’utilisateur actuel, les polices préférées, la langue et le répertoire de travail par défaut. N’enregistrez aucune donnée ni aucun projet dans le dossier .qualcoder. Le seul fichier que vous devriez y placer est un fichier stopwords.txt, uniquement si vous avez besoin d’appliquer un ensemble différent de mots vides pour les fonctions de nuage de mots et de comptage de mots. Ce dossier est réservé à l’usage du logiciel QualCoder pendant son exécution. -## Options avancées et journalisation +## Options avancées et journalisation {#advanced-options-and-logging} Les **options liées à l’IA**, situées en bas de la boîte de dialogue des paramètres, sont décrites ici : [Configuration de l’IA](2.3.-AI-Setup) \ No newline at end of file diff --git a/docs/doc/fr/2.3.-AI-Setup.md b/docs/doc/fr/2.3.-AI-Setup.md index 6a0e81d7..9c193207 100644 --- a/docs/doc/fr/2.3.-AI-Setup.md +++ b/docs/doc/fr/2.3.-AI-Setup.md @@ -13,19 +13,19 @@ Toutes les options liées à l’IA se trouvent au bas de la boîte de dialogue **Étapes de l’assistant de configuration :** 1. **Activez l’intégration de l’IA** en cochant la case dans la boîte de dialogue Paramètres. -2. **[Choisissez le modèle d’IA que vous souhaitez utiliser](#selection-dun-modele-dia)** et configurez-le. -3. La **[mémoire IA locale](#configuration-de-la-memoire-locale-de-lia)** est ensuite configurée et créée automatiquement. Soyez patient, car cela peut prendre un certain temps. +2. **[Choisissez le modèle d’IA que vous souhaitez utiliser](#ai-model-selection)** et configurez-le. +3. La **[mémoire IA locale](#the-local-ai-memory-setup)** est ensuite configurée et créée automatiquement. Soyez patient, car cela peut prendre un certain temps. 4. L’agent IA dans QualCoder est alors **prêt** à l’emploi. -Vous pouvez également consulter [comment préparer au mieux votre projet à l’utilisation de l’IA](#ameliorer-lergonomie-de-lia-dans-votre-projet) ainsi que nos [remarques sur la confidentialité des données](#quelques-remarques-sur-la-confidentialite-et-la-protection-des-donnees) ci-dessous. +Vous pouvez également consulter [comment préparer au mieux votre projet à l’utilisation de l’IA](#improve-ai-usability-in-your-project) ainsi que nos [remarques sur la confidentialité des données](#some-notes-on-privacy-and-data-protection) ci-dessous. -## Sélection d’un modèle d’IA +## Sélection d’un modèle d’IA {#ai-model-selection} Avec QualCoder, vous pouvez choisir parmi un large éventail de fournisseurs d’IA commerciaux et non commerciaux, et même utiliser des modèles locaux hébergés sur votre propre machine. Sélectionnez l’une des options dans le menu déroulant « Profil IA » de la boîte de dialogue Paramètres. -### Modèles de pointe d’OpenAI, d’Anthropic ou de Google +### Modèles de pointe d’OpenAI, d’Anthropic ou de Google {#frontier-models-from-openai-anthropic-or-google} Ces modèles de grande envergure offrent l’analyse la plus nuancée de vos données empiriques et garantissent une expérience globale des plus fluides. Plusieurs options s’offrent à vous : @@ -46,7 +46,7 @@ Ces modèles de grande envergure offrent l’analyse la plus nuancée de vos don - Notez que QualCoder n’a accès à aucune information de votre compte ChatGPT en dehors des modèles d’IA bruts. Cela vaut également dans l’autre sens, puisque ChatGPT ne peut accéder à aucune donnée au sein de QualCoder. - Il est toutefois recommandé de désactiver l’option « Améliorer le modèle pour tous » dans les paramètres « Contrôles des données » de votre profil ChatGPT. Cela empêche que le contenu de vos interactions avec ChatGPT ne soit utilisé pour l’entraînement futur de modèles d’IA. - QualCoder utilise la même interface de communication que Codex, l’assistant de programmation d’OpenAI. Si votre organisation a désactivé Codex dans votre compte ChatGPT, il se peut que vous ne puissiez pas utiliser cette intégration avec QualCoder. -- Pour les **abonnements à Anthropic Claude ou Google Gemini**, la connexion à QualCoder est moins simple. Si vous avez des compétences techniques, vous pouvez tout de même y parvenir en utilisant [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) comme passerelle. Si vous optez pour cette solution, [ajoutez un profil IA personnalisé](#autres-modeles) dans QualCoder et utilisez `http://localhost:8317/v1` comme paramètre « URL de base de l’API ». +- Pour les **abonnements à Anthropic Claude ou Google Gemini**, la connexion à QualCoder est moins simple. Si vous avez des compétences techniques, vous pouvez tout de même y parvenir en utilisant [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) comme passerelle. Si vous optez pour cette solution, [ajoutez un profil IA personnalisé](#other-models) dans QualCoder et utilisez `http://localhost:8317/v1` comme paramètre « URL de base de l’API ». **Microsoft Azure** @@ -62,7 +62,7 @@ Pour continuer, vous aurez besoin des informations suivantes : Accédez à « Projet > Paramètres > Intégration IA », cliquez sur « Options IA avancées > Nouveau profil IA », puis attribuez-lui un nom. Saisissez ensuite votre clé API dans le champ correspondant, le nom de votre déploiement Azure dans les champs « Large Model » et « Fast Model » (ces deux champs peuvent contenir la même valeur), et l’URL du point de terminaison Azure dans le champ « api_base ». Vous pouvez également ajuster la taille de la fenêtre de contexte en fonction du modèle. -### Infrastructure universitaire d’IA +### Infrastructure universitaire d’IA {#academic-ai-infrastructure} Les infrastructures universitaires d’IA à but non lucratif vous permettent d’accéder à des modèles de taille moyenne tout en respectant des normes très strictes en matière de confidentialité des données. Ces services sont généralement gratuits pour le personnel éligible. La qualité des résultats fournis par ces modèles de taille moyenne s’est considérablement améliorée ces derniers temps et est suffisante pour la plupart des tâches sur QualCoder. Cependant, elle n’atteint pas encore le niveau des grandes offres commerciales. Vous pouvez également rencontrer davantage de problèmes lors de vos interactions avec l’agent d’IA, tels que des erreurs opérationnelles ou des références sources mal formées. @@ -80,14 +80,14 @@ Allemagne : - **[hessian.AI Darmstadt](https://hessian.ai/) :** Accès expérimental, réservé aux personnes éligibles issues des universités de Hesse en Allemagne. Suivez les instructions pour GWDG ci-dessus, mais utilisez `https://llm-service.ai.tu-darmstadt.de` comme URL de base de l’API. -### Modèles de taille moyenne tels que Mistral, DeepSeek et autres +### Modèles de taille moyenne tels que Mistral, DeepSeek et autres {#mid-size-models-like-mistral-deepseek-and-others} Le menu déroulant « Profil IA » de la boîte de dialogue des paramètres propose également des options pour [Mistral (France)](https://mistral.ai/), [DeepSeek (Chine)](https://deepseek.com/) et [OpenRouter](https://openrouter.ai/), une plateforme permettant d’accéder à de nombreux grands modèles linguistiques hébergés sur différents serveurs. Pour toutes ces options, vous aurez besoin d’une clé API et, très probablement, d’un compte payant pour un usage intensif. Vérifiez attentivement les conditions de confidentialité des données avant d’utiliser l’un de ces services. -### Modèles d’IA locaux sur votre propre machine +### Modèles d’IA locaux sur votre propre machine {#local-ai-models-on-your-own-machine} Les modèles d’IA locaux offrent le plus haut niveau de protection des données, mais ils nécessitent également un matériel assez puissant pour fonctionner à une vitesse et avec une qualité raisonnables. Lors des tests, `Gemma-4-31B-it` a plutôt bien fonctionné. Il nécessite au moins 24 Go de VRAM en quantification 4 bits avec une taille de fenêtre de contexte acceptable. Pour tout travail sérieux impliquant des agents dans QualCoder, il est déconseillé de descendre bien en dessous de cette configuration. Le [codage assisté par IA](4.2.-AI-Assisted-Coding) peut toutefois fonctionner avec des modèles légèrement plus petits. @@ -97,7 +97,7 @@ Les modèles d’IA locaux offrent le plus haut niveau de protection des donnée - Sélectionnez un modèle volumineux et rapide dans la liste, probablement le même pour les deux, car vous n’aurez généralement qu’un seul modèle chargé à la fois. Vous pouvez également ajuster la taille de la fenêtre de contexte en fonction de vos paramètres Ollama. -### Autres modèles +### Autres modèles {#other-models} Si vous avez accès à d’autres modèles linguistiques volumineux sur des plateformes cloud, des serveurs universitaires ou votre propre machine, vous pouvez également essayer de les intégrer à QualCoder. - Le service que vous souhaitez utiliser doit fournir une interface compatible avec l’API OpenAI. C’est souvent le cas, car cette API est devenue une norme de facto ces dernières années. @@ -123,7 +123,7 @@ Notez que le nom de la section doit toujours commencer par le préfixe « ai_mod Si vous parvenez à faire fonctionner d’autres services dans QualCoder, ou si vous avez essayé sans succès, nous aimerions connaître votre expérience. -## Options avancées d’IA +## Options avancées d’IA {#advanced-ai-options} Tout en bas de la boîte de dialogue « Paramètres », vous trouverez un bouton « Options avancées d’IA ». En cliquant dessus, vous accéderez à quelques options supplémentaires. @@ -132,7 +132,7 @@ Tout en bas de la boîte de dialogue « Paramètres », vous trouverez un bouton - En ce qui concerne les autres options avancées, il est probablement préférable de les laisser à leurs valeurs par défaut si vous ne comprenez pas leur signification. Notez que les paramètres « temperature » et « top_p » peuvent être ignorés sans avertissement par certains modèles, en particulier en mode de raisonnement. -## Configuration de la mémoire locale de l’IA +## Configuration de la mémoire locale de l’IA {#the-local-ai-memory-setup} * L’agent IA de QualCoder utilise une mémoire locale spéciale pour effectuer des recherches rapides dans des documents empiriques et trouver des passages pertinents. Cela réduit considérablement la quantité de données envoyées vers le cloud, ce qui renforce la confidentialité, économise des ressources et augmente la vitesse. * Cette mémoire s’appuie sur un petit [modèle d’IA open source local](https://huggingface.co/intfloat/multilingual-e5-large), d’une taille d’environ 2,5 Go, qui est téléchargé automatiquement lors de la première activation de l’IA. Emplacements de stockage du modèle : @@ -148,7 +148,7 @@ Tout en bas de la boîte de dialogue « Paramètres », vous trouverez un bouton Note technique : la mémoire IA locale de QualCoder est un système hybride basé sur des embeddings [E5 sentence encoder](https://huggingface.co/intfloat/multilingual-e5-large) stockés dans un [magasin de vecteurs FAISS](https://github.com/facebookresearch/faiss) pour la recherche sémantique, et sur un [index BM25 SQLite](https://sqlite.org/fts5.html) pour une recherche rapide par mot-clé. De plus, l’agent IA peut utiliser des expressions régulières pour effectuer des recherches dans les données du projet. -## Améliorer l’ergonomie de l’IA dans votre projet +## Améliorer l’ergonomie de l’IA dans votre projet {#improve-ai-usability-in-your-project} L’agent IA de QualCoder doit être capable de lire et de comprendre la structure de votre projet, vos documents empiriques, vos codes et vos notes. Il doit également avoir une vision claire des objectifs, des questions de recherche et des méthodes qui guident votre recherche. Cela lui permet de fournir des réponses bien plus ciblées. Voici quelques suggestions : @@ -158,7 +158,7 @@ L’agent IA de QualCoder doit être capable de lire et de comprendre la structu - Si vous utilisez des **mémos** pour consigner des notes personnelles et des idées de brainstorming inachevées que vous ne souhaitez pas partager avec l’agent IA, placez ces notes après la marque « ##### ». Tout contenu de mémo situé sous cette marque ne sera pas transmis à l’IA. -## Quelques remarques sur la confidentialité et la protection des données +## Quelques remarques sur la confidentialité et la protection des données {#some-notes-on-privacy-and-data-protection} * Nous comprenons que l’utilisation de services basés sur le cloud, tels que ceux proposés par OpenAI, soulève des questions concernant la confidentialité et la protection des données. @@ -174,6 +174,6 @@ QualCoder suit une approche **« Privacy by Design »** : * QualCoder ne se limite pas aux fournisseurs d’IA commerciaux. Par exemple, nous avons établi un partenariat avec **« Blablador »**, un service exploitant de grands modèles linguistiques sur du matériel universitaire non commercial qui offre une excellente protection de la vie privée (voir ci-dessus). -* De plus, il est possible d’[ajouter vos propres modèles à QualCoder](#autres-modeles), y compris ceux fonctionnant entièrement en local sur votre machine sans aucun accès au réseau. À l’heure actuelle, cependant, la perte de qualité des résultats est si importante que les modèles d’IA locaux n’ont que des cas d’utilisation limités, à moins que vous ne disposiez d’un matériel très puissant. Nous espérons que cette situation évoluera à l’avenir. +* De plus, il est possible d’[ajouter vos propres modèles à QualCoder](#other-models), y compris ceux fonctionnant entièrement en local sur votre machine sans aucun accès au réseau. À l’heure actuelle, cependant, la perte de qualité des résultats est si importante que les modèles d’IA locaux n’ont que des cas d’utilisation limités, à moins que vous ne disposiez d’un matériel très puissant. Nous espérons que cette situation évoluera à l’avenir. * De manière générale, nous vous recommandons d’**anonymiser vos données** avec le plus grand soin avant d’utiliser tout service d’IA basé sur le cloud à des fins d’analyse. \ No newline at end of file diff --git a/docs/doc/fr/2.4.-Working-in-a-Team.md b/docs/doc/fr/2.4.-Working-in-a-Team.md index 864a37c1..813a1089 100644 --- a/docs/doc/fr/2.4.-Working-in-a-Team.md +++ b/docs/doc/fr/2.4.-Working-in-a-Team.md @@ -5,7 +5,7 @@ path: 2.4.-Working-in-a-Team # Travailler en équipe Plusieurs stratégies permettent d’organiser le travail collaboratif sur un même projet dans QualCoder. Choisissez celle qui correspond le mieux à votre approche méthodologique et à votre environnement de travail spécifique. -## 1) Édition séquentielle du même projet +## 1) Édition séquentielle du même projet {#1-sequential-editing-of-the-same-project} Cette approche peut être appliquée aussi bien au codage inductif que déductif. Elle repose sur le principe que tous les membres de l’équipe travaillent sur les mêmes fichiers de projet, mais pas simultanément. **Coordination de la séquence de travail** @@ -19,7 +19,7 @@ Cette approche peut être appliquée aussi bien au codage inductif que déductif Gérez soigneusement les noms des codeur⋅euses (voir ci-dessous). -## 2) Utilisation d’un projet maître : l’approche « codage séparé puis fusion » +## 2) Utilisation d’un projet maître : l’approche « codage séparé puis fusion » {#2-using-a-master-project-the-coding-separately-then-merging-approach} Cette stratégie permet à votre équipe de travailler simultanément dans une certaine mesure. Elle est particulièrement efficace si vous utilisez une approche de codage déductif, où le système de codes ne change pas beaucoup pendant l’analyse. Si vous l’utilisez avec un codage inductif, prévoyez de consacrer du temps à nettoyer et consolider le système de codes lors de la fusion des travaux des différents membres de l’équipe. @@ -30,10 +30,10 @@ Suivez ces étapes : * Compressez le dossier du projet, y compris tous les sous-dossiers et fichiers, et envoyez-le à vos collaborateurs (courriel, transfert de fichier ou clé USB). * Décidez d’une stratégie pour gérer les codeur⋅euses dans votre équipe, comme expliqué dans les notes ci-dessous. * Chaque membre de l’équipe peut ensuite décompresser sa copie locale du projet et y travailler indépendamment, en ajoutant des codes, des codages, des mémos, etc. Cependant, ne modifiez pas le texte importé des documents empiriques eux-mêmes, car cela pourrait causer des problèmes lors de la fusion ultérieure. -* Enfin, rassemblez toutes les copies locales et fusionnez-les séquentiellement dans votre projet maître, en utilisant [le processus décrit ici](6.1.-Imports-and-Exports#merge-qualcoder-projects). +* Enfin, rassemblez toutes les copies locales et fusionnez-les séquentiellement dans votre projet maître, en utilisant [le processus décrit ici](6.1.-Imports-and-Exports#merge-projects). -## Considérations importantes concernant les codeur⋅euses +## Considérations importantes concernant les codeur⋅euses {#important-considerations-regarding-coder-names} * Dans la plupart des cas, il est préférable d’attribuer un nom unique à chaque codeur⋅euse de votre équipe afin de pouvoir identifier les contributions individuelles même après la fusion des projets. * Dans Projet > Paramètres, cliquez sur le bouton « Modifier » situé à côté du nom du codeur⋅euse pour ouvrir une fenêtre dans laquelle vous pouvez modifier votre propre identité ou créer, renommer ou fusionner d’autres codeur⋅euses au sein du projet en cours. @@ -47,7 +47,7 @@ Suivez ces étapes : !!! warning Ne stockez pas le dossier du projet sur un lecteur réseau ou dans un espace de stockage en ligne, et n’accédez pas à cet emplacement pendant l’exécution de QualCoder. Si la connexion à la base de données venait à être interrompue, cela risquerait d’endommager la base de données alors que QualCoder effectue une série d’opérations sur celle-ci. -## Sauvegardes +## Sauvegardes {#backups} Nous vous recommandons de faire une sauvegarde avant d’effectuer des modifications substantielles, comme une réorganisation importante des codes et des catégories, la fusion de projets ou de codes. QualCoder effectue des sauvegardes horaires (en conservant jusqu’à cinq sauvegardes récentes) si cette option est activée dans les paramètres. diff --git a/docs/doc/fr/3.1.-Creating-a-New-Project.md b/docs/doc/fr/3.1.-Creating-a-New-Project.md index ea3ca1be..fa385717 100644 --- a/docs/doc/fr/3.1.-Creating-a-New-Project.md +++ b/docs/doc/fr/3.1.-Creating-a-New-Project.md @@ -8,7 +8,7 @@ Vous pouvez **créer un nouveau projet depuis le menu « Projet »**. Si vous le nommez « Test », le projet sera enregistré sous le nom Test.qda. Test.qda est en réalité un dossier contenant des sous-dossiers avec la base de données, les documents empiriques et d’autres fichiers. Si vous souhaitez envoyer le projet par courriel à quelqu’un d’autre, compressez l’intégralité du dossier. -## Écran principal +## Écran principal {#main-screen} L’onglet **Journal des actions** dans la fenêtre principale affiche les différentes modifications apportées lors de l’utilisation de QualCoder. La fenêtre principale comporte une barre de menu en haut qui comporte de nombreuses options. Elle comporte cinq onglets : _journal des actions_, _gestion_, _rapports_, _codage_ et _chat IA_. @@ -22,7 +22,7 @@ Il est **déconseillé d’exécuter votre projet depuis un emplacement cloud** Pour tout projet, maintenez de bonnes pratiques de gestion des données, comme des sauvegardes régulières, idéalement stockées à différents endroits (cloud, dossiers sur différents ordinateurs, disques durs, clés USB). -## Rédiger un mémo de projet +## Rédiger un mémo de projet {#write-a-project-memo} Cela est **particulièrement important si vous souhaitez utiliser les fonctionnalités basées sur l’IA** dans QualCoder. Le mémo de projet permet de fournir des informations contextuelles sur le projet en cours et le type de documents empiriques traités. Ces informations, incluses dans chaque requête, aident l’IA à produire des réponses beaucoup plus ciblées et utiles. Vous pouvez accéder au **Mémo de projet** via le menu **Projet > Mémo de projet**. diff --git a/docs/doc/fr/3.2.-Files.md b/docs/doc/fr/3.2.-Files.md index 991436d6..269c9fd4 100644 --- a/docs/doc/fr/3.2.-Files.md +++ b/docs/doc/fr/3.2.-Files.md @@ -9,7 +9,7 @@ Chaque fichier est précédé d’une icône décrivant le type de fichier. les ![img](/images/71172904-3ae5-4eb3-9b04-350f036f1c9d.png) -## Importer des fichiers +## Importer des fichiers {#importing-files} Importez du texte à partir de documents texte brut, docx, epub, md, odt, pdf, rtf, tex (LaTeX.tex - les fichiers \input et \include ne sont pas pris en charge). Importez des images à partir des formats : jpg, jpeg et png. Importez des fichiers audio/vidéo aux formats : mp3, m4a, mp4, wav, mov, ogg. Les fichiers PDF peuvent être codés sous forme de texte ou d’image. Vous pouvez également, plutôt que d’importer des fichiers dans le dossier du projet, créer des liens vers des fichiers stockés localement dans le système de fichiers de votre ordinateur. Cela peut être une bonne option si vous disposez d’une structure de dossiers spécifique importante pour votre projet. Les fichiers texte contenant des émoticônes peuvent être importés et affichés. Cependant, les émoticônes peuvent « décaler » les bandes de codage suivantes d’un caractère par émoticône. @@ -28,14 +28,14 @@ Si vous débutez dans QualCoder, ouvrez le dossier « Examples » et importez ` Après l’import, ouvrez chaque fichier en double-cliquant ou en utilisant le menu du clic-droit. Vous pouvez tester la pseudonymisation (voir après) en enlevant `ID2.odt`, en ajoutant `Joe Bloggs` dans le bouton de Pseudonymiser et en réimportant le fichier. -### PDF +### PDF {#pdfs} Les fichiers PDF contenant des passages surlignés peuvent être importés et ces passages peuvent être codés automatiquement. Dans les anciens projets, l’extraction du texte s’effectuait différemment de la version 4.0. Ainsi, lors de l’ouverture d’un ancien projet, la version 4.0 tentera de faire correspondre les segments de texte du mieux possible. Cependant, la correspondance risque de ne pas être parfaite. -### Pseudonymisation (désidentification des données) +### Pseudonymisation (désidentification des données) {#pseudonymisation-data-de-identification} La pseudonymisation est disponible pour remplacer des mots ou des phrases. Pour la plupart des langues (avec des exceptions possibles pour le chinois, japonais, coréen), il est possible de délimiter si les caractères précédant et suivant la phrase ne sont pas alphanumériques. La pseudonymisation est sensible à la casse. Les mots originaux doivent comporter au moins deux caractères et les pseudonymes au moins trois. Vous pouvez également laisser le champ du pseudonyme vide pour obtenir un terme généré aléatoirement. @@ -52,7 +52,7 @@ Les fichiers texte importés et les colonnes qualitatives des enquêtes importé Les fichiers PDF ne sont pas pseudonymisés. -## Auto-codage des intervenant⋅es +## Auto-codage des intervenant⋅es {#auto-speaker-codings} « Surligner les intervenant⋅es » crée des codes pour chaque intervenant⋅e dans un entretien ou une discussion de groupe, en assignant des extraits automatiquement. Vous pouvez accéder via le menu contextuel du fichier ou le bouton suivant de la barre d’outils : @@ -60,56 +60,56 @@ Les fichiers PDF ne sont pas pseudonymisés. Voir [cette partie](4.1.-Coding-Text#auto-speaker-codings) pour des détails complémentaires. -## Fonctions générales +## Fonctions générales {#general-functions} Les noms de fichiers enregistrés dans la base de données peuvent être modifiés ; les noms des fichiers originaux, eux, restent inchangés. Un menu contextuel (accessible par un clic droit) permet de visualiser, d’exporter ou de supprimer le fichier sélectionné. Le bouton en forme de corbeille permet de sélectionner plusieurs fichiers en vue de leur suppression. Le point d’interrogation (« ? ») permet d’ouvrir cette page d’aide. Les fichiers peuvent être visualisés soit via le menu contextuel (clic droit sur le fichier), soit en cliquant sur l’icône en forme de loupe. C’est à cet endroit que l’on peut saisir les transcriptions pour les fichiers audio et vidéo lors de leur visualisation. ![button](/images/f03c0a5d-29ea-40c7-a5a1-917aeb894f9b.png) Renommer en masse toutes les lignes de fichiers. Vous fournissez un préfixe, puis un suffixe numéroté est ajouté. Cela s’applique à toutes les lignes visibles du tableau. Vous pouvez présélectionner les lignes visibles en cliquant avec le bouton droit et en choisissant « Afficher cette valeur », par exemple sur un attribut. Ce bouton vous permet de renommer les fichiers en masse : -## Attributs +## Attributs {#attributes} Attributes are variables to describe the files. These can be added using the (x) button or through the Manage Attributes menu option. They can be character or numeric. The above image shows an added character attribute called _origin_ as well as one of several reference attribute columns _Ref-author_. Les attributs peuvent être exportés vers un fichier Excel à l’aide d’un bouton : ![img](/images/ccf331d7-63b6-460b-96df-41edd7cfe63b.png) -## Filtrer les colonnes et les lignes +## Filtrer les colonnes et les lignes {#filtering-columns-and-rows} -### Filtrer les lignes +### Filtrer les lignes {#filtering-rows} Le menu contextuel accessible par un clic droit vous permet également de réorganiser les fichiers par nom, date et type de fichier, notamment en cliquant avec le bouton droit sur les colonnes « Nom » ou « Date ». Vous pouvez afficher uniquement certains types d’attributs : sélectionnez l’option « Afficher cette valeur ». Vous pouvez également sélectionner « Afficher les valeurs de type ». L’option « Afficher les valeurs de type » peut être appliquée plusieurs fois pour réduire davantage la liste des lignes affichées. -### Visibilité des colonnes +### Visibilité des colonnes {#column-visibility} Parfois, de nombreuses colonnes peuvent être affichées, ce qui peut être accablant. Vous pouvez masquer des colonnes en faisant un clic droit sur la ligne d’en-tête du tableau pour masquer cette colonne ou masquer les colonnes commençant par un texte spécifique. Ou pour afficher les colonnes dont le nom commence par un texte spécifique. -### Enregistrer et charger les filtres de colonnes et de lignes +### Enregistrer et charger les filtres de colonnes et de lignes {#save-and-load-column-and-row-filters} Trois boutons permettent d’enregistrer, de charger et de supprimer les paramètres de filtre, afin de visualiser rapidement le tableau de gestion des fichiers comme vous le souhaitez. ![Boutons pour enregistrer, charger et supprimer les filtres du tableau](/images/96ae69f5-1493-4aa8-a3f5-31ee15c22fef.png) -## Ouvrir les URLs des attributs +## Ouvrir les URLs des attributs {#open-attribute-urls} Faites un clic droit sur une URL dans un attribut et ouvrez-la avec le navigateur web par défaut. Cela ne fonctionne que si l’attribut est une URL et qu’elle passe la validation d’URL. -## Copier la référence dans le presse-papiers +## Copier la référence dans le presse-papiers {#copy-reference-to-clipboard} Utilisez l’option du menu contextuel pour les colonnes de référence (Ref_Authors, Ref_Title, Ref_Journal, Ref_Type, Ref_Year). Cela vous permet de copier la référence dans le presse-papiers au format Vancouver ou APA. -## Assigner un fichier sélectionné à un cas +## Assigner un fichier sélectionné à un cas {#assign-a-selected-file-to-a-case} Vous pouvez assigner un fichier à un cas via le menu contextuel (clic droit) dans la colonne*« cas ». -## Intelligence artificielle +## Intelligence artificielle {#artificial-intelligence} Si vous avez activé l’intégration de l’IA dans QualCoder, les nouveaux fichiers texte importés seront lus par le modèle d’IA local et stockés dans sa mémoire locale. Cela se fait en arrière-plan (la barre d’état affiche « IA : lecture »). Vous pouvez continuer à utiliser QualCoder, mais les fonctionnalités améliorées par l’IA ne seront pas disponibles tant que l’IA n’aura pas terminé la mise à jour de sa mémoire. Cela se produit également si vous modifiez un fichier texte déjà importé dans QualCoder. Si vous avez l’impression que la mémoire de l’IA n’est pas synchronisée et a manqué certaines mises à jour de vos données (ce qui ne devrait pas se produire en temps normal), vous pouvez reconstruire la mémoire à partir de zéro en sélectionnant « IA > Reconstruire la mémoire interne ». Cela relira tous les documents, ce qui peut prendre un certain temps. -## Création et édition de fichiers texte +## Création et édition de fichiers texte {#text-file-creation-and-editing} Vous pouvez créer et entrer du texte dans la base de données en appuyant sur l’icône crayon. @@ -130,7 +130,7 @@ Vous pouvez sélectionner du texte non souligné et le copier/remplacer sans pro Il y a quelques limitations : il est préférable d’éviter de sélectionner des sections de texte à supprimer (ou à taper ou coller par-dessus) si ces sections contiennent à la fois du texte non souligné (non codé/annoté/assigné à un cas) et du texte souligné (codé, annoté, assigné à un cas). La raison en est que les positions des codes/annotations/assignations de cas sous-jacents peuvent ne pas correspondre correctement comme prévu. Si vous avez effectué une modification qui, selon vous, a mal affecté ces positions codées/annotées/assignées à un cas, quittez la fenêtre d’édition de texte en appuyant sur le bouton « Annuler ». -## Fichiers audio et vidéo +## Fichiers audio et vidéo {#audio-and-video-files} Les fichiers vidéo (mov, mp4, wmv, ogg) et audio (wav, mp3, m4a) peuvent être importés. Le chargement d’un fichier audio ou vidéo créera automatiquement un fichier texte de transcription vide. Ce fichier aura le même nom que le fichier audio ou vidéo, mais avec une extension « .txt ». Initialement, cette transcription textuelle sera vide. Vous pouvez transcrire le fichier vous-même ou par un professionnel et copier-coller le texte dans ce fichier. @@ -149,7 +149,7 @@ Si ffmpeg est installé, une forme d’onde est affichée. Si le fichier audio c -### Transcrire l’audio et la vidéo +### Transcrire l’audio et la vidéo {#transcribing-audio-and-video} Pour transcrire, ouvrez l’option de menu « Gérer les fichiers », puis lancez le fichier audio ou vidéo. Le fichier audio/vidéo se chargera et une zone de texte s’affichera pour saisir le texte transcrit. @@ -199,7 +199,7 @@ Ctrl D Supprime un ou plusieurs noms d’intervenants. Ctrl 1 à 8 Insère le nom d’un intervenant au format suivant : [nom] -### Transcriptions contenant des codes, annotations et/ou assignations de cas +### Transcriptions contenant des codes, annotations et/ou assignations de cas {#transcriptions-that-have-codes-annotations-and-or-case-assigned} Les sections du fichier texte ou du fichier audio/vidéo transcrit auront des sections de texte soulignées en vert (cas attribué), jaune (annotation) ou rouge (codé). Le texte peut être modifié même après avoir été codé, annoté ou attribué (totalement ou partiellement) à un cas. @@ -208,14 +208,14 @@ Vous pouvez sélectionner du texte non souligné et le copier/remplacer sans pro !!! info "Il y a quelques limitations" Il est préférable d’éviter de sélectionner des sections de texte à supprimer (ou à taper ou coller par-dessus) si ces sections contiennent à la fois du texte non souligné (non codé/annoté/assigné à un cas) et du texte souligné (codé, annoté, assigné à un cas). La raison en est que les positions des codes/annotations/assignations de cas sous-jacents peuvent ne pas correspondre correctement comme prévu. Si vous avez effectué une modification qui, selon vous, a mal affecté ces positions codées/annotées/assignées à un cas, quittez la fenêtre d’édition de texte en appuyant sur le bouton « Annuler ». -## Fichiers d’exemple +## Fichiers d’exemple {#example-files} Les fichiers d’exemple se trouvent dans le dossier Examples. Ceux-ci peuvent être utilisés pour tester l’importation de fichiers de différents formats de documents et l’importation d’une image. Il y a également des fichiers d’exemple pour tester l’importation d’attributs de cas et l’importation d’une enquête. -## Gérer les liens rompus vers les fichiers { #manage-bad-links-to-files } +## Gérer les liens rompus vers les fichiers {#manage-bad-links-to-files} Si votre projet contient des fichiers liés en externe, ces fichiers peuvent être déplacés, renommés ou supprimés. La fonctionnalité « Gérer les liens rompus » vous permet de modifier le lien existant et de le remplacer par un nouveau, en recherchant le fichier correct et son emplacement. Les liens rompus affectent les images, les fichiers audio et vidéo. Le texte n’est pas affecté, sauf si vous devez consulter un document texte original. En effet, le texte brut, sur lequel s’effectue le codage, est importé dans la base de données QualCoder. -La recherche automatisée prend du temps et parcourt le répertoire personnel de l’utilisateur en cherchant jusqu’à deux noms de fichiers correspondants. Elle permet de retrouver plus rapidement les fichiers dont le lien est rompu. +La recherche automatisée prend du temps et parcourt le répertoire personnel de l’utilisateur en cherchant jusqu’à deux noms de fichiers correspondants. Elle permet de retrouver plus rapidement les fichiers dont le lien est rompu. \ No newline at end of file diff --git a/docs/doc/fr/3.3.-Cases.md b/docs/doc/fr/3.3.-Cases.md index 1a5e4eae..aaba5768 100644 --- a/docs/doc/fr/3.3.-Cases.md +++ b/docs/doc/fr/3.3.-Cases.md @@ -13,14 +13,14 @@ Lorsqu’une enquête est importée, chaque ligne du fichier d’enquête est at ![image](/images/a2076cfb-da5e-486f-a443-6ef6a070fc9a.png) -## Masquer et afficher les lignes et colonnes +## Masquer et afficher les lignes et colonnes {#hiding-and-showing-rows-and-columns} Masquez les colonnes en faisant un clic droit sur la ligne d’en-tête du tableau pour obtenir des options permettant de masquer cette colonne ou les colonnes commençant par un texte spécifique. Ou pour afficher les colonnes commençant par une valeur textuelle. Masquez les lignes via le menu contextuel (clic droit) en sélectionnant une valeur textuelle qui est égale ou « similaire » à un texte choisi. Faites un clic droit pour trier par nom de cas ou par valeur d’attribut, par ordre croissant ou décroissant. !!! example "Exemple pratique" Ajoutez les trois étudiants (ou cas) en cliquant sur l’icône Ajouter un cas. Nommez chaque étudiant : ID1, ID2 et ID3. -## Gestionnaire de fichiers de cas +## Gestionnaire de fichiers de cas {#case-file-manager} Ajoutez maintenant le fichier de chaque étudiant à son cas. Cliquez sur la cellule de la colonne « Fichiers » correspondant au cas ID3, par exemple. Cela ouvre la boîte de dialogue du gestionnaire de cas. Vous pouvez également cliquer sur l’icône « Documents », ce qui ouvrira également le gestionnaire de cas. @@ -31,7 +31,7 @@ Dans le _gestionnaire de fichiers de cas_, cliquez sur un cas, par exemple ID3, Vous pouvez également sélectionner un cas, surligner manuellement des portions de texte dans un document plus volumineux, puis cliquer avec le bouton droit pour marquer – ou attribuer – le texte au cas sélectionné. -## Importer des cas et des attributs de cas +## Importer des cas et des attributs de cas {#importing-cases-and-case-attributes} Vous pouvez importer des attributs depuis un fichier CSV ou XLSX en utilisant ce bouton : @@ -41,7 +41,7 @@ La première ligne doit contenir les en-têtes des attributs. La première colon Pour cet exemple, supprimez tous les cas affichés. Ensuite, importez les attributs du fichier cases.csv via la boîte de dialogue Importer les attributs. Vous devrez à nouveau associer les fichiers et le texte des fichiers à chaque cas. -## Exporter les informations sur les cas +## Exporter les informations sur les cas {#exporting-case-information} Vous pouvez exporter le tableau des cas vers un fichier Excel (XLSX) en utilisant ce bouton : diff --git a/docs/doc/fr/4.1.-Coding-Text.md b/docs/doc/fr/4.1.-Coding-Text.md index f82d86f1..a16c68a1 100644 --- a/docs/doc/fr/4.1.-Coding-Text.md +++ b/docs/doc/fr/4.1.-Coding-Text.md @@ -39,13 +39,13 @@ _Codes se chevauchant_ Les codes qui se chevauchent peuvent être difficiles à voir clairement. Les sections qui se chevauchent sont soulignées. En passant la souris dessus, vous verrez apparaître le texte codé, y compris les chevauchements. Vous pouvez appuyer sur « O » après avoir cliqué sur une section qui se chevauche pour faire défiler les codes à cet endroit. -## Annotations +## Annotations {#annotations} Ajoutez une annotation (une note pour un segment de texte) à une sélection de texte. Elles sont utiles pour expliquer les acronymes et le jargon, par exemple. Le texte sera mis en gras pour marquer la position de l’annotation. Pour rouvrir une annotation, sélectionnez une partie du texte en gras et Cliquez-droit de la souris pour obtenir l’option Annoter. Vous pouvez également cliquer sur l’icône du bloc-notes et du crayon à gauche, ou appuyer sur la touche « a ». ![img](/images/104526a8-1bba-4dae-8bcd-43d2ddc5f9c8.png) -## Auto-codage +## Auto-codage {#auto-code} En haut à droite de la boîte de dialogue se trouvent des boutons permettant d’auto-coder le texte : @@ -78,7 +78,7 @@ Les caractères emoji bruts peuvent compter pour un seul caractère dans une cha ![image](/images/8ac5bcf5-fae4-4da3-a1dd-8dccf12d585b.png) -## Auto-codage des intervenant⋅es +## Auto-codage des intervenant⋅es {#auto-speaker-codings} La fonction « Marquer les intervenant⋅es » crée des codes pour chaque intervenant⋅e dans un entretien ou une discussion de groupe, et attribue automatiquement les interventions. Cela permet d’obtenir des rapports plus ciblés, en ne considérant que certains intervenant⋅es à la fois. Vous pouvez accéder à cette fonction via le menu contextuel du fichier ou le bouton suivant de la barre d’outils : @@ -92,10 +92,10 @@ La fonction « Marquer les intervenant⋅es » crée des codes pour chaque int - Chaque intervenant⋅e recevra son propre code dans la catégorie spéciale « 📌 Intervenant⋅es » tout en bas de l’arborescence du code. Les couleurs par défaut sont issues de la gamme des gris, afin de les rendre moins distrayantes. - Cependant, vous pouvez toujours choisir de masquer ces codages dans la fenêtre de texte, afin qu’ils ne vous distraient pas dans votre propre codage analytique. Pour ce faire, cliquez sur le bouton « … » situé juste à côté du nom du codeur en haut à gauche de la barre d’outils. Dans la boîte de dialogue suivante, sélectionnez l’entrée « 📌 Codage des intervenant⋅es » et réglez la visibilité sur « masqué ». -## Maximiser la zone d’écran +## Maximiser la zone d’écran {#maximise-screen-area} Pour masquer le panneau de contrôle supérieur, cliquez dans la zone de texte et appuyez sur la touche « h ». Pour afficher le panneau supérieur, appuyez à nouveau sur « h ». -## Méthodes pratiques pour charger des fichiers texte dans le volet de la liste des fichiers. +## Méthodes pratiques pour charger des fichiers texte dans le volet de la liste des fichiers. {#convenience-methods-for-loading-text-files-in-the-files-list-pane} Certains projets peuvent comporter de nombreux fichiers texte et la boîte de dialogue d’affichage des fichiers peut présenter trop de fichiers à ouvrir. Cliquez-droit de la souris sur les fichiers dans l’arborescence des fichiers pour passer au fichier suivant, aller au fichier marqué d’un signet ou aller au fichier avec les derniers codages : @@ -104,7 +104,7 @@ Certains projets peuvent comporter de nombreux fichiers texte et la boîte de di * Sélectionner le fichier qui a été codé le plus récemment, * Aller à un emplacement marqué d’un signet dans un fichier. Pour créer un signet, Cliquez-droit de la souris sur un texte lors du codage et sélectionnez l’option « Signet ». Le signet ne fonctionne que pour un seul projet à la fois. Si vous ouvrez un autre projet, le signet sera incorrect ou ne fonctionnera pas du tout. -### Boutons pratiques sous la liste des fichiers +### Boutons pratiques sous la liste des fichiers {#convenience-buttons-underneath-the-files-list} * Charger le fichier suivant * Charger le fichier contenant le dernier codage @@ -115,7 +115,7 @@ Certains projets peuvent comporter de nombreux fichiers texte et la boîte de di ![image](/images/b3c32938-c1df-455c-be3e-3753c813535c.png) -## Modification des positions du code +## Modification des positions du code {#modifying-code-positions} Cliquez-droit sur un code et sélectionnez « Redimensionner ». Les poignées situées à chaque extrémité du segment codé peuvent être repositionnées. @@ -135,7 +135,7 @@ Il est toujours préférable d’enregistrer une copie du projet avant de modifi * Symbole dollar $ Décale les positions du code à partir de la position du caractère sur lequel on a cliqué. Cela peut s’avérer nécessaire après modification du texte (ajout ou suppression) pour décaler les segments de code suivants d’un certain nombre de caractères. -## Autres raccourcis clavier pour le codage de texte +## Autres raccourcis clavier pour le codage de texte {#other-shortcut-keys-for-text-coding} * A. Annoter le texte sélectionné @@ -173,7 +173,7 @@ Il est toujours préférable d’enregistrer une copie du projet avant de modifi * Ctrl Z. Rétablit le dernier codage dont le marquage a été supprimé. -## Recherche de texte +## Recherche de texte {#search-text} La boîte de dialogue de codage de texte contient une fonction de recherche de texte en haut au milieu, avec des cases à cocher pour la recherche sensible à la casse et pour la recherche dans tous les fichiers texte. Dans la zone de texte, sélectionnez du texte et appuyez sur la touche de raccourci « s » pour remplir la zone de recherche et mettre en surbrillance le bouton fléché « suivant » afin de rechercher rapidement le texte sélectionné dans le document. La recherche nécessite au minimum 3 caractères par défaut. Cliquez-droit de la souris pour modifier la valeur par défaut et la passer à 5 caractères ou pour effectuer la recherche uniquement après avoir appuyé sur la touche Entrée. La case à cocher « Sensible à la casse » limitera la recherche à la casse. La case à cocher « Tous les fichiers » poursuivra la recherche dans les autres fichiers texte. @@ -185,7 +185,7 @@ La recherche utilise les fonctions Regex. * « \. » correspondra au symbole du point, « \ ? » correspondra au point d’interrogation. « \n » correspondra au symbole de fin de ligne. Ce [mémo Regex](www.rexegg.com/regex-quickstart.html) peut vous aider. * \b limite de mot, « \bbound\b » recherchera le mot complet « bound », mais pas « boundary ». -## Parcourir le texte pour un code sélectionné +## Parcourir le texte pour un code sélectionné {#moving-through-the-text-for-one-selected-code} Sous l’arborescence des codes se trouvent les boutons : avant, arrière et un bouton en forme de grille (pour quitter la fonction). @@ -197,23 +197,23 @@ Sélectionnez un code, puis cliquez sur les flèches avant et arrière. Celles-c Traduit avec DeepL.com (version gratuite) -## Afficher uniquement le texte codé important +## Afficher uniquement le texte codé important {#show-only-important-coded-text} Sous l’arborescence des codes se trouve un bouton avec un symbole en forme d’étoile. Ce bouton permet de basculer entre l’affichage de tout le texte codé et l’affichage du texte codé marqué comme important. -## Exporter des rapports +## Exporter des rapports {#export-reports} Exportation au format ODT, compatible avec LibreOffice et Microsoft Office. Soit avec la mise en évidence des codes, soit avec des commentaires en marge. Le rapport au format ODT contient des informations détaillées sur les codes utilisés, leur fréquence d’apparition, les annotations, les notes et le texte codé. D’autres options sont disponibles, notamment l’exportation au format texte brut, HTML et sous forme de grilles de codages. -## Volet latéral droit +## Volet latéral droit {#right-hand-pane} Le côté droit du volet de texte codé comporte un autre volet caché. Pour l’ouvrir, cliquez et faites glisser à partir du côté droit de la fenêtre, ou appuyez sur le bouton situé à côté du bouton Aide. Ce volet contient des options utiles pour le codage. L’un des boutons permet, lorsque vous cliquez sur un code, d’afficher le nom du code, la règle du code (mémo) et des exemples aléatoires de texte codé provenant du projet. L’autre bouton affiche le mémo du projet. ![image](/images/a6977ba3-bdf2-43c8-9097-562a252af815.png) -## Modification du texte en mode « Codage » - Texte de code +## Modification du texte en mode « Codage » - Texte de code {#editing-text-when-in-coding-code-text} Le texte peut être modifié même après avoir été codé, annoté ou attribué (en totalité ou en partie) à un cas. Certaines sections du fichier texte ou du fichier audio/vidéo transcrit seront soulignées en vert (cas attribué), en jaune (annotation) ou en rouge (codé) par TOUS les codeur⋅euses. @@ -237,6 +237,6 @@ Voici à quoi ressemble l’écran d’édition de texte : ![image](/images/b02d740e-d561-4c3c-aff0-637d45740d03.png) -## Catégories et codes +## Catégories et codes {#categories-and-codes} Voir [Catégories et codes](4.7.-Codes-Tree/) \ No newline at end of file diff --git a/docs/doc/fr/4.2.-AI-Assisted-Coding.md b/docs/doc/fr/4.2.-AI-Assisted-Coding.md index a3092139..55968f52 100644 --- a/docs/doc/fr/4.2.-AI-Assisted-Coding.md +++ b/docs/doc/fr/4.2.-AI-Assisted-Coding.md @@ -3,7 +3,7 @@ path: 4.2.-AI-Assisted-Coding --- # Coder avec l’assistant IA -## Introduction +## Introduction {#introduction} Les fonctionnalités d’IA intégrées à QualCoder (version 3.6 et supérieure) peuvent faciliter le processus de codage de différentes manières : @@ -15,11 +15,11 @@ Les fonctionnalités d’IA intégrées à QualCoder (version 3.6 et supérieure Notez que le « codage assisté par IA » n’est pas une méthode à part entière ; il s’agit d’un ensemble de techniques qui peuvent être adaptées à de nombreuses méthodes travaillant avec des codes, de la théorie fondée à l’analyse de contenu ou thématique. Consultez ce [tutoriel vidéo]( https://www.youtube.com/watch?v=FrQyTOTJhCc) pour un exemple pratique. -## Conditions préalables +## Conditions préalables {#preconditions} - L’IA doit être activée, entièrement chargée et prête pour de nouvelles requêtes (voir la barre d’état pour connaître l’état actuel). - Il est **fortement recommandé** d’utiliser la note de projet (menu « IA > Note de projet ») pour inclure une brève description des thèmes de recherche, des questions, des objectifs et des données empiriques collectées dans le cadre de votre projet. Ces informations accompagneront chaque requête envoyée à l’IA, ce qui permettra d’obtenir des résultats beaucoup plus ciblés. -## Démarrer le codage assisté par l’IA +## Démarrer le codage assisté par l’IA {#start-ai-assisted-coding} Le codage assisté par l’IA est intégré à l’espace de travail de codage de texte. Pour le démarrer, cliquez sur « Codage > Codage assisté par l’IA » ou, si vous êtes déjà dans l’espace de travail de codage de texte, sélectionnez l’onglet « Assistance IA » à gauche. Cliquez ensuite sur « Démarrer la recherche IA ». ![Capture d’écran de l’onglet Assistance IA](/images/1eeca42f-2e4e-48a6-aca7-68e4b13df6c4.png) @@ -28,9 +28,9 @@ Dans la fenêtre suivante, vous devez (1) définir l’objet de votre recherche ![Capture d’écran de la boîte de dialogue de recherche IA](/images/0d66baa1-6c60-423a-b4d6-742d387322dc.png) -### 1) Que rechercher : recherche par code ou par sujet libre +### 1) Que rechercher : recherche par code ou par sujet libre {#1-what-to-search-for-code-vs-free-topic-search} -#### Recherche de code +#### Recherche de code {#code-search} Utilisez cette option pour approfondir un aspect particulier et ajouter davantage de données provenant de l’ensemble de votre corpus à un code déjà existant. @@ -40,10 +40,10 @@ Utilisez cette option pour approfondir un aspect particulier et ajouter davantag - **Envoyer une note à l’IA :** si cette option est sélectionnée, la note du code sera également partagée avec l’IA. Utilisez cette option pour décrire ou définir votre code et aider l’IA à générer de meilleurs résultats. Si vous souhaitez également ajouter des notes personnelles à la note de code, vous pouvez le faire en insérant « ##### » dans le texte. Tout ce qui se trouve en dessous de cette marque ne sera pas envoyé à l’IA. - **Inclure les segments codés :** cette option est désactivée par défaut, ce qui signifie que la recherche IA ne renverra que les nouvelles données qui n’ont pas encore été codées avec ce code particulier. Activez cette option pour inclure également les données précédemment codées. -#### Recherche libre par thème +#### Recherche libre par thème {#free-topic-search} Recherchez n’importe quel thème, phénomène ou concept dans l’ensemble de vos données sans code prédéfini. Entrez un nom et une description pour indiquer à l’IA ce que vous recherchez. -### 2) Comment analyser les données : l’instruction analytique pour l’IA +### 2) Comment analyser les données : l’instruction analytique pour l’IA {#2-how-to-analyse-the-data-the-analytic-prompt-for-the-ai} L’instruction analytique indique à l’IA comment examiner vos données. Sélectionnez-la en bas à gauche de la fenêtre. @@ -54,10 +54,10 @@ L’instruction analytique indique à l’IA comment examiner vos données. Sél **Explorez ces instructions** en passant votre souris sur les éléments de la liste déroulante. Cliquez sur « Modifier » pour [modifier les instructions analytiques ou définir les vôtres](6.3.-AI-Prompt-Library) (option avancée). -### 3) Filtre : affinez votre recherche +### 3) Filtre : affinez votre recherche {#3-filter-narrow-your-search-down} Par défaut, l’ensemble complet des données textuelles du projet en cours est exploré. Si vous souhaitez limiter la recherche à certains **documents** ou **cas**, vous pouvez les sélectionner dans la partie droite de la fenêtre (Ctrl + clic pour sélectionner plusieurs éléments). Vous pouvez également définir un filtre basé sur les **variables d’attribut** sélectionnées. -## Le processus de codage assisté par l’IA +## Le processus de codage assisté par l’IA {#the-process-of-ai-assisted-coding} Commencez par effectuer la recherche IA. Il s’agit d’un processus en deux étapes : **Étape 1 :** l’IA interroge sa base de données locale pour trouver des données potentiellement pertinentes dans votre corpus. @@ -66,7 +66,7 @@ Commencez par effectuer la recherche IA. Il s’agit d’un processus en deux é Veuillez patienter, car l’affichage des premiers résultats peut prendre un certain temps. En cliquant sur un résultat, le document s’affiche dans la fenêtre principale et la citation pertinente est mise en évidence. Veillez à également consulter le texte entourant la citation afin de comprendre son contexte. -### Traitement des résultats +### Traitement des résultats {#working-through-the-results} Vous pouvez **coder le texte sélectionné** comme vous le feriez pour n’importe quel autre texte dans l’espace de travail [de codage de texte](4.1.-Coding-Text). Développez ou modifiez la sélection selon vos besoins. @@ -80,7 +80,7 @@ QualCoder utilise un **algorithme de classement** pour afficher les résultats l Au fil du temps, cependant, les résultats renvoyés par l’IA commenceront à **s’éloigner du sujet initial** et deviendront de moins en moins pertinents. C’est à ce moment-là que vous devez arrêter l’investigation et passer au sujet ou au code suivant. Vous n’avez pas besoin de cliquer sur « trouver plus » tant qu’il reste des données à analyser à partir de la première étape de la recherche. Comparez cela à une recherche Google : il n’est pas nécessaire de cliquer sur chaque page de résultats si vous savez déjà ce que vous voulez savoir. -### Que faire si vous n’obtenez aucun résultat +### Que faire si vous n’obtenez aucun résultat {#what-to-do-if-you-get-no-results} 1) **Si la première étape ne renvoie aucune donnée potentiellement pertinente :** N’oubliez pas que par défaut, la recherche de code n’extrait que les nouvelles données. Si vous avez déjà codé vos documents de manière exhaustive, il se peut qu’il n’y ait tout simplement rien de nouveau à explorer sur un sujet particulier. Réfléchissez également à votre requête de recherche, en particulier au nom du code ou au sujet de la recherche : est-il trop spécifique ou pas assez clair ? 2) **Si la deuxième étape ne donne aucun résultat :** cliquez sur « trouver plus » (si disponible) pour analyser davantage de données. Si cela ne donne pas non plus de résultats, vous pouvez lancer une nouvelle recherche avec une instruction plus ouverte et inclusive (par exemple, « recherche ouverte »). diff --git a/docs/doc/fr/4.3.-Coding-Text-on-PDFs.md b/docs/doc/fr/4.3.-Coding-Text-on-PDFs.md index 804304eb..e06669d3 100644 --- a/docs/doc/fr/4.3.-Coding-Text-on-PDFs.md +++ b/docs/doc/fr/4.3.-Coding-Text-on-PDFs.md @@ -9,7 +9,7 @@ Les zones de texte et d’image du PDF peuvent être annotées. ![image](/images/ba02d9ee-24fe-4b67-84b0-4f62cd62a1c6.png) -### Raccourcis clavier +### Raccourcis clavier {#key-presses} * H Afficher ou masquer les sections supérieures de l’écran. * Ctrl F permet d’accéder à la zone de recherche de texte. @@ -21,13 +21,13 @@ Les zones de texte et d’image du PDF peuvent être annotées. * Ctrl 9 Affiche les segments annotés importants. Active ou désactive cette fonction. * Ctrl 0 Affiche la page d’aide dans le navigateur. -#### Dans la zone d’affichage du PDF : +#### Dans la zone d’affichage du PDF : {#in-the-pdf-display-area} Vous pouvez zoomer et dézoomer en cliquant sur le PDF affiché et en appuyant sur les touches + ou -. Appuyez sur Q pour marquer rapidement la sélection avec le code le plus récent. Appuyez sur R pour marquer rapidement la sélection avec l’un des codes récemment utilisés. -#### Dans la zone de texte brut : +#### Dans la zone de texte brut : {#in-the-plain-text-area} * A : ajouter une annotation – pour la sélection actuelle – édition de texte uniquement * Q : marquage rapide avec un code – pour la sélection actuelle @@ -38,16 +38,16 @@ Appuyez sur R pour marquer rapidement la sélection avec l’un des codes récem * U Démarquer à l’emplacement sélectionné * V Attribuer un code « in vivo » au texte sélectionné -## Exporter des rapports +## Exporter des rapports {#export-reports} Exporter au format ODT – compatible avec LibreOffice et Microsoft Word ou au format PDF avec les surlignages appliqués. -## Anciennes versions 3.8.2 et antérieures +## Anciennes versions 3.8.2 et antérieures {#older-versions-382-and-earlier} L’écran est divisé en 3 volets ajustables. Le volet de gauche contient la liste des fichiers et l’arborescence des codes. Le volet central affiche la représentation au format PDF. Le volet de droite affiche le texte brut extrait du PDF. Les polices d’origine du texte ne sont pas utilisées. À la place, la police standard de QualCoder est utilisée dans les zones de texte PDF affichées. Un curseur de réglage de la taille de police permet de réduire celle-ci afin d’éviter, dans la mesure du possible, que le texte se chevauche. Il est réglé sur -2, mais la valeur -3 peut également convenir. Le volet de droite affiche le texte brut tel qu’il apparaîtrait dans la section « Code ». Vous pouvez marquer, démarquer ou ajouter une note au texte codé, marquer le codage comme important et annoter le texte à cet endroit. -## Catégories et codes +## Catégories et codes {#categories-and-codes} Voir [Catégories et codes](4.7.-Codes-Tree/) \ No newline at end of file diff --git a/docs/doc/fr/4.4.-Coding-Images.md b/docs/doc/fr/4.4.-Coding-Images.md index f345b778..cd570e64 100644 --- a/docs/doc/fr/4.4.-Coding-Images.md +++ b/docs/doc/fr/4.4.-Coding-Images.md @@ -10,7 +10,7 @@ En haut à droite de la boîte de dialogue, vous trouverez des détails sur la z ![image](/images/8e9e2ac8-61c0-4b4a-9d8b-31556da21fb2.png) -## Codage d’images PDF +## Codage d’images PDF {#pdf-image-coding} Les fichiers PDF peuvent être codés en images ici ou dans le volet « Coder en PDF ». @@ -20,17 +20,17 @@ Boutons de navigation PDF : ![Boutons de navigation PDF](/images/36effc9c-f0a2-4f02-9fe0-293abcd3060a.png) -## Zones codées importantes +## Zones codées importantes {#important-coded-areas} Les zones codées importantes, telles que les exemples pour un rapport, peuvent être marquées comme telles à l’aide du menu contextuel lorsque vous vous trouvez sur les zones codées et que vous sélectionnez Important. En haut de l’écran se trouve un bouton avec un symbole en forme d’étoile. Ce bouton permet de basculer entre l’affichage de toutes les zones codées et celui des zones codées marquées comme importantes. -## Raccourcis +## Raccourcis {#shortcuts} * Raccourci H. Appuyez sur h lorsque vous vous trouvez sur l’image pour masquer et afficher la section des commandes supérieures de l’écran. * Raccourci L. Appuyez sur L pour « Afficher les codes similaires » et afficher une liste restreinte dans l’arborescence des codes. * Appuyez sur les boutons + ou - pour agrandir ou réduire l’image. * Ctrl Z pour restaurer la dernière zone de codage non marquée. -## Boutons sous la liste des fichiers +## Boutons sous la liste des fichiers {#convenience-buttons-underneath-the-files-list} * Charger le fichier suivant * Charger le fichier avec le dernier codage @@ -38,7 +38,7 @@ Les zones codées importantes, telles que les exemples pour un rapport, peuvent * Utiliser une fonction de filtre pour afficher uniquement les fichiers qui répondent à certains critères. Ceux-ci peuvent provenir des attributs des fichiers ou être associés à certains cas. (Bouton qui affiche une balise) -## Clic droit sur la zone d’image pour plus d’options +## Clic droit sur la zone d’image pour plus d’options {#right-click-on-the-image-area-for-more-options} Les options comprennent la rotation et la mise en évidence d’un code ou d’une zone codée spécifique. Ces options de mise en évidence sont les suivantes : grisé, flou, solarisé. Elles s’ouvrent dans votre programme de visualisation d’images par défaut pour que vous puissiez les afficher et les enregistrer. @@ -50,10 +50,10 @@ Exemple de zones codés mise en évidence, avec légendes : ![image](/images/be991d7a-363b-4e5a-a93a-d02ccde42930.png) -## Exporter +## Exporter {#export} L’image avec les zones codées peut être exportée vers un fichier HTML. Après avoir ouvert le fichier dans un navigateur, passez la souris sur les zones codées pour afficher le nom du code et les mémos. -## Catégories et codes +## Catégories et codes {#categories-and-codes} Voir [Catégories et codes](4.7.-Codes-Tree) \ No newline at end of file diff --git a/docs/doc/fr/4.5.-Coding-Audio-and-Video.md b/docs/doc/fr/4.5.-Coding-Audio-and-Video.md index 7d98afca..7c675495 100644 --- a/docs/doc/fr/4.5.-Coding-Audio-and-Video.md +++ b/docs/doc/fr/4.5.-Coding-Audio-and-Video.md @@ -10,7 +10,7 @@ Le texte de la transcription peut également être codé et annoté dans cette f ![Écran de codage audio/vidéo](/images/bac80f08-c719-4add-9878-104d3fbc084e.png) -## Raccourcis clavier +## Raccourcis clavier {#keyboard-shortcuts} * Ctrl R Rembobiner 5 secondes * Alt R ou Alt moins Rembobiner 30 secondes @@ -32,7 +32,7 @@ Lorsque la zone de texte est sélectionnée : * Raccourci Q. Appuyez sur Q pour attribuer rapidement le code le plus récent. (Vous devez avoir sélectionné du texte) * Raccourci R. Appuyez sur R pour sélectionner les codes récents. (Vous devez avoir sélectionné du texte) -## Segments audio-vidéo +## Segments audio-vidéo {#audio-video-segments} Une fois qu’un segment a été créé à l’aide du bouton _Démarrer le segment/Arrêter le segment_, il peut être attribué à un code en cliquant-droit sur le code concerné et en attribuant le segment. @@ -40,7 +40,7 @@ Les bandes de codage pour les segments codés sont affichées en bas. En passant Le texte de la transcription peut également être codé et annoté dans cette boîte de dialogue. Cependant, lorsque la case à cocher « Faire défiler la transcription » est cochée, cela n’est pas possible. La lecture de la vidéo lorsque cette case est cochée fera défiler la transcription en utilisant les horodatages en synchronisation avec la vidéo. -## Textes et segments codés importants +## Textes et segments codés importants {#important-coded-text-and-segments} Les textes codés importants, tels que les exemples pour un rapport, peuvent être marqués comme importants en utilisant le menu contextuel lorsque vous êtes sur le texte codé et en sélectionnant « Important ». De même, les segments codés peuvent être marqués comme importants. En haut de l’écran se trouve un bouton avec un symbole en forme d’étoile. Celui-ci permet de basculer entre l’affichage de tous les textes et segments codés et l’affichage des textes et segments codés importants. @@ -48,7 +48,7 @@ Les textes codés importants, tels que les exemples pour un rapport, peuvent êt Sélectionnez du texte (il peut être codé ou, de préférence, non codé), puis attribuez-le à un segment. Sélectionnez d’abord le texte. Cliquez-droit sur la bande du segment pour ouvrir le menu. Choisissez Lier le texte au segment pour attribuer le texte. -## Modification des positions du code dans la zone de texte +## Modification des positions du code dans la zone de texte {#modifying-code-positions-in-the-text-area} Dans la zone de texte, cliquez sur un code (notez que le code ne doit pas chevaucher un autre code à cette position). Appuyez sur les combinaisons de touches suivantes pour étendre ou réduire le segment de texte codé. @@ -62,17 +62,17 @@ Vous pouvez également cliquer-droit sur un code et sélectionner « Modifier la Dans la fenêtre vidéo, vous pouvez cliquer-droit et choisir parmi plusieurs options pour modifier la taille de la fenêtre, en pixels. Vous pouvez également exporter une capture d’écran. La capture d’écran sera enregistrée sous le nom Frame_yyyymmdd_hh_mm_ss.jpg dans le répertoire indiqué dans les paramètres. -## Boutons pratiques sous la liste des fichiers +## Boutons pratiques sous la liste des fichiers {#convenience-buttons-underneath-the-files-list} * Charger le fichier suivant * Charger le fichier avec le dernier codage * Ouvrir le mémo du fichier sélectionné * Utiliser une fonction de filtrage pour afficher uniquement les fichiers qui répondent à certains critères. Ceux-ci peuvent provenir des attributs des fichiers ou du fait que les fichiers sont associés à certains cas. -## Problèmes avec la vidéo et l’audio avec quelques systèmes d’exploitation +## Problèmes avec la vidéo et l’audio avec quelques systèmes d’exploitation {#audio-and-video-problems-on-some-operating-systems} Fedora ne semble pas fonctionner avec la vidéo et l’audio. -## Catégories et codes +## Catégories et codes {#categories-and-codes} Voir [Catégories et codes](4.7.-Codes-Tree) \ No newline at end of file diff --git a/docs/doc/fr/4.7.-Codes-Tree.md b/docs/doc/fr/4.7.-Codes-Tree.md index 32296a87..394f083e 100644 --- a/docs/doc/fr/4.7.-Codes-Tree.md +++ b/docs/doc/fr/4.7.-Codes-Tree.md @@ -11,7 +11,7 @@ Des mémos peuvent être attribués aux catégories et aux codes. Les mémos peu !!! note La possibilité d’attribuer un même code à plusieurs catégories est une fonctionnalité souvent demandée. Toutefois, nous avons décidé de ne pas l’implémenter, car cela rendrait le système trop complexe. Cela s’explique par le fait que QualCoder repose sur une structure arborescente, alors que la fonctionnalité demandée nécessiterait une [structure de données en graphe](https://www.baeldung.com/cs/tree-vs-graph-data-structure). Comme alternative, vous pouvez utiliser des codes aux noms similaires dans vos différentes catégories. -## Réduire le nombre de codes affichés dans l’arborescence des codes +## Réduire le nombre de codes affichés dans l’arborescence des codes {#reducing-the-amount-of-codes-displayed-in-the-codes-tree} Pour réduire le nombre de codes affichés dans l’arborescence des codes. Dans les fenêtres de codage (texte de code, code, a/v ou image de code), clic-droit de la souris sur l’arborescence des codes et sélectionnez « Afficher les codes contenant » dans le menu, ou, lorsque l’arborescence des codes est active, appuyez sur la touche F9. Saisissez ensuite du texte dans la zone de texte. Seuls les codes contenant ce texte s’afficheront alors. Pour afficher à nouveau tous les codes, ne saisissez rien dans la zone de texte et cliquez sur OK. @@ -19,13 +19,13 @@ Une deuxième option consiste à sélectionner _Afficher les codes de couleur_. Un autre bouton situé sous l’arborescence des codes, avec une icône de recherche, permet de rechercher le premier code contenant le texte correspondant à celui que vous avez saisi. -## Options du menu de l’arborescence des codes +## Options du menu de l’arborescence des codes {#codes-tree-menu-options} Dans l’arborescence des codes située à gauche, un clic droit sur un code ouvre un menu contextuel proposant diverses options. Les sous-menus permettent notamment de modifier un code ou une catégorie, ainsi que d’appliquer des filtres et de trier les éléments. ![image](/images/4adaa97e-da9c-45bf-88f3-8e0110edf638.png) -### Afficher les fichiers codés +### Afficher les fichiers codés {#show-coded-files} L’une des options est « Afficher les fichiers codés » : elle affiche tous les endroits où vous avez utilisé le code sélectionné. En cliquant sur une section codée particulière, vous ouvrirez ce code dans son contexte d’origine pour plus de détails. @@ -35,8 +35,8 @@ Avec « Afficher les fichiers codés », vous pouvez cliquer avec le bouton droi Trier l’arborescence des codes par ordre croissant (touche F11 lorsque l’arborescence des codes est active) ou par ordre décroissant (touche F12 lorsque l’arborescence est active). -## Accessibilité et couleurs des codes { #accessibility-and-code-colours } +## Accessibilité et couleurs des codes {#accessibility-and-code-colours} Dans le menu Codage, vous trouverez une option appelée **Palette de couleurs**. -Vous pouvez appliquer une gamme de couleurs à une série de codes sélectionnés, plutôt que de vous fier aux couleurs générées aléatoirement ou de modifier les couleurs un par un pour chaque code. Dans cette zone, vous pouvez également voir comment les couleurs des codes peuvent apparaître à une personne atteinte d’un certain type de daltonisme : protanomalie, protanopie, deutéranomalie, deutéranopie. +Vous pouvez appliquer une gamme de couleurs à une série de codes sélectionnés, plutôt que de vous fier aux couleurs générées aléatoirement ou de modifier les couleurs un par un pour chaque code. Dans cette zone, vous pouvez également voir comment les couleurs des codes peuvent apparaître à une personne atteinte d’un certain type de daltonisme : protanomalie, protanopie, deutéranomalie, deutéranopie. \ No newline at end of file diff --git a/docs/doc/fr/5.1.-AI-chat-based-analysis.md b/docs/doc/fr/5.1.-AI-chat-based-analysis.md index c00565fd..00c0c2fb 100644 --- a/docs/doc/fr/5.1.-AI-chat-based-analysis.md +++ b/docs/doc/fr/5.1.-AI-chat-based-analysis.md @@ -4,7 +4,7 @@ path: 5.1.-AI-chat-based-analysis # Analyser les données avec l’agent IA -## Principes fondamentaux de l’intégration de l’IA +## Principes fondamentaux de l’intégration de l’IA {#core-principles-of-ai-integration} **1) Choix des modèles d’IA** @@ -22,7 +22,7 @@ Les instructions qui guident le travail de l’agent IA sont consultables et peu L’accent est mis sur le dialogue avec l’IA : développer de nouvelles perspectives, interroger ses propres interprétations et mieux comprendre le matériau. Sur demande, l’agent peut aussi exécuter des tâches plus longues de manière semi-autonome. L’automatisation à grande échelle n’a toutefois jamais été l’objectif principal. -## Travailler avec l’agent IA +## Travailler avec l’agent IA {#working-with-the-ai-agent} - L’agent IA dispose de son **propre onglet** dans QualCoder. Vous pouvez aussi le déplacer dans une **barre latérale** (voir ci-dessous), à côté de vos données, en cliquant sur le petit bouton en forme de flèche. ![Bouton en forme de flèche pour déplacer l’agent IA dans la barre latérale](../../images/ai-agent-sidebar-button-de.png){ width="118" } @@ -33,20 +33,20 @@ L’accent est mis sur le dialogue avec l’IA : développer de nouvelles perspe !!! note L’IA doit être **entièrement chargée** et prête à recevoir de nouvelles requêtes avant de pouvoir commencer une discussion (barre d’état : « IA : prête »). -### À quoi sert l’agent IA ? +### À quoi sert l’agent IA ? {#what-is-the-ai-agent-for} - L’agent IA vous aide à **explorer votre matériau empirique**, à développer des interprétations et des analyses, à coder les données et à rédiger des mémos. - Vous pouvez discuter de passages particuliers avec l’IA ou rechercher des thèmes et des cas contrastés dans l’ensemble du corpus du projet. - Vous pouvez faire évoluer votre système de codes, réfléchir à des idées et à des stratégies d’analyse, puis les confronter directement au matériau empirique. - Contrairement aux chatbots génériques, l’agent IA de QualCoder **reprend exactement là où votre analyse en est :** il examine le système de codes actuel, peut lire les mémos et les passages codés, intégrer les cas et leurs caractéristiques (attributs) à l’analyse, etc. Vous obtenez ainsi des retours adaptés à l’état actuel de votre recherche. -### Que peut faire l’agent IA ? +### Que peut faire l’agent IA ? {#what-can-the-ai-agent-do} - Même avec un simple **accès en lecture** au projet, l’agent IA est un outil puissant pour explorer des idées. - Sur demande, il peut aussi **faire avancer activement l’analyse**, au-delà des réponses à vos questions. Avec les autorisations appropriées (voir ci-dessous), il peut créer de nouveaux codes ou réorganiser les codes existants, rechercher et coder de nouveaux passages, réviser des mémos ou créer de nouveaux attributs de cas. - Dans le dialogue avec l’agent, vous pouvez examiner ses propositions, poser des questions complémentaires et décider de la suite du travail. -### Quelles sont ses limites ? +### Quelles sont ses limites ? {#what-are-its-limitations} - Actuellement, l’agent IA ne peut travailler qu’avec des **données textuelles**, pas avec des images, des fichiers audios ou des vidéos. Les journaux sont également exclus. - Vous pouvez choisir entre trois niveaux d’autorisation : @@ -60,7 +60,7 @@ L’accent est mis sur le dialogue avec l’IA : développer de nouvelles perspe - Une **limite stricte** s’applique toujours : les données empiriques elles-mêmes constituent la « vérité de terrain » de toute l’analyse. L’IA ne peut les modifier en aucun cas. - L’agent IA n’a par ailleurs **aucun accès à des informations externes**, par exemple sur Internet. Il ne peut donc travailler qu’avec les données que vous avez délibérément intégrées au projet. -### Comment voir les modifications effectuées par l’IA ? +### Comment voir les modifications effectuées par l’IA ? {#how-can-i-see-which-changes-the-ai-makes} - L’agent **documente ses étapes dans la discussion**, cite ses sources et demande votre accord avant d’effectuer des modifications importantes. - Vous pouvez facilement **annuler** les dernières modifications de l’agent IA à l’aide du bouton correspondant dans la fenêtre de discussion : @@ -75,7 +75,7 @@ L’accent est mis sur le dialogue avec l’IA : développer de nouvelles perspe ![Réglage de la visibilité des codages de l’AI Agent](../../images/ai-agent-code-visibility-de.png){ width="250" } -### Comment préparer mon projet ? +### Comment préparer mon projet ? {#how-should-i-prepare-my-project} - Un **mémo de projet** informatif est important (menu « Projet > Mémo de projet »). Consignez-y les éléments suivants : @@ -96,7 +96,7 @@ L’accent est mis sur le dialogue avec l’IA : développer de nouvelles perspe !!! note **Notes personnelles dans les mémos** : Si vous souhaitez aussi utiliser les mémos pour des notes personnelles, placez celles-ci après le séparateur `#####`. Tout ce qui suit est inaccessible à l’IA. -### Comment fonctionne l’agent IA ? +### Comment fonctionne l’agent IA ? {#how-does-the-ai-agent-work} - L’agent IA n’agit que lorsque vous lui confiez une **tâche**, jamais de sa propre initiative. - L’agent traite une tâche dans une **boucle ReAct** (Reflect + Act, [Shunyu et al. 2022](https://arxiv.org/abs/2210.03629)) : @@ -110,13 +110,13 @@ L’accent est mis sur le dialogue avec l’IA : développer de nouvelles perspe - L’agent dispose d’**outils puissants** : il peut, par exemple, effectuer une recherche par similarité sémantique dans l’ensemble du corpus, rechercher à l’aide d’expressions régulières ou dans un index de mots-clés BM25, et utiliser des outils pour créer ou modifier des codes s’il dispose des droits d’écriture. -### Que deviennent mes données ? +### Que deviennent mes données ? {#what-happens-to-my-data} - Toutes les données restent **stockées localement sur votre ordinateur**, dans le projet QualCoder en cours. Les opérations de recherche mentionnées ci-dessus sont également exécutées localement. - Le **modèle d’IA ne voit que les données** (par exemple, des résultats de recherche ou des passages particuliers) nécessaires à l’analyse en cours. Ces fragments de données sont envoyés au modèle d’IA avec la tâche correspondante. - Dans ses réponses, l’agent IA documente en détail les données sur lesquelles reposent ses analyses. QualCoder transforme ces références en **liens vers les sources avec des numéros de ligne**. Un clic sur une référence ouvre le passage dans son contexte d’origine. -## Quatre façons d’engager la conversation avec l’agent +## Quatre façons d’engager la conversation avec l’agent {#four-ways-to-start-a-conversation-with-the-agent} ![Quatre points de départ : une question ouverte, un thème, un passage de texte et un code ou une catégorie](../../images/ai-agent-conversation-paths-fr.png) @@ -126,7 +126,7 @@ En bas à gauche de la fenêtre de l’agent IA, vous pouvez démarrer une nouve Ces options constituent simplement **différents points de départ** pour l’analyse. Vous pouvez ensuite orienter la conversation dans la direction de votre choix. -### 1) Nouvelle discussion ouverte +### 1) Nouvelle discussion ouverte {#1-new-open-chat} C’est la façon la plus souple de démarrer une nouvelle analyse avec l’agent. Commencez par une idée ou une question ouverte, ou indiquez les codes ou les passages que vous souhaitez étudier. @@ -152,7 +152,7 @@ C’est la façon la plus souple de démarrer une nouvelle analyse avec l’agen Pour intégrer à la conversation des **instructions prédéfinies ou vos propres instructions** de la [Bibliothèque d’instructions IA](./6.3.-AI-Prompt-Library.md), utilisez la notation avec une barre oblique : par exemple, « /in-vivo-coding » insère dans la conversation en cours l’instruction correspondante que vous avez précédemment enregistrée dans la bibliothèque. -### 2) Exploration thématique +### 2) Exploration thématique {#2-topic-exploration} Cette analyse est particulièrement utile pour obtenir un **premier aperçu** de la manière dont un thème est abordé dans le matériau empirique. Pour des questions de recherche simples portant sur des thèmes bien délimités, cette fonction peut également produire des analyses de synthèse qui peuvent être directement retravaillées dans un rapport. @@ -169,7 +169,7 @@ Cette analyse est particulièrement utile pour obtenir un **premier aperçu** de > > **Résultat** : Une analyse comparative d’Ethel et de Flora sur le thème « Élever des enfants en temps de guerre », structurée autour des trois sous-questions. -### 3) Analyse de texte +### 3) Analyse de texte {#3-text-analysis} - Permet une **analyse au plus près du texte d’un passage sélectionné** avec l’agent IA. - Développez ensemble de nouvelles lectures et des propositions de codes, ou discutez des ambivalences, des incertitudes et des questions d’interprétation encore ouvertes. @@ -190,7 +190,7 @@ Vous pouvez également enregistrer vos propres instructions d’analyse de texte > d) Une **conversation sur le matériau** commence alors, au cours de laquelle vous explorez et discutez ensemble différentes interprétations possibles. > e) **Conservez les résultats** : Lorsque vous avez terminé, demandez à l’agent IA d’enregistrer une synthèse des résultats sous forme d’annotation de texte. -### 4) Analyse de codes +### 4) Analyse de codes {#4-code-analysis} - Analyse toutes les **données regroupées sous un code ou une catégorie donnés**, y compris les sous-codes. - Discutez de vos codages avec l’agent IA, comparez différents codes, créez des sous-codes ou produisez des rapports. @@ -209,14 +209,14 @@ Vous pouvez aussi créer vos propres instructions pour cette fonction dans la [B > > **Résultat** : un rapport détaillé sur la « saturation théorique » du code actuel ou de la catégorie sélectionnée au sens de la théorie ancrée. L’agent IA recherche activement dans le matériau des variantes encore non codées du phénomène saisi par le code, des cas limites et des contrexemples, afin d’évaluer la saturation empirique et conceptuelle/théorique du code et de repérer les lacunes. Le mémo du code est également pris en compte. -## Pour conclure : la question de l’anthropomorphisation +## Pour conclure : la question de l’anthropomorphisation {#a-final-reflection-on-anthropomorphism} Nous avons délibérément choisi de ne pas donner de nom à l’agent IA de QualCoder, comme « Claude » chez Anthropic. Néanmoins, l’approche dialogique de l’intégration de l’IA dans QualCoder met en scène une forme de pseudo-interaction qui s’inspire, à bien des égards, des modes d’interaction humains, par exemple au sein d’une équipe de recherche. Dans son [instruction système fondamentale](https://github.com/ccbogel/QualCoder/blob/master/src/qualcoder/ai_prompts/_agent.md), l’agent IA de QualCoder se voit précisément attribuer ce rôle de quasi-membre de l’équipe. Anthropomorphisons-nous donc une machine en interagissant avec elle comme s’il s’agissait d’une personne menant une recherche ? Dans une certaine mesure, c’est effectivement le cas. Mais il me semble plus pertinent de considérer ces interactions comme une forme de « jeu de rôle », comme l’ont proposé [Shanahan, McDonell & Reynolds 2023](https://www.nature.com/articles/s41586-023-06647-8). Les modèles de langage actuels sont entrainés sur des interactions langagières humaines. Ils fonctionnent donc au mieux lorsqu’ils sont intégrés à ce type de situation d’interaction. Néanmoins, une utilisation de l’IA qui s’appuie sur une réflexion méthodologique en recherche qualitative en sciences sociales exige de garder à l’esprit qu’il s’agit d’un jeu de rôle induit par la technologie, et non d’une interaction avec un interlocuteur humain. -## Autres fonctions +## Autres fonctions {#further-functions} - Dans la **[Bibliothèque d’instructions IA](./6.3.-AI-Prompt-Library.md)**, vous pouvez enregistrer des stratégies d’analyse et des démarches méthodologiques qui ont fait leurs preuves sous forme d’instructions réutilisables. - Le **[Codage assisté par IA](./4.2.-AI-Assisted-Coding.md)**, dans l’espace « Coder le texte », utilise une recherche fondée sur l’IA pour vous aider à trouver, dans l’ensemble du corpus, des passages correspondant à un code donné. -- Si vous avez des **questions sur l’utilisation de QualCoder**, l’agent IA peut aussi vous aider en produisant des réponses fondées sur la documentation de QualCoder. Dans le menu principal, choisissez *Aide > Demander à l’agent IA*. +- Si vous avez des **questions sur l’utilisation de QualCoder**, l’agent IA peut aussi vous aider en produisant des réponses fondées sur la documentation de QualCoder. Dans le menu principal, choisissez *Aide > Demander à l’agent IA*. \ No newline at end of file diff --git a/docs/doc/fr/5.2.-Journals.md b/docs/doc/fr/5.2.-Journals.md index 11fa65e5..de363e9e 100644 --- a/docs/doc/fr/5.2.-Journals.md +++ b/docs/doc/fr/5.2.-Journals.md @@ -25,7 +25,7 @@ Vous pouvez trier les journaux par nom ou par date de modification. Vous pouvez La fenêtre du journal sera flottante, afin que vous puissiez saisir des notes pendant le codage ou la génération de rapports. -## Mettre en évidence le texte du journal à l’aide de balises +## Mettre en évidence le texte du journal à l’aide de balises {#highlight-journal-text-using-markdown} Certaines balises sont disponibles pour mettre en évidence des mots dans un journal. Utilisez un à trois symboles dièse pour les niveaux de titre. Entourez les mots d’un astérisque simple pour mettre le texte en italique. Entourez le texte de deux astérisques pour le mettre en gras. \ No newline at end of file diff --git a/docs/doc/fr/5.3.-Analysis.md b/docs/doc/fr/5.3.-Analysis.md index 648871f3..97842236 100644 --- a/docs/doc/fr/5.3.-Analysis.md +++ b/docs/doc/fr/5.3.-Analysis.md @@ -12,7 +12,7 @@ path: 5.3.-Analysis * Analyse assisté par IA, par sujet, texte et code. -## Recherche de codes { #code-retrieval } +## Recherche de codes {#code-retrieval} Ce rapport fournit une liste ou une matrice des données codées en fonction de vos sélections. Un ou plusieurs codes doivent être sélectionnés. Si une catégorie est sélectionnée, tous les codes de cette catégorie sont également sélectionnés. Plusieurs catégories peuvent être sélectionnées à l’aide de la souris et de la touche « Ctrl ». @@ -26,18 +26,18 @@ Les résultats du codage peuvent être affinés à l’aide des boutons Sélecti Si du texte est saisi dans le champ Rechercher du texte, seuls les codages contenant le texte correspondant seront présentés. Le texte recherché est également recherché dans les mémos des zones d’image codées et des segments audio/vidéo codés. La fonction de recherche de texte doit être utilisée en combinaison avec la sélection de fichiers, la sélection de cas ou la sélection d’attributs. -## Textes, images et segments codés importants +## Textes, images et segments codés importants {#important-coded-text-images-segments} Une case à cocher permet de sélectionner uniquement les codages importants. Cette fonction est utile pour trouver rapidement les exemples importants que vous pouvez utiliser dans un rapport écrit. -## Sélection d’attributs dans les rapports +## Sélection d’attributs dans les rapports {#attribute-selection-in-reports} Le bouton Sélection d’attributs ouvre une fenêtre dans laquelle vous pouvez sélectionner des attributs pour les fichiers et les cas, par exemple : uniquement les fichiers d’entretien pour les personnes âgées de plus de 60 ans. De plus, les paramètres d’attributs peuvent être enregistrés, chargés et supprimés. ![Sélection d’attributs](/images/8d349854-7e35-474b-8bba-119b23ed40b0.png) -## Matrice de codage +## Matrice de codage {#coding-matrix} Si vous créez un rapport et sélectionnez l’une des options de matrice, le volet des résultats sera divisé en deux volets. Le volet gauche affiche les données codées sous forme de liste, tandis que le volet droit affiche une matrice composée de lignes et de colonnes. Les types de colonnes peuvent être des codes, des catégories ou des catégories de niveau supérieur. Options de matrice : codes/catégories par fichier ou par cas. La matrice peut être transposée à l’aide de la case à cocher. @@ -51,18 +51,18 @@ Les rapports peuvent être exportés vers des fichiers texte, Open Document (ODT _Lorsque des cas sont sélectionnés, un autre volet s’affiche, présentant un tableau des cas (en lignes) et des catégories ou codes en colonnes_ -## Cases à cocher +## Cases à cocher {#check-boxes} * Cochez cette case pour afficher uniquement les segments codés qui ont été marqués comme importants. * Cochez cette case pour ajouter des statistiques récapitulatives au rapport. * Cochez cette case pour afficher le contexte des segments de texte codés. Cela permet d’afficher les 100 à 300 caractères de texte environnants (paramètre défini dans les paramètres) afin de replacer la section codée dans son contexte dans les résultats. Le segment de texte codé est affiché en gras. * Cochez cette case pour ajouter une référence au résultat codé. Cela s’applique si une référence a été importée et liée au fichier spécifique. -## Autres fonctions +## Autres fonctions {#other-functions} * Raccourci H. Appuyez sur h pour masquer ou afficher la section des commandes supérieures de la fenêtre. -### Mémos +### Mémos {#memos} * Affichage des mémos. Une liste déroulante propose différentes options : ne pas inclure de mémos, inclure divers mémos ou afficher les annotations des fichiers texte sélectionnés. @@ -71,7 +71,7 @@ Cliquez-droit sur un en-tête de code dans le rapport généré pour afficher d ![image](/images/a6d29ccf-2d9f-4faf-a1a6-5aaf3498e9a9.png) -### Exporter des rapports +### Exporter des rapports {#exporting-reports} Les rapports peuvent être exportés au format html, odt, txt, csv, xlsx. @@ -89,7 +89,7 @@ Les rapports peuvent être exportés au format html, odt, txt, csv, xlsx. ![image](/images/998a1792-38b1-489e-a459-200819bbbf73.png) -## Rapport de co-occurences de codes { #code-co-occurrence-report } +## Rapport de co-occurences de codes {#code-co-occurrence-report} Ce rapport présente un tableau de noms de codes sur les axes x et y. Les cellules du tableau indiquent le nombre de cooccurrences de codes. Il s’agit des cas où deux codes se chevauchent ou sont directement contigus. Cliquez sur la cellule pour afficher les détails du codage du texte. @@ -110,7 +110,7 @@ Exemples de graphe de cooccurrence et de graphe de clusters. ![images](/images/651896887-02b544ba-31f7-4ac8-b0f6-b6c017fd418d.png) -## Rapport de relations de code { #code-relations-report } +## Rapport de relations de code {#code-relations-report} Cette boîte de dialogue affiche les relations entre deux codes ou plus. Elle ne peut être appliquée qu’aux fichiers texte. Sélectionnez deux codes ou plus, puis cliquez sur le bouton Calculer. @@ -132,13 +132,13 @@ Des statistiques sommaires et des boîtes à moustaches peuvent être générée ![image](/images/a04d7b62-506b-4f05-ba62-5394e5f09748.png) -## Rapport correspondances exactes entre les codes { #code-text-by-exact-matches-report } +## Rapport correspondances exactes entre les codes {#code-text-by-exact-matches-report} Ce rapport détaille toutes les correspondances exactes de segments de texte codés, quand différents codes sont appliqués dans le même texte exact. Sélectionnez deux documents texte et deux codes ou plus. ![img](/images/284f388e-f561-416e-accb-ec18ad509944.png) -## Rapport de codage par segments de texte { #codes-by-text-segments-report } +## Rapport de codage par segments de texte {#codes-by-text-segments-report} Ce rapport affiche des lignes de segments de texte codés et des colonnes indiquant les codes qui ont été appliqués. Pour certains utilisateurs, par exemple dans le domaine juridique, il est pratique de voir quels codes ont été appliqués au même segment de texte. @@ -146,10 +146,10 @@ Un fichier Excel peut être exporté. ![image](/images/226f7c7d-f343-46d7-a2a7-49d86bfa3ef2.png) -## Graphe (carte heuristique) +## Graphe (carte heuristique) {#graph-mind-map} [Voir la page dédiée](5.5.-Graph) -## Analyse assisté par l’IA +## Analyse assisté par l’IA {#ai-assisted-analysis} -[Voir la page dédiée](5.1.-AI-chat-based-analysis) +[Voir la page dédiée](5.1.-AI-chat-based-analysis) \ No newline at end of file diff --git a/docs/doc/fr/5.3.-legacy-reports-landing.md b/docs/doc/fr/5.3.-legacy-reports-landing.md index 0fd8494b..d2d07ad9 100644 --- a/docs/doc/fr/5.3.-legacy-reports-landing.md +++ b/docs/doc/fr/5.3.-legacy-reports-landing.md @@ -7,4 +7,4 @@ path: 5.3.-legacy-reports-landing La page d’aide vers laquelle pointent les anciennes versions de QualCoder a été divisée en deux pages. Choisissez la section correspondant à l’outil que vous utilisez : - [Options du menu Analyse](5.3.-Analysis.md) : recherche de codes, cooccurrence et relations entre codes, correspondances exactes, segments de texte, graphes et analyse assistée par l’IA. -- [Options du menu Rapport](5.4.-Reports.md) : comparaison du codage, nombre et fréquence des codes, résumés des fichiers et des codes, graphiques et requêtes de base de données. +- [Options du menu Rapport](5.4.-Reports.md) : comparaison du codage, nombre et fréquence des codes, résumés des fichiers et des codes, graphiques et requêtes de base de données. \ No newline at end of file diff --git a/docs/doc/fr/5.4.-Reports.md b/docs/doc/fr/5.4.-Reports.md index 0a8efd27..ac00639f 100644 --- a/docs/doc/fr/5.4.-Reports.md +++ b/docs/doc/fr/5.4.-Reports.md @@ -18,7 +18,7 @@ path: 5.4.-Reports Dans la version 3.8 et les versions ultérieures, vous pouvez cliquer-droit de la souris sur une cellule contenant du texte codé par cooccurrence pour créer un nouveau code fusionné qui combine les deux codes qui se chevauchent. -## Rapport de comparaison de codage { #coding-comparison-report } +## Rapport de comparaison de codage {#coding-comparison-report} Cette option affiche les similitudes et les différences globales entre deux codeur⋅euses dans tous les fichiers texte. Sélectionnez deux codeur⋅euses et cliquez sur le bouton « Exécuter les comparaisons ». Les statistiques créées ici concernent uniquement le texte codé, et non les images ou les fichiers multimédias codés. @@ -40,7 +40,7 @@ Clic droit sur un code pour plus d’options : ![image](/images/gh-ad6903e9-1f1a-4901-92c4-9c7e00d174e4.png) -## Rapport de comparaison de codage par fichier { #coding-comparison-by-file-report } +## Rapport de comparaison de codage par fichier {#coding-comparison-by-file-report} Cette option affiche les similitudes et les différences globales entre deux codeur⋅euses dans UN fichier sélectionné. Sélectionnez un fichier, un code et deux codeur⋅euses. Cliquez ensuite sur le bouton « Exécuter les comparaisons ». Les statistiques et les comparaisons pour les segments audio/vidéo codés sont en cours de développement. La concordance globale, la discordance et le coefficient Kappa de Cohen sont calculés pour le texte et les images. Un fichier image s’affiche dans une fenêtre séparée, montrant les sélections des deux codeur⋅euses dans des zones encadrées en jaune ou en bleu. Le texte en vert indique les endroits où les deux codeur⋅euses ont codé la même section de texte. Le survol de la souris fournit des informations supplémentaires. @@ -48,7 +48,7 @@ La concordance globale, la discordance et le coefficient Kappa de Cohen sont cal ![image](/images/cd5eff94-2cc0-4988-af48-da12f55bfc48.png) -## Rapport de fréquence de codes { #code-frequencies-report } +## Rapport de fréquence de codes {#code-frequencies-report} Cette fenêtre affiche tous les codes et catégories ainsi que la fréquence d’utilisation pour chaque codeur⋅euse. Les fréquences des codes peuvent être sélectionnées pour des fichiers spécifiques. @@ -58,7 +58,7 @@ Clic droit sur un code pour plus d’options : ![image](/images/gh-2a499964-a0c6-4961-ae7e-d1851bf0d549.png) -## Rapport récapitulatif du fichier { #file-summary-report } +## Rapport récapitulatif du fichier {#file-summary-report} Cliquez sur un fichier pour obtenir un résumé de celui-ci. Il décrit les métadonnées multimédias, les caractères et la fréquence des mots. Attributs. Il résume le nombre de codes pour ce fichier. Pour les codages de texte, il résume la longueur moyenne du texte. Pour les codages d’images, il résume la surface moyenne en pixels. Pour les codages audio/vidéo, il résume la longueur moyenne des segments. @@ -70,7 +70,7 @@ Clic droit sur un code pour plus d’options : ![image](/images/gh-05dbe1fd-f4ae-4899-99c9-df274ae43f12.png) -## Rapport récapitulatif du code { #code-summary-report } +## Rapport récapitulatif du code {#code-summary-report} Cliquez sur un code pour obtenir un résumé de ce code. Les codeur⋅euses qui ont utilisé le code. Le nombre de codages dans les médias texte, image et audio/vidéo. Pour les codages texte, il résume la longueur moyenne du texte et les mots les plus courants. Pour les codages image, il résume la surface moyenne en pixels. Pour les codages audio/vidéo, il résume la longueur moyenne des segments. @@ -82,7 +82,7 @@ Clic droit sur un code pour plus d’options : ![image](/images/gh-2a499964-a0c6-4961-ae7e-d1851bf0d549.png) -## Graphiques { #charts } +## Graphiques {#charts} Différents types de graphiques et options de filtrage sont disponibles. @@ -130,7 +130,7 @@ Les mots vides actuellement utilisés se trouvent dans le fichier stopwords.txt ![Nuage de mots](/images/wc.png) -## Requêtes de base de données { #database-queries } +## Requêtes de base de données {#database-queries} Appliquez des requêtes SQL pour interroger les données. Cette fenêtre contient trois volets. Le volet supérieur sert à saisir les instructions SQL et le volet inférieur contient les résultats des requêtes. Le volet gauche contient les noms des tables et des champs. Double-cliquez sur un nom de champ pour l’ajouter à la requête SQL. Les résultats peuvent être exportés vers un fichier délimité. Si vous n’êtes pas familiarisé avec le langage SQL, soyez vigilant, car vous pourrez mettre à jour et supprimer les données, ainsi que sélectionner des données. Remarque : certains symboles Unicode ne sont pas convertis en texte brut et sont ignorés. Plusieurs déclarations préparées sont répertoriées : @@ -156,4 +156,4 @@ Les requêtes par défaut, telles que celles illustrées dans l’image, sont de ![image](/images/18c552a3-b256-453a-80ec-5c2931016e12.png) -Comme vous pouvez effectuer toutes les requêtes de base de données, y compris la mise à jour des données et la suppression des tables, conservez des copies de sauvegarde, faute de quoi il est possible de détruire irrémédiablement la base de données. +Comme vous pouvez effectuer toutes les requêtes de base de données, y compris la mise à jour des données et la suppression des tables, conservez des copies de sauvegarde, faute de quoi il est possible de détruire irrémédiablement la base de données. \ No newline at end of file diff --git a/docs/doc/fr/5.5.-Graph.md b/docs/doc/fr/5.5.-Graph.md index 74573c78..3ed3d405 100644 --- a/docs/doc/fr/5.5.-Graph.md +++ b/docs/doc/fr/5.5.-Graph.md @@ -19,7 +19,7 @@ Un clic droit sur une ligne vous permet de modifier son épaisseur, de passer à Le texte codé, les images codées et les segments audiovisuels codés peuvent être affichés. Les notes relatives au texte codé, aux images codées et aux segments audiovisuels codés peuvent être affichées dans des zones de texte. Chacune d’entre elles comporte des info-bulles fournissant des informations supplémentaires. Vous ne pouvez pas afficher plusieurs fois le même segment codé dans le graphe. -## Faites un clic droit sur les éléments pour plus d’options +## Faites un clic droit sur les éléments pour plus d’options {#right-click-on-items-for-more-options} Image : ![image](/images/gh-4c02fe82-c630-4a9a-a982-912ddd4176c3.png) Segment de texte codé : @@ -29,5 +29,5 @@ Segment de texte codé : Style de ligne : ![image](/images/gh-baa778e1-e439-4727-bd42-b84e00a3f0a3.png) -## Options d’export +## Options d’export {#export-options} Les graphes peuvent être enregistrés, chargés et supprimés. Ils peuvent être exportés aux formats suivants : PNG, PDF, ODT (pour LibreOffice et MS Office), [Draw.io](https://www.drawio.com/). \ No newline at end of file diff --git a/docs/doc/fr/6.1.-Imports-and-Exports.md b/docs/doc/fr/6.1.-Imports-and-Exports.md index 61124b07..c46d5326 100644 --- a/docs/doc/fr/6.1.-Imports-and-Exports.md +++ b/docs/doc/fr/6.1.-Imports-and-Exports.md @@ -16,17 +16,17 @@ Options similaires pour les exports : Les enquêtes peuvent être importées dans le gestionnaire de fichiers. [Voir Importation d’enquêtes](6.2.-Survey-Imports) -## Exporter une grille de codage +## Exporter une grille de codage {#codebook-export} Il s’agit d’une option disponible dans le menu Projet > Exporter. Une grille de codage est une liste de vos codes. Chaque mémo de code doit détailler les raisons pour lesquelles chaque code a été créé. La grille de codage peut être exportée vers un fichier texte. La grille de codage indique également la fréquence d’utilisation des codes (par tous les codeur⋅euses). Les codes et les catégories étant organisés dans une structure arborescente, le double signe moins « – » indique les codes et catégories subordonnés au sein d’une catégorie. -## Importer une grille de codage +## Importer une grille de codage {#codebook-import} Importez une grille de codage sous forme de fichier texte brut (.txt) ou de fichier .csv. Utilisez deux symboles « supérieur à » pour séparer la catégorie et le code. Utilisez trois symboles « supérieur à » pour définir un code subordonné à un code. -### Grille de codage - Import de texte brut +### Grille de codage - Import de texte brut {#codebook-plain-text-import} Utilisez une tabulation pour ajouter une note. @@ -42,7 +42,7 @@ catégorie3>>code4 code5>>>code6>>>code7 ``` -### Grille de codage - Fichier CSV +### Grille de codage - Fichier CSV {#codebook-csv-file} Créez un fichier CSV dans Libre Office Calc ou Microsoft Office Excel. Les catégories et codes se trouvent dans la première colonne, et configurés de la même manière qu’un fichier en texte brut. Les mémos de code se trouvent dans la deuxième colonne. @@ -54,7 +54,7 @@ catégorie1>>catégorie2>>code2 catégorie3>>code3 ``` -## REFI-QDA +## REFI-QDA {#refi-qda} La [Rotterdam Exchange Format Initiative (REFI)](https://www.qdasoftware.org) est une norme ouverte permettant d’exporter et d’importer des grilles de codage et des projets depuis et vers différents logiciels d’analyse qualitative de données assistée par ordinateur. À l’heure actuelle, QualCoder est capable d’importer une grille de codage à condition que la grille de codage utilise la version « urn:QDA-XML:codebook:1.0 ». QualCoder exporte également dans cette version. @@ -72,7 +72,7 @@ Si aucune donnée codée n’est visible, vous devrez peut-être modifier le nom Cette information est désormais obsolète (février 2021), mais un utilisateur a testé l’importation d’un fichier de projet REFI-QDA généré par QualCoder et importé dans MAXQDA, Quirkos et Atlas.ti. Seuls le texte et les images ont été testés. Un PDF des résultats du test est disponible ici : [Test d’importation de fichiers de projet REFI-QDA dans Atlas, MAXQDA, Quirkos PDF](https://qualcoder.files.wordpress.com/2021/02/refi-qda-project-import-quirkos-maxqda-atlas.pdf) -## Importer depuis Taguette +## Importer depuis Taguette {#taguette-import} Les projets créés avec [Taguette](https://www.taguette.org/) peuvent être importés depuis un fichier sqlite. Toutes vos données de codage principales seront transférées. @@ -80,30 +80,30 @@ Fermez tout projet ouvert. Ensuite, dans le menu principal, sous « Projet », c Si vous ne voyez aucune donnée codée, vous devrez peut-être modifier le nom du codeur⋅euse actuel dans les paramètres. Essayez la liste déroulante du nom du codeur⋅euse. -## Importer depuis Sonal π (Sonal Pi) +## Importer depuis Sonal π (Sonal Pi) {#sonal-sonal-pi-import} Il est possible d’importer des projets créés avec [Sonal Pi](https://www.sonal-info.com), un logiciel d’analyse qualitative des données développé en France. -## Importer depuis RQDA +## Importer depuis RQDA {#rqda-import} Les projets créés avec [RQDA](http://rqda.r-forge.r-project.org/) peuvent être importés directement. Toutes les données, à l’exception des catégories de fichiers, sont importées. Fermez tous les projets ouverts. Ensuite, dans le menu principal, sous Projet, cliquez sur Importation de projet RQDA. Vous serez invité à créer un nouveau projet. Entrez donc un nom. Il vous sera ensuite demandé de sélectionner le fichier de projet RQDA. QualCoder importera alors les données. Si aucune donnée codée n’est visible, vous devrez peut-être modifier le nom du codeur⋅euse actuel dans les paramètres. Essayez la liste déroulante du nom du codeur⋅euse. -## Import d’enquête +## Import d’enquête {#survey-import} Voir la page [Import d’enquête](6.2.-Survey-Imports) -## Importer une bibliographie +## Importer une bibliographie {#bibliography-import} Voir la page [Gestion des données - Références](3.5.-References) -## Aide - Fonctions spéciales +## Aide - Fonctions spéciales {#help-special-functions} -### Mise à jour dynamique du contenu textuel +### Mise à jour dynamique du contenu textuel {#dynamic-update-text-content} Cette fonction est utile pour mettre à jour des fichiers texte tels que des extraits d’articles de blog qui changent au fil du temps. Mettez à jour un fichier texte tout en essayant de conserver les segments de texte codés existants. Sélectionnez le fichier texte à remplacer et sélectionnez le fichier de remplacement. Cliquez sur le bouton en forme de roue dentée pour lancer la mise à jour. Cette fonction fonctionne en recherchant le texte identique dans le fichier de remplacement, à mesure qu’elle analyse le texte du fichier. Elle peut produire des segments codés erronés. -### Fusionner des projets +### Fusionner des projets {#merge-projects} -Voir la page [Fusionner des projets QualCoder](6.4.-Merge-Projects) +Voir la page [Fusionner des projets QualCoder](6.4.-Merge-Projects) \ No newline at end of file diff --git a/docs/doc/fr/6.2.-Survey-Imports.md b/docs/doc/fr/6.2.-Survey-Imports.md index 48c2516f..2c9ba0da 100644 --- a/docs/doc/fr/6.2.-Survey-Imports.md +++ b/docs/doc/fr/6.2.-Survey-Imports.md @@ -24,7 +24,7 @@ Ci-dessus, les données contenues dans le fichier *survey456.csv* Ci-dessus figurent les données du fichier *survey789.xlsx* -## Importer le fichier survey456 +## Importer le fichier survey456 {#importing-the-file-survey456csv} Cliquez sur le bouton « Importer l’enquête » et sélectionnez le fichier dans le dossier « Exemples ». @@ -50,7 +50,7 @@ Dans l’écran Gestion > Cas, ela s’affiche comme suit, avec un fichier texte ![image](/images/gh-a35b341a-40e6-4d38-9647-179f6bc25d5e.png) -### Ajouter des données supplémentaires +### Ajouter des données supplémentaires {#adding-more-data} À l'aide du bouton « Importer un sondage », sélectionnez et importez le fichier survey789.xlsx. Ne cochez aucune case. ![image](/images/gh-03a07b75-d7bf-496d-952c-cb397ebab8f7.png) @@ -69,4 +69,4 @@ La différence réside ici dans le fait que les nouveaux fichiers comportaient d Les informations supplémentaires sont importées et ajoutées aux cas corrects. ![image](/images/gh-7445de6b-7c72-4598-9f78-35be4f272c35.png) À partir du dossier Examples, importez survey789_replace_data.xlsx, en utilisant les mêmes paramètres d'importation que précédemment. Celui-ci contient les attributs Pet, PetAge, pour ID7, ID8 et ID9. Chacun de ces attributs contient désormais des données différentes, qui remplaceront les données d'origine. -![image](/images/gh-0dd5c404-0a5c-484c-84cf-2c89d04bebc9.png) +![image](/images/gh-0dd5c404-0a5c-484c-84cf-2c89d04bebc9.png) \ No newline at end of file diff --git a/docs/doc/fr/6.3.-AI-Prompt-Library.md b/docs/doc/fr/6.3.-AI-Prompt-Library.md index 3104ea43..c8e65229 100644 --- a/docs/doc/fr/6.3.-AI-Prompt-Library.md +++ b/docs/doc/fr/6.3.-AI-Prompt-Library.md @@ -11,7 +11,7 @@ path: 6.3.-AI-Prompt-Library - Nous avons déjà intégré certaines instructions intéressantes proposées par d’autres chercheurs en qualité et publiées dans diverses revues. Nous espérons que l’utilisation croissante de l’IA dans la recherche qualitative s’accompagnera d’une culture de développement, de partage et de discussion autour d’instructions sophistiquées au sein de la communauté scientifique, afin que nous puissions tous apprendre les uns des autres et améliorer les nouvelles méthodes émergentes dans ce domaine. -## La structure d’une instruction +## La structure d’une instruction {#the-structure-of-a-prompt} Dans son sens le plus basique, une instruction ressemble à la question que vous tapez dans l’interface web de ChatGPT. Mais même dans ce cas, c’est un peu plus complexe. En arrière-plan, ChatGPT accompagne votre question d’une « instruction système » invisible qui demande à l’IA d’être un assistant utile et bienveillant, de ne pas donner de conseils médicaux ou juridiques, etc. @@ -29,7 +29,7 @@ Cette structure comprend : - et l'**instruction analytique** (en orange), que vous pouvez modifier et adapter à vos besoins. -## Instructions analytiques +## Instructions analytiques {#analytic-prompts} Les instructions analytiques sont **au cœur des fonctionnalités d’IA de QualCoder**. Elles indiquent à l’IA comment analyser vos données. Ces instructions peuvent être simples, mais aussi devenir des directives complexes avec des descriptions détaillées de chaque étape que l’IA doit suivre pendant l’analyse, y compris le contexte méthodologique, etc. (voir Lieder & Schäffer, 2024)1. diff --git a/docs/doc/fr/7.2.-QualCoder-Video-Tutorials.md b/docs/doc/fr/7.2.-QualCoder-Video-Tutorials.md index c058b937..b060f743 100644 --- a/docs/doc/fr/7.2.-QualCoder-Video-Tutorials.md +++ b/docs/doc/fr/7.2.-QualCoder-Video-Tutorials.md @@ -4,7 +4,7 @@ path: 7.2.-QualCoder-Video-Tutorials # Vidéos présentant l’usage de QualCoder -## QualCoder 3.7 +## QualCoder 3.7 {#qualcoder-37} [QualCoder 3.7 part 1 - Colin Curtain](https://www.youtube.com/watch?v=TCLCT893JcM) @@ -20,13 +20,13 @@ path: 7.2.-QualCoder-Video-Tutorials [Alpha version of 3.7 compared with other qualitative software - Van Tran](https://www.youtube.com/watch?v=Cqwu3mjJJHg) -## QualCoder 3.6 +## QualCoder 3.6 {#qualcoder-36} [Webinar: KI-unterstütze Datenanalyse in QualCoder 3 .6 - In German](https://www.youtube.com/watch?v=JF64vbngedA) [Qualitativ Forschen - AI-based horizontal coding](https://www.youtube.com/watch?v=FrQyTOTJhCc) -## QualCoder 3.5 +## QualCoder 3.5 {#qualcoder-35} [Tutorial, by the Colin Curtain](https://www.youtube.com/watch?v=wj5fY4F5Jxo) @@ -37,6 +37,6 @@ path: 7.2.-QualCoder-Video-Tutorials [Qualcoder - Data Hub Tool Talk - University of Idaho](https://www.youtube.com/watch?v=119k-jNOl8I) -## Anciens tutoriels +## Anciens tutoriels {#older-tutorials} D’anciens tutoriels peuvent être trouvé sur Youtube. \ No newline at end of file diff --git a/docs/doc/fr/7.3.-QualCoder-Development.md b/docs/doc/fr/7.3.-QualCoder-Development.md index b000de1c..709503d4 100644 --- a/docs/doc/fr/7.3.-QualCoder-Development.md +++ b/docs/doc/fr/7.3.-QualCoder-Development.md @@ -9,14 +9,14 @@ QualCoder est actuellement développé sur Windows 11. QualCoder est écrit en Après la version 4.0, l’un des axes de développement consistera à revoir l’aspect visuel et l’interface utilisateur de QualCoder. L’objectif est de rendre l’interface plus moderne et plus attrayante. Un autre axe d'amélioration consistera à fournir davantage de documentation relative à la gouvernance, afin de faciliter l'utilisation de QualCoder au sein des grandes institutions. -## Operating systems used +## Operating systems used {#operating-systems-used} QualCoder a été utilisé sur Windows 11, macOS, Ubuntu 24, Lubuntu, Fedora, Linux Mint, Arch Linux, Fedora, NixOS et ZorinOS. * L’utilisation de l’audio/vidéo avec QualCoder sur Fedora fait planter QualCoder. * Debian avec Gnome et l’option de fenêtres en mosaïque — réduit la taille de la fenêtre QualCoder. La meilleure option consiste à désactiver le placement des fenêtres en mosaïque dans les paramètres de Gnome. -## Remerciements +## Remerciements {#acknowledgements} Ronggui Huang, Zhang Gehao – Créateurs de RQDA, source d’inspiration pour QualCoder. Mike MacCana – Code source du module docx. @@ -29,24 +29,24 @@ Jofen Kihlstrom pour ses précédentes traductions en suédois. Van Tran, pour ses nombreuses suggestions utiles et son soutien au cours de ces dernières années. Aux nombreux membres de GitHub, pour leurs commentaires, leurs idées et leur soutien à ce projet. -## Citation +## Citation {#citation} Citation : Curtain C, Dröge K, Missaghieh--Poncet J, Salomón L. (2026) QualCoder 4.0 [Computer software]. Disponible à https ://github.com/ccbogel/QualCoder/releases/tag/4.0 -## Structures de données +## Structures de données {#data-structures} **Le dossier de projet qda** Contient des dossiers pour les documents importés, les images et l’audio et la vidéo. Il contient également la base de données sqlite, nommée data.qda, pour stocker les données de codage. Lorsque l’IA est activée, il existe un dossier ai_data contenant une base de données sqlite d’historique de conversation et un vectorstore. Un vector store est une représentation numérique de mots, de phrases et d’expressions utilisée par le modèle de langage IA. Le vectorstore utilise faiss, qui sert aux recherches de similarité par l’IA. **Le dossier de travail .qualcoder** QualCoder crée les fichiers QualCoder.log et QualCoder_settings.txt à l’intérieur d’un dossier .qualcoder dans votre répertoire personnel. Le fichier de paramètres contient le nom du codeur actuel, un répertoire de travail par défaut, la police, les langues et d’autres options. Le fichier journal enregistre les erreurs du programme et certaines actions de l’utilisateur. Il peut y avoir plusieurs fichiers journaux successifs (à rotation). Vous ne devez placer aucun fichier dans ce dossier, car il est utilisé comme zone de stockage des paramètres de travail du programme QualCoder. -## Licences +## Licences {#licenses} -### Licence LGPL-3.0 +### Licence LGPL-3.0 {#lgpl-30-license} QualCoder is free software : you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. QualCoder is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY ; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with QualCoder. If not, see [https://www.gnu.org/licenses ](https://www.gnu.org/licenses) -### Licence pour highlighter.py +### Licence pour highlighter.py {#license-for-highlighterpy-code} Copyright (C) 2013 Riverbank Computing Limited. Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). @@ -77,7 +77,7 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." -### Licence pour docx.py +### Licence pour docx.py {#license-for-docxpy-code} Copyright (c) 2009-2010 Mike MacCana Permission is hereby granted, free of charge, to any person @@ -102,7 +102,7 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -### Dependency Licenses +### Dependency Licenses {#dependency-licenses} Les dépendances sont des modules Python supplémentaires dont QualCoder a besoin pour fonctionner. Les licences relatives à ces dépendances se trouvent dans le dossier QualCoder/docs. Dernière mise à jour : 8 octobre 2026. [DEPENDENCY_LICENSES.txt](https://github.com/ccbogel/QualCoder/blob/master/docs/DEPENDENCY_LICENSES.md) \ No newline at end of file diff --git a/docs/doc/fr/7.4.-SQlite-Data-Structure.md b/docs/doc/fr/7.4.-SQlite-Data-Structure.md index 0c65d9ea..c3f3763d 100644 --- a/docs/doc/fr/7.4.-SQlite-Data-Structure.md +++ b/docs/doc/fr/7.4.-SQlite-Data-Structure.md @@ -8,7 +8,7 @@ The current v8 data structure is described to assist with developing sql queries Tables are listed alphabetically. -## Table: annotation +## Table: annotation {#table-annotation} **anid** _integer_ A unique auto-number @@ -24,7 +24,7 @@ Tables are listed alphabetically. **date** _text_ The date and time the entry was created, format `yyyy-mm-dd hh:mm:ss` -## Table: attribute +## Table: attribute {#table-attribute} **attrid** _integer_ A unique auto-number. @@ -40,7 +40,7 @@ Tables are listed alphabetically. **date** _text_ The date and time the entry was created, format `yyyy-mm-dd hh:mm:ss` -## Table: attribute_type +## Table: attribute_type {#table-attribute-type} **name** _text_ The unique name of the attribute. @@ -54,7 +54,7 @@ Tables are listed alphabetically. **valuetype** _text_ This is either 'character' or 'numeric' -## Table: case_text +## Table: case_text {#table-case-text} **id** _integer_ Unique autonumber. @@ -72,7 +72,7 @@ Tables are listed alphabetically. **date** _text_ The date and time the entry was created, format `yyyy-mm-dd hh:mm:ss` -## Table: cases +## Table: cases {#table-cases} **caseid** _integer_ A unique auto-number. @@ -84,7 +84,7 @@ Tables are listed alphabetically. **date** _text_ The date and time the entry was created, format `yyyy-mm-dd hh:mm:ss` -## Table: code_av +## Table: code_av {#table-code-av} **avid** _integer_ A unique auto-number. @@ -104,7 +104,7 @@ Tables are listed alphabetically. **important** _integer_ If assigned 1 it is an important code. -## Table: code_cat +## Table: code_cat {#table-code-cat} **catid** _integer_ A unique auto-number. @@ -118,7 +118,7 @@ Tables are listed alphabetically. **supercatid** _integer_ This represents the parent category of this category. It is Null if it is a top category. -## Table: code_image +## Table: code_image {#table-code-image} **imgid** _integer_ A unique auto-number. @@ -144,7 +144,7 @@ Tables are listed alphabetically. **pdf_page** _integer_ Null or a number representing the page of the pdf -## Table: code_name +## Table: code_name {#table-code-name} **cid** _integer_ A unique auto-number. @@ -160,7 +160,7 @@ Tables are listed alphabetically. **color** _text_ A hex value ranging from '#000000' to '#FFFFFF' QualCoder recognises 120 colours so can apply light or dark text over the top. -## Table: code_text +## Table: code_text {#table-code-text} **ctid** _integer_ A unique auto-number. (added in v3). @@ -184,7 +184,7 @@ Tables are listed alphabetically. **important** _integer_ If assigned 1 it is an important code. -## Table: journal +## Table: journal {#table-journal} **jid** _integer_ A unique auto-number. @@ -196,7 +196,7 @@ Tables are listed alphabetically. **date** _text_ The date and time the entry was created, format `yyyy-mm-dd hh:mm:ss` -## Table: project +## Table: project {#table-project} Should contain one row. @@ -216,7 +216,7 @@ Should contain one row. **recently_used_codes** _text_ Contained code_ids of recently used text codes, space delimited. -## Table: source +## Table: source {#table-source} **id** _integer_ A unique auto-number. @@ -244,7 +244,7 @@ If the mediapath begins with: '/images/' , '/audio/', '/video/' the image, audio If the mediapath begins with: 'images:' , 'audio:', 'video:' the image, audio or video file is linked to externally. The full path to the file is stored. -## Table: stored_sql +## Table: stored_sql {#table-stored-sql} **title** _text_ The title of the sql. @@ -254,7 +254,7 @@ If the mediapath begins with: 'images:' , 'audio:', 'video:' the image, audio or **ssql** _text_ The user generated sql. -## Table: ris +## Table: ris {#table-ris} Used for RIS bibliography @@ -266,11 +266,11 @@ Used for RIS bibliography **value** _text_ text data for the tag. -## Graph visualisation tables +## Graph visualisation tables {#graph-visualisation-tables} Several tables to store details of save graphs then the items within the graphs. -## Table: graph +## Table: graph {#table-graph} **grid** _integer_ Unique identifier. @@ -284,7 +284,7 @@ Several tables to store details of save graphs then the items within the graphs. **scene_height** _integer_ Used to set scene size on load. -## Table: gr_av_item +## Table: gr_av_item {#table-gr-av-item} Displays an arrow icon for a playable A/V coded segment. @@ -308,7 +308,7 @@ Displays an arrow icon for a playable A/V coded segment. **color** text -## Table: gr_case_text_item +## Table: gr_case_text_item {#table-gr-case-text-item} Displays details of the case, with formatting parameters. @@ -330,7 +330,7 @@ Displays details of the case, with formatting parameters. **displaytext** text -## Table: gr_cdct_line_item +## Table: gr_cdct_line_item {#table-gr-cdct-line-item} Display line linking codes and categories @@ -354,7 +354,7 @@ Display line linking codes and categories **isvisible** integer -## Table: gr_cdct_text_item +## Table: gr_cdct_text_item {#table-gr-cdct-text-item} Displays coded text with some formatting parameters. @@ -380,7 +380,7 @@ Displays coded text with some formatting parameters. **displaytext** text -## Table: gr_file_text_item +## Table: gr_file_text_item {#table-gr-file-text-item} Displays file details with formatting parameters. @@ -402,7 +402,7 @@ Displays file details with formatting parameters. **displaytext** text -## Table: gr_free_line_item +## Table: gr_free_line_item {#table-gr-free-line-item} Displays user defined line link between objects @@ -426,7 +426,7 @@ Displays user defined line link between objects **isvisible** integer -## Table: gr_free_text_item +## Table: gr_free_text_item {#table-gr-free-text-item} Displays free text, or memos with formatting parameters. @@ -458,7 +458,7 @@ Displays free text, or memos with formatting parameters. **memo_avid** integer -## Table: gr_pix_item +## Table: gr_pix_item {#table-gr-pix-item} Displays coded image. @@ -484,4 +484,4 @@ Displays coded image. **tooltip** text -**pdf_page** integer - if an image of a pdf +**pdf_page** integer - if an image of a pdf \ No newline at end of file diff --git a/docs/doc/fr/7.5.-AI-Technical-Information.md b/docs/doc/fr/7.5.-AI-Technical-Information.md index cd338142..661d3f12 100644 --- a/docs/doc/fr/7.5.-AI-Technical-Information.md +++ b/docs/doc/fr/7.5.-AI-Technical-Information.md @@ -3,4 +3,4 @@ path: 7.5.-AI-Technical-Information --- # Informations techniques sur l’IA -(La mise à jour se fera plus tard) +(La mise à jour se fera plus tard) \ No newline at end of file diff --git a/docs/doc/fr/7.6.-How-to-contribute.md b/docs/doc/fr/7.6.-How-to-contribute.md index 1ee63506..f3845c05 100644 --- a/docs/doc/fr/7.6.-How-to-contribute.md +++ b/docs/doc/fr/7.6.-How-to-contribute.md @@ -3,18 +3,18 @@ path: 7.6.-How-to-contribute.md --- # Comment contribuer ? -## Contribuer au code +## Contribuer au code {#contributing-to-the-code} Merci de lire les [lignes directives de la contribution](https://github.com/ccbogel/QualCoder/blob/master/docs/CONTRIBUTING.md). -### Règles clés en bref +### Règles clés en bref {#key-rules-at-a-glance} - **Choisir d'abord un ticket (issue).** Recherchez un ticket existant ou créez-en un, et commentez-le avant d'ouvrir une Pull Request. Attendez que le ticket vous soit assigné avant de commencer à travailler. - **Une Pull Request, un seul commit.** Regroupez votre travail en un seul commit avec un message descriptif reflétant vos changements. - **Nommage.** Créez une branche dédiée, nommée en fonction du ticket traité. - **Licence.** En soumettant une Pull Request, vous placez votre contribution sous la licence LGPLv3 du projet (« Inbound = Outbound »). -### Contributions assistées par l'IA +### Contributions assistées par l'IA {#ai-assisted-contributions} Il est possible d'utiliser des outils d'IA pour assister vos contributions, mais vous restez pleinement responsable de tout ce que vous soumettez. @@ -26,12 +26,12 @@ Il est possible d'utiliser des outils d'IA pour assister vos contributions, mais Les outils d'IA ne doivent **pas** être utilisés pour corriger les tickets étiquetés `good first issue`. Ils existent pour l'apprentissage humain. -## Contribuer à la traduction -### Traduire la documentation +## Contribuer à la traduction {#contribute-to-the-translation} +### Traduire la documentation {#translate-the-documentation} Il est possible de traduire la documentation, en créant / modifiant les fichiers markdown dans docs/doc dans [le dépôt du site internet](https://github.com/QualCoder-Org/qualcoder-org.github.io). -### Traduire le logiciel +### Traduire le logiciel {#translate-the-software} QualCoder gère la fonctionnalité multilingue grâce à deux types de fichiers de traduction : @@ -63,4 +63,4 @@ Glossaire concernant la traduction, afin d’avoir une cohérence dans la traduc - Green weak : Deutéranomalie - Green blind : Deutéranopie - Pie charts : Diagrammes circulaires -- Bar charts : Graphique à barres +- Bar charts : Graphique à barres \ No newline at end of file diff --git a/docs/doc/fr/index.md b/docs/doc/fr/index.md index 31c63c3d..a72ea661 100644 --- a/docs/doc/fr/index.md +++ b/docs/doc/fr/index.md @@ -24,7 +24,7 @@ QualCoder comprend un ensemble de fonctionnalités assistées par l’IA qui uti - **QualCoder peut être modifié**. Vous pouvez modifier et adapter QualCoder à vos besoins, à condition de mettre vos modifications à la disposition de tous. Cela signifie également que vous pouvez copier le logiciel et le transmettre gratuitement à vos collègues ou à vos étudiants. - **QualCoder est un logiciel conçu pour soutenir la science ouverte**. [Recommandations de l’UNESCO sur la science ouverte](https://www.unesco.org/en/open-science?hub=686) -## Version actuelle +## Version actuelle {#current-release} Les versions du logiciel sont disponibles sur [GitHub](https://github.com/ccbogel/QualCoder/releases). Elles contiennent le code source et les fichiers exécutables. Les fichiers exécutables constituent un moyen simple d’exécuter QualCoder : il suffit de double-cliquer dessus pour le lancer, mais sachez que l’ouverture peut prendre jusqu’à 20 secondes. [:octicons-archive-24: Dernière version stable disponible sur GitHub](/latest){ .md-button .md-button--primary } @@ -42,7 +42,7 @@ Les versions du logiciel sont disponibles sur [GitHub](https://github.com/ccboge La version en développement est disponible ici : [https://github.com/ccbogel/QualCoder](https://github.com/ccbogel/QualCoder) -## Soutenir QualCoder +## Soutenir QualCoder {#support-qualcoder} Si vous appréciez QualCoder et que vous l’avez trouvé utile dans votre travail, n’hésitez pas à laisser un avis sur des sites tels que [Saashub](https://www.saashub.com/qualcoder-alternatives) ou [AlternativeTo](https://alternativeto.net/software/qualcoder). @@ -54,12 +54,12 @@ La création de ce logiciel, mis à disposition gratuitement, a nécessité de t QualCoder est écrit en Python et utilise Qt6 pour l’interface graphique. QualCoder a été utilisé sous Windows 11, macOS et diverses distributions Linux : Ubuntu, Lubuntu, ZorinOS, Arch, Fedora. -## Citation +## Citation {#citation} Curtain, C. Dröge, K. Missaghieh--Poncet, J. Salomón, L. (2026) QualCoder 4.0 [Logiciel]. Disponible à l’adresse suivante : https://github.com/ccbogel/QualCoder/releases/tag/4.0 Remplacer le numéro de version (4.0) au besoin par la version que vous utilisez. -## Licence +## Licence {#license} -QualCoder est sous licence LGPL v3. +QualCoder est sous licence LGPL v3. \ No newline at end of file diff --git a/docs/doc/pt/1.-Overview.md b/docs/doc/pt/1.-Overview.md index 80685061..c8ad84e2 100644 --- a/docs/doc/pt/1.-Overview.md +++ b/docs/doc/pt/1.-Overview.md @@ -5,19 +5,19 @@ path: 1.-Overview.md As instruções descrevem como instalar e usar o QualCoder. As informações aqui referem-se à versão mais recente do QualCoder. -## O que é o QualCoder? +## O que é o QualCoder? {#what-is-qualcoder} O QualCoder é um software livre e de código aberto para análise de dados qualitativos. Com o QualCoder você pode codificar texto, imagens, áudio e vídeo, escrever notas de diário e memorandos. Você pode organizar códigos em um esquema de categorização em árvore. Vários tipos de relatórios podem ser gerados. A maioria dos relatórios pode ser exportada como html, texto de documento aberto (ODT), texto simples ou arquivos de Excel (XLSX). -Versões recentes contêm recursos opcionais auxiliados por IA que usam GPT-4 ou outros modelos de linguagem em larha escala para ajudar a explorar, analisar e interagir com dados de formas inovadoras. Familiarize-se com novos dados ao[explorar tópicos ou conceitos amplos](5.1.-AI-chat-based-analysis#topic-analysis-chat) numa conversa interactiva com a IA. Aprofunde-se em aspectos específicos com a [Codificação auxiliada por IA](4.2.-AI-Assisted-Coding)e[análise de texto](5.1.-AI-chat-based-analysis#text-analysis-chat). E se você chegar ao ponto onde você deve sintetizar e consolidar seus resultados,[dicuta-os em um chat de código](5.1.-AI-chat-based-analysis#code-analysis-chat) com a IA. +Versões recentes contêm recursos opcionais auxiliados por IA que usam GPT-4 ou outros modelos de linguagem em larha escala para ajudar a explorar, analisar e interagir com dados de formas inovadoras. Familiarize-se com novos dados ao[explorar tópicos ou conceitos amplos](5.1.-AI-chat-based-analysis#2-topic-exploration) numa conversa interactiva com a IA. Aprofunde-se em aspectos específicos com a [Codificação auxiliada por IA](4.2.-AI-Assisted-Coding)e[análise de texto](5.1.-AI-chat-based-analysis#3-text-analysis). E se você chegar ao ponto onde você deve sintetizar e consolidar seus resultados,[dicuta-os em um chat de código](5.1.-AI-chat-based-analysis#4-code-analysis) com a IA. O QualCoder é projetado para ser usado como [software baseado em cliente](https://pt.wikipedia.org/wiki/Cliente_(computa%C3%A7%C3%A3o)) para ser usado por uma pessoa de cada vez. (Um segundo codificador pode usar o mesmo projeto no mesmo computador, ou a pasta do projeto pode ser transferida para o computador do segundo codificador).O QualCoder não é projetado para ser acessado por mais de um usuário ao mesmo tempo. Acessar/Abrir o projeto em uma localização na nuvem não é recomendado, isso pode corromper o banco de dados se a conexão de banco de dados for perdida durante qualquer processo de atualização de banco de dados. -## Colaboração em um projeto QualCoder +## Colaboração em um projeto QualCoder {#collaboration-on-a-qualcoder-project} [Página sobre como trabalhar em equipe com o QualCoder](2.4.-Working-in-a-Team) -## Última versão +## Última versão {#latest-release} O último pré-lançamento é 4.0-Beta. A versão mais recente é QualCoder 3.8.2. @@ -28,7 +28,7 @@ O último pré-lançamento é 4.0-Beta. A versão mais recente é QualCoder 3.8. ![image](/images/12d00e05-3844-4b48-9dc9-ff657aa7382f.png) -## Código mais recente - _software_ em desenvolvimento +## Código mais recente - _software_ em desenvolvimento {#latest-code-software-under-development} [Baixar a versão de desenvolvimento](https://github.com/ccbogel/QualCoder/archive/refs/heads/master.zip), descompacte e siga as instruções de instalação no documento `README.md`. diff --git a/docs/doc/pt/2.1.-Installation.md b/docs/doc/pt/2.1.-Installation.md index cdd43290..fc790348 100644 --- a/docs/doc/pt/2.1.-Installation.md +++ b/docs/doc/pt/2.1.-Installation.md @@ -5,11 +5,11 @@ icon: lucide/package-open # Instalação e instruções de execução do QualCoder -## INSTALAÇÃO +## INSTALAÇÃO {#installation} Para as instalações manuais (utilizando a linha de comando ou terminal) Uma versão específica pode ser mencionada, por exemplo a versão 4.0. Por favor, verifique a [página de versões](https://github.com/ccbogel/QualCoder/releases)para a versão mais atual, como pode ser mais recente. -### Pré-requisitos +### Pré-requisitos {#prerequisites} O VLC é opcional, mas você precisará dele instalado se precisar fazer qualquer codificação de áudio/vídeo. Ocasionalmente em alguns sistemas operacionais (por exemplo, Fedora) O QualCoder não consegue encontrar VLC para usá-lo. Opcionalmente, instale ffmpeg para exibição de forma de onda, veja[phenixnap.com/kb/ffmpeg-janelas](https://phoenixnap.com/kb/ffmpeg-windows). === "Windows" diff --git a/docs/doc/pt/2.2.-Settings.md b/docs/doc/pt/2.2.-Settings.md index 286e64db..0073180b 100644 --- a/docs/doc/pt/2.2.-Settings.md +++ b/docs/doc/pt/2.2.-Settings.md @@ -9,7 +9,7 @@ A janela de configurações permite que você altere vários recursos, incluindo ![image](/images/baec9b31-e0bd-4607-85c2-65e141f040d6.png) -### Nome do codificador +### Nome do codificador {#coder-name} Vários codificadores podem codificar e anotar o mesmo texto. O seu nome de codificador atual é mostrado no topo da janela de configuração. @@ -17,7 +17,7 @@ Vários codificadores podem codificar e anotar o mesmo texto. O seu nome de codi Este nome será usado para identificar suas contribuições para o projeto. Clique no botão "Alterar" para alterar sua identidade ou para criar, renomear ou mesclar outros codificadores no projeto atual. Leia [Trabalhando em equipe](2.4.-Working-in-a-Team#important-considerations-regarding-coder-names) para mais informações. -### Configurações gerais +### Configurações gerais {#general-settings} O idioma padrão do QualCoder é o inglês. Francês, alemão e espanhol são idiomas alternativos regularmente atualizados. Outros idiomas não foram cuidadosamente revisados para precisão. Para outros idiomas mantidos pela comunidade, [baixe o arquivo relevante.zip](/community) e o coloque na pastsa `.qualcoder/i18n`, em seguida, selecione seu idioma nas configurações. @@ -27,7 +27,7 @@ Há poucas opções para alterar a aparência geral do QualCoder. Para transcrever áudio e vídeo, o formato de tempo e o tipo de parenteses (parenteses ou colchetes) podem ser selecionados. -### _backups_ +### _backups_ {#backups} O _backup_ do projeto pode ser configurado para _backup_ automático a cada hora, ou sem _backup_. O QualCoder mantem os _backups_ mais recentes com data e hora. O nome de _backup_ é: _nomedoprojeto_BKP_yyyymmdd_hh.qda_ onde _hh_ é 24 horas. Isso também significa que vários _backups_ não são feitos dentro de uma hora. Assim, um novo _backup_ não substitui outro _backup_ criado na mesma hora. Um número limitado de _backups_ são mantidos, **_backups_ mais antigos são excluídos**. As configurações permitem que você escolha entre 1 e 10 _backups_. @@ -37,6 +37,6 @@ Renomeie ou mova para outro local os _backups_ específicos que você precisa ma Em sua pasta pessoal, o QualCoder criará uma pasta `.qualcoder` com um arquivo `QualCoder.log` para registrar eventos e um arquivo `config.ini` que conterá muitas configurações, como o nome do codificador atual, fontes preferenciais, idioma e um diretório de trabalho preferido. Não armaneze quaisquer dados ou projetos dentro da pasta `.qualcoder`. O único arquivo que você deve colocar aqui é o `stopwords.txt`, somente se você precisar aplicar um conjunto de exlusão de palavras para as funções de nuvem de palavras e contagem de palavras. Esta pasta é apenas para o QualCoder usar quando ele está em execução. -## Opções avançadas e registro +## Opções avançadas e registro {#advanced-options-and-logging} As opções relacionadas com a **IA** se localizam na parte inferior da janela de Configuração e são descritas aqui: [Configuração da IA](2.3.-AI-Setup) \ No newline at end of file diff --git a/docs/doc/pt/2.3.-AI-Setup.md b/docs/doc/pt/2.3.-AI-Setup.md index 72853529..9abcef7b 100644 --- a/docs/doc/pt/2.3.-AI-Setup.md +++ b/docs/doc/pt/2.3.-AI-Setup.md @@ -20,12 +20,12 @@ Todas as opções relacionadas com IA estão localizadas na parte inferior da ja Você também pode querer ler [como preparar melhor seu projeto para uso de IA](#improve-ai-usability-in-your-project) e o nosso [notas sobre privacidade de dados](#some-notes-on-privacy-and-data-protection) abaixo. -## Seleção do Modelo de IA +## Seleção do Modelo de IA {#ai-model-selection} Com a QualCoder, você pode escolher entre uma ampla gama de provedores de IA comerciais e não comerciais, e até mesmo usar modelos locais hospedados em sua própria máquina. Selecione uma das opções na lista de "Perfil da IA" na janela de Configuração. -### Modelos de Fronteira da OpenAI, da _Anthropic_ ou do Google +### Modelos de Fronteira da OpenAI, da _Anthropic_ ou do Google {#frontier-models-from-openai-anthropic-or-google} Estes modelos em larga escala fornecem a análise com mais nuances de seus dados empíricos e proporcionam, em geral, a experiência mais suave. Você tem várias opções: @@ -62,7 +62,7 @@ Para prosseguir, você precisará das seguintes informações: Vá em "Projeto > Configurações > Integração de IA", clique em "Opções avançadas de IA > Novo perfil de IA", e dê-lhe um nome. Em seguida, insira sua chave de API no campo correspondente, o nome da sua implementação Azure nos campos "Modelo Grande" e "Modelo Rápido" (podem ser idênticos), e o URL do _enpoint_ da Azure no campo "base da api". Você também pode querer ajustar o tamanho da janela de contexto, dependendo do modelo. -### Infraestrutura AI Acadêmica +### Infraestrutura AI Acadêmica {#academic-ai-infrastructure} A infraestrutura de IA acadêmica sem fins lucrativos lhe dá acesso a modelos de médio porte, mantendo padrões de privacidade de dados muito elevados. Estes serviços são geralmente gratuitos para o pessoal elegível. A qualidade de saída desses modelos de tamanho médio melhorou muito ultimamente e é bom o suficiente para a maioria das tarefas no QualCoder. No entanto, ainda não está no mesmo nível que as grandes ofertas comerciais. Você também pode encontrar mais problemas ao interagir com o agente de IA, como erros operacionais ou referências de fonte mal-formadas. @@ -80,14 +80,14 @@ Alemanha: - **[Hessian. AL Darmstadt](https://hessian.ai/):** Acesso experimental, apenas para pessoas elegíveis de universidades hessianas na Alemanha. Siga as instruções para GWDG acima, mas use `https://llm-service.ai.tu-darmstadt.de` como URL base da API. -### Modelos médios como Mistral, DeepSeek e outros +### Modelos médios como Mistral, DeepSeek e outros {#mid-size-models-like-mistral-deepseek-and-others} O menu em cascata (_drop-down_) "Perfil de IA" na janela de configurações também oferece opções para [Mistral (França)](https://mistral.ai/), [DeepSeek (China)](https://deepseek.com/), e [OpenRouter](https://openrouter.ai/), uma plataforma através da qual muitos modelos de linguagem em laraga escala podem ser acessados em diferentes servidores . Para todas essas opções, você precisará de uma chave API e provavelmente também uma conta paga para um trabalho sério. Verifique cuidadosamente as condições de privacidade dos dados antes de utilizar qualquer um destes serviços. -### Modelos de IA locais em sua própria máquina +### Modelos de IA locais em sua própria máquina {#local-ai-models-on-your-own-machine} Os modelos de IA locais oferecem o mais alto nível de proteção de dados, mas também requerem _hardware_ bastante poderoso para funcionar em uma velocidade e qualidade razoáveis. No meu teste, O `Gemma-4-31B-it` funcionou muito bem. Precisa de pelo menos 24 GB de VRAM em quantização de 4 bits com uma janela de contexto aceitável. Para qualquer trabalho sério em QualCoder, eu não seria muito menor do que isso. [Codificação assistida por IA](4.2.-AI-Assisted-Coding), no entanto, ainda pode funcionar com modelos ligeiramente menores. @@ -97,7 +97,7 @@ Os modelos de IA locais oferecem o mais alto nível de proteção de dados, mas - Selecione um modelo grande e um rápido da lista, provavelmente o mesmo para ambos, pois você geralmente terá apenas um modelo carregado de cada vez. Você também pode querer ajustar o tamanho da janela de contexto, dependendo das configurações do Ollama. -### Outros Modelos +### Outros Modelos {#other-models} Se você tiver acesso a outros modelos de linguagem em larga esacala em plataformas na nuvem, servidores universitários ou sua própria máquina, você também pode tentar integrá-los no QualCoder. - O serviço que você deseja usar deve fornecer uma interface compatível com a API da OpenAI. Este é frequentemente o caso, uma vez que esta API tornou-se um padrão _de facto_ nos últimos anos. @@ -121,7 +121,7 @@ Note que o nome da seção deve sempre começar com o prefixo 'ai_model '. Se você tiver outros serviços em execução no QualCoder, ou se você tentou e falhou, gostaríamos de ouvir sobre sua experiência. -## Opções avançadas de IA +## Opções avançadas de IA {#advanced-ai-options} Na parte inferior da janela de Configurações, encontra-se um botão "Opções de IA avançadas". Clicar nele revela mais algumas opções. @@ -130,7 +130,7 @@ Na parte inferior da janela de Configurações, encontra-se um botão "Opções - Quando se trata de outras opções avançadas, provavelmente é melhor deixá-las em seus valores padrão se você não sabe o que elas significam. Note que os parâmetros "temperatura" (_temperature_) e "top_p" podem ser silenciosamente ignorados por alguns modelos, especialmente no modo de raciocínio. -## A Configuração Local da Memória da IA +## A Configuração Local da Memória da IA {#the-local-ai-memory-setup} * O agente de IA do QualCoder usa uma memória local especial para pesquisar documentos empíricos rapidamente e encontrar passagens relevantes. Isso reduz muito a quantidade de dados enviados para a nuvem, aumentando assim a privacidade, economizando recursos e aumentando a velocidade. * A memória é alimentada por um pequeno [modelo de IA de código aberto local](https://huggingface.co/intfloat/multilingual-e5-large), com aproximadamente 2,5 GB de tamanho, que é baixado automaticamente na primeira vez que você ativa a IA. Modelo de locais de armazenamento: @@ -146,7 +146,7 @@ Na parte inferior da janela de Configurações, encontra-se um botão "Opções Nota técnica: A memória de IA local QualCoder é um sistema híbrido baseado em um [Codificador de frases E5](https://huggingface.co/intfloat/multilingual-e5-large) cujas incorporações armazenadas em uma [Armazenagem de vetores FAISS](https://github.com/facebookresearch/faiss) para pesquisa semântica, e um [Índice SQLite BM25](https://sqlite.org/fts5.html) para recuperação rápida de palavras-chave. Além disso, o agente de IA pode usar expressões regulares (_regex_) para pesquisar os dados do projeto. -## Melhore a usabilidade da IA em seu projeto +## Melhore a usabilidade da IA em seu projeto {#improve-ai-usability-in-your-project} O agente de IA do QualCoder deve ser capaz de ler e entender a estrutura do seu projeto, seus documentos empíricos, códigos e memorandos. Também deve ter uma imagem clara dos objetivos, perguntas de pesquisa e métodos que impulsionam sua pesquisa. Isto permite-lhe fornecer respostas muito mais específicas. Algumas sugestões: @@ -156,7 +156,7 @@ O agente de IA do QualCoder deve ser capaz de ler e entender a estrutura do seu - Se você usa **memorandos** para gravar notas pessoais e ideias de _brainstorming_ inacabadas que você não quer compartilhar com o agente de IA, coloque essas notas atrás de uma marca "######". Qualquer conteúdo de memorando abaixo desta marca não será enviado para a IA. -## Algumas Notas sobre Privacidade e Proteção de Dados +## Algumas Notas sobre Privacidade e Proteção de Dados {#some-notes-on-privacy-and-data-protection} * Entendemos que o uso de serviços baseados na nuvem como os da OpenAI levantam dúvidas sobre privacidade e proteção de dados. diff --git a/docs/doc/pt/2.4.-Working-in-a-Team.md b/docs/doc/pt/2.4.-Working-in-a-Team.md index bf5c6327..b5a6e476 100644 --- a/docs/doc/pt/2.4.-Working-in-a-Team.md +++ b/docs/doc/pt/2.4.-Working-in-a-Team.md @@ -5,7 +5,7 @@ path: 2.4.-Working-in-a-Team # Trabalhando em Equipe Existem várias estratégias para organizar trabalho colaborativo no mesmo projeto em QualCoder. Escolha o que melhor se adequa à sua abordagem metodológica e ambiente de trabalho específico. -## 1) Edição sequencial do mesmo projeto +## 1) Edição sequencial do mesmo projeto {#1-sequential-editing-of-the-same-project} Essa abordagem pode ser aplicada tanto na codificação indutiva quanto na dedutiva. Baseia-se no princípio de que todos os membros da equipe trabalham nos mesmos arquivos do projeto, embora não simultaneamente. ** Coordenação da Sequência do Trabalho: ** @@ -17,7 +17,7 @@ Essa abordagem pode ser aplicada tanto na codificação indutiva quanto na dedut Lidar com os nomes do codificador cuidadosamente (ver abaixo). -## 2) Usando um Projeto Mestre: A Abordagem de 'Codificação Separada Depois Mesclagem' +## 2) Usando um Projeto Mestre: A Abordagem de 'Codificação Separada Depois Mesclagem' {#2-using-a-master-project-the-coding-separately-then-merging-approach} Essa estratégia permite que sua equipe trabalhe simultaneamente até certo ponto. É mais eficaz se você usar uma abordagem de codificação dedutiva, onde o sistema de código não muda muito durante a análise. Se você usá-lo com codificação indutiva, esteja preparado para passar algum tempo limpando e consolidando o sistema de código ao fundir o trabalho de diferentes membros da equipe. @@ -29,9 +29,9 @@ Siga estes passos: * Feche sua pasta de projeto, incluindo todas as subpastas e arquivos, e envie para seus colaboradores (e-mail, transferência de arquivos ou USB-stick). * Decida sobre uma estratégia para lidar com nomes de codificadores em sua equipe, como explicado nas notas abaixo. * Agora, cada membro da equipe pode descompactar sua cópia local do projeto e trabalhar nele de forma independente, adicionando códigos, codificação, memorandos, etc. No entanto, não edite o texto importado dos próprios documentos empíricos, uma vez que isso pode causar problemas durante o processo de fusão mais tarde. -* Finalmente, reúna todas as cópias locais e misture-as sequencialmente em seu projeto mestre, usando o [processo descrito aqui](6.1.-Imports-and-Exports#merge-qualcoder-projects). +* Finalmente, reúna todas as cópias locais e misture-as sequencialmente em seu projeto mestre, usando o [processo descrito aqui](6.1.-Imports-and-Exports#merge-projects). -## Considerações importantes sobre nomes de codificadores +## Considerações importantes sobre nomes de codificadores {#important-considerations-regarding-coder-names} * Na maioria dos casos, você deseja ter um nome único para cada codificador em sua equipe para que as contribuições individuais possam ser identificadas mesmo após a fusão do projeto. * No Projeto > Configurações, clique no botão "Alterar" ao lado do nome do codificador para abrir uma janela onde você pode alterar sua própria identidade ou criar, renomear ou mesclar outros codificadores dentro do projeto atual. @@ -47,7 +47,7 @@ Siga estes passos: !!! warning Não mantenha a pasta do projeto em uma unidade de rede ou em uma localização na nuvem, e acesse essa localização enquanto executa o Qualcoder. Se a conexão do banco de dados for perdida, ele corromperia o banco de dados enquanto o QualCoder está realizando uma série de operações de banco de dados. -## Cópias de segurança +## Cópias de segurança {#backups} Faça um backup da pasta do projeto antes de fazer quaisquer alterações substanciais, como uma reorganização substancial de códigos e categorias, projetos de fusão ou códigos de fusão. O QualCoder realiza backups por hora (mantendo até os cinco mais recentes, se os backups estiverem definidos nas configurações). Além disso, não armazenar arquivos extras ou saídas dentro da pasta do projeto. diff --git a/docs/doc/pt/3.1.-Creating-a-New-Project.md b/docs/doc/pt/3.1.-Creating-a-New-Project.md index baf193eb..8f36b123 100644 --- a/docs/doc/pt/3.1.-Creating-a-New-Project.md +++ b/docs/doc/pt/3.1.-Creating-a-New-Project.md @@ -8,7 +8,7 @@ Você pode **criar um novo projeto no menu ‘Projeto’.** Se você nomeá-lo "Teste", o projeto será salvo como Test.qda. Test.qda é na verdade uma pasta com subpastas contendo o banco de dados, documentos empíricos e outros arquivos. Se você quiser enviar e-mail do projeto para outra pessoa, feche a pasta inteira. -## Tela principal +## Tela principal {#main-screen} A aba Action Log na janela principal exibe várias alterações que são feitas ao usar o QualCoder. A janela principal tem uma barra de menu no topo cheio de opções. Existem cinco abas para: action log , manage , reports , coding e AI chat . Mudar diretamente entre tabulações é geralmente OK. Mas se você estiver adicionando, renomeando, excluindo arquivos em Gerenciar arquivos ou alterando códigos ou categorias de código na área de codificação, é melhor atualizar cada guia selecionando a opção relevante na barra de menu no topo da tela. Por exemplo, alterar arquivos em Gerenciar arquivos, em seguida, fazer codificação ou relatórios - selecione uma opção no Menu para codificação ou relatório, em vez de clicar diretamente na guia para codificação ou relatórios. Isto acontece porque algumas alterações de gestão podem não se actualizar. @@ -20,7 +20,7 @@ A aba Action Log na janela principal exibe várias alterações que são feitas !!! tip "Boas práticas de gestão de dados" Para qualquer projeto, mantenha boas práticas de gerenciamento de dados, como ter backups armazenados regularmente e, idealmente, backups armazenados em diferentes locais (por exemplo, nuvem, pastas de computador diferentes, discos rígidos, pendrives USB). -## Escreva um memorando de projeto +## Escreva um memorando de projeto {#write-a-project-memo} Isto é **especialmente importante se você quiser usar os recursos baseados em IA** no QualCoder. O memorando do projeto é usado para fornecer algumas informações contextuais sobre o projeto atual e o tipo de documentos empíricos com os quais estamos lidando. Esta informação, que está incluída em cada consulta, ajuda a IA a produzir respostas muito mais direcionadas e úteis. Você pode acessar o Memo do Projeto > Memo do Projeto. diff --git a/docs/doc/pt/3.2.-Files.md b/docs/doc/pt/3.2.-Files.md index dc95fe32..2f7bb358 100644 --- a/docs/doc/pt/3.2.-Files.md +++ b/docs/doc/pt/3.2.-Files.md @@ -9,7 +9,7 @@ Cada arquivo é precedido por um ícone que descreve o tipo de arquivo. Outras c ![imagem](/images/71172904-3ae5-4eb3-9b04-350f036f1c9d.png) -## Importando arquivos +## Importando arquivos {#importing-files} Importar texto de documentos de texto simples, docx, epub, md, odt, pdf, rtf e tex (LaTex.tex, note que os arquivos .input e ..include não são resolvidos). Importar imagens de: jpg, jpeg e png. Importar formatos de áudio/vídeo: mp3, m4a, mp4, wav, mov, ogg. PDFs podem ser codificados como texto ou imagens. Alternativamente, ao invés de importar arquivos para a pasta do projeto, você pode linkar para arquivos localmente no sistema de arquivos do seu computador. Esta pode ser uma boa opção se você tem uma estrutura de pastas específica que é importante para o seu projeto. @@ -27,12 +27,12 @@ Se você está começando com QualCoder, abra o `Examples` pasta e importação Após a importação, abra cada arquivo clicando duas vezes ou usando o menu com o botão direito do mouse. Você pode testar o pseudônimo (ver abaixo) removendo `ID2.odt`, adicionar `Joe Bloggs` através do botão Pseudonymise, e depois importando o arquivo novamente. -### PDFs +### PDFs {#pdfs} PDFs com destaques podem ser importados e seus segmentos destacados codificados automaticamente. Projetos antigos extraíram texto de forma diferente da versão 4.0. Assim, ao abrir um projeto mais antigo, a versão 4.0 tentará combinar os segmentos de texto o melhor possível. No entanto, pode não ser idêntico. -### Pseudonimização (desidentificação dos dados) +### Pseudonimização (desidentificação dos dados) {#pseudonymisation-data-de-identification} A pseudonimização está disponível para substituir palavras ou frases. Para muitas línguas (possivelmente, exceto chinês, japonês, coreano), fornecendo o personagem antes da frase e o personagem após a frase são não-alfabeticos e não-numéricos, este é um ponto de corte fácil de aprovar. A pseudonimização é sensível a casos. As palavras originais devem ter pelo menos 2 caracteres, e os pseudônimos devem ter pelo menos 3 caracteres. Alternativamente, deixe o pseudônimo em branco para um termo gerado aleatoriamente. @@ -47,7 +47,7 @@ Os ficheiros de texto e as colunas qualitativas importados serão pseudónimos. Os arquivos PDF não são pseudônimos. -## Codificações de colunas automáticas +## Codificações de colunas automáticas {#auto-speaker-codings} "Mark Speakers" cria códigos para cada palestrante em uma entrevista ou discussão em grupo, e atribui enunciados automaticamente. Você pode alcançá-lo através do menu de contexto do arquivo ou do seguinte botão da barra de ferramentas: @@ -55,55 +55,55 @@ Os arquivos PDF não são pseudônimos. [Veja esta secção](4.1.-Coding-Text#auto-speaker-codings) para mais detalhes. -## Funções gerais +## Funções gerais {#general-functions} Os itens de nome de arquivo podem ser alterados no banco de dados. Os nomes dos ficheiros originais não serão alterados. Um menu de contexto com o botão direito do mouse permite visualizar, exportar, excluir um arquivo atual. O botão lixo é uma opção para selecionar vários arquivos para exclusão. O ponto de interrogação '?' abre esta página de ajuda. Os arquivos podem ser vistos pelo menu com o botão direito do mouse no arquivo, ou clicando no ícone da lupa. É aqui que podem ser inseridas transcrições para áudio e vídeo, ao visualizar um arquivo de áudio ou vídeo. ![botão](/images/f03c0a5d-29ea-40c7-a5a1-917aeb894f9b.png)Renomear em massa todas as linhas de arquivos. Você fornece um prefixo e então um sufixo numerado é adicionado. Isto aplica-se a todas as linhas visíveis na tabela. Você pode pré-selecionar linhas visíveis com o clique direito e 'mostrar este valor' por exemplo em um atributo. Este botão permite- lhe alterar o nome dos ficheiros: -## Atributos +## Atributos {#attributes} Atributos são variáveis para descrever os arquivos. Estes podem ser adicionados usando o botão (x) ou através da opção de menu Gerenciar atributos. Eles podem ser caráter ou numérico. A imagem acima mostra um atributo de caracteres adicionado chamado origin , bem como uma das várias colunas de atributos de referência Ref-autor . Atributos podem ser exportados para um arquivo Excel através de um botão: ![imagem](/images/ccf331d7-63b6-460b-96df-41edd7cfe63b.png) -## Filtrar colunas e linhas +## Filtrar colunas e linhas {#filtering-columns-and-rows} -### Filtrar linhas +### Filtrar linhas {#filtering-rows} O menu de contexto com o botão direito do mouse também permite que você reordene os arquivos de acordo com o nome, data e tipo de arquivo e quando clicar com o botão direito nas colunas nome ou data. Você pode mostrar apenas os tipos de atributos selecionados: Escolha Mostrar esta opção de valor Você também pode selecionar Mostrar valores como. Mostrar valores como pode ser aplicado várias vezes para encurtar ainda mais a lista de linhas exibidas. -### Visibilidade da coluna +### Visibilidade da coluna {#column-visibility} Às vezes, muitas colunas podem ser exibidas, o que pode ser esmagador. Você pode ocultar colunas clicando com o botão direito na linha de cabeçalho da tabela para opções para ocultar essa coluna ou para ocultar colunas começando com texto específico. Ou para mostrar colunas onde o nome da coluna começa com texto específico. -### Salvar e carregar os filtros coluna e linha +### Salvar e carregar os filtros coluna e linha {#save-and-load-column-and-row-filters} Existem três botões para salvar, carregar e excluir as configurações do filtro, para que você possa visualizar a tabela gerenciar arquivos de maneiras que você deseja, rapidamente. ![Botões para salvar, carregar e excluir filtros de tabela](/images/96ae69f5-1493-4aa8-a3f5-31ee15c22fef.png) -## Abrir URLs de atributos +## Abrir URLs de atributos {#open-attribute-urls} Clique com o botão direito em um URL em um atributo e abra o URL com o navegador padrão. Isto é somente se o atributo for um URL e passar a validação de URL. -## Copiar referência para a área de transferência +## Copiar referência para a área de transferência {#copy-reference-to-clipboard} Use a opção de menu do botão direito para colunas de referência (Ref Autors, Ref Título, Ref Journal, Ref Type, Ref Ano). Isso permite copiar referência à área de transferência como uma referência de estilo Vancouver ou APA. -## Atribuir um ficheiro seleccionado a um caso +## Atribuir um ficheiro seleccionado a um caso {#assign-a-selected-file-to-a-case} Você pode atribuir um arquivo a um caso através do menu com o botão direito do mouse quando na coluna de casos. -## Inteligência Artificial +## Inteligência Artificial {#artificial-intelligence} Se você ativou a integração de IA no QualCoder, os arquivos de texto recém-importados serão lidos pelo modelo de IA local e armazenados em sua memória local. Isso acontece em segundo plano (a barra de status mostra "AI: leitura"). Você pode continuar usando o QualCoder, mas os recursos aprimorados por IA não estarão disponíveis até que o IA tenha terminado de atualizar sua memória. Isso também acontece se você editar um arquivo de texto já importado no QualCoder. Se você tiver a impressão de que a memória IA está fora de sincronia e perdeu algumas atualizações de seus dados (o que não deve acontecer em circunstâncias normais), você pode reconstruir a memória do zero selecionando "AI > Reconstruir Memória Interna". Isto irá reler todos os documentos, o que pode levar algum tempo. -## Criação e edição de arquivos de texto +## Criação e edição de arquivos de texto {#text-file-creation-and-editing} Você pode criar e inserir texto em texto no banco de dados pressionando o ícone lápis. @@ -121,7 +121,7 @@ Você pode selecionar texto que não está sublinhado e copiar/substituir sem pr !!! info Existem algumas limitações: É melhor evitar selecionar seções de texto para excluir (ou digitar ou colar) se essas seções tiverem uma combinação de não sublinhado (não codificado/anotado/atribuído caso) e sublinhado (codificado, anotado, atribuído caso). A razão é que as posições dos códigos/anotações subjacentes/caixa atribuída podem não corresponder correctamente ao previsto. Se você fez uma alteração que você acha que afetou estas posições codificadas/anotadas/atribuídas mal, saia da janela de edição de texto pressionando o botão Cancelar. -## Arquivos de áudio e vídeo +## Arquivos de áudio e vídeo {#audio-and-video-files} Video (mov, mp4, wmv, ogg) e arquivos de áudio (wav, mp3, m4a) podem ser importados. Carregar um arquivo de áudio ou vídeo também criará automaticamente um arquivo transcrito de texto em branco. Este arquivo terá o mesmo nome que o arquivo de áudio ou vídeo, mas tem um sufixo '.txt'. Inicialmente, esta transcrição de texto estará vazia. Você pode transcrever o arquivo você mesmo ou obter o arquivo transcrito profissionalmente e copiar e colar o texto neste arquivo. @@ -138,7 +138,7 @@ Se você tem um arquivo .srt (um arquivo de transcrição que é lido por VLC) v Se tiver o ffmpeg instalado, é mostrada uma forma de onda. Se os arquivos de áudio tem várias faixas de áudio, apenas a primeira faixa é mostrada para o waveform. -### Transcrição de áudio e vídeo +### Transcrição de áudio e vídeo {#transcribing-audio-and-video} Para transcrever, abra a opção do menu Gerenciar arquivos e, em seguida, veja o arquivo de áudio ou vídeo. O áudio/vídeo irá carregar e haverá uma área de texto para inserir texto transcrito. @@ -187,7 +187,7 @@ Ctrl D Apagar um ou mais nomes de colunas. Ctrl 1 a 8 Inserir nome de coluna neste formato: [nome] -### Transcrições que têm códigos, anotações e / ou casos atribuídos +### Transcrições que têm códigos, anotações e / ou casos atribuídos {#transcriptions-that-have-codes-annotations-and-or-case-assigned} Seções do arquivo de texto ou arquivo áudio/vídeo transcrito terão seções de texto sublinhadas em verde (caso atribuído), amarelo (anotação) ou vermelho (codificado). O texto pode ser editado mesmo após o texto ser codificado ou anotado ou atribuído (total ou parcialmente) a um caso. @@ -196,11 +196,11 @@ Você pode selecionar texto que não está sublinhado e copiar/substituir sem pr !!!! "Existem algumas limitações" Existem algumas limitações: É melhor evitar selecionar seções de texto para excluir (ou digitar ou colar) se essas seções tiverem uma combinação de não sublinhado (não codificado/anotado/atribuído caso) e sublinhado (codificado, anotado, atribuído caso). A razão é que as posições dos códigos/anotações subjacentes/caixa atribuída podem não corresponder correctamente ao previsto. Se você fez uma alteração que você acha que afetou estas posições codificadas/anotadas/atribuídas mal, saia da janela de edição de texto pressionando o botão Cancelar. -## Arquivos de exemplo +## Arquivos de exemplo {#example-files} Existem arquivos de exemplo na pasta Exemplos. Estes podem ser usados para testar a importação de arquivos de diferentes formatos de documento e de importar uma imagem. Existem também arquivos de exemplo para testar os atributos de importação de casos, e para importar uma pesquisa. -## Gerenciar Links Maus para Arquivos +## Gerenciar Links Maus para Arquivos {#manage-bad-links-to-files} Se seu projeto contém arquivos conectados externamente, esses arquivos podem ser movidos, renomeados ou excluídos. diff --git a/docs/doc/pt/3.3.-Cases.md b/docs/doc/pt/3.3.-Cases.md index d39b26cb..50739be8 100644 --- a/docs/doc/pt/3.3.-Cases.md +++ b/docs/doc/pt/3.3.-Cases.md @@ -12,14 +12,14 @@ Quando uma pesquisa é importada, cada linha de pesquisa pode ser atribuída a u ![imagem](/images/a2076cfb-da5e-486f-a443-6ef6a070fc9a.png) -## Esconder e mostrar linhas e colunas +## Esconder e mostrar linhas e colunas {#hiding-and-showing-rows-and-columns} Ocultar colunas com o botão direito do mouse na linha de cabeçalho da tabela para opções para ocultar essa coluna ou para ocultar colunas começando com texto específico. Ou para mostrar colunas começando com um valor de texto. Ocultar linhas pelo menu com o botão direito do mouse e selecionar um valor de texto que seja igual ou 'é como' algum texto escolhido. Clique com o botão direito para encomendar pelo nome do caso ou pelo valor do atributo, ascendente ou descendente. !!! example "Exemplo prático" Adicione os três alunos (ou casos) clicando no ícone Adicionar caso. Nome de cada estudante: ID1, ID2 e ID3. -## Gerenciador de arquivos de casos +## Gerenciador de arquivos de casos {#case-file-manager} Agora, adicione o arquivo de cada estudante a cada estudante. Clique na célula na coluna Arquivos para o caso ID3 por exemplo. Isto abre a janela do gestor de ficheiros casos . Em alternativa, clique no ícone de documentos que também abrirá o gerenciador de arquivos de caso. @@ -29,7 +29,7 @@ No gerenciador de arquivos case , clique em um caso, diga ID3, em seguida, cliq Você também pode selecionar um caso, destacar manualmente partes de texto dentro de um documento de texto maior, e clicar com o botão direito para marcar – ou atribuir – o texto para o caso selecionado. -## Importando casos e atributos de caso +## Importando casos e atributos de caso {#importing-cases-and-case-attributes} Você pode importar atributos de um arquivo CSV ou XLSX usando este botão: ![imagem](/images/0b9d8a34-33ff-4591-ae6d-c6f43bfb9625.png) @@ -38,7 +38,7 @@ A primeira linha deve conter os cabeçalhos dos atributos. A primeira coluna dev Para este exemplo – excluir todos os casos mostrados. Em seguida, importe os atributos do arquivo cases.csv através da janela Importar Atributos. Você precisará novamente ligar os arquivos e o texto do arquivo a cada caso. -## Exportar informações sobre os casos +## Exportar informações sobre os casos {#exporting-case-information} Você pode exportar a tabela Casos para um arquivo Excel (xlsx), usando este botão: ![imagem](/images/15d879be-bde6-4dfd-a1a7-baf5386ef8d9.png) \ No newline at end of file diff --git a/docs/doc/pt/4.1.-Coding-Text.md b/docs/doc/pt/4.1.-Coding-Text.md index a2c3d8db..6073906b 100644 --- a/docs/doc/pt/4.1.-Coding-Text.md +++ b/docs/doc/pt/4.1.-Coding-Text.md @@ -39,12 +39,12 @@ Sobreposição de códigos Sobreposição de códigos pode ser difícil de ver claramente. As secções sobrepostas são sublinhadas. O cursor do rato irá mostrar texto codificado sobreposto. Você pode pressionar 'O' depois de clicar em uma seção sobreposta para percorrer os códigos nesse local. -## Anotações +## Anotações {#annotations} Adicione uma anotação (um memorando para um segmento de texto) a uma seleção de texto. Estes são úteis para explicar siglas e jargão. O texto ficará arrojado para marcar a posição da anotação. Para reabrir uma anotação, selecione alguns dos textos em negrito e clique com o botão direito para obter a opção Anotar. Em alternativa, clique no bloco de notas mais à esquerda e no botão lápis, ou pressione a tecla 'A'. Para remover uma anotação, abra a anotação e apague todo o texto. ![imagem](/images/104526a8-1bba-4dae-8bcd-43d2ddc5f9c8.png) -## Auto- código +## Auto- código {#auto-code} O canto superior direito da tela tem botões para o texto de codificação automática: ![botões de código automático](/images/d689c833-505f-49e4-938c-e392d4a2cc14.png) @@ -79,7 +79,7 @@ Existe um botão de desfazer para remover as auto-codificações que foram aplic ![imagem](/images/8ac5bcf5-fae4-4da3-a1dd-8dccf12d585b.png) -## Codificações de colunas automáticas +## Codificações de colunas automáticas {#auto-speaker-codings} A função "marca falantes" cria códigos para cada falante em uma entrevista ou discussão em grupo, e atribui enunciados automaticamente. Isto permite mais relatórios focados, apenas olhando para certos oradores de cada vez. Você pode alcançar a função através do menu de contexto do arquivo ou do seguinte botão da barra de ferramentas: @@ -94,10 +94,10 @@ A função "marca falantes" cria códigos para cada falante em uma entrevista ou - No entanto, você ainda pode optar por esconder esses códigos na janela de texto, para que eles não distraiam você em sua própria codificação analítica. Para fazer isso, clique no botão "..." ao lado do nome do codificador no canto superior esquerdo da barra de ferramentas. No diálogo a seguir, selecione a entrada de "codificação do alto-falante" e defina a visibilidade para "escondido". - A função "marcar alto-falantes" também está disponível no espaço de trabalho "gerir arquivos". -## Maximizar a área do ecrã +## Maximizar a área do ecrã {#maximise-screen-area} Para ocultar o painel de controle superior, clique na área de texto e pressione a tecla 'H'. Para mostrar o painel superior, pressione 'H' novamente. -## Métodos de conveniência para carregar arquivos de texto no painel da lista de arquivos. +## Métodos de conveniência para carregar arquivos de texto no painel da lista de arquivos. {#convenience-methods-for-loading-text-files-in-the-files-list-pane} Alguns projetos podem ter muitos arquivos de texto e a janela de visualização de arquivos pode apresentar muitos arquivos para serem abertos. Clique com o botão direito do mouse nos arquivos no botão árvore de arquivos para ir para o próximo arquivo, ir para o arquivo com favoritos ou ir para o arquivo com os códigos mais recentes: @@ -106,7 +106,7 @@ Alguns projetos podem ter muitos arquivos de texto e a janela de visualização * Selecione o arquivo que foi codificado mais recentemente, * Ir para uma localização marcada num ficheiro. Para criar um favorito, clique com o botão direito em algum texto ao codificar e selecione a opção favorito. O favorito funciona apenas para um projeto de cada vez, então se você abrir um projeto diferente, o favorito estará incorreto ou pode não funcionar. -### Botões de conveniência abaixo da lista de arquivos +### Botões de conveniência abaixo da lista de arquivos {#convenience-buttons-underneath-the-files-list} * Carregar o próximo ficheiro * Carregar o ficheiro com a última codificação @@ -117,7 +117,7 @@ Alguns projetos podem ter muitos arquivos de texto e a janela de visualização ![imagem](/images/b3c32938-c1df-455c-be3e-3753c813535c.png) -## Modificando posições de código +## Modificando posições de código {#modifying-code-positions} Clique com o botão direito em um código e selecione Redimensionar. As alças em cada extremidade do segmento codificado podem ser reposicionadas. @@ -136,7 +136,7 @@ Alternativamente, clique em um código com o mouse (Note que o código não deve * Dollar symbol $ Shift code positions, after the clicked character position. Pode ser necessário depois que o texto é editado (adicionado ou excluído) para mudar segmentos de codificação subsequentes por um número de caracteres. -## Outras teclas de atalho para codificação de texto +## Outras teclas de atalho para codificação de texto {#other-shortcut-keys-for-text-coding} * A. Anotar o texto seleccionado @@ -174,7 +174,7 @@ Alternativamente, clique em um código com o mouse (Note que o código não deve * Ctrl Z. Restaura o último código que não foi marcado. -## Procurar texto +## Procurar texto {#search-text} O diálogo de texto de codificação contém uma busca por função de texto no meio superior, com as caixas de seleção para procurar case sensitive e para pesquisar através de todos os arquivos de texto. Quando na área de texto, selecionar algum texto e pressionar a tecla de atalho 's' irá preencher a caixa de texto de pesquisa e focar no botão de seta 'próximo' para olhar rapidamente através do documento para o texto selecionado. A busca requer um mínimo de 3 caracteres como padrão. Clique com o botão direito para alterar o padrão para 5 caracteres, ou para pesquisar apenas após Enter é pressionado. A caixa de seleção sensível ao Case limitar- se- á à pesquisa sensível ao Case. A caixa de seleção Todos os arquivos continuará a pesquisa através de outros arquivos de texto. @@ -186,7 +186,7 @@ A pesquisa usa funções Regex. * «\. irá corresponder ao símbolo de ponto, '\?' irá corresponder ao ponto de interrogação. '\n' irá corresponder ao símbolo de fim de linha. Isto [Folha de fraude do Regex](www.rexegg.com/regex-quickstart.html) pode ajudar. * \b limite de palavra, '\bbound\b' irá procurar a palavra completa 'bound', mas não 'boundary' -## Movendo através do texto para um código selecionado +## Movendo através do texto para um código selecionado {#moving-through-the-text-for-one-selected-code} Debaixo da árvore de códigos estão os botões: para frente, para trás e um botão de ícone de grade (para sair da função). @@ -195,21 +195,21 @@ Selecione um código e, em seguida, clique nas setas para frente e para trás. E !!! note Na versão 4.0, todo o arquivo de texto é despachado. Nas versões anteriores, por exemplo, 3.8.2 havia uma opção para carregar um arquivo de texto em pedaços de 50.000 caracteres. Se você precisa carregar texto em blocos, então recomendamos que você use o anterior [QualCoder versão 3.8.2](https://github.com/ccbogel/QualCoder/releases/tag/3.8.2)No entanto, note que o carregamento de texto em PDF mudou de 3.8.2 para 4.0, o que pode causar imprecisão com as posições do segmento de codificação ao abrir um projeto mais novo (por exemplo, 4.0) na versão mais antiga (3.8.2 ou anterior). -## Mostrar apenas texto codificado importante +## Mostrar apenas texto codificado importante {#show-only-important-coded-text} Sob a árvore de códigos está um botão com um símbolo de estrela. Este botão alterna entre mostrar todo o texto codificado e o texto codificado marcado como Importante. -## Relatórios de exportação +## Relatórios de exportação {#export-reports} Exportar em formato odt - compatível com LibreOffice e Microsoft Word. Ou com destaques de código, ou comentários ao lado. Relatório Odt contém detalhes de códigos usados, frequências, anotações, memorandos e texto codificado. Outras opções incluem texto simples, html e uma exportação de livro de códigos. -## Painel à direita +## Painel à direita {#right-hand-pane} O lado direito do painel de texto de codificação tem outro painel escondido. Para abrir clique e arraste do lado direito da janela ou pressione o botão ao lado do botão Ajuda. Este painel contém opções úteis ao codificar. Um botão é ao clicar em um código, o nome de código, regra de código (memo) e exemplos de texto codificados aleatórios do projeto são exibidos. O outro botão exibe o memorando do projeto. ![imagem](/images/a6977ba3-bdf2-43c8-9097-562a252af815.png) -## Edição de texto quando em codificação - Texto de código +## Edição de texto quando em codificação - Texto de código {#editing-text-when-in-coding-code-text} O texto pode ser editado mesmo após o texto ser codificado ou anotado ou atribuído (total ou parcialmente) a um caso. Seções do arquivo de texto ou arquivo áudio/vídeo transcrito terão seções de texto sublinhadas em verde (caso atribuído), amarelo (anotação) ou vermelho (codificado) por todos os codificadores. @@ -233,6 +233,6 @@ Abaixo está como a tela de texto de edição parece. ![imagem](/images/b02d740e-d561-4c3c-aff0-637d45740d03.png) -## Categorias e códigos +## Categorias e códigos {#categories-and-codes} Ver [Categorias e códigos](4.7.-Codes-Tree/) \ No newline at end of file diff --git a/docs/doc/pt/4.2.-AI-Assisted-Coding.md b/docs/doc/pt/4.2.-AI-Assisted-Coding.md index f08b76ae..d93056f3 100644 --- a/docs/doc/pt/4.2.-AI-Assisted-Coding.md +++ b/docs/doc/pt/4.2.-AI-Assisted-Coding.md @@ -3,7 +3,7 @@ path: 4.2.-AI-Assisted-Coding --- # AI Codificação Assistida -## Introdução +## Introdução {#introduction} Os recursos de IA incorporados da QualCoder (versão 3.6 e up) podem auxiliar o processo de codificação de várias maneiras: @@ -15,11 +15,11 @@ Os recursos de IA incorporados da QualCoder (versão 3.6 e up) podem auxiliar o Note-se que "AI Assisted Coding" não é um método por si só; é um conjunto de técnicas que podem ser adaptadas a muitos métodos que trabalham com códigos, desde teoria fundamentada até análise de conteúdo ou temática. Vê isto? [tutorial em vídeo]( https://www.youtube.com/watch?v=FrQyTOTJhCc) para um exemplo prático. -## Pré-condições +## Pré-condições {#preconditions} - O IA deve ser ativado, totalmente carregado e pronto para novas consultas (veja a barra de status do estado atual). - É ** Altamente recomendado** usar o memorando do projeto (Menu "AI > Memo do Projeto") para incluir uma breve descrição dos tópicos de pesquisa do seu projeto, questões, objetivos e os dados empíricos coletados. Essas informações acompanharão cada alerta enviado à IA, resultando em resultados muito mais direcionados. -## Iniciar a codificação assistida por IA +## Iniciar a codificação assistida por IA {#start-ai-assisted-coding} A codificação assistida por IA está integrada no espaço de trabalho de codificação de texto. Comece clicando em "Coding > AI-assisted coding" ou, se você já estiver na área de trabalho de codificação de texto, selecione a guia "AI Assistance" à esquerda. Em seguida, clique em "Iniciar pesquisa de IA." ![Página de Assistência de I.A. de captura de tela](/images/1eeca42f-2e4e-48a6-aca7-68e4b13df6c4.png) @@ -28,9 +28,9 @@ Na próxima janela, você tem que (1) definir o objeto de sua pesquisa (código ![Janela de pesquisa da imagem IA](/images/0d66baa1-6c60-423a-b4d6-742d387322dc.png) -### 1) O que procurar: Código vs. Pesquisa de Tópico Livre +### 1) O que procurar: Código vs. Pesquisa de Tópico Livre {#1-what-to-search-for-code-vs-free-topic-search} -#### Pesquisa de Códigos +#### Pesquisa de Códigos {#code-search} Use isso para mergulhar mais profundamente em um aspecto particular e adicionar mais dados de todo o seu corpus para um código já existente. @@ -40,10 +40,10 @@ Use isso para mergulhar mais profundamente em um aspecto particular e adicionar - **Enviar memorando para IA:** Se selecionado, o memorando de código também será compartilhado com a IA. Use isso para descrever ou definir seu código e ajudar a IA a gerar melhores resultados. Se você também quiser adicionar notas pessoais ao memorando de código, você pode fazer isso inserindo "######" no texto. Qualquer coisa abaixo desta marca não será enviada para a IA. - ** Incluir segmentos codificados:** Defaulted to off, significando que a pesquisa de IA irá retornar apenas novos dados ainda não codificados com este código particular. Ative esta opção para incluir também dados codificados anteriormente. -#### Pesquisa de Tópicos Grátis +#### Pesquisa de Tópicos Grátis {#free-topic-search} Procure qualquer tópico, fenômeno ou conceito em todo o seu corpus de dados sem um código predefinido. Digite um nome e uma descrição para comunicar à IA o que você está procurando. -### 2) Como analisar os dados: O Prompt Analítico para a IA +### 2) Como analisar os dados: O Prompt Analítico para a IA {#2-how-to-analyse-the-data-the-analytic-prompt-for-the-ai} O prompt analítico instrui a IA a examinar seus dados. Selecione- o na parte inferior esquerda da janela. @@ -54,10 +54,10 @@ O prompt analítico instrui a IA a examinar seus dados. Selecione- o na parte in **Explore estes prompts** passando o mouse sobre os itens da lista suspensa. Clique em "Editar" para [editar os prompts analíticos ou definir o seu próprio](6.3.-AI-Prompt-Library) (opção avançada). -### 3) Filtro: Estreite sua busca para baixo +### 3) Filtro: Estreite sua busca para baixo {#3-filter-narrow-your-search-down} Por padrão, o corpus completo de dados textuais no projeto atual é explorado. Se você quiser limitar a pesquisa a certos **documents** ou **cases**, você pode selecioná-los no lado direito da janela (Ctrl + Clique para selecionar múltiplos). Você também pode definir um filtro com base em ** variáveis de atributos selecionadas.** -## O processo de codificação assistida por IA +## O processo de codificação assistida por IA {#the-process-of-ai-assisted-coding} Primeiro, realize a busca de IA. Este é um processo em duas etapas: ** Passo 1:** A IA consulta seu banco de dados local para dados potencialmente relevantes em seu corpus. @@ -66,7 +66,7 @@ Primeiro, realize a busca de IA. Este é um processo em duas etapas: Por favor, seja paciente, pois pode levar algum tempo para os resultados iniciais aparecerem. Clicando em um resultado carrega o documento na janela principal e destaca a citação relevante. Também certifique-se de olhar para o texto em torno da citação para entender o seu contexto. -### Trabalhar através dos Resultados +### Trabalhar através dos Resultados {#working-through-the-results} Você pode **codificar o texto selecionado** como faria qualquer outro texto no [espaço de trabalho código- texto](4.1.-Coding-Text). Expandir ou modificar a seleção conforme necessário. @@ -80,7 +80,7 @@ QualCoder usa um algoritmo ** para exibir os resultados mais relevantes no topo Ao longo do tempo, no entanto, os resultados retornados pela IA começarão a ** divergir do tópico original** e tornar-se cada vez menos relevante. Este é o ponto onde você deve parar a investigação e passar para o próximo tópico ou código. Você não precisa clicar em "encontrar mais" até que não haja absolutamente nenhum dado para analisar a partir do primeiro passo da pesquisa. Compare isso com uma pesquisa do Google: Não há necessidade de clicar em cada página de resultados se você já entender o que você quer saber. -### O que fazer se não obtiver resultados +### O que fazer se não obtiver resultados {#what-to-do-if-you-get-no-results} 1) **Se o passo não retornar quaisquer dados potencialmente relevantes:** Lembre-se que, por padrão, a pesquisa de código apenas extrai novos dados. Se você já codificou completamente seus documentos, pode simplesmente não haver nada novo para explorar em um determinado tópico. Além disso, pense sobre sua pesquisa, especialmente o nome do código ou tópico de pesquisa: É muito específico ou não é suficientemente claro? 2) **Se a etapa dois não produzir resultados:** Clique em "encontrar mais" (se disponível) para analisar mais dados. Se isso também não produzir nenhum resultado, você pode querer iniciar uma nova pesquisa com um prompt mais aberto, inclusive (por exemplo, "open search"). diff --git a/docs/doc/pt/4.3.-Coding-Text-on-PDFs.md b/docs/doc/pt/4.3.-Coding-Text-on-PDFs.md index d6796eee..7c0f26be 100644 --- a/docs/doc/pt/4.3.-Coding-Text-on-PDFs.md +++ b/docs/doc/pt/4.3.-Coding-Text-on-PDFs.md @@ -9,7 +9,7 @@ As áreas de texto e imagem no PDF podem ser codificadas. ![imagem](/images/ba02d9ee-24fe-4b67-84b0-4f62cd62a1c6.png) -### Prensas de teclas +### Prensas de teclas {#key-presses} * H Mostrar ou esconder as seções superiores da tela. * Ctrl F salta para a caixa de pesquisa de texto. @@ -21,13 +21,13 @@ As áreas de texto e imagem no PDF podem ser codificadas. * Ctrl 9 Mostrar segmentos codificados importantes. Liga e desliga. * Ctrl 0 Mostrar página de ajuda no navegador. -#### Na área de exibição PDF: +#### Na área de exibição PDF: {#in-the-pdf-display-area} Você pode ampliar dentro e fora clicando no PDF mostrado e pressionando as teclas + ou -. Pressione Q para marcar rapidamente a seleção com o código recente. Pressione R para marcar rapidamente a seleção com uma escolha de códigos usados recentemente. -#### Na área de texto simples: +#### Na área de texto simples: {#in-the-plain-text-area} * Um anotado - para a seleção atual - apenas edição de texto * Q Quick Mark com código - para a seleção atual @@ -38,10 +38,10 @@ Pressione R para marcar rapidamente a seleção com uma escolha de códigos usad * U Desmarcar na localização selecionada * V atribuir código 'in vivo' ao texto selecionado -## Relatórios de exportação +## Relatórios de exportação {#export-reports} Exportar em formato odt - compatível com LibreOffice e Microsoft Word. Ou como um PDF com destaque aplicado. -## Versões mais antigas 3.8.2 e anteriores +## Versões mais antigas 3.8.2 e anteriores {#older-versions-382-and-earlier} A tela é dividida em 3 painéis ajustáveis. O painel do lado esquerdo contém a lista de ficheiros e a árvore de códigos. O painel médio mostra a representação em PDF. O painel direito mostra o texto simples extraído do PDF. As fontes originais para o texto não são usadas. Em vez disso, a fonte padrão dentro do QualCoder é usada nas caixas de texto PDF exibidas. Existe um ajuste de tamanho de fonte para diminuir o tamanho da fonte, para tentar evitar sobreposição de texto. É definido em -2, e -3 pode ser muito bom também. @@ -49,6 +49,6 @@ O painel do lado direito mostra o texto simples da mesma forma que o texto seria Para codificar, clique com o botão esquerdo e arraste o mouse para selecionar caixas de texto PDF. Isso pode ser complicado dependendo do tamanho e das posições das caixas. Em seguida, clique em um código para atribuir a seleção a ele. Outros ajustes podem ser feitos no painel de texto simples à direita usando as setas esquerda ou direita para estender, ou as setas alt esquerda e direita para encolher a seção de texto codificada. -## Categorias e códigos +## Categorias e códigos {#categories-and-codes} Ver [Categorias e códigos](4.7.-Codes-Tree/) \ No newline at end of file diff --git a/docs/doc/pt/4.4.-Coding-Images.md b/docs/doc/pt/4.4.-Coding-Images.md index b70ec690..4d4c537f 100644 --- a/docs/doc/pt/4.4.-Coding-Images.md +++ b/docs/doc/pt/4.4.-Coding-Images.md @@ -10,7 +10,7 @@ A parte superior direita do diálogo mostra alguns detalhes de um clique na áre ![imagem](/images/8e9e2ac8-61c0-4b4a-9d8b-31556da21fb2.png) -## Codificação de imagens PDF +## Codificação de imagens PDF {#pdf-image-coding} Os PDFs podem ser codificados aqui ou na seção Código PDF. @@ -19,17 +19,17 @@ Os PDFs podem ser codificados aqui ou na seção Código PDF. Botões de navegação em PDF: ![Botões de navegação PDF](/images/36effc9c-f0a2-4f02-9fe0-293abcd3060a.png) -## Áreas codificadas importantes +## Áreas codificadas importantes {#important-coded-areas} Áreas importantes codificadas, como exemplos para um relatório, podem ser sinalizadas como Importante usando o menu com o botão direito do mouse quando nas áreas codificadas e selecionando Importante. No topo da tela está um botão com um símbolo de estrela. Este botão alterna entre mostrar todas as áreas codificadas e as áreas codificadas marcadas como Importantes. -## Atalhos +## Atalhos {#shortcuts} * Atalho H. Pressione h quando na imagem para esconder e desocultar a seção de controles superiores da tela. * Atalho L. Pressione L para 'Mostrar códigos como', para mostrar uma lista na árvore de códigos. * Pressione + ou - botões para ampliar ou encolher a imagem. * Ctrl Z para restaurar a última área de codificação não marcada. -## Botões de conveniência abaixo da lista de arquivos +## Botões de conveniência abaixo da lista de arquivos {#convenience-buttons-underneath-the-files-list} * Carregar o próximo ficheiro * Carregar o ficheiro com a última codificação @@ -37,7 +37,7 @@ Botões de navegação em PDF: * Use uma função de filtro mostrar apenas os arquivos que atendem a determinados critérios. Estes podem ser de atributos de arquivo ou se os arquivos estão associados a certos casos. (Botão que exibe uma etiqueta) -## Clique com o botão direito na área da imagem para mais opções +## Clique com o botão direito na área da imagem para mais opções {#right-click-on-the-image-area-for-more-options} As opções incluem rotação e destaque de um código específico ou área codificada. Estas opções de realce são: acinzentado, borrado, solarizar, e eles abrem em seu programa de visualização de imagem padrão para visualizar e salvar. @@ -50,10 +50,10 @@ Destaque o exemplo de áreas codificadas, com legendas: ![imagem](/images/be991d7a-363b-4e5a-a93a-d02ccde42930.png) -## Exportação +## Exportação {#export} A imagem com áreas codificadas pode ser exportada para um arquivo HTML. Depois de abrir o arquivo em um navegador, o mouse pairando sobre as áreas codificadas mostra o nome de código e memorandos. -## Categorias e códigos +## Categorias e códigos {#categories-and-codes} Ver [Categorias e códigos](4.7.-Codes-Tree/) \ No newline at end of file diff --git a/docs/doc/pt/4.5.-Coding-Audio-and-Video.md b/docs/doc/pt/4.5.-Coding-Audio-and-Video.md index fbd633c2..444693ed 100644 --- a/docs/doc/pt/4.5.-Coding-Audio-and-Video.md +++ b/docs/doc/pt/4.5.-Coding-Audio-and-Video.md @@ -10,7 +10,7 @@ O texto de transcrição também pode ser codificado e anotado nesta janela. Cli ![imagem](/images/bac80f08-c719-4add-9878-104d3fbc084e.png) -## Atalhos de teclado +## Atalhos de teclado {#keyboard-shortcuts} * Ctrl R Rebobinar 5 segundos * Alt R ou Alt Minus Rebobinar 30 segundos @@ -32,7 +32,7 @@ Quando a área de texto tem foco: * Pressione Q para código rápido com o código mais recente. (Deve ter uma seleção de texto) * Pressione R para selecionar códigos recentes. (Deve ter uma seleção de texto) -## Segmentos de vídeo de áudio +## Segmentos de vídeo de áudio {#audio-video-segments} Uma vez que um segmento é feito usando o botão Start segment/Stop segment , isso pode ser atribuído a um código clicando com o botão direito do mouse no código relevante e atribuindo o segmento. @@ -40,7 +40,7 @@ Faixas de codificação para os segmentos codificados são mostradas na área in O texto transcrito também pode ser codificado e anotado nesta janela. No entanto, quando a caixa de verificação de transcrição do Scroll é marcada, isso não pode ser realizado. Reproduzir o vídeo quando este estiver marcado irá rolar a transcrição usando as datas com o vídeo. -## Texto e segmentos codificados importantes +## Texto e segmentos codificados importantes {#important-coded-text-and-segments} Textos codificados importantes, como exemplos para um relatório, podem ser sinalizados Importante usando o menu com o botão direito do mouse quando no texto codificado e selecionando Importante. Da mesma forma, segmentos de código podem ser sinalizados Importante. No topo da tela está um botão com um símbolo de estrela. Isto alterna entre mostrar todos os textos codificados e segmentos ou texto e segmentos importantes codificados. @@ -48,7 +48,7 @@ Textos codificados importantes, como exemplos para um relatório, podem ser sina Selecione o texto (pode ser codificado ou preferencialmente não codificado), então atribua-o a um segmento. Primeiro, selecione o texto. Em seguida, clique com o botão direito na faixa de segmento para abrir o menu. Escolha o texto Link para o segmento, para atribuir o texto. -## Modificar as posições do código na área de texto +## Modificar as posições do código na área de texto {#modifying-code-positions-in-the-text-area} Quando na área de texto, clique em um código com o mouse (Nota: o código não deve se sobrepor com outro código nessa posição). Pressione as seguintes combinações de teclas para estender ou encolher o segmento de texto codificado. @@ -61,17 +61,17 @@ Você também pode clicar com o botão direito em um código e selecionar mudar Você também pode exportar uma captura de tela. A imagem será salva como Frame yyymmdd hh mm ss.jpg. Você pode salvar uma imagem para codificação de imagem dentro do projeto. -## Botões de conveniência abaixo da lista de arquivos +## Botões de conveniência abaixo da lista de arquivos {#convenience-buttons-underneath-the-files-list} * Carregar o próximo ficheiro * Carregar o ficheiro com a última codificação * Abre o memorando do ficheiro seleccionado * Use uma função de filtro mostrar apenas os arquivos que atendem a determinados critérios. Estes podem ser de atributos de arquivo ou se os arquivos estão associados a certos casos. -## Problemas de áudio e vídeo em alguns sistemas operacionais +## Problemas de áudio e vídeo em alguns sistemas operacionais {#audio-and-video-problems-on-some-operating-systems} Fedora não funciona com o áudio e vídeo. -## Categorias e códigos +## Categorias e códigos {#categories-and-codes} Ver [Categorias e códigos](4.7.-Codes-Tree/) \ No newline at end of file diff --git a/docs/doc/pt/4.7.-Codes-Tree.md b/docs/doc/pt/4.7.-Codes-Tree.md index 78da0eb7..5bd39b17 100644 --- a/docs/doc/pt/4.7.-Codes-Tree.md +++ b/docs/doc/pt/4.7.-Codes-Tree.md @@ -11,7 +11,7 @@ Categorias e códigos podem ser atribuídos memorandos. Os memorandos podem cont !!! note A capacidade de atribuir um único código a várias categorias é uma característica frequentemente solicitada. No entanto, decidimos não implementar essa funcionalidade, pois seria excessivamente complicado. Isso é devido ao uso da estrutura de uma árvore pela QualCoder, enquanto o recurso solicitado requer [estrutura de dados do gráfico](https://www.baeldung.com/cs/tree-vs-graph-data-structure)Como alternativa, você pode usar códigos com nomes semelhantes em suas diferentes categorias. -## Redução da quantidade de códigos exibidos na árvore de códigos +## Redução da quantidade de códigos exibidos na árvore de códigos {#reducing-the-amount-of-codes-displayed-in-the-codes-tree} Para reduzir o número de códigos mostrados na árvore de código. Nas janelas de codificação (texto de código, código, a/v ou imagem de código), clique com o botão direito na árvore de código e selecione Mostrar códigos como no menu, ou quando a árvore de códigos está em foco pressione F9.. Em seguida, digite texto na caixa de texto. Isto só mostrará códigos que contenham esse texto. Para mostrar todos os códigos novamente, digite nada na caixa de texto e pressione OK para mostrar todos os códigos. @@ -19,13 +19,13 @@ Uma segunda opção é Mostrar códigos de cor . Pressione a tecla F10 quando a Outro botão sob a árvore de códigos - com um ícone de pesquisa - ao clicar irá procurar o primeiro código que contém o texto correspondente que você inserir. -## Opções do menu da árvore de códigos +## Opções do menu da árvore de códigos {#codes-tree-menu-options} Na árvore de códigos à esquerda, clicando com o botão direito em um código abre um menu de contexto para várias opções. Sub-menus incluem modificar um código ou categoria, filtragem e ordenação. ![imagem](/images/4adaa97e-da9c-45bf-88f3-8e0110edf638.png) -### Mostrar os ficheiros codificados +### Mostrar os ficheiros codificados {#show-coded-files} Uma opção é Mostrar arquivos codificados - isso mostra em qualquer lugar que você tenha codificado com o código selecionado. Clicando em uma seção codificada em particular irá abrir esse código no contexto original para mais informações. @@ -35,7 +35,7 @@ Com arquivos codificados show, você pode clicar com o botão direito na seção Ordenar a árvore de códigos em ascensão (chave F11 quando códigos em foco), ou descendente (chave F12 quando árvore em foco). -## Acessibilidade e cores de código +## Acessibilidade e cores de código {#accessibility-and-code-colours} No menu de codificação existe uma opção chamada ** esquema de cores**. diff --git a/docs/doc/pt/5.1.-AI-chat-based-analysis.md b/docs/doc/pt/5.1.-AI-chat-based-analysis.md index c298f294..78ede96a 100644 --- a/docs/doc/pt/5.1.-AI-chat-based-analysis.md +++ b/docs/doc/pt/5.1.-AI-chat-based-analysis.md @@ -4,7 +4,7 @@ path: 5.1.-AI-chat-based-analysis # Analisando dados com o agente de IA -## Princípios fundamentais da integração da IA +## Princípios fundamentais da integração da IA {#core-principles-of-ai-integration} **1) Escolha dos modelos de IA** @@ -22,7 +22,7 @@ Os impulsos que orientam o trabalho do agente de IA são acessíveis e podem, em O foco é trabalhar com IA através do diálogo: desenvolver perspectivas adicionais, questionar suas próprias interpretações e obter uma melhor compreensão do material. A pedido, o agente também pode realizar tarefas mais longas de forma semi-autônoma. A automação em grande escala, no entanto, nunca foi o objetivo principal. -## Trabalhar com o agente de IA +## Trabalhar com o agente de IA {#working-with-the-ai-agent} - O agente de IA tem sua **separação ** em QualCoder. Você também pode movê-lo para uma barra lateral** (veja abaixo), ao lado de seus dados, clicando no botão seta pequena. ![Botão de seta para mover o agente de IA para a barra lateral](../../images/ai-agent-sidebar-button-de.png){ largura="118"} @@ -33,20 +33,20 @@ O foco é trabalhar com IA através do diálogo: desenvolver perspectivas adicio !!! note O IA deve estar ** totalmente carregado** e pronto para novas consultas antes de iniciar um chat (barra de status: "AI: pronto"). -### Para que serve o agente de IA? +### Para que serve o agente de IA? {#what-is-the-ai-agent-for} - O agente de IA ajuda você **explore seu material empírico,** desenvolva interpretações e análises, dados de código e escreva memorandos. - Você pode discutir passagens individuais com a IA ou pesquisar todo o corpus do projeto para temas ou casos contrastantes. - Você pode desenvolver seu sistema de código, ideias de brainstorm e estratégias analíticas, e confira-os diretamente com os dados empíricos. - Ao contrário dos chatbots genéricos, o agente de IA em QualCoder ** capta exatamente onde sua análise parou:** examina o sistema de código atual, pode ler memorandos e passagens codificadas, incorporar casos e suas características (atributos) na análise, e muito mais. Isso lhe dá feedback adaptado à fase atual de sua pesquisa. -### O que pode o agente de IA fazer? +### O que pode o agente de IA fazer? {#what-can-the-ai-agent-do} - Mesmo com apenas **read access** para o projeto, o agente de IA já é uma poderosa ferramenta de brainstorming. - A pedido, pode também **avançar activamente a análise**. Com as permissões apropriadas (veja abaixo), ele pode criar novos códigos ou reorganizar os existentes, encontrar e codificar novas passagens de texto, revisar memorandos ou criar novos atributos de caso. - Em conversa com o agente, você pode revisar sugestões, fazer perguntas de seguimento e decidir como proceder. -### Quais são as suas limitações? +### Quais são as suas limitações? {#what-are-its-limitations} - Atualmente, o agente de IA só pode trabalhar com ** dados de texto**, não com imagens, áudio ou vídeo. Os periódicos da QualCoder também estão excluídos por enquanto. - Você pode escolher entre três níveis de permissão: @@ -60,7 +60,7 @@ Nível de permissão - Um **limite restrito** sempre se aplica: os documentos empíricos formam a "verdade de fundo" de toda a análise. Em nenhuma circunstância o IA pode modificá-los. - O agente de IA também não tem ** acesso a informações externas,** como informações da internet. Portanto, ele só pode trabalhar com dados que você deliberadamente incluiu no projeto. -### Como posso ver que mudanças a IA faz? +### Como posso ver que mudanças a IA faz? {#how-can-i-see-which-changes-the-ai-makes} - O agente ** documenta seus passos no chat,** fornece referências de origem, e pergunta antes de fazer grandes mudanças. - Você pode facilmente **undo** as últimas alterações do agente de IA usando o botão correspondente na janela de bate-papo: @@ -75,7 +75,7 @@ Nível de permissão ![Ajustar a visibilidade dos códigos do agente de IA](../../images/ai-agent-code-visibility-de.png){largura="250"} -### Como devo preparar meu projeto? +### Como devo preparar meu projeto? {#how-should-i-prepare-my-project} - Um bom **project memo** é muito importante (menu: "Project > Project memo"). Deve conter: @@ -96,7 +96,7 @@ Nível de permissão !!! note ** Notas pessoais em memorandos:** Se você também quiser usar memorandos para notas pessoais, escreva-os após o separador `#####`Tudo depois é inacessível para a IA. -### Como funciona o agente de IA? +### Como funciona o agente de IA? {#how-does-the-ai-agent-work} - O agente de IA só age quando você lhe dá uma tarefa**, não por sua própria iniciativa. - O agente trabalha através de uma tarefa em **ReAct loop** (Refletir + Acto, [Shunyu et al. 2022](https://arxiv.org/abs/2210.03629)): @@ -110,13 +110,13 @@ Nível de permissão - O agente tem **powerful tools** à sua disposição: por exemplo, ele pode realizar uma pesquisa de similaridade semântica em todo o corpus, pesquisar usando expressões regulares ou um índice de palavras-chave BM25, e chamar ferramentas para criar ou modificar códigos se ele tiver permissões de escrita. -### O que acontece aos meus dados? +### O que acontece aos meus dados? {#what-happens-to-my-data} - Todos os dados são mantidos **localmente em seu computador** no projeto QualCoder atual. As operações de pesquisa mencionadas acima também são executadas localmente. - O modelo **AI só vê a parte dos dados** (por exemplo, resultados de busca ou passagens individuais) especificamente necessária para a análise atual. Esses fragmentos de dados são enviados para o modelo de IA juntamente com a tarefa relevante. - Nas suas respostas, o agente de IA documenta em pormenor os dados em que as suas análises se baseiam. QualCoder transforma essas referências em **links de código com números de linha.** Clicar em uma referência abre a passagem em seu contexto original. -## Quatro maneiras de começar uma conversa com o agente +## Quatro maneiras de começar uma conversa com o agente {#four-ways-to-start-a-conversation-with-the-agent} ![Quatro pontos de partida: uma pergunta aberta, um tópico, uma passagem de texto e um código ou categoria](../../images/ai-agent-conversation-paths-en.png) @@ -126,7 +126,7 @@ Na parte inferior esquerda da janela do agente de IA, você pode iniciar uma nov Essas opções simplesmente fornecem **pontos de partida diferentes** para a análise. Você pode então levar a conversa em qualquer direção que você escolher, usando o conjunto de ferramentas completo disponível para o agente. -### 1) Novo chat aberto +### 1) Novo chat aberto {#1-new-open-chat} Esta é a maneira mais flexível de iniciar uma nova análise com o agente. Comece com uma ideia ou uma pergunta aberta, ou nomeie os códigos ou passagens que você gostaria de investigar. @@ -152,7 +152,7 @@ Esta é a maneira mais flexível de iniciar uma nova análise com o agente. Come Para incorporar ** prompts predefinidos ou seus próprios prompts** a partir do [Biblioteca AI Prompt](./6.3.-AI-Prompt-Library.md) na conversa, use 'slash notation': por exemplo, "/in-vivo-coding" inseriria o prompt correspondente que você criou anteriormente na Biblioteca Prompt na conversa atual. -### 2) Exploração de tópicos +### 2) Exploração de tópicos {#2-topic-exploration} Este tipo de análise é particularmente útil para obter uma ** visão inicial** de como um determinado tópico é discutido no material empírico. Para perguntas de pesquisa simples com tópicos claramente definidos, você também pode usar esta função para produzir análises de resumo que podem ser desenvolvidas diretamente em um relatório. @@ -169,7 +169,7 @@ Este tipo de análise é particularmente útil para obter uma ** visão inicial* > > **Resultado:** Uma análise comparativa de Ethel e Flora sobre o tema "Levantando crianças durante a guerra", estruturado em torno das três subquestões. -### 3) Análise de texto +### 3) Análise de texto {#3-text-analysis} - Permite **fechar análise de uma passagem selecionada** com o agente IA. - Desenvolver novas leituras e sugestões de código juntos, ou discutir ambiguidades, incertezas e questões de interpretação não resolvidas. @@ -190,7 +190,7 @@ Você também pode salvar suas próprias instruções de análise de texto no [B > d) Uma ** conversa sobre o material** então começa, em que você explora e discute diferentes interpretações possíveis juntos. > e) **Salvar os resultados:** Quando terminar, instrua o agente de IA a guardar um resumo dos resultados como uma anotação de texto. -### 4) Análise de código +### 4) Análise de código {#4-code-analysis} - Analisa todos os **dados recolhidos sob um determinado código ou categoria,** incluindo subcódigos. - Discuta seus códigos com o agente de IA, compare códigos diferentes, crie subcódigos ou produza relatórios. @@ -209,14 +209,14 @@ Você pode criar seus próprios prompts para esta função no [Biblioteca AI Pro > > ** Resultado:** Um relatório detalhado sobre a "saturação teórica" do código atual ou categoria selecionada no sentido da teoria fundamentada. O agente de IA busca ativamente o material para variações ainda não codificadas do fenômeno captado pelo código, para casos limítrofes e contraexemplos, para avaliar a saturação empírica e conceitual/teórica do código e identificar lacunas. O memorando de código também é levado em conta. -## Uma reflexão final sobre o antropomorfismo +## Uma reflexão final sobre o antropomorfismo {#a-final-reflection-on-anthropomorphism} Decidimos deliberadamente contra dar um nome ao agente de IA em QualCoder, como o "Claude" da Anthropic. No entanto, a abordagem da QualCoder à integração de IA através do diálogo encena uma espécie de pseudo-interação que, em muitos aspectos, segue padrões de interação humana, por exemplo, dentro de uma equipe de pesquisa. Na sua [prompt do sistema central](https://github.com/ccbogel/QualCoder/blob/master/src/qualcoder/ai_prompts/_agent.md), o agente de IA em QualCoder é atribuído precisamente esse papel como uma espécie de membro da equipe. Estamos, portanto, antropomorfizando uma máquina interagindo com ela como se fosse um pesquisador humano? Até certo ponto, estamos. Mas me parece muito útil ver essas interações como uma espécie de "jogo de papel", como proposto por [Shanahan, McDonell & Reynolds 2023](https://www.nature.com/articles/s41586-023-06647-8)Os modelos de linguagem de IA atuais são treinados em interações linguísticas humanas. Eles, portanto, funcionam melhor quando incorporados em tais configurações de interação. No entanto, uma abordagem metodologicamente reflexiva da IA na pesquisa social qualitativa requer lembrar que estamos nos engajando em um papel induzido tecnologicamente, em vez de interagir com uma contraparte humana. -## Outras funções +## Outras funções {#further-functions} - No **[Biblioteca AI Prompt](./6.3.-AI-Prompt-Library.md)**, você pode salvar estratégias analíticas bem sucedidas e abordagens metodológicas como instruções reutilizáveis para mais tarde. - **[AI Codificação Assistida](./4.2.-AI-Assisted-Coding.md)** na área de trabalho 'Code text' usa uma pesquisa baseada em IA para ajudá-lo a encontrar passagens relevantes para um determinado código em todo o corpus. -- Se você tiver **perguntas sobre o uso do QualCoder**, o agente de IA pode ajudar com isso também, fornecendo respostas baseadas na documentação do QualCoder. Selecione * Ajuda > Pergunte ao agente de IA* no menu principal. +- Se você tiver **perguntas sobre o uso do QualCoder**, o agente de IA pode ajudar com isso também, fornecendo respostas baseadas na documentação do QualCoder. Selecione * Ajuda > Pergunte ao agente de IA* no menu principal. \ No newline at end of file diff --git a/docs/doc/pt/5.2.-Journals.md b/docs/doc/pt/5.2.-Journals.md index 5539314f..39015497 100644 --- a/docs/doc/pt/5.2.-Journals.md +++ b/docs/doc/pt/5.2.-Journals.md @@ -23,7 +23,7 @@ Você pode classificar diários por nome ou data. Você pode adicionar atributos A janela do diário será de flutuação livre, para que você possa inserir notas enquanto codifica ou gera relatórios. -## Realçar o texto do diário usando linguagem markdown +## Realçar o texto do diário usando linguagem markdown {#highlight-journal-text-using-markdown} Alguns markdowns estão disponíveis para destacar o texto em um diário. Use um a três símbolos de hash/jogo da velha (#) para os níveis de cabeçalho. Asterisco único em torno de palavras para texto itálico. Dois asteriscos para texto em negrito. diff --git a/docs/doc/pt/5.3.-Analysis.md b/docs/doc/pt/5.3.-Analysis.md index 43b72781..51699422 100644 --- a/docs/doc/pt/5.3.-Analysis.md +++ b/docs/doc/pt/5.3.-Analysis.md @@ -14,7 +14,7 @@ path: 5.3.-Analysis -## Recuperação de segmentos codificados { #code-retrieval } +## Recuperação de segmentos codificados {#code-retrieval} Este relatório fornece uma lista, ou matriz, de dados codificados com base em suas seleções. Um ou mais códigos precisam ser selecionados. Se uma categoria for selecionada, todos os códigos dessa categoria também são selecionados. Várias categorias podem ser selecionadas usando o mouse e o botão ‘ctrl’. @@ -27,15 +27,15 @@ Os resultados da codificação podem ser reduzidos usando os botões de seleçã Se o texto for inserido no campo Buscar texto, serão apresentados apenas códigos que contenham o texto correspondente. A busca de texto também procura por texto correspondente em memorandos para áreas de imagens codificadas e segmentos de áudio/vídeo codificados. A função de buscar texto deve ser usada em combinação com a seleção de arquivos, a seleção de casos ou a seleção de atributos. -## Texto, imagens, trechos codificados como Importante +## Texto, imagens, trechos codificados como Importante {#important-coded-text-images-segments} Existe uma caixa de seleção para selecionar apenas os códigos importantes. Isso é útil para encontrar rapidamente aqueles exemplos importantes que você pode usar em um relatório escrito. -## Seleção de atributos nos relatórios +## Seleção de atributos nos relatórios {#attribute-selection-in-reports} O botão de seleção do atributo abre uma janela onde você pode selecionar atributos para arquivos e casos, por exemplo: apenas arquivos de entrevista para pessoas com > 60 anos. Além disso, as configurações de atributos podem ser salvas, carregadas e apagadas. ![Seleção de atributos](/images/8d349854-7e35-474b-8bba-119b23ed40b0.png) -## Matriz de codificação +## Matriz de codificação {#coding-matrix} Se você estiver criando um relatório e selecionando uma das opções da matriz, então o painel de resultados será dividido em dois painéis. O painel esquerdo mostra os dados codificados em uma lista, e o painel direito mostra uma matriz de linhas e colunas. Os tipos de colunas podem ser códigos, categorias ou categorias de nível superior. Opções da matriz: ter códigos/categorias por arquivo ou por caso. A matriz pode ser transposta, usando a caixa de seleção. @@ -48,18 +48,18 @@ Os relatórios podem ser exportados para arquivos de texto, OpenDocument (ODT), _Quando os casos são selecionados, outro painel é exibido mostrando uma tabela de casos (em linhas) e categorias ou códigos em colunas_ -## Caixas de seleção +## Caixas de seleção {#check-boxes} * Marque uma caixa para mostrar apenas segmentos codificados que foram marcados importantes. * Marque uma caixa para adicionar estatísticas resumidas ao relatório. * Há uma caixa de seleção para o contexto do texto dos trechos codificados de texto. Isto mostra os cercando 100 a 300 caracteres do texto (definido nas iConfigurações) para ajudar a colocar o trcho codificado em contexto nos resultados. O segmento de texto codificado é mostrado em negrito. * Marque a caixa para adicionar uma referência ao resultado codificado. Isto se uma referência tiver sido importada e vinculada ao arquivo específico. -## Outras funções +## Outras funções {#other-functions} * Atalho H. Pressionr h irá esconder e desocultar a seção de controles superiores da janela. -### Memorandos +### Memorandos {#memos} * Mostar memorandos. Uma caixa suspensa que oferece opções para incluir nenhum memorando, várias opções de memorando ou para exibir arquivos de anotações de texto para arquivos de texto selecionados. @@ -67,7 +67,7 @@ Clique com o botão direito em um cabeçalho de código no relatório gerado par ![image](/images/a6d29ccf-2d9f-4faf-a1a6-5aaf3498e9a9.png) -### Exportação de Relatórios +### Exportação de Relatórios {#exporting-reports} Relatórios podem ser exportados como html, odt, txt, csv, xlsx, (em versões 3.8+) iramuteq. @@ -87,7 +87,7 @@ Relatórios podem ser exportados como html, odt, txt, csv, xlsx, (em versões 3. -## Relatório de co-ocorrência do código { #code-co-occurrence-report } +## Relatório de co-ocorrência do código {#code-co-occurrence-report} Este relatório mostra uma tabela dos nomes de código ao longo dos eixos x e y. As células da tabela mostram a contagem de co-ocorrências de codificação. É aqui que dois códigos se sobrepõem ou são adjacente diretamente. Clique na célula para mostrar os detalhes da codificação de texto. @@ -106,7 +106,7 @@ Exemplos de gráfico de co-ocorrência e gráfico de agrupamento. ![image](/images/651896887-02b544ba-31f7-4ac8-b0f6-b6c017fd418d.png) -## Relatório sobre as relações com os códigos { #code-relations-report } +## Relatório sobre as relações com os códigos {#code-relations-report} Esta caixa de diálogo mostra as relações entre dois ou mais códigos. Isto só pode ser aplicado a arquivos de texto. Selecione dois ou mais códigos e pressione o botão Calcular. @@ -130,7 +130,7 @@ Estatísticas resumidas e gráficos de caixas podem ser produzidos. -## Correspondências Exatas de texto de Código { #code-text-by-exact-matches-report } +## Correspondências Exatas de texto de Código {#code-text-by-exact-matches-report} Este relatório detalha todos os segmentos exatos de texto codificado, onde diferentes códigos são aplicados ao mesmo texto. Selecione documentos de texto e dois ou mais códigos. @@ -138,7 +138,7 @@ Este relatório detalha todos os segmentos exatos de texto codificado, onde dife -## Relatório de Códigos por segmentos de texto { #codes-by-text-segments-report } +## Relatório de Códigos por segmentos de texto {#codes-by-text-segments-report} Este relatório mostra linhas de segmentos de texto codificados e colunas cujos códigos foram aplicados. Para alguns usuários, por exemplo, na área legal, é conveniente ver quais códigos foram aplicados ao mesmo segmento de texto. @@ -148,10 +148,10 @@ Um arquivo Excel pode ser exportado. -## Gráfico (Mapa mental) +## Gráfico (Mapa mental) {#graph-mind-map} [Ver página](5.5.-Graph) -## Análise assistida por IA +## Análise assistida por IA {#ai-assisted-analysis} -[Ver página](5.1.-AI-chat-based-analysis) +[Ver página](5.1.-AI-chat-based-analysis) \ No newline at end of file diff --git a/docs/doc/pt/5.3.-legacy-reports-landing.md b/docs/doc/pt/5.3.-legacy-reports-landing.md index 6b5a6eec..6fdd73e7 100644 --- a/docs/doc/pt/5.3.-legacy-reports-landing.md +++ b/docs/doc/pt/5.3.-legacy-reports-landing.md @@ -7,4 +7,4 @@ path: 5.3.-legacy-reports-landing A página de ajuda vinculada por versões mais antigas do QualCoder foi dividida em duas páginas. Escolha a seção correspondente à ferramenta que você está usando: - [Opções do menu de Análise](5.3.-Analysis.md): recuperação de códigos, co-ocorrência de códigos, relações entre códigos, correspondências de texto, segmentos de texto, gráficos e análise assistida por IA. -- [Opções do menu de relatórios](5.4.-Reports.md): comparações entre codificadores, contagens e frequências de códigos, resumos de arquivos e códigos, gráficos e consultas à base de dados. +- [Opções do menu de relatórios](5.4.-Reports.md): comparações entre codificadores, contagens e frequências de códigos, resumos de arquivos e códigos, gráficos e consultas à base de dados. \ No newline at end of file diff --git a/docs/doc/pt/5.4.-Reports.md b/docs/doc/pt/5.4.-Reports.md index 058351a5..9c804022 100644 --- a/docs/doc/pt/5.4.-Reports.md +++ b/docs/doc/pt/5.4.-Reports.md @@ -14,7 +14,7 @@ path: 5.4.-Reports * Consultas (_queries_) de Banco de Dados (consultas no banco de dados, incluindo consultas padrão) -## Relatório de Comparação de Codificação { #coding-comparison-report } +## Relatório de Comparação de Codificação {#coding-comparison-report} Esta opção mostra as semelhanças e diferenças globais entre dois codificadores em todos os arquivos de texto. Selecione dois codificadores e clique no botão de comparação de execução. As estatísticas criadas aqui são apenas para texto codificado, não para imagens codificadas ou arquivos de mídia. Para cada código: @@ -39,14 +39,14 @@ Clique com o botão direito de um código para mais opções: ![image](/images/gh-ad6903e9-1f1a-4901-92c4-9c7e00d174e4.png) -## Comparação de Codificação por relatório de arquivo { #coding-comparison-by-file-report } +## Comparação de Codificação por relatório de arquivo {#coding-comparison-by-file-report} Esta opção mostra as semelhanças e diferenças globais entre dois codificadores em um arquivo selecionado. Selecione um arquivo, um código e dois codificadores. Em seguida, clique no botão de comparação de execução. As estatísticas e comparações para segmentos codificados em áudio/vídeo estão em desenvolvimento. Concordância geral, discordância e Kappa de Cohen são calculados para textos e imagens. Um arquivo de imagem é exibido em uma janela separada, mostrando as seleções dos dois codificadores em áreas amarelas ou azuis. Texto verde indica onde ambos os codificadores codificaram a mesma seção do texto. O cursor do mouse fornece informações adicionais. ![imagem](/images/cd5eff94-2cc0-4988-af48-da12f55bfc48.png) -## Relatório das frequências de código { #code-frequencies-report } +## Relatório das frequências de código {#code-frequencies-report} Esta janela mostra todos os códigos e categorias e a frequência de uso para cada codificador. As frequências de código podem ser selecionadas para arquivos específicos. @@ -55,7 +55,7 @@ Esta janela mostra todos os códigos e categorias e a frequência de uso para ca ![imagem](/images/gh-2a499964-a0c6-4961-ae7e-d1851bf0d549.png) -## Relatório de Resumo do Arquivo { #file-summary-report } +## Relatório de Resumo do Arquivo {#file-summary-report} Clique em um arquivo para obter um resumo desse arquivo. Descreve metadados de mídia, caracteres e frequência de palavras. Atributos. Ele resume a contagem de códigos para esse arquivo. Os códigos de texto resumem o comprimento médio do texto. Para codificação de imagens ele resume a área média de pixels. Para codificação de áudio/vídeo resume o comprimento médio do trecho. @@ -68,7 +68,7 @@ Clique com o botão direito nos arquivos para mais opções: ![imagem](/images/gh-05dbe1fd-f4ae-4899-99c9-df274ae43f12.png) -## Relatório de Resumo do Código { #code-summary-report } +## Relatório de Resumo do Código {#code-summary-report} Clique em um código para obter um resumo desse código. Os codificadores que usaram o código. O número de codificações em texto, imagem e áudio/vídeo. Os códigos de texto resumem o comprimento médio do texto e as palavras mais comuns. Para codificação de imagens ele resume a área média de pixels. Para codificação de áudio/vídeo resume o comprimento médio do segmento. @@ -80,7 +80,7 @@ Clique com o botão direito de um código para mais opções: ![image](/images/gh-2a499964-a0c6-4961-ae7e-d1851bf0d549.png)[ -## Gráficos { #charts } +## Gráficos {#charts} Vários tipos de gráficos e opções de filtro estão disponíveis. @@ -125,7 +125,7 @@ As _stopwords_ atualmente usadas estão em `stopwords.txt` na pasta `Examples`. ![Nuvem de Palavras](/images/wc.png) -## Consultas na base de dados { #database-queries } +## Consultas na base de dados {#database-queries} Aplicar expressões SQL para consultar o banco de dados. Esta janela contém três painéis. O painel superior é onde as instruções SQL são inseridas e o painel inferior contém os resultados de consultas. O painel esquerdo contém tabelas e nomes de campos. Clicando duas vezes em um nome de campo adiciona-o à instrução SQL. Os resultados podem ser exportados para um arquivo delimitado. Se você não está familiarizado com SQL tome cuidado, pois você será capaz de atualizar e excluir os dados, bem como selecionar dados. Nota: Alguns símbolos Unicode não são convertidos para texto simples e são ignorados. @@ -151,4 +151,4 @@ Consultas padrão, como a mostrada na imagem, são consultas SQL prontas para ex ![image](/images/18c552a3-b256-453a-80ec-5c2931016e12.png) -Como você é capaz de realizar quaisquer consultas no banco de dados, incluindo atualização de dados e exclusão de tabelas, mantenha cópias de backup. Caso contrário, é possível destruir irreparavelmente o banco de dados. +Como você é capaz de realizar quaisquer consultas no banco de dados, incluindo atualização de dados e exclusão de tabelas, mantenha cópias de backup. Caso contrário, é possível destruir irreparavelmente o banco de dados. \ No newline at end of file diff --git a/docs/doc/pt/5.5.-Graph.md b/docs/doc/pt/5.5.-Graph.md index 6dcf028f..2be5235b 100644 --- a/docs/doc/pt/5.5.-Graph.md +++ b/docs/doc/pt/5.5.-Graph.md @@ -18,7 +18,7 @@ Clicar com o botão direito numa linha permite alterar a espessura, mudar para o Texto codificado, imagens codificadas e trechos A/V codificados podem ser mostrados. Os memorandos de texto codificado, de imagem codificada e de trechos A/V codificados podem ser mostrados em caixas de texto. Cada um destes tem dicas para dar mais informações. Você não pode exibir o mesmo trecho codificado várias vezes no gráfico. -## Clique com o botão direito do mouse nos itens para mais opções +## Clique com o botão direito do mouse nos itens para mais opções {#right-click-on-items-for-more-options} Imagem: @@ -37,6 +37,6 @@ Estilo de linha: ![image](/images/gh-baa778e1-e439-4727-bd42-b84e00a3f0a3.png) -## Opções de exportação +## Opções de exportação {#export-options} Os gráficos podem ser salvos, carregados e excluídos. Os gráficos podem ser exportados como: PNG, PDF, ODT (para LibreOffice e MS Office),[Draw.io](https://www.drawio.com/). \ No newline at end of file diff --git a/docs/doc/pt/6.1.-Imports-and-Exports.md b/docs/doc/pt/6.1.-Imports-and-Exports.md index 62a7a6f7..1686d9ca 100644 --- a/docs/doc/pt/6.1.-Imports-and-Exports.md +++ b/docs/doc/pt/6.1.-Imports-and-Exports.md @@ -14,17 +14,17 @@ Opções semelhantes para as exportações: ![image](/images/gh-d2d1f30f-4058-4533-a568-b814a1b72e82.png) As _surveys_ são importadas através da tela Gerenciar arquivos. [Ver Importações de Survey](6.2.-Survey-Imports) -## Exportar livro de códigos (_codebook_) +## Exportar livro de códigos (_codebook_) {#codebook-export} Esta é uma opção no Menu Projeto > Exportações. Um livro de códigos (ou _codebook_) é uma lista dos seus códigos. Cada memorando de código deve especificar as razões para a finalidade de cada código. O livro de códigos pode ser exportado para um arquivo de texto. O livro de códigos também mostra a frequência dos códigos utilizados (de todos os codificadores). Uma vez que os códigos e categorias são colocados numa estrutura semelhante a uma árvore, o travessão/'menos duplo' ("–") indica os códigos e categorias subordinados dentro de uma categoria. -## Importação do _codebook_ +## Importação do _codebook_ {#codebook-import} Importe um livro de códigos como um arquivo de texto simples (.txt) ou como um arquivo .csv. Use dois símbolos de "maior que" (>>) para separar categorias e códigos. Use três símbolos "maior que" (>>>) para definir um código sob um código. -### Texto simples +### Texto simples {#codebook-plain-text-import} Use a aba para adicionar um memorando. ``` @@ -39,7 +39,7 @@ category3>>code4 code5>>>code6>>>code7 ``` -### CSV +### CSV {#codebook-csv-file} As categorias e códigos estão na primeira coluna. Quaisquer memorandos de código estão na segunda coluna. ``` @@ -50,7 +50,7 @@ category1>>category2>>code2 category3>>code3 ``` -## REFI-QDA +## REFI-QDA {#refi-qda} A [Iniciativa Formato de Intercâmbio de Roterdã (em inglês _Rotterdam Exchange Format Initiative_ - REFI)](https://www.qdasoftware.org) é um padrão aberto para exportação e importação de _codebooks_ e projetos de e para diferentes _softwares_ de análise de dados qualitativos assistidos por computador. Atualmente, o QualCoder é capaz de importar um codebook desde que esteja usando a versão "urn:QDA-XML:codebook:1.0". O QualCoder também exporta nesta versão. @@ -67,18 +67,18 @@ Se nenhum dado codificado estiver visível, você pode precisar alterar o nome d Este rescuro é antigo (Fev 2021), mas um usuário testou a importação de um arquivo de projeto REFI-QDA gerado pela QualCoder e importado para MAXQDA, Quirkos, Atlas.ti. Apenas texto e imagens foram testados. Um PDF dos resultados do teste está aqui:[Teste de importação de arquivos do projeto REFI-QDA para Atlas, MAXQDA, Quirkos PDF](https://qualcoder.files.wordpress.com/2021/02/refi-qda-project-import-quirkos-maxqda-atlas.pdf) -## Taguette +## Taguette {#taguette-import} Projetos criados com o [Taguette](https://www.taguette.org/) podem ser importados diretamente. Todos os seus dados de codificação serão transferidos. Feche qualquer projecto aberto. Em seguida, no Menu Principal do Projeto, clique em "Importar projeto do Taguette". Você será solicitado a criar um novo projeto, então digite um nome. Em seguida, você será solicitado a selecionar o arquivo de projeto Taguette (geralmente com uma extensão `.sqlite3`). O QualCoder irá então proceder à importação. Se quaisquer dados codificados não vierem, poderá ser preciso alterar o nome do codificador atual nas Definições. Tente usar o nome do codificador. -## Sonal π (Solal Pi) +## Sonal π (Solal Pi) {#sonal-sonal-pi-import} Projetos criados com o [Sonal Pi](https://www.sonal-info.com), um _software_ de análise de dados qualitativos desenvolvido em francês, podem ser importadoa. -## RQDA +## RQDA {#rqda-import} Projetos realizados com o [RQDA](http://rqda.r-forge.r-project.org/) podem ser importados diretamente. Todos os dados, exceto as categorias de arquivos, são importados. @@ -86,20 +86,20 @@ Feche qualquer projecto aberto. Em seguida, no Menu Principal em Projeto clique Se nenhum dado codificado estiver visível, você pode precisar alterar o nome do codificador atual em Configurações. Tente a caixa de nomes do codificador. -## Importação de _survey_ +## Importação de _survey_ {#survey-import} Ver página [Importações de _survey_](6.3.-Survey-Imports) -## Importação de Bibliografia +## Importação de Bibliografia {#bibliography-import} Ver página[Gestão de Dados - Referências](3.5.-References) -## Ajuda - Funções Especiais +## Ajuda - Funções Especiais {#help-special-functions} -### Conteúdo de texto de atualização dinâmica +### Conteúdo de texto de atualização dinâmica {#dynamic-update-text-content} Isso é útil para atualizar arquivos de texto, como extratos de posts do blog, que mudam ao longo do tempo. Atualize um arquivo de texto enquanto tenta manter os segmentos de texto codificados existentes. Selecione o arquivo de texto que precisa ser substituído e selecione o arquivo de substituição. Clique no botão engrenagens para executar a atualização. Esta função funciona encontrando o texto correspondente idêntico no arquivo de substituição como ele analisa através do texto do arquivo. Pode produzir segmentos erroneamente codificados. -### Mesclar Projetos +### Mesclar Projetos {#merge-projects} Ver página:[Mesclar projetos do QualCoder](6.4.-Merge-Projects) \ No newline at end of file diff --git a/docs/doc/pt/6.2.-Survey-Imports.md b/docs/doc/pt/6.2.-Survey-Imports.md index 86684f9d..2e350f87 100644 --- a/docs/doc/pt/6.2.-Survey-Imports.md +++ b/docs/doc/pt/6.2.-Survey-Imports.md @@ -24,7 +24,7 @@ Acima estão os dados em `survey456.csv`. Acima estão os dados em `survey789.xlsx`. -## Importando o arquivo `survey456.csv` +## Importando o arquivo `survey456.csv` {#importing-the-file-survey456csv} Pressione o botão importar survey e selecione o arquivo na pasta Exemplos. @@ -50,7 +50,7 @@ Na Gerenciar > Tela de casos é mostrado assim, com um arquivo de texto atribuí ![image](/images/gh-a35b341a-40e6-4d38-9647-179f6bc25d5e.png) -### Adicionando mais dados +### Adicionando mais dados {#adding-more-data} Usando o botão de importação do survey, selecione e importe o arquivo `survey789.xls`. Deixe as caixas de seleção desmarcadas. @@ -66,4 +66,4 @@ Pressione OK. Os novos arquivos qualitativos foram adicionados, e os atributos do arquivo agora são estendidos com as três novas respostas do survey. A diferença aqui é que os novos arquivos tinham diferentes componentes qualitativos. Ambas as colunas de resposta qualitativa foram reunidas em um arquivo de texto para cada caso. -![image](/images/gh-e5920d18-10e5-47d5-af59-dfd7dced11e1.png) +![image](/images/gh-e5920d18-10e5-47d5-af59-dfd7dced11e1.png) \ No newline at end of file diff --git a/docs/doc/pt/6.3.-AI-Prompt-Library.md b/docs/doc/pt/6.3.-AI-Prompt-Library.md index dc31223f..fe046fa8 100644 --- a/docs/doc/pt/6.3.-AI-Prompt-Library.md +++ b/docs/doc/pt/6.3.-AI-Prompt-Library.md @@ -10,7 +10,7 @@ path: 6.3.-AI-Prompt-Library - Já incluímos algumas sugestões interessantes de outras pesquisas qualitativas publicadas em diversos lugares. Esperamos que o uso crescente de IA na pesquisa qualitativa seja acompanhado por uma cultura de desenvolvimento, compartilhamento e discussão de prompts sofisticados na comunidade científica, para que todos possamos aprender uns com os outros e melhorar os novos métodos emergentes no campo. -## A Estrutura de um Prompt +## A Estrutura de um Prompt {#the-structure-of-a-prompt} Em um sentido muito básico, um "_prompt_" é como a pergunta que você digita na interface _web_ do ChatGPT. Mas, mesmo nesse caso, é um pouco mais complexo. No fundo, o ChatGPT acompanhará sua pergunta com um "_prompt_ de sistema invisível" que instrui a IA a ser um assistente útil e solidário, a não dar aconselhamento médico ou jurídico, etc. @@ -27,7 +27,7 @@ Esta estrutura consiste em: - **dados empíricos** (aqui em amarelo), selecionados de várias maneiras; e - o prompt **analítico** (mostrado em laranja), que você pode modificar e adaptar às suas necessidades. -## Perguntas analíticas +## Perguntas analíticas {#analytic-prompts} Os prompts analíticos são o **cerne dos recursos de IA do QualCoder**. Eles instruem a IA sobre como analisar seus dados. Essas instruções podem ser bastante simples, mas também podem se transformar em diretrizes complexas, com descrições detalhadas de cada passo que a IA deve executar durante a análise, incluindo o contexto metodológico, etc. (ver Lieder & Schäffer, 2024).1 diff --git a/docs/doc/pt/7.2.-QualCoder-Video-Tutorials.md b/docs/doc/pt/7.2.-QualCoder-Video-Tutorials.md index 4796ea06..dc1ca508 100644 --- a/docs/doc/pt/7.2.-QualCoder-Video-Tutorials.md +++ b/docs/doc/pt/7.2.-QualCoder-Video-Tutorials.md @@ -4,7 +4,7 @@ path: 7.2.-QualCoder-Video-Tutorials # Vídeos mostrando como usar o QualCoder -## QualCoder 3.7 +## QualCoder 3.7 {#qualcoder-37} [QualCoder 3.7 parte 1 - Colin Curtain](https://www.youtube.com/watch?v=TCLCT893JcM) @@ -20,13 +20,13 @@ path: 7.2.-QualCoder-Video-Tutorials [Versão alfa de 3.7 em comparação com outros softwares qualitativos - Van Tran](https://www.youtube.com/watch?v=Cqwu3mjJJHg) -## QualCoder 3.6 +## QualCoder 3.6 {#qualcoder-36} [Webinar: KI-unterstütze Datenanalyse in QualCoder 3 .6 - In German](https://www.youtube.com/watch?v=JF64vbngedA) [Qualitativ Forschen - Codificação horizontal baseada em IA](https://www.youtube.com/watch?v=FrQyTOTJhCc) -## QualCoder 3.5 +## QualCoder 3.5 {#qualcoder-35} [Tutorial, pela Cortina Colin](https://www.youtube.com/watch?v=wj5fY4F5Jxo) @@ -36,6 +36,6 @@ path: 7.2.-QualCoder-Video-Tutorials [Qualcoder - Data Hub Tool Talk - University of Idaho](https://www.youtube.com/watch?v=119k-jNOl8I) -## Tutoriais antigos +## Tutoriais antigos {#older-tutorials} Tutoriais mais antigos podem ser encontrados no YouTube. \ No newline at end of file diff --git a/docs/doc/pt/7.3.-QualCoder-Development.md b/docs/doc/pt/7.3.-QualCoder-Development.md index 7c054460..239370cf 100644 --- a/docs/doc/pt/7.3.-QualCoder-Development.md +++ b/docs/doc/pt/7.3.-QualCoder-Development.md @@ -8,14 +8,14 @@ Atualmente, o QualCoder é desenvolvido no Windows 11. O QualCoder é escrito em Após a versão 4.0, uma área de desenvolvimento será revisar a presença visual, isto é a interface do usuário, do QualCoder. O objetivo é tornar a interface mais moderna e atraente. Outra área de melhoria será fornecer mais documentação de governança, para apoiar o uso do QualCoder em grandes instituições. -## Sistemas operativos utilizados +## Sistemas operativos utilizados {#operating-systems-used} O QualCoder foi usado no Windows 11, macOS, Ubuntu 24, Lubuntu, Fedora, Linux Mint, Arch Linux, Fedora, NixOS e ZorinOS. * Usar áudio ou vídeo com o QualCoder no Fedora faz o QualCoder quebrar. * Debian com o Gnome e a opção de janela em _tiling_ - encolhe o tamanho da janela QualCoder. A melhor opção é desligar o _tiling_ de janelas nas configurações do Gnome. -## Agradecimentos +## Agradecimentos {#acknowledgements} Ronggui Huang, Zhang Gehao - Criador do RQDA - inspiração para QualCoder. @@ -35,22 +35,22 @@ Van Tran por fornecer muitas sugestões úteis e apoio ao longo dos últimos ano Aos muitos membros do GitHub por _feedback_, ideias e apoio a este projeto. -## Citação +## Citação {#citation} Citação: Curtain C, Dröge K, Missaghieh--Poncet J, Salomón L. (2026) QualCoder 4.0 [Software de computador]. Extraído de https://github.com/ccbogel/QualCoder/releases/tag/4.0 -## Estruturas de dados +## Estruturas de dados {#data-structures} **A pasta de projeto qda** contém pastas para documentos importados e o banco de dados sqlite para armazenar os dados de codificação. Quando a IA está ativada, há uma pasta `ai_data` contendo um banco de dados sqlite com o histórico de conversas e uma _vectorstore_. Uma _vectorstore_ é uma representação numérica de palavras, frases e orações usada pelo modelo de linguagem de IA. **A pasta de trabalho `.qualcoder`** em sua pasta _home_. O QualCoder cria o arquivo `QualCoder.log` e arquivos de configuração. Não coloque nenhum arquivo dentro desta pasta, pois ela é usada como uma área de configurações e armazenamento de trabalho do QualCoder. A **pasta `.qualcoder_ai`** na pasta _home_ contém os detalhes de configuração para o uso da IA. -## Licenças +## Licenças {#licenses} !!! info Dadas as necessidades legais das licenças às quais o QualCoder está submetido, a documentação necessária foi incluída em seu idioma original (inglês). -### Licença LGPL-3.0 +### Licença LGPL-3.0 {#lgpl-30-license} QualCoder is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. @@ -58,7 +58,7 @@ QualCoder is distributed in the hope that it will be useful, but WITHOUT ANY WAR You should have received a copy of the GNU Lesser General Public License along with QualCoder. If not, see [https://www.gnu.org/licenses ](https://www.gnu.org/licenses) -### License for highlighter.py code +### License for highlighter.py code {#license-for-highlighterpy-code} Copyright (C) 2013 Riverbank Computing Limited. @@ -90,7 +90,7 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -### License for docx.py code +### License for docx.py code {#license-for-docxpy-code} Copyright (c) 2009-2010 Mike MacCana @@ -115,6 +115,6 @@ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -### Dependency Licenses +### Dependency Licenses {#dependency-licenses} -Dependencies are extra python modules that QualCoder needs to run. Dependency licences are found in the QualCoder/docs folder. Last update 8 october 2026. +Dependencies are extra python modules that QualCoder needs to run. Dependency licences are found in the QualCoder/docs folder. Last update 8 october 2026. \ No newline at end of file diff --git a/docs/doc/pt/7.4.-SQlite-Data-Structure.md b/docs/doc/pt/7.4.-SQlite-Data-Structure.md index 8aecf755..46798baf 100644 --- a/docs/doc/pt/7.4.-SQlite-Data-Structure.md +++ b/docs/doc/pt/7.4.-SQlite-Data-Structure.md @@ -8,7 +8,7 @@ A estrutura de dados v8 atual é descrita para auxiliar no desenvolvimento de bu As tabelas estão listadas alfabeticamente. -## Table: annotation[*](7.4.-SQlite-Data-Structure.md#493) +## Table: annotation[*](7.4.-SQlite-Data-Structure.md#493) {#table-annotation} **anid** _integer_[1](7.4.-SQlite-Data-Structure.md#494) Um número único gerado automaticamente @@ -24,7 +24,7 @@ As tabelas estão listadas alfabeticamente. **date** _text_ A data e hora em que entrada foi criada, formato`yyyy-mm-dd hh:mm:ss` -## Table: attribute +## Table: attribute {#table-attribute} **attrid** _integer_ Um número único gerado automaticamente. @@ -40,7 +40,7 @@ As tabelas estão listadas alfabeticamente. **date** _text_ A data e hora em que a entrada foi criada, formato`yyyy-mm-dd hh:mm:ss` -## Tabela: atribute_type +## Tabela: atribute_type {#table-attribute-type} **name** _text_ O nome único do atributo. @@ -54,7 +54,7 @@ As tabelas estão listadas alfabeticamente. **valuetype** _text_ Isto é 'caractere' ou 'numérico' -## Tabela: case_text +## Tabela: case_text {#table-case-text} **id** _integer_ Número único gerado automaticamente. @@ -72,7 +72,7 @@ As tabelas estão listadas alfabeticamente. **date** _text_ A data e hora em que a entrada foi criada, formato`yyyy-mm-dd hh:mm:ss` -## Quadro: cases +## Quadro: cases {#table-cases} **Caseid** _integer_ Um número único gerado automaticamente. @@ -84,7 +84,7 @@ As tabelas estão listadas alfabeticamente. **date** _text_ A data e hora em que a entrada foi criada, formato`yyyy-mm-dd hh:mm:ss` -## Tabela: code_av +## Tabela: code_av {#table-code-av} **avid** _integer_ Um número único gerado automaticamente. @@ -104,7 +104,7 @@ As tabelas estão listadas alfabeticamente. **important** _integer_ Se atribuído 1, é um código importante. -## Tabela: code_cat +## Tabela: code_cat {#table-code-cat} **catid** _integer_ Um número único gerado automaticamente. @@ -118,7 +118,7 @@ As tabelas estão listadas alfabeticamente. **supercatid** _integer_ Isto representa a categoria-mãe desta categoria. É _Null_ se é uma categoria de topo. -## Tabela: code_image +## Tabela: code_image {#table-code-image} **imgid** _integer_ Um número único gerado automaticamente. @@ -144,7 +144,7 @@ As tabelas estão listadas alfabeticamente. **pdf_page** _integer_ Nulo ou um número representando a página do pdf -## Tabela: code_name +## Tabela: code_name {#table-code-name} **cid** _integer_ Um número único gerado automaticamente. @@ -160,7 +160,7 @@ As tabelas estão listadas alfabeticamente. **color** _text_ Um valor de hex que varia de '#000000' a '#FFFFFF'. O QualCoder reconhece 120 cores para que possa aplicar texto claro ou escuro no topo. -## Tabela: code_text +## Tabela: code_text {#table-code-text} **ctid** _integer_ Um número único gerado automaticamente. (adicionado em v3). @@ -184,7 +184,7 @@ As tabelas estão listadas alfabeticamente. **important** _integer_ Se atribuído 1 é um código importante. -## Tabela: journal +## Tabela: journal {#table-journal} **jid** _integer_ Um número único gerado automaticamente. @@ -196,7 +196,7 @@ As tabelas estão listadas alfabeticamente. **date** _text_ A data e hora em que a entrada foi criada, formato`yyyy-mm-dd hh:mm:ss` -## Quadro: project +## Quadro: project {#table-project} Deve conter uma linha. @@ -216,7 +216,7 @@ Deve conter uma linha. ** recentemente used codes** text Código ids contidos de códigos de texto usados recentemente, espaço delimitado. -## Tabela: source +## Tabela: source {#table-source} **id** _integer_ Um número único gerado automaticamente. @@ -244,7 +244,7 @@ Se o mediapath começa com: '/images/' , '/audio/', '/video/' a imagem, áudio o Se o mediapath começa com: 'images:' , 'audio:', 'video:' a imagem, áudio ou arquivo de vídeo está ligado externamente. O caminho completo para o arquivo é armazenado. -## Tabela: stored_sql +## Tabela: stored_sql {#table-stored-sql} **title** _text_ O título do sql. @@ -254,7 +254,7 @@ Se o mediapath começa com: 'images:' , 'audio:', 'video:' a imagem, áudio ou a **ssql** _text_ O sql gerado pelo usuário. -## Tabela: ris +## Tabela: ris {#table-ris} Usado para bibliografia RIS @@ -266,11 +266,11 @@ Usado para bibliografia RIS **value** _text_ Dado de texta para etiqueta. -## Quadros de visualização de gráficos +## Quadros de visualização de gráficos {#graph-visualisation-tables} Várias tabelas para armazenar os detalhes dos gráficos de gravação, em seguida, os itens dentro dos gráficos. -## Tabela: graph +## Tabela: graph {#table-graph} **grid** _integer_ Identificador único. @@ -284,7 +284,7 @@ Várias tabelas para armazenar os detalhes dos gráficos de gravação, em segui **Cena altura** _integer_ Usado para definir o tamanho da cena ao carregar. -## Tabela: gr_av_item +## Tabela: gr_av_item {#table-gr-av-item} Mostra um ícone de seta para um trecho codificado A/V reproduzível. @@ -308,7 +308,7 @@ Mostra um ícone de seta para um trecho codificado A/V reproduzível. **color** _text_ -## Tabela: gr_case_text_item +## Tabela: gr_case_text_item {#table-gr-case-text-item} Mostra detalhes do caso, com parâmetros de formatação. @@ -330,7 +330,7 @@ Mostra detalhes do caso, com parâmetros de formatação. **displaytext** text -## Tabela: gr_cdct_line_item +## Tabela: gr_cdct_line_item {#table-gr-cdct-line-item} Exibir linhas que ligam códigos e categorias @@ -354,7 +354,7 @@ Exibir linhas que ligam códigos e categorias **isvisible** _integer_ -## Tabela: gr_cdct_text_item +## Tabela: gr_cdct_text_item {#table-gr-cdct-text-item} Mostra o texto codificado com alguns parâmetros de formatação. @@ -380,7 +380,7 @@ Mostra o texto codificado com alguns parâmetros de formatação. **displaytext** _text_ -## Tabela: gr_file_text_item +## Tabela: gr_file_text_item {#table-gr-file-text-item} Mostra detalhes do arquivo com parâmetros de formatação. @@ -402,7 +402,7 @@ Mostra detalhes do arquivo com parâmetros de formatação. **displaytext** _text_ -## Tabela: gr_free_line_item +## Tabela: gr_free_line_item {#table-gr-free-line-item} Mostra o vínculo em linha entre objetos definido pelo usuário @@ -426,7 +426,7 @@ Mostra o vínculo em linha entre objetos definido pelo usuário **isvisible** _integer_ -## Tabela: gr_free_text_item +## Tabela: gr_free_text_item {#table-gr-free-text-item} Mostra texto livre, ou memorandos com parâmetros de formatação. @@ -458,7 +458,7 @@ Mostra texto livre, ou memorandos com parâmetros de formatação. **memo avid** _integer_ -## Tabela: gr_pix_item +## Tabela: gr_pix_item {#table-gr-pix-item} Mostra a imagem codificada. diff --git a/docs/doc/pt/7.5.-AI-Technical-Information.md b/docs/doc/pt/7.5.-AI-Technical-Information.md index b3dbae62..b9d3fd0e 100644 --- a/docs/doc/pt/7.5.-AI-Technical-Information.md +++ b/docs/doc/pt/7.5.-AI-Technical-Information.md @@ -4,4 +4,4 @@ path: 7.5.-AI-Technical-Information # Informações técnicas de IA -(Será atualizado mais tarde.) +(Será atualizado mais tarde.) \ No newline at end of file diff --git a/docs/doc/pt/7.6.-How-to-contribute.md b/docs/doc/pt/7.6.-How-to-contribute.md index 1b753ef2..c3c35bbf 100644 --- a/docs/doc/pt/7.6.-How-to-contribute.md +++ b/docs/doc/pt/7.6.-How-to-contribute.md @@ -4,18 +4,18 @@ path: 7.6.-How-to-contribute.md # Como contribuir -## Contribua com o código +## Contribua com o código {#contributing-to-the-code} Por favor leia as [diretrizes de contribuição](https://github.com/ccbogel/QualCoder/blob/master/docs/CONTRIBUTING.md) -### Regras principais em resumo +### Regras principais em resumo {#key-rules-at-a-glance} - **Escolha primeiro uma issue.** Procure uma issue existente ou crie uma, e comente nela antes de abrir um Pull Request. Aguarde até que a issue seja atribuída a você antes de começar a trabalhar. - **Um Pull Request, um commit.** Reúna (squash) seu trabalho em um único commit com uma mensagem descritiva que reflita suas alterações. - **Nomenclatura.** Crie um branch dedicado com o nome da issue que você está tratando. - **Licença.** Ao enviar um Pull Request, você licencia sua contribuição sob a licença LGPLv3 do projeto ("Inbound = Outbound"). -### Contribuições assistidas por IA +### Contribuições assistidas por IA {#ai-assisted-contributions} Você pode usar ferramentas de IA para auxiliar suas contribuições, mas você permanece totalmente responsável por tudo o que enviar. @@ -26,13 +26,13 @@ Você pode usar ferramentas de IA para auxiliar suas contribuições, mas você Ferramentas de IA **não** devem ser usadas para corrigir issues rotuladas `good first issue`. Elas existem para o aprendizado humano. -## Contribua para a tradução +## Contribua para a tradução {#contribute-to-the-translation} -### Traduza a documentação +### Traduza a documentação {#translate-the-documentation} Você pode traduzir a documentação criando/modificando os arquivos _Markdown_ (.md) em `docs/doc` [no repositório do site](https://github.com/QualCoder-Org/qualcoder-org.github.io). -### Traduza o software +### Traduza o software {#translate-the-software} O QualCoder suporta a funcionalidade multilíngue usando dois tipos de arquivos de tradução: @@ -55,4 +55,4 @@ Por favor, note que os nomes dos seus arquivos de idioma devem seguir o formato *** -> A tradução em Português é mantida por um brasileiro de maneira **voluntária**. Qualquer problema, imprecisão ou questão com a **tradução**, contate [BetoNetu](https://github.com/BetoNetu) +> A tradução em Português é mantida por um brasileiro de maneira **voluntária**. Qualquer problema, imprecisão ou questão com a **tradução**, contate [BetoNetu](https://github.com/BetoNetu) \ No newline at end of file diff --git a/docs/doc/pt/index.md b/docs/doc/pt/index.md index 6dd38e49..63a05de8 100644 --- a/docs/doc/pt/index.md +++ b/docs/doc/pt/index.md @@ -22,7 +22,7 @@ O QualCoder inclui um conjunto de recursos assistidos por IA que utilizam modelo - **QualCoder pode ser modificado**. Você pode modificar e adaptar o QualCoder às suas necessidades, desde que libere suas alterações para todos. Isso também significa que você pode copiar o _software_ e dá-lo a seus colegas ou alunos gratuitamente. - **QualCoder é uma opção de software para apoiar a ciência aberta**. [Recomendações da UNESCO sobre ciência aberta (em inglês)](https://www.unesco.org/en/open-science?hub=686) -## Versão atual +## Versão atual {#current-release} As versões estão disponíveis no [GitHub](https://github.com/ccbogel/QualCoder/releases). Elas existem enquanto código fonte ou executáveis. Os executáveis são uma maneira fácil de executar o QualCoder; clique duas vezes para executar, apenas esteja ciente de que pode levar até 20 segundos para abrir o programa. @@ -38,7 +38,7 @@ As versões estão disponíveis no [GitHub](https://github.com/ccbogel/QualCoder O código em desenvolvimento está disponível aqui:[https://github.com/ccbogel/QualCoder](https://github.com/ccbogel/QualCoder) -## Apoie o QualCoder +## Apoie o QualCoder {#support-qualcoder} Se você gosta de QualCoder e o achou útil para o seu trabalho. Por favor, deixe uma revisão sobre ele em sites como [Saashub](https://www.saashub.com/qualcoder-alternatives) ou [AlternativeTo](https://alternativeto.net/software/qualcoder). @@ -50,7 +50,7 @@ Foram necessárias muitas e muitas horas de trabalho para criar este software qu O QualCoder é escrito em python usando Qt6 para a interface gráfica. QualCoder tem sido usado no Windows 11, macOS e várias distros Linux: Ubuntu, Lubuntu, ZorinOS, Arch, Fedora. -## Citação +## Citação {#citation} APA: @@ -67,6 +67,6 @@ Substitua o número da versão (4.0/4.0-Beta) conforme necessário para a versã INTERNATIONAL BUSINESS MACHINES CORPORATION. SPSS Statistics. Versão 26.0. New York: IBM, 2019. Software para análise estatística. -## Licença +## Licença {#license} -QualCoder está licenciado sob a [licença LGPL v3](https://www.gnu.org/licenses/lgpl-3.0.en.html#license-text). +QualCoder está licenciado sob a [licença LGPL v3](https://www.gnu.org/licenses/lgpl-3.0.en.html#license-text). \ No newline at end of file diff --git a/scripts/check_anchors.py b/scripts/check_anchors.py new file mode 100644 index 00000000..9955c873 --- /dev/null +++ b/scripts/check_anchors.py @@ -0,0 +1,85 @@ +#!/usr/bin/env python3 +"""Check that docs carry explicit heading anchors. + +Every heading of level 2 or more in docs/doc//*.md (English included) +must carry an explicit attr_list anchor ({ #some-id }). In translations, +anchors are aligned on the English slugs so cross-page links written +against English ids keep working in every language; in English, the anchor +gels the current auto-generated id so rewording a title can never silently +break links. The level-1 headings, index.md and the generated print.md are +ignored. + +Usage: + python scripts/check_anchors.py # every language + python scripts/check_anchors.py fr de # specific languages +Exit code is 1 if any heading is missing an explicit anchor. +""" + +from __future__ import annotations + +import re +import sys +from pathlib import Path + +DOC_DIR = Path(__file__).resolve().parent.parent / "docs" / "doc" + +HEADING_RE = re.compile(r"^(#{1,6}) (.+?)(\s*\{[^}]*})?\s*$") + + +def iter_headings(text: str): + fence = False + for line in text.splitlines(): + if line.lstrip().startswith("```"): + fence = not fence + continue + if fence: + continue + match = HEADING_RE.match(line) + if match: + yield match + + +def strip_frontmatter(text: str) -> str: + return re.sub(r"\A---\s*\n.*?\n---\s*\n", "", text, count=1, flags=re.DOTALL) + + +def check_language(lang: str) -> list[str]: + problems: list[str] = [] + lang_dir = DOC_DIR / lang + if not lang_dir.is_dir(): + return problems + for page in sorted(lang_dir.glob("*.md")): + if page.name in ("print.md", "index.md"): + continue + text = strip_frontmatter(page.read_text(encoding="utf-8")) + for match in iter_headings(text): + level, title, attr = match.group(1), match.group(2), match.group(3) + if len(level) == 1: + continue + if attr is None or "#" not in attr: + problems.append( + f"{page.relative_to(page.parents[2])}:" + f"{'#' * len(level)} {title.strip()}") + return problems + + +def main(argv: list[str]) -> int: + langs = argv[1:] + if not langs: + langs = sorted( + d.name for d in DOC_DIR.iterdir() if d.is_dir()) + failed = False + for lang in langs: + problems = check_language(lang) + if problems: + failed = True + print(f"error: {lang} — headings without an explicit anchor:") + for problem in problems: + print(f" {problem}") + else: + print(f"ok: {lang}") + return 1 if failed else 0 + + +if __name__ == "__main__": + raise SystemExit(main(sys.argv[1:]))