diff --git a/.gitignore b/.gitignore index 6afcc05..090f9f8 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,3 @@ __pycache__ build/ *.bk *.lock - diff --git a/doc/config.toml b/doc/config.toml index 48c0e6b..56aef8c 100644 --- a/doc/config.toml +++ b/doc/config.toml @@ -1,4 +1,4 @@ -baseURL = 'https://doc.cuates.net' +baseURL = 'https://doc.cuates.net/easymacro' languageCode = 'en-us' title = "EasyMacro's documentation" @@ -31,7 +31,7 @@ defaultContentLanguageInSubdir= true title = "Documentación para EasyMacro" weight = 2 languageName = "Español" - landingPageURL = "/es" + landingPageURL = "/easymacro/es" landingPageName = " Inicio" [Languages.pt] diff --git a/doc/content/es/_index.md b/doc/content/es/_index.md index a400cb1..ddf2d5d 100644 --- a/doc/content/es/_index.md +++ b/doc/content/es/_index.md @@ -1,10 +1,10 @@ -# Bienvenido a la documentación de easymacro! +## Documentación de easymacro! #### Software Libre, no software gratis. **easymacro** es una librería para desarrollar más fácilmente macros en LibreOffice con Python. Es una capa de abstracción entre la extensa y compleja API UNO de LibreOffice y tu código. -Probablemente, será más feliz si la usas :) +Probablemente, será más feliz si la usa :) Puede utilizar **easymacro** con cualquier extensión o directamente en sus macros. diff --git a/doc/content/es/installation/_index.md b/doc/content/es/installation/_index.md index 9387fc9..e918db2 100644 --- a/doc/content/es/installation/_index.md +++ b/doc/content/es/installation/_index.md @@ -11,22 +11,27 @@ Clone el repositorio en su directorio de proyectos favorito. git clone https://git.cuates.net/elmau/easymacro ``` -y copie la librería dentro de la carpeta **pythonpath** en la carpeta de macros Python dentro de su perfil de usuario. Reemplace **USUARIO** por su usuario real. - +Muévase al directorio ``` -/home/`USUARIO`/.config/libreoffice/4/user/Scripts/python/pythonpath/easymacro.py +cd easymacro/source ``` -o use un vínculo duro. Reemplace **RUTA_ABSOLUTA** por la ruta absoluta donde se localice **easymacro.py** en su sistema de archivos y **USUARIO** por su nombre de usuario. +copie la carpeta `easymacro` a la carpeta **pythonpath** en la carpeta de macros Python dentro de su perfil de usuario. Reemplace **USUARIO** por su usuario real. ``` -ln `RUTA_ABSOLUTA`/easymacro/source/easymacro.py /home/`USUARIO`/.config/libreoffice/4/user/Scripts/python/pythonpath/ +/home/`USUARIO`/.config/libreoffice/4/user/Scripts/python/pythonpath +``` + +o use un vínculo simbólico. Reemplace **RUTA_ABSOLUTA** por la ruta absoluta donde se localice **easymacro** en su sistema de archivos y **USUARIO** por su nombre de usuario. + +``` +ln -s `RUTA_ABSOLUTA`/easymacro/source/easymacro /home/`USUARIO`/.config/libreoffice/4/user/Scripts/python/pythonpath/ ``` ## Probar -En su archivo de macros favorito, por ejemplo **mismacros.py**. Usa tu editor de texto plano o IDE favorito. +En su archivo de macros favorito, por ejemplo **mismacros.py**. Use su editor de texto plano o IDE favorito. ``` vim /home/`USUARIO`/.config/libreoffice/4/user/Scripts/python/mismacros.py @@ -46,7 +51,7 @@ Ejecute la macro **main** desde LibreOffice, si ve un cuadro de mensaje con info ![Test instalation](install_01.png) -Esta listo para desarrollar macros con **easymacro.py**. +Esta todo listo para empezar a desarrollar macros con **easymacro**. !Feliz programación! diff --git a/doc/content/es/tools_debug/_index.md b/doc/content/es/tools_debug/_index.md new file mode 100644 index 0000000..54d0c87 --- /dev/null +++ b/doc/content/es/tools_debug/_index.md @@ -0,0 +1,184 @@ ++++ +title = "Herramientas para depurar" +weight = 2 ++++ + +### INFO_DEBUG + +Mostrar información de depuración en un cuadro de mensaje. + +Si tiene cualquier problema en su código durante el desarrollo de sus macros, puede [abrir un ticket][1] de soporte en el sistema de ticket de este proyecto. Siempre copie la información de depuración mostrada en este mensaje. + +```python +import easymacro as app + +def info(): + app.msgbox(app.INFO_DEBUG) + return +``` + +![Info debug](tools_01.png) + + +### debug + +Mostrar información en la terminal. + +```python +import easymacro as app + +def test_debug(): + msg = 'Verificar esta información...' + app.debug(msg) + return +``` + +``` +11/08/2022 18:15:45 - DEBUG - Verificar esta información... +``` + + +### info + +Mostrar mensajes informativos en la terminal. + +```python +import easymacro as app + +def test_info(): + msg = 'Iniciando proceso...' + app.info(msg) + return +``` + +``` +11/08/2022 18:23:53 - INFO - Iniciando proceso... +``` + + +### error + +Mostrar mensajes de error en la terminal. + +```python +import easymacro as app + +def test_error(): + msg = 'Error 505' + app.error(msg) + return +``` + +``` +11/08/2022 18:27:34 - ERROR - Error 505 +``` + + +### save_log + +Guardar registro en un archivo, automáticamente se agrega la fecha y hora. + +```python +import easymacro as app + +def test_save_log(): + + app.save_log('/home/mau/log.txt', 'PyUNO') + app.save_log('/home/mau/log.txt', 'Maldito Mundo') + + return +``` + +``` +cat ~/log.txt +2022-08-11 18:30:11 - 'PyUNO' +2022-08-11 18:30:11 - 'Maldito Mundo' +``` + + +### msgbox + +Mostrar cualquier información en un cuadro de mensaje. + +```python +def message(): + + msg = 'Por favor, consume menos.' + app.msgbox(msg) + + msg = ('uno', 2, 'tres') + app.msgbox(msg) + + msg = {'nombre': 'Teresa'} + app.msgbox(msg) + + app.msgbox(app) + + return +``` + +### catch_exception + +Capturar cualquier error que se produzca al ejecutar una macro. + +```python +@app.catch_exception +def test_capturar_error(): + r = 1 / 0 + return +``` + +``` +11/08/2022 18:44:36 - ERROR - test_capturar_error +Traceback (most recent call last): + File "/home/mau/.config/libreoffice/4/user/Scripts/python/pythonpath/easymacro/easytools.py", line 115, in func + return f(*args, **kwargs) + File "/home/mau/.config/libreoffice/4/user/Scripts/python/test.py", line 18, in test_capturar_error + r = 1 / 0 +ZeroDivisionError: division by zero +``` + +{{% notice warning %}} +Usa este método solo en tiempo de desarrollo. No la uses en producción. +{{% /notice %}} + + +### mri + +[MRI][2] es la mejor extensión para inspeccionar cualquier objeto UNO de LibreOffice. Necesita instalarla primero para poder llamarla. + + +```python +def inspeccionar_objeto(): + obj = app.active + app.mri(obj) + return +``` + +### inspect + +Inspeccionar un objeto. + +```python +def inspeccionar_objeto(): + doc = app.active + data = app.inspect(doc) + for p in data.properties: + app.debug(p) + for m in data.methods: + app.debug(m) + return +``` + +Vaciar en una hoja de calculo. + +```python +def inspeccionar_objeto(): + doc = app.active + app.inspect(doc, True) + return +``` + + +[1]: https://git.cuates.net/elmau/easymacro/issues +[2]: https://github.com/hanya/MRI diff --git a/doc/content/es/tools_debug/tools_01.png b/doc/content/es/tools_debug/tools_01.png new file mode 100644 index 0000000..6395bb4 Binary files /dev/null and b/doc/content/es/tools_debug/tools_01.png differ diff --git a/doc/public/404.html b/doc/public/404.html index cce2e96..e86b9a8 100644 --- a/doc/public/404.html +++ b/doc/public/404.html @@ -4,20 +4,20 @@ - + 404 Page not found - - - - - - - + + + + + + + - + - +