[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/transcribe 23566ca 02/27: Added some usage information
From: |
Stefan Monnier |
Subject: |
[elpa] externals/transcribe 23566ca 02/27: Added some usage information |
Date: |
Tue, 1 Dec 2020 17:33:45 -0500 (EST) |
branch: externals/transcribe
commit 23566cac5b3e80b022649873966da674b89e3b36
Author: David Gonzalez Gandara <dggandara@member.fsf.org>
Commit: David Gonzalez Gandara <dggandara@member.fsf.org>
Added some usage information
---
transcribe.el | 46 +++++++++++++++++++++++++++++++++-------------
1 file changed, 33 insertions(+), 13 deletions(-)
diff --git a/transcribe.el b/transcribe.el
index 85a11c2..dd4a333 100644
--- a/transcribe.el
+++ b/transcribe.el
@@ -21,23 +21,43 @@
;;;Commentary:
-;;
-;; to install manually:
+;; INSTALLATION
+;;-------------------
+;; If you don't use transcribe as a package, you can install manually:
;; Copy this file to somewhere in your drive
;; To load the file --> M-: (load "~/transcribe.el") --- change the route to
where you copied the file
-;; Commands:
-;; C-x C-n --> new episode structure
-;; <f6> ----> New tag. Interactively insert new tag
-;; C-x C-a ----> call interactively analyze_episodes.py to extract
interactions by a person
-;; C-x C-p ----> play audio file
-;; <f5> ----> pause or play audio
-;; C-x <right> ----> seek 10 seconds forward
-;; C-x <left> ---->seek 10 seconds backward
-;; <f8> ----> seek interactively: positive seconds go forward and negative
seconds go backward
-;; <f11> --------> l1 tag
-;; <f12> --------> l2 tag
+;; DEPENDENCIES:
+;;-----------------------------
+;; In order to use the most important functions of transcribe, you need to
install emms and mpg321.
+;;
+;; DESCRIPTION
+;;-------------------------
+;; Transcribe is a tool to make audio transcriptions easy. It allows the
transcriber to control the audio easily while typing, as well as automate the
insertion of xml tags, in case the transcription protocol include them.
+;;
+;; AUDIO COMMANDS
+;;------------------------------
+;; C-x C-p --------> Play audio file. You will be prompted for the name of
the file. The recommended format is mp2.
+;; <f5> -----------> Pause or play audio.
+;; C-x <right> ----> seek audio 10 seconds forward.
+;; C-x <left> ----->seek audio 10 seconds backward.
+;; <f8> -----------> seek interactively: positive seconds go forward and
negative seconds go backward
+;;
+;; XML TAGGING COMMANDS
+;;--------------------------------------------------
+;; C-x C-n --> Create new episode structure. This is useful in case your
xml file structure requires it. You can customize the text inserted
manipulating the realted function.
+;; <f6> -----> Interactively insert new tag. You will be prompted for the
content of the tag. The starting tag and the end tag will be inserted
automatically and the cursor placed in the proper place to type.
+;;
+;;
+;;
+;; SPECIFIC COMMANDS I USE, THAT YOU MAY FIND USEFUL
+;;------------------------------------------------
+;; C-x C-a ------> This runs an external discourse analysis tool. It
defaults to my own script analyze_episodes2.py, but you can customise the
command to launch any other.
+;; <f11> --------> Customised tag 1. Edit the function to adapt to your
needs.
+;; <f12> --------> Customised tag 2. Edit the function to adapt to your
needs.
+;; <f7> ---------> Break tag. This command "breaks" a tag in two, that is
it inserts an ending tag and then a starting tag. Edit the function to suit
your needs. It is useful if you are segmenting discourse into tags and then you
decide the segmentation was not correct.
+;; <f4> ---------> Insert atributes. This function insert custom xml
attributes. Edit the function to suit you needs.
;;;Code:
- [elpa] branch externals/transcribe created (now f381a3d), Stefan Monnier, 2020/12/01
- [elpa] externals/transcribe d5ed001 01/27: Package transcribe added, Stefan Monnier, 2020/12/01
- [elpa] externals/transcribe 23566ca 02/27: Added some usage information,
Stefan Monnier <=
- [elpa] externals/transcribe 6617973 03/27: * transcribe.el: Fix up formatting and copyright, Stefan Monnier, 2020/12/01
- [elpa] externals/transcribe e0032f9 06/27: Added minor-mode function as suggested, Stefan Monnier, 2020/12/01
- [elpa] externals/transcribe 39f91f3 11/27: packages/transcribe.el: Add native discourse analysis in elisp, Stefan Monnier, 2020/12/01
- [elpa] externals/transcribe 7fcb7ab 04/27: * transcribe.el: Add `provide' statement, Stefan Monnier, 2020/12/01
- [elpa] externals/transcribe aa1a6e2 05/27: * transcribe/transcribe.el: Allow compilation without emms, Stefan Monnier, 2020/12/01
- [elpa] externals/transcribe 4b595d0 08/27: * transcribe/transcribe.el: Remove manual change log, Stefan Monnier, 2020/12/01
- [elpa] externals/transcribe 51dd51f 10/27: Merge branch 'master' of git.sv.gnu.org:/srv/git/emacs/elpa: transcribe.el update, Stefan Monnier, 2020/12/01
- [elpa] externals/transcribe 6e00216 12/27: /packages/transcribe: Fix variables, Stefan Monnier, 2020/12/01
- [elpa] externals/transcribe 5306782 07/27: * packages/transcribe.el: Manually changed Changelog, Stefan Monnier, 2020/12/01
- [elpa] externals/transcribe 6cdaf56 23/27: packages/transcribe.el - minor bug corrections, Stefan Monnier, 2020/12/01