johananim/note-diary

Un complemento de NVDA para crear, modificar, importar y exportar notas de una manera muy rápida y fácil.

Note Diary v2023.2.0

Un complemento de NVDA para crear, modificar, importar y exportar notas de una manera muy rápida y fácil.

Como usar el complemento

Para usar el complemento sigue los siguientes pasos:

1. Abre el complemento desde el menú de NVDA, Herramientas y finalmente Note diary. De manera inicial Note diary no tiene asignado un gesto de teclado para abrir la ventana, pero puedes asignarlo en preferencias>Gestos de entrada bajo la categoría de Note diary.
2. Crea un diario. Para crear un nuevo diario simplemente pulsa el botón de menú que está en la parte de arriba y selecciona Nuevo diario o de manera alternativa puedes pulsar la combinación de teclado CTRL+N estando en el Árbol de diarios, luego, escribe el nombre del diario que quieras. Por ejemplo, si quieres crear un diario personal donde guardes tus notas diarias como cualquier diario común puedes escribir algo como: "Mi diario personal" o otro similar, es dependiendo de que contenido vayas a guardar en el.
3. Crea capítulos a tu diario recién creado. Puedes hacer esto también de dos maneras: La primera es pulsando el botón de menú de más opciones>Nuevo capítulo o pulsando la combinación de teclado CTRL+P (Más adelante se explican todas las combinaciones posibles). Luego, dale un nombre a tu capítulo, puede ser un título que describa el contenido de ese capítulo, por ejemplo, en el ejemplo anterior, como título de tus notas de diario personal podrías poner la fecha en que lo escribiste. O por ejemplo, si tienes un diario que se llame "Curso de Python" el primer capítulo podría ser algo como: "Clase 01 Hola mundo". Luego de escribir el nombre del capítulo confirma con enter o tab luego enter en el botón de aceptar. Nota importante: Debes estar enfocado en el diario en que quieres crear los capítulos.
4. Escribe dentro de un capítulo. Luego cuando ya hayas creado el capítulo, simplemente da enter o pulsa la tecla de aplicaciones o la combinación shift f10 y selecciona "Editar" y listo! Solo comienza a escribir en el campo multilínea que se enfoca automáticamente al abrir un capítulo.
5. Guarda el capítulo. Luego cuando ya hayas terminado de escribir, para guardar solo pulsa la combinación alt+g o navega con tab hasta el botón de "Guardar" y púlsalo, si tienes los sonidos activados emitirá un sonido que indica el guardado del capítulo, de igual manera, si hay edición en el capítulo y pulsas la tecla escape o en botón cerrar se te preguntará si quieres guardar el capítulo antes de cerrar o de lo contrario quieres cerrar sin guardar o continuar con la edición.
6. Listo! ahora tienes un espacio para escribir tus notas de una manera ordenada, fácil y eficiente.

Explicación de la interfaz

La lista de diarios

En primer lugar, te encontrarás con la lista de vista de árbol que te permite navegar por tus diarios y capítulos muy fácilmente, en el nivel 0 siempre estarán los diarios, con las flechas arriba y abajo te mueves por los diarios o capítulos, con la tecla enter o las teclas izquierda o derecha expandes o contraes el diario para ver sus capítulos; o también puedes navegar con las teclas de las letras de laa hasta la z.

El botón de más opciones

Cuando pulses este botón de menú o te ubiques en el, y pulses la flecha abajo aparecerán las siguientes opciones:

• Nuevo diario: Crea un nuevo diario en la lista de diarios.
• Nuevo capítulo: Crea un nuevo capítulo en el diario seleccionado.
• Importar diarios: Restaura diarios desde un archivo .ndn que contiene todos los diarios junto con sus capítulos correspondientes a tu árbol de diarios.
• Exportar diarios: Guarda todos tus diarios y capítulos en un archivo ndn para tenerlo siempre disponible como una copia de seguridad o para compartirlo con otra persona y así intercambiar notas.
• Y finalmente, en el sup menú de Ayuda encuentras los siguientes elementos: Acerca de. Muestra un diálogo con la información básica de este complemento. Documentación: Muestra este archivo en el navegador predeterminado.

Cuadro de información de solo lectura

Después de la lista de diarios te encontrarás con un cuadro de edición de solo lectura que contendrá la información básica del diario o capítulo seleccionado.

Por ejemplo en los diarios te dirá el nombre del diario, la fecha de creación, la fecha de modificación y los números de capítulos que contiene el diario. En los capítulos te dirá el nombre del capítulo seleccionado, el diario que pertenece el capítulo, fecha de creación, fecha de modificación y número de páginas del capítulo.

El botón de cerrar

Simplemente cierra la ventana del complemento o alternativamente puedes cerrarla con la tecla escape.

Lista de atajos de teclado

Esta es la lista de atajos disponibles para el complemento:

• Ctrl+N: Crea un nuevo diario.
• Ctrl+P: Crea un nuevo capítulo en el diario seleccionado.
• Suprimir: Elimina un diario con todos sus capítulos o un capítulo independiente de algún diario.
• Enter: Abrir y cerrar un diario y en los capítulos, abre la ventana de edición de ese capítulo.
• F5: Actualiza la ventana.
• F2: Renombra el diario o capítulo seleccionado.
• F1 abre este documento.
• tecla de aplicaciones o shift + F10 abre un menú contextual para el diario o el capítulo seleccionado.

Otros atajos útiles en la ventana de diarios:

• Alt+M: Abre el menú.
• Alt+D: Enfoca la lista de diarios
• Alt+i: enfoca el cuadro de edición de información.
• Alt+C: Cierra la ventana del complemento.

Atajos útiles dentro de la ventana de edición de un capítulo:

• Alt+N: Se enfoca en el campo de edición.
• Alt+P: Copia todo el contenido del capítulo al portapapeles.
• Alt+G: guarda el capítulo.
• Alt+C: cierra el diálogo del capítulo.

Algunas notas más sobre Note diary

En las opciones de NVDA podrás encontrar el item de Note diary para los ajustes, en en estos momentos el único disponible es el de activar o desactivar los sonidos dentro del complemento. Cuando está activada esta opción, se reproducirá en algunos eventos del complemento sonidos, como cuando pasas de diario o de capítulo.

Descarga este complemento

Para descargar directamente el complemento puedes dar click en el siguiente enlace: Descargar última versión de Note diary

Colaboradores

Programadores

créditos a los siguientes usuarios por colaborar con parte del código fuente y con algunas funcionalidades del mismo: funcionalidades del mismo:

• Héctor J. Benítez Corredera: Implementó la parte inicial de este complemento.
• metalalchemist: Implementación de algunas de las funcionalidades del complemento.

© 2023 Johan A G

note-diary's Issues

Bug: using an invalid character in a chapter title fails to create chapter, but user is not warned (Error: el uso de un carácter no válido en el título de un capítulo no permite crear el capítulo, pero no se advierte al usuario)

(English below)
Intentando crear un nombre de capítulo como:

Qué hacer si sucede lo 1/2

Vuelve a la ventana del diario abierto como si lo hubiera logrado, pero no se crea ningún capítulo nuevo.
En las versiones de prueba de NVDA, se reproduce un sonido de error.
Hay un error de archivo no encontrado en el registro de NVDA.

Creo que en los casos en que se utilizan caracteres no válidos, un cuadro de diálogo debería advertir al usuario y el título del capítulo ingresado (no válido) debería mostrarse nuevamente para su posterior edición.

Diario de notas para NVDA 2024.1.0

---

Attempting to create a chapter name such as:

What to do if thing 1/thing 2 is happening

Returns to the open diary window as if it succeeded, but no new chapter is created.
In test versions of NVDA, an error sound plays.
There is a file not found error in the NVDA log.

I think in cases where invalid characters are used, a dialog should warn the user, and the entered (invalid) chapter title should be shown again for further editing.

Note Diary for NVDA 2024.1.0

Better explanation of export files, consider adding Markdown export (Mejor explicación de los archivos de exportación, considere agregar exportación de rebajas)

(English below)
En la documentación, los archivos de exportación .ndn y cómo usarlos fuera del complemento no se explican realmente hasta donde pude encontrar. Esto puede llevar a la gente a pensar que si el complemento deja de mantenerse y se vuelve incompatible con NVDA, sus datos pueden perderse.

La documentación podría explicar que estos son solo archivos zip que contienen representaciones de archivos de texto organizados del contenido del diario.

Otra cosa en la que pensé cuando comencé a usar el complemento es que sería bueno si permitiera exportar en formato Markdown.

Es decir: un diario por archivo .md, con el nombre del diario en el nivel de encabezado 1 y los capítulos separados como entradas de nivel de encabezado 2.

Esto facilitaría la lectura de un diario completo en el Bloc de notas o similar y su manejo en otras formas sin dificultad.

---

In the documentation, the export .ndn files and how to use them outside the add-on, are not really explained as far as I could find. This may lead people to think that if the add-on stops being maintained, and it becomes incompatible with NVDA, their data may be lost.

The documentation could explain that these are just zip files containing organized text file representations of the diary content.

Another thing I thought of when starting to use the add-on, is that it would be nice if it allowed exporting in Markdown form.

That is: one diary per .md file, with the diary name at heading level 1, and the chapters separated as heading level 2 entries.

This would make it easy to read a whole diary into Notepad or similar, and handle it in other forms without difficulty.

Maybe bug: Can't add chapter while a chapter is selected (Quizás error: no se puede agregar un capítulo mientras hay un capítulo seleccionado)

(English below)

Una vez que se selecciona un diario, al avanzar por los capítulos, pensé que debería ser posible agregar un nuevo capítulo presionando Control+P. Sin embargo, dice que no se ha seleccionado ningún diario. Pero, por supuesto, se selecciona un diario, ya que estoy usando las flechas para moverme por los capítulos del diario abierto.

Creo que al tener la selección dentro de un diario expandido, incluso si la selección no está en el nombre del diario, el comando "nuevo capítulo" debería funcionar. Lo mismo debería hacer cualquier otro capítulo.

Versión del diario de notas: 2024.1.0

---

Once a diary is selected, when moving through the chapters, I thought it should be possible to add a new chapter by pressing Control+P. However, it says that no diary is selected. But of course a diary is selected, since I am using the arrows to move through the open diary's chapters.

I think that having the selection within an expanded diary, even if the selection is not on the diary name, the "new chapter" command should work. So should any other chapter command.

Note Diary version: 2024.1.0

Feature: buttons to move chapter up or down (Característica: botones para mover el capítulo hacia arriba o hacia abajo)

(Machine translation; English text appears below)

Gracias por este útil complemento. Satisface algunas de mis necesidades, pero tengo algunas solicitudes de funciones. Uno es este:

¿Puede agregar botones al menú de capítulos que muevan el capítulo actualmente seleccionado hacia arriba o hacia abajo en la lista?

Uno de mis usos es mantener notas de soporte técnico.
Por ejemplo, tengo un diario de "Soporte de Windows".
En él, tengo capítulos para varias tareas rápidas que podría necesitar realizar para un cliente.
Sin embargo, puedo agregarlos en cualquier orden, según los pienso o los aprendo.
El hecho de que un capítulo se haya agregado primero no significa que deba aparecer primero en el futuro.

Naturalmente, también me gustaría utilizar teclas de método abreviado para esto.

Gracias por su consideración.

---

Thank you for this useful add-on. It fills some of my needs, but I have a few feature requests. One is this:

Can you please add buttons to the chapter menu, that will move the currently selected chapter up or down in the list?

One of my uses is to keep technical support notes.
For example I have a "Windows Support" diary.
In it, I have chapters for various quick tasks I might need to perform for a customer.
However, I can add those in any order, as I think of them or learn them.
Just because a chapter was added first, does not mean it should appear first in the future.

Naturally, I would also like shortcut keys for this.

Thank you for your consideration.