Help for ODF edition

[eturpault]

Hello,
For whom it may interest, I share with you xml files that I made for Notepad++ editor to facilitate the edition of ODF (.organ) files :

• one which permits to highlight key words to make it more readable (file Notepad++ Language ODF.xml)
• one to have in the functions list of Notepad++ the list of the elements of the ODF to navigate more easily inside the file (file Notepad++ Functions ODF.xml)

ZIP file containing those two xml files : Notepad++ xml for ODF.zip

Here is an example of what it looks like ;

To add the language file to Notepad++, go in the menu "Language", then select "Define your language..." at the bottom of the menu list. Inside the opened window, click on the button "Import..." and select the attached file "Notepad++ Language ODF.xml". An entry "ODF" has normally appeared in the top left dropdown list "User language". By selecting it you can see the properties of the xml file.
You can close the window a open an .orgal file to see the effect of the coloration.

To add the functions list file to Notepad++, copy the attached file "Notepad++ Functions ODF.xml" in your folder %APPDATA%\Notepad++\functionList, and rename it in "odf.xml". Restart Notepadd++ if it is already opened.
Enjoy it !

[jason-barba]

To add the functions list file to Notepad++, copy the attached file "Notepad++ Functions ODF.xml" in your folder
%APPDATA%\Roaming\Notepad++\functionList, and rename it in "odf.xml". Restart Notepadd++ if it is already opened. Enjoy it !

This description is somewhat unclear to me. There is no %APPDATA%\Roaming\Notepad++\functionList directory on my disk, but there is a file functionList.xml. Should I include the content of Notepad++ Functions ODF.xml into functionList.xml? But if so, why rename the file?

[eturpault]

Solution found for who still doesn't arrive to have the ODF function list feature working in Notepad++ : in the folder \Notepad++\functionList (where it is necessary to add the odf.xml file provided before) there is a file named overrideMap.xml. Inside this file it is necessary to add the following line (other user language definition lines should be already present) at the end of the file, in the section User Defined Languages :

association id= "odf.xml" userDefinedLangName="ODF"

The language ODF has to have been added as described in a previous comment.

[jason-barba]

Have to re-open this thread.
Imported the language .xml file ok.
Copied the function .xml file to functionList folder and added the association clause to overideMap.xml.

		<!-- ==================== User Defined Languages ============================ -->
		<association id= "krl.xml"				userDefinedLangName="KRL"/>
		<association id= "sinumerik.xml"		userDefinedLangName="Sinumerik"/>
		<association id= "universe_basic.xml"	userDefinedLangName="UniVerse BASIC"/>
		<association id= "odf.xml"				userDefinedLangName="ODF"/>
		<!-- ======================================================================== 

Restarted Notepad++.
But, the Function List is empty :-(
Please, advice me.

[eturpault]

I repeated again on my computer (with a fresh new installed Notepad++) the installation procedure (import .xml language file in Notepad++, copied funtion .xml file in the functionList folder, added its reference in the overideMap.xml file), I do have the sections names visible in the function list of Notepad++.
Maybe you have two Notepad++ installation folders on your computer, for example (if you are in Windows) one in C:\Users\MyName\AppData\Roaming\Notepad++ and one in C:\Program Files\Notepad++, and you edited overideMap.xml in the folder which is not used by Notepad++, and you placed the function .xml in a functionList folder which is not used by Notepad++.

Else you can use OdfEdit which is more convenient than Notepad++ to edit an ODF.

[jason-barba]

You were right!
My Notepad++ had its installation folder also in C:\Users\MyName\AppData\Roaming\Notepad++. So, I created a functionList sub- folder in that folder (there was none before) and copied the function .xml to it and renamed it. And success!

Thanks for kind help.

BTW I tried to install OdfExit on an Ubuntu 22.04 LTS host. After installing pillow etc I stopped at installing PortAudio. I couldn't find a reasonable installation guide for that :-(

[eturpault]

About PortAudio installation issue in Linux, here is a solution which worked for another user : GrandOrgue/OdfEdit#42

Note : it is OdfEdit, not OdfExit (funny typo) 😉

[Jean-Gabriel1982]

Wahou !
Thank you very much @eturpault for this !

Is that work on Linux ?

Is there a way to make an explanation of the structure of the ODF file ?
I try to create an ODF file but I don't understand at all the structure, the requested options etc ...

[eturpault]

Here are the files to obtain this additional panel with the Friesach sample set of Piotr Grabowski : MonFriesach.zip
The file "MonFriesach.organ" and the folder "Data - Friesach" have to be put in the folder where is located the original file Friesach.organ.
It is designed for a screen having a 720p vertical resolution.
We can have a call so that I explain you how I did it (I will contact you by LinkedIn).

[Psi58]

@eterpault thanks for your contributions - I'm using the Notepad++ extensions and also ODFEdit which are both very helpful for a newbie. You mention "the Excel macros that I provided in this discussion.." - but I can't find them, could you provide a link?
For my first "project" I'm trying to add extra panels to an existing sampleset, and it sounds like these could be useful.

[eturpault]

The Excel macros were the embryo of what OdfEdit is now, it is better that you use OdfEdit which has very much more features.
For adding sections in an ODF, OdfEdit has a "Add" button for that, permitting to link automatically the added section to its parent section.
If you want to use Excel all the same, here is the file :
GrandOrgue ODF Excel editor.zip

[larspalo]

@Psi58 And a GUI editor for GrandOrgue odfs that allow creating additional panels and much more can be found at https://github.com/larspalo/GOODF if you want to avoid digging in the text code.

[Psi58]

Thank you - this looks very promising for enthusiasts who are not programmers (ie people like me...) 😉

[eturpault]

Hello,
For who is interrested, here is an application (that I called ODFedit) which permits to edit an ODF in plain text, with navigation among the objects sections by list or tree, and with an integrated help and syntax / data check.
I implemented it in Python, so it can run on Windows, Linux, Mac.
If you test it, please inform me in this messages thread if you see bugs or errors, and if you have suggestions of improvement.
Here is a screenshot of the application:

It is available in the zip with the source code (Python3 script) and the executable files for Windows and Linux.

[eturpault]

Update with the version v1.3.
Change log :

• data management improvement,
• change in the way to define the parent-child relations between the objects,
• completed some attributes values maximum check,
• added a tab to search a string in the whole ODF

ODFedit_v1.3.zip

@oleg68 : would you agree that in the files repository of GO a folder "Tools" is added, and inside it a folder "ODFedit" in which I could put the last version of my tool ? This would give it more visibility and may help some people who want to edit their ODF in plain-text and check its content vs the ODF format specification.

[oleg68]

@eturpault I don't object to include ODFEdit to the GrandOrgue distribution, but it needs to work more

1. To solve the dependenciy problems. For now it can not be easy run under linux:

[oleg@oleg2 Linux]$ ./ODFedit 
[683436] Error loading Python lib '/tmp/_MEIC69m7r/libpython3.10.so.1.0': dlopen: /lib64/libm.so.6: version `GLIBC_2.35' not found (required by /tmp/_MEIC69m7r/libpython3.10.so.1.0)

2. To make building from the source, including adding OdfEdit as a git submodule to the GrandOrgue source code
3. To rename ODFedit to OdfEdit according to the naming conventions of GrandOrgue

[rousseldenis]

Hi @rousseldenis, Thanks for the creation of this repo. I think that @oleg68 would prefer that you name it OdfEdit instead of ODFEdit as he wrote in this discussion on May 22nd.

Indeed, but I think he refers more to the tool name itself than repo name(we have GrandOrgue in grandorgue repo).

So, as communication was already made on that, let's go like this and name our tool OdfEdit.

[eturpault]

I have populated the repo GrandOrgue/ODFEdit with my files.
@rousseldenis : is it possible to enable the Discussions feature for this repo ? It could be used if somebody wants to suggest/discuss evolutions of the tool.
@oleg68 : could you please change the link in the WiKi FAQ to this new repo ? I will then delete my repo eturpault/OdfEdit. Thank you.

[rousseldenis]

@eturpault Thanks for this.

The idea was to create a Pull request in order to review your code.

We we'll keep it as is, but for next changes, it's better to use that flow.

I can enable Discussions. For features/bug requests, creating issues is better.

[eturpault]

Sorry I am new in Git, I will do pull request on next times.
If issues is better for features requests as well, so no need to enable Discussions.

[oleg68]

could you please change the link in the WiKi FAQ to this new repo ? I will then delete my repo eturpault/OdfEdit. Thank you.

Done.