Skip to content

Commit

Permalink
README*.md update
Browse files Browse the repository at this point in the history
  • Loading branch information
@prrvchr
prrvchr committed Nov 16, 2023
1 parent 4eaf585 commit 7c6604c
Show file tree
Hide file tree
Showing 2 changed files with 157 additions and 157 deletions.
158 changes: 79 additions & 79 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,23 +23,23 @@
║ ║
╚════════════════════════════════════════════════════════════════════════════════════╝
-->
# [![vCardOOo logo][0]][-1] Documentation
# [![vCardOOo logo][1]][2] Documentation

**Ce [document][1] en français.**
**Ce [document][3] en français.**

**The use of this software subjects you to our [Terms Of Use][2] and [Data Protection Policy][3].**
**The use of this software subjects you to our [Terms Of Use][4] and [Data Protection Policy][5].**

# version [1.0.3][4]
# version [1.0.3][6]

## Introduction:

**vCardOOo** is part of a [Suite][5] of [LibreOffice][6] ~~and/or [OpenOffice][7]~~ extensions allowing to offer you innovative services in these office suites.
**vCardOOo** is part of a [Suite][7] of [LibreOffice][8] ~~and/or [OpenOffice][9]~~ extensions allowing to offer you innovative services in these office suites.
This extension gives you access, in LibreOffice, to your contacts present on a CardDAV server (or vCard Extensions to WebDAV).

Being free software I encourage you:
- To duplicate its [source code][8].
- To duplicate its [source code][10].
- To make changes, corrections, improvements.
- To open [issue][9] if needed.
- To open [issue][11] if needed.

In short, to participate in the development of this extension.
Because it is together that we can make Free Software smarter.
Expand All @@ -52,15 +52,15 @@ In order to take advantage of the latest versions of the Python libraries used i
This means that **vCardOOo no longer supports OpenOffice and LibreOffice 6.x on Windows since version 1.0.0**.
I can only advise you **to migrate to LibreOffice 7.x**.

vCardOOo uses a local [HsqlDB][10] database version 2.7.2.
HsqlDB being a database written in Java, its use requires the [installation and configuration][11] in LibreOffice / OpenOffice of a **JRE version 11 or later**.
I recommend [Adoptium][12] as your Java installation source.
vCardOOo uses a local [HsqlDB][12] database version 2.7.2.
HsqlDB being a database written in Java, its use requires the [installation and configuration][13] in LibreOffice / OpenOffice of a **JRE version 11 or later**.
I recommend [Adoptium][14] as your Java installation source.

If you are using **LibreOffice Community on Linux**, you are subject to [bug 139538][13]. To work around the problem, please **uninstall the packages** with commands:
If you are using **LibreOffice Community on Linux**, you are subject to [bug 139538][15]. To work around the problem, please **uninstall the packages** with commands:
- `sudo apt remove libreoffice-sdbc-hsqldb` (to uninstall the libreoffice-sdbc-hsqldb package)
- `sudo apt remove libhsqldb1.8.0-java` (to uninstall the libhsqldb1.8.0-java package)

If you still want to use the Embedded HsqlDB functionality provided by LibreOffice, then install the [HyperSQLOOo][14] extension.
If you still want to use the Embedded HsqlDB functionality provided by LibreOffice, then install the [HyperSQLOOo][16] extension.

___

Expand All @@ -69,15 +69,15 @@ ___
It seems important that the file was not renamed when it was downloaded.
If necessary, rename it before installing it.

- [![OAuth2OOo logo][15]][16] Install **[OAuth2OOo.oxt][17]** extension [![Version][18]][17]
- [![OAuth2OOo logo][17]][18] Install **[OAuth2OOo.oxt][19]** extension [![Version][20]][19]

You must install this extension, if it is not already installed.

- [![jdbcDriverOOo logo][19]][20] Install **[jdbcDriverOOo.oxt][21]** extension [![Version][22]][21]
- [![jdbcDriverOOo logo][21]][22] Install **[jdbcDriverOOo.oxt][23]** extension [![Version][24]][23]

You must install this extension, if it is not already installed.

- ![vCardOOo logo][23] Install **[vCardOOo.oxt][24]** extension [![Version][25]][24]
- ![vCardOOo logo][25] Install **[vCardOOo.oxt][26]** extension [![Version][27]][26]

Restart LibreOffice / OpenOffice after installation.

Expand All @@ -87,20 +87,20 @@ ___

In LibreOffice / OpenOffice go to: **File -> Wizards -> Address Data Source...**

![vCardOOo screenshot 1][26]
![vCardOOo screenshot 1][28]

The **Address Book Datasource Wizard** open.

In step: **1.Address Book Type**:
- Select: **Other external data source**.
- Click button: **Next**.

![vCardOOo screenshot 2][27]
![vCardOOo screenshot 2][29]

In step: **2.Connection Settings**:
- Click button: **Settings**.

![vCardOOo screenshot 3][28]
![vCardOOo screenshot 3][30]

A new wizard opens. **Data source properties**.

Expand All @@ -109,7 +109,7 @@ In Database type list:
- Select: **vCard Contacts**.
- click button: **Next**.

![vCardOOo screenshot 4][29]
![vCardOOo screenshot 4][31]

In step: **2.Connection Settings**.
In General: Enter the DBMS/driver-specific connection string here.
Expand All @@ -122,20 +122,20 @@ In User Authentication: User name:
Then:
- Click button: **Test connection**.

![vCardOOo screenshot 5][30]
![vCardOOo screenshot 5][32]

In Authentication required: Password:
- Put your password.

![vCardOOo screenshot 6][31]
![vCardOOo screenshot 6][33]

Normally you should see: Connection Test: The connection was established successfully.

![vCardOOo screenshot 7][32]
![vCardOOo screenshot 7][34]

If the connection has been established, you can complete this wizard with the **Finish** button.

![vCardOOo screenshot 8][33]
![vCardOOo screenshot 8][35]

In step: **3.Table Selection**.
If your data source has multiple tables, you will be asked to select the primary table.
Expand All @@ -145,7 +145,7 @@ In step: **4.Field Assignment**.
If necessary it is possible to rename the names of the columns of the data source using the button: **Field Assignment**.
Please continue this wizard with the button: **Next**.

![vCardOOo screenshot 9][34]
![vCardOOo screenshot 9][36]

In step: **5.Data Source Title**.

Expand All @@ -157,7 +157,7 @@ This odb file must also be made accessible. To do this you must:
- **Check the box**: Make this address book available to all modules in LibreOffice
- Named the address book in the field: **Address book name**.

![vCardOOo screenshot 10][35]
![vCardOOo screenshot 10][37]

Have fun...

Expand All @@ -171,10 +171,10 @@ ___

* LibreOffice 7.4.3.2(x64) - Windows 10(x64) - Python version 3.8.15 - Adoptium JDK Hotspot 11.0.17 (x64) (under Lubuntu 22.04 / VirtualBox 6.1.38)

* **Does not work with OpenOffice on Windows** see [bug 128569][36]. Having no solution, I encourage you to install **LibreOffice**.
* **Does not work with OpenOffice on Windows** see [bug 128569][38]. Having no solution, I encourage you to install **LibreOffice**.

I encourage you in case of problem :confused:
to create an [issue][9]
to create an [issue][11]
I will try to solve it :smile:

___
Expand All @@ -185,24 +185,24 @@ ___

This extension was written in order to make usable in free software (LibreOffice or OpenOffice) your personal data (your vCard) stored on a Nextcloud server.

With the [eMailerOOo][37] extension, it can be the data source for [mail merge][38] by email, to your correspondents (your vCard) coming from the Nextcloud server.
With the [eMailerOOo][39] extension, it can be the data source for [mail merge][40] by email, to your correspondents (your vCard) coming from the Nextcloud server.

It will give you access to an information system that only larges companies are able, today, to implement.

### What has been done for version 0.0.1:

- Writing of the UNO service [com.sun.star.sdbc.Driver][39] responding to the call from the url `sdbc:address:vcard:*`
The `connect(url, info)` method of this Driver use the [DataSource][40] singleton to return the UNO service `com.sun.star.sdbc.Connection`.
- Writing of the UNO service [com.sun.star.sdbc.Driver][41] responding to the call from the url `sdbc:address:vcard:*`
The `connect(url, info)` method of this Driver use the [DataSource][42] singleton to return the UNO service `com.sun.star.sdbc.Connection`.

- This DataSource singleton is responsible for:

- When created, create a [Replicator][41] thread to track remote changes on Nextcloud servers.
- Create and cache a [User][42] Interface needed for:
- When created, create a [Replicator][43] thread to track remote changes on Nextcloud servers.
- Create and cache a [User][44] Interface needed for:
- Creating the connection to the underlying database.
- Connect the Replicator to Nextcloud servers.
- Start the Replicator each time you connect to the database.

- After retrieving the remote modifications, the Replicator uses to analyze the content of the vCards a UNO `com.sun.star.task.Job` service [CardSync][43] written in Java and using the [ez-vcard][44] library.
- After retrieving the remote modifications, the Replicator uses to analyze the content of the vCards a UNO `com.sun.star.task.Job` service [CardSync][45] written in Java and using the [ez-vcard][46] library.

### What has been done for version 1.0.1:

Expand All @@ -226,49 +226,49 @@ It will give you access to an information system that only larges companies are

- Anything welcome...

[0]: </img/contact.svg#collapse>
[-1]: <https://prrvchr.github.io/vCardOOo/>
[1]: <https://prrvchr.github.io/vCardOOo/README_fr>
[2]: <https://prrvchr.github.io/vCardOOo/source/vCardOOo/registration/TermsOfUse_en>
[3]: <https://prrvchr.github.io/vCardOOo/source/vCardOOo/registration/PrivacyPolicy_en>
[4]: <https://prrvchr.github.io/vCardOOo#historical>
[5]: <https://prrvchr.github.io/>
[6]: <https://www.libreoffice.org/download/download/>
[7]: <https://www.openoffice.org/download/index.html>
[8]: <https://github.com/prrvchr/vCardOOo>
[9]: <https://github.com/prrvchr/vCardOOo/issues/new>
[10]: <http://hsqldb.org/>
[11]: <https://wiki.documentfoundation.org/Documentation/HowTo/Install_the_correct_JRE_-_LibreOffice_on_Windows_10>
[12]: <https://adoptium.net/releases.html?variant=openjdk11>
[13]: <https://bugs.documentfoundation.org/show_bug.cgi?id=139538>
[14]: <https://prrvchr.github.io/HyperSQLOOo/>
[15]: <https://prrvchr.github.io/OAuth2OOo/img/OAuth2OOo.svg#middle>
[16]: <https://prrvchr.github.io/OAuth2OOo/>
[17]: <https://github.com/prrvchr/OAuth2OOo/releases/latest/download/OAuth2OOo.oxt>
[18]: <https://img.shields.io/github/v/tag/prrvchr/OAuth2OOo?label=latest#right>
[19]: <https://prrvchr.github.io/jdbcDriverOOo/img/jdbcDriverOOo.svg#middle>
[20]: <https://prrvchr.github.io/jdbcDriverOOo/>
[21]: <https://github.com/prrvchr/jdbcDriverOOo/releases/latest/download/jdbcDriverOOo.oxt>
[22]: <https://img.shields.io/github/v/tag/prrvchr/jdbcDriverOOo?label=latest#right>
[23]: <img/vCardOOo.svg#middle>
[24]: <https://github.com/prrvchr/vCardOOo/releases/latest/download/vCardOOo.oxt>
[25]: <https://img.shields.io/github/downloads/prrvchr/vCardOOo/latest/total?label=v1.0.3#right>
[26]: <img/vCardOOo-1.png>
[27]: <img/vCardOOo-2.png>
[28]: <img/vCardOOo-3.png>
[29]: <img/vCardOOo-4.png>
[30]: <img/vCardOOo-5.png>
[31]: <img/vCardOOo-6.png>
[32]: <img/vCardOOo-7.png>
[33]: <img/vCardOOo-8.png>
[34]: <img/vCardOOo-9.png>
[35]: <img/vCardOOo-10.png>
[36]: <https://bz.apache.org/ooo/show_bug.cgi?id=128569>
[37]: <https://prrvchr.github.io/eMailerOOo/>
[38]: <https://en.wikipedia.org/wiki/Mail_merge>
[39]: <https://github.com/prrvchr/vCardOOo/blob/main/source/vCardOOo/service/Driver.py>
[40]: <https://github.com/prrvchr/vCardOOo/blob/main/uno/lib/uno/card/card/datasource.py>
[41]: <https://github.com/prrvchr/vCardOOo/blob/main/uno/lib/uno/card/card/replicator.py>
[42]: <https://github.com/prrvchr/vCardOOo/blob/main/uno/lib/uno/card/card/user.py>
[43]: <https://github.com/prrvchr/vCardOOo/blob/main/source/vCardOOo/source/io/github/prrvchr/carddav/CardSync.java>
[44]: <https://github.com/mangstadt/ez-vcard>
[1]: </img/contact.svg#collapse>
[2]: <https://prrvchr.github.io/vCardOOo/>
[3]: <https://prrvchr.github.io/vCardOOo/README_fr>
[4]: <https://prrvchr.github.io/vCardOOo/source/vCardOOo/registration/TermsOfUse_en>
[5]: <https://prrvchr.github.io/vCardOOo/source/vCardOOo/registration/PrivacyPolicy_en>
[6]: <https://prrvchr.github.io/vCardOOo#historical>
[7]: <https://prrvchr.github.io/>
[8]: <https://www.libreoffice.org/download/download/>
[9]: <https://www.openoffice.org/download/index.html>
[10]: <https://github.com/prrvchr/vCardOOo>
[11]: <https://github.com/prrvchr/vCardOOo/issues/new>
[12]: <http://hsqldb.org/>
[13]: <https://wiki.documentfoundation.org/Documentation/HowTo/Install_the_correct_JRE_-_LibreOffice_on_Windows_10>
[14]: <https://adoptium.net/releases.html?variant=openjdk11>
[15]: <https://bugs.documentfoundation.org/show_bug.cgi?id=139538>
[16]: <https://prrvchr.github.io/HyperSQLOOo/>
[17]: <https://prrvchr.github.io/OAuth2OOo/img/OAuth2OOo.svg#middle>
[18]: <https://prrvchr.github.io/OAuth2OOo/>
[19]: <https://github.com/prrvchr/OAuth2OOo/releases/latest/download/OAuth2OOo.oxt>
[20]: <https://img.shields.io/github/v/tag/prrvchr/OAuth2OOo?label=latest#right>
[21]: <https://prrvchr.github.io/jdbcDriverOOo/img/jdbcDriverOOo.svg#middle>
[22]: <https://prrvchr.github.io/jdbcDriverOOo/>
[23]: <https://github.com/prrvchr/jdbcDriverOOo/releases/latest/download/jdbcDriverOOo.oxt>
[24]: <https://img.shields.io/github/v/tag/prrvchr/jdbcDriverOOo?label=latest#right>
[25]: <img/vCardOOo.svg#middle>
[26]: <https://github.com/prrvchr/vCardOOo/releases/latest/download/vCardOOo.oxt>
[27]: <https://img.shields.io/github/downloads/prrvchr/vCardOOo/latest/total?label=v1.0.3#right>
[28]: <img/vCardOOo-1.png>
[29]: <img/vCardOOo-2.png>
[30]: <img/vCardOOo-3.png>
[31]: <img/vCardOOo-4.png>
[32]: <img/vCardOOo-5.png>
[33]: <img/vCardOOo-6.png>
[34]: <img/vCardOOo-7.png>
[35]: <img/vCardOOo-8.png>
[36]: <img/vCardOOo-9.png>
[37]: <img/vCardOOo-10.png>
[38]: <https://bz.apache.org/ooo/show_bug.cgi?id=128569>
[39]: <https://prrvchr.github.io/eMailerOOo/>
[40]: <https://en.wikipedia.org/wiki/Mail_merge>
[41]: <https://github.com/prrvchr/vCardOOo/blob/main/source/vCardOOo/service/Driver.py>
[42]: <https://github.com/prrvchr/vCardOOo/blob/main/uno/lib/uno/card/card/datasource.py>
[43]: <https://github.com/prrvchr/vCardOOo/blob/main/uno/lib/uno/card/card/replicator.py>
[44]: <https://github.com/prrvchr/vCardOOo/blob/main/uno/lib/uno/card/card/user.py>
[45]: <https://github.com/prrvchr/vCardOOo/blob/main/source/vCardOOo/source/io/github/prrvchr/carddav/CardSync.java>
[46]: <https://github.com/mangstadt/ez-vcard>
Loading

0 comments on commit 7c6604c

Please sign in to comment.