Generator: Which configuration file do we need to use?

[samuel-duhaime]

Discussion

Problems

Currently, the problem is that it's not possible to review an Excel file using GitHub, which makes it difficult to review all the changes using Generator. Additionally, it's challenging to have two people working on the same project with a Generator because the changes are in the cloud. This means that when someone makes a change in Excel, it affects everyone working on the project. We want to find a better solution for this.

Possible solutions

We've discussed two possible configurations: 'csv' and 'yaml'. Each has pros and cons.

YAML

For example, we could use a 'yaml' configuration. This is an example of a widget.

widget: 
    questionName: home_dwellingType
    inputType: Radio
    active: true
    section: home
    path: home.dwellingType
    fr: Dans quel **type d'habitation ou de propriété** vivez-vous ?
    en: In what **type of dwelling or property** do you live?
    choices: dwellingType
    containsHtml: true
    customPath: home.dwellingTypeOther
    customChoice: other

Pros:

• Easy to understand
• Simple to use array values
• Easy to write for non-technical individuals
• No need to write unnecessary keys for the widget

Cons:

• Lacks types
• Quite verbose
• Difficult to change the keys to all the widgets
• Will require more time to make it work with Generator compared to 'csv'
• Challenging to compare one widget to another

CSV

I don't think I need to provide an example. It's something that everyone knows.

Pros:

• Easy to convert Excel to CSV
• Concise
• Simple to update multiple labels simultaneously

Cons:

• Lacks types
• More challenging to work with array or object values
• The widgets may have numerous headers at some point if we want to support complex case with Generator
• More difficult to comprehend with big file
• Likely requires installation of an extension to work with Visual Studio

Other Alternatives

We could consider using other alternatives such as 'JSON' or 'TypeScript'. Perhaps we don't need the configuration files to be uniform for everything. Alternatively, we could simulate some type checking with the generator and raise an error if the widget configuration is not well-written.

Discussion

I believe it's crucial to gather everyone's input before launching the creation of OD_National.

[kaligrafy]

Ods (libre office) with an online editor would be the best

[samuel-duhaime]

Great, @kaligrafy mind sharing the pro and cons?

[kaligrafy]

I see a lot of future potential evolution users that would not be able to use yml/csv or any other text-only file. An online editor is more useful for non-tech people and using a ods file will make it easy to have all the tabs/sections in the same file.

[samuel-duhaime]

@kaligrafy
What about the issues that we can't review and the inability to work on different issues simultaneously? I'm doubtful that an online editor with ODS will fix that. Do we still face the same problems, or am I misunderstanding your proposal?

[kaligrafy]

However this is temporary until we create a full fledge questionnaire editor, so csv or yaml would be fine

[kaligrafy]

There should be online editors that allows multi users editsEnvoyé de mon iPhoneLe 5 juill. 2024 à 09:10, Samuel Duhaime-Morissette ***@***.***> a écrit : @kaligrafy What about the issues we can't review and the inability to work on different issues simultaneously? I'm doubtful that an online editor with ODS will fix that. Do we still face the same problems, or am I misunderstanding your proposal? —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: ***@***.***>

[greenscientist]

Something to consider: XLSForm
https://xlsform.org/en/
https://docs.getodk.org/xlsform/