How to translate MadCap Flare keyword entries in Studio 2017?

Dear community,

I am having trouble translating keyword terms in HTML files created with MadCap Flare.

All I have achieved so far by using the parser settings is having those keywords displayed as uneditable tags, but I need to translate those terms to English.

This is what it looks like in the Studio 2017 editor:

Blurred screenshot of Trados Studio editor showing uneditable tags for keywords within HTML markup.

And in EmEditor:

Blurred screenshot of EmEditor displaying HTML code with keyword terms nested within h1 tags.

I understand that I need to define a rule making <MadCap:keyword term="..." /> editable but I just cannot seem to find the right settings.

Also note that those keywords are nested within further structural markups, <h1> in this specific case.

The file type is HTML 5, so I cannot leverage XPath for this.

Thank you in advance for any input you may have!



Generated Image Alt-Text
[edited by: Trados AI at 5:34 PM (GMT 0) on 28 Feb 2024]
emoji
  • The file type is HTML 5, so I cannot leverage XPath for this.

    That's incorrect. MadCap Flare files are XMLs, not HTMLs.
    The simple fact that they contain custom non-HTML elements defined in the "MadCap" namespace (like the "MadCap:keyword" you mention) makes them XML, not HTML.

    So your filetype should be defined as XML... and then you have the full power of XPath at your hands to define all elements you want.
    For example, I was even able to define differently colored MadCap's tracked changes, similarly as MS Word (red striked-through for deletions, blue for additions)...

  • By the way, sorry for the small screenshots.

    Here we go again with readable ones:

    Screenshot of Trados Studio displaying file paths and keywords for 'Displaying and Editing the Shift Protocol' in German and English.

    Close-up of HTML code for 'Displaying and Editing the Shift Protocol' with a MadCap keyword term in German.

    emoji


    Generated Image Alt-Text
    [edited by: Trados AI at 5:34 PM (GMT 0) on 28 Feb 2024]
  • The files containing the keywords are all *.htm and have definitely been imported using the HTML 5 file type settings.

    The other files (only *.flsnp in this specific projects) were imported as per MadCap XML settings, but those do not contain any keywords anyway.

  • The files containing the keywords are all *.htm and have definitely been imported using the HTML 5 file type settings.

    File extension is irrelevant. File content is the only relevant thing. And the content clearly says it's XML.
    So it's on you to configure Studio to use the appropriate file type to parse the files - e.g. to turn off the unwanted ones, or to move the wanted ones to the top of the list.

    Unfortunately, the default Studio settings for MadCap files are completely wrong and incomplete :( and it takes some effort and knowledge to make it work as it should.

    Later today when I get to a machine with Studio, I can post some screenshots of a correct and working setup.

  • I see that the "Related" column finally served a good purpose...
    Here is my older thread with my customized filetype attached: community.sdl.com/.../customized-madcap-flare-file-type-disappears-from-project-settings-after-closing-and-reopening-studio

  • Well, this was my first Flare job so far and I was shocked to see that the MadCap XML file type settings do not even contain the basic Flare file types, such as *.flsnp. I managed to sort that out quickly, with the keywords remaining my only pain point at this stage.

    Great, thanks, I'll wait for your reply then. I am also not in a hurry since I resorted to translating the keywords directly in EmEditor so I could deliver the files to my client. I'll just need the correct settings for the follow-up jobs they announced.

  • I was shocked to see that the MadCap XML file type settings do not even contain the basic Flare file types, such as *.flsnp.

    Exactly.
    Given that the file type was originally available only as separate download, it seems to me that the file type was born as some quick'n'dirty solution for some internal need... but that need was probably only for the HTML-like content translation, so they did not made the file type complete... and did not bother to complete it yet.

  • I don't think it was quick and dirty... but I do recall discussing this around 2014 when I was looking at these (not sure if these are a complete list or not, or whether they all contain translatable content or not):

    .htm/.html: Topic file

    .flglo: Glossary file

    .fltar: Target file

    .fltoc: Table of contents file

    .flvar: Variable set file

    .flsnp: Snippet file

    .flsfs: Search filter set file

    *.flmsp: Flare template master page file

    *flpgl: Flare template page layout file

    I think the response at the time was that without a proper spec for them and engaging with MadCap the developer was reluctant to base changes on the few examples we ever came across.  I'll see what the current thoughts are on this as the filetype hasn't evolved since it was put into Studio 2015 as part of the product.  It's still XML: MadCap 1.2 v 1.0.0.0.

    Paul Filkin | RWS Group

    ________________________
    Design your own training!

    You've done the courses and still need to go a little further, or still not clear? 
    Tell us what you need in our Community Solutions Hub

  • without a proper spec for them and engaging with MadCap the developer was reluctant to base changes on the few examples we ever came across.

    To be honest, I would expect that a company claiming to be an industry leader WILL get in touch with MadCap when developing an official connector.
    Or at least invest a half-day or a day in some basic own research (e.g. it's not that problematic to get MadCap installed, read the documentation, do some Googling, etc.)... Still better than nothing if no official spec is available.

    Since it looks like that this did not happen (as not even the basic file extensions you just listed are included in the filetype definition), it naturally led to me to a conclusion that it was just some quick'n'dirty guerilla action...

    Regarding basing changes on just a few examples - I would think that this is what e.g. the beta forum (or the forums in general and closer personal relations with users) are for. It's easy to get connected with users of that particular functionality and improve it together... as long as the users' ideas and tips actually get implemented in a sensible time frame, of course.

  • You're right ... it's so easy I don't know why we didn't do it.  Perhaps because these other formats don't come up a lot... I hardly ever see them and the last mention I had was many years ago.  It's also simple to solve so no real urgency either.

    I have asked the question though so perhaps we'll find out shortly.

    Paul Filkin | RWS Group

    ________________________
    Design your own training!

    You've done the courses and still need to go a little further, or still not clear? 
    Tell us what you need in our Community Solutions Hub

1 2 3