1592043 - Remove toolbox.dtd and migrate strings to ftl for toolbox-options.xhtml

Status: RESOLVED FIXED

(DevTools :: Framework, task, P2)

Description

[Brian Grinstead [:bgrins]]

https://searchfox.org/mozilla-central/search?q=toolbox.dtd&path=

A few notes:

• It's loaded in devtools/client/framework/toolbox.xul but that file appears to use no entities (it also loads globalKeys.dtd). I think the following lines can just be removed: https://searchfox.org/mozilla-central/rev/11d9c7b7fa82fdfb8ac2a8f0864e9d8d5fe2b926/devtools/client/framework/toolbox.xul#10-15.
• So that leaves toolbox-options.xhtml - it's possible some of the entities in toolbox.dtd are unused (although a first pass in Bug 1580981 should have caught this).
• Zibi has a script to help automate this in https://github.com/zbraniecki/convert_xul_to_fluent. There aren't many docs yet, but he can help get started if someone gives this a shot.

Comment 2

[Alexandre Poirot [:ochameau]]

(In reply to Brian Grinstead [:bgrins] from comment #0)

• Zibi has a script to help automate this in https://github.com/zbraniecki/convert_xul_to_fluent. There aren't many docs yet, but he can help get started if someone gives this a shot.

Zibi mentioned this command line on Slack:
python3 convert.py --mc ~/projects/mozilla-unified/ --dom ./devtools/client/framework/toolbox-options.xhtml --dtd devtools/client/locales/en-US/toolbox.dtd --ftl devtools/client/locales/en-US/toolbox.ftl
(you'll need --bug-id and --description too)

Comment 3

[Brian Grinstead [:bgrins]]

A couple notes from a quick dry run here:

I did git clone https://github.com/zbraniecki/convert_xul_to_fluent.git && cd convert_xul_to_fluent then:

pip3 install fluent.syntax
pip3 install six

Then to run it:

touch ~/Code/mozilla-central/devtools/client/locales/en-US/toolbox.ftl && python3 convert.py --bug_id 1592043 --description "Migrate toolbox options strings from DTD to FTL" --mc ~/Code/mozilla-central --dom ./devtools/client/framework/toolbox-options.xhtml --dtd devtools/client/locales/en-US/toolbox.dtd --ftl devtools/client/locales/en-US/toolbox.ftl

This line's formatting messes up the scripts detection so it gets skipped: https://searchfox.org/mozilla-central/rev/4537228c0a18bc0ebba2eb7f5cbebb6ea9ab211c/devtools/client/framework/toolbox-options.xhtml#23. Probably easiest to first rewrite this to one line before starting.

After this, will need to:

• manually move or remove the LOCALIZATION NOTE comments from devtools/client/locales/en-US/toolbox.dtd into the ftl file
• remove the reference to toolbox.dtd in toolbox-options.xhtml
• add the link to toolbox-options.ftl (may require registering the directory if this is the first ftl file in devtools).

Comment 4

[Brian Grinstead [:bgrins]]

I got far enough along testing this that I'll send up some patches.

Comment 5

[Brian Grinstead [:bgrins]]

Attachment: Bug 1592043 - Part 1 - Reformat toolbox-options.xhtml to support the fluent converter tool

Comment 6

[Brian Grinstead [:bgrins]]

Attachment: Bug 1592043 - Part 2 - Introduce a toolbox-options.ftl file and reference it from toolbox-options.xhtml

Depends on D59000

Comment 7

[Brian Grinstead [:bgrins]]

Attachment: Bug 1592043 - Part 3 - Automated ftl conversion for toolbox.dtd strings in toolbox-options.xhtml

Generated with https://github.com/zbraniecki/convert_xul_to_fluent and:

python3 convert.py --bug_id 1592043 --description "Migrate toolbox options strings from DTD to FTL" --mc ~/Code/mozilla-central --dom devtools/client/framework/toolbox-options.xhtml --dtd devtools/client/locales/en-US/toolbox.dtd --ftl devtools/client/locales/en-US/toolbox-options.ftl

Depends on D59002

Comment 8

[Brian Grinstead [:bgrins]]

Attachment: Bug 1592043 - Part 4 - Port comments from dtd to ftl, move ftl into sections, and remove reference to the dtd file in toolbox-options.xhtml

Depends on D59003

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c9c0d42603ba
Part 1 - Reformat toolbox-options.xhtml to support the fluent converter tool r=jdescottes
https://hg.mozilla.org/integration/autoland/rev/0570d7ff220f
Part 2 - Introduce a toolbox-options.ftl file and reference it from toolbox-options.xhtml r=fluent-reviewers,jdescottes,flod
https://hg.mozilla.org/integration/autoland/rev/fc1aa6e85939
Part 3 - Automated ftl conversion for toolbox.dtd strings in toolbox-options.xhtml r=fluent-reviewers,jdescottes,flod
https://hg.mozilla.org/integration/autoland/rev/5cbf5bb11c58
Part 4 - Port comments from dtd to ftl, move ftl into sections, and remove reference to the dtd file in toolbox-options.xhtml r=fluent-reviewers,jdescottes,flod

Comment 10

[Andreea Pavel [:apavel]]

https://hg.mozilla.org/mozilla-central/rev/c9c0d42603ba
https://hg.mozilla.org/mozilla-central/rev/0570d7ff220f
https://hg.mozilla.org/mozilla-central/rev/fc1aa6e85939
https://hg.mozilla.org/mozilla-central/rev/5cbf5bb11c58