A small bug of no consequence

Please post all new bug reports for Help & Manual 5 here.
Post Reply
User avatar
Martin Wynne
Posts: 2656
Joined: Mon May 12, 2003 3:21 pm
Location: West of the Severn, UK

A small bug of no consequence

Unread post by Martin Wynne »

When starting a new project, HM5 offers some default empty topics -- Introduction, Welcome, etc.

Until they have been edited, the XML files for these topics are missing the translate="true" attributes on the text and title tags.

This is of no significance by itself, but reported in case it is a pointer to a problem elsewhere.

regards,

Martin.
User avatar
Tim Green
Site Admin
Posts: 23156
Joined: Mon Jun 24, 2002 9:11 am
Location: Bruehl, Germany
Contact:

Re: A small bug of no consequence

Unread post by Tim Green »

Hi Martin,
Until they have been edited, the XML files for these topics are missing the translate="true" attributes on the text and title tags.
That's not quite it. These attributes are added as soon as the project is saved, and this happens for all topics. When you create a new project the topics are actually not fully formed yet. This is normal and changes as soon as you save. :)
Regards,
Tim (EC Software Documentation & User Support)

Private support:
Please do not email or PM me with private support requests -- post to the forum directly.
User avatar
Martin Wynne
Posts: 2656
Joined: Mon May 12, 2003 3:21 pm
Location: West of the Severn, UK

Re: A small bug of no consequence

Unread post by Martin Wynne »

Tim Green wrote:These attributes are added as soon as the project is saved, and this happens for all topics.
er no, Tim. :)

If you create a new project, immediately save it and close HM5, and then open the XML files in a text editor, you find:

Code: Select all

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="../helpproject.xsl" ?>
<topic template="Default" status="" lasteditedby="martin5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../helpproject.xsd">
  <title>Sub chapter 2.1</title>
  <body>
    <header><para styleclass="Heading1">Sub chapter 2.1</para></header>
    <para styleclass="Normal">Enter topic text here.</para>
  </body>
</topic>
i.e. there is no <text> tag in the para or translate attribute in the <title> tag.

It doesn't matter, because no project will use these files unmodified. But the fact that the file can be created this way might indicate a deeper problem.

regards,

Martin.
User avatar
Tim Green
Site Admin
Posts: 23156
Joined: Mon Jun 24, 2002 9:11 am
Location: Bruehl, Germany
Contact:

Re: A small bug of no consequence

Unread post by Tim Green »

Hi Martin,

Actually, we're both right: If you look in the XML Source tab in the Help & Manual editor you'll see the translate=true attributes as soon as the project is saved. It looks like this:

Code: Select all

<topic template="Default" lasteditedby="TimMBP64">
  <title translate="true">Welcome topic</title>
  <body>
    <header>
      <para styleclass="Heading1"><text styleclass="Heading1" translate="true">Welcome topic</text></para>
    </header>
    <para styleclass="Normal"><text styleclass="Normal" translate="true">Enter topic text here.</text></para>
  </body>
</topic>
However, the topic file on the disk will look a little different until you edit the topic, vis like this (same topic):

Code: Select all

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="../helpproject.xsl" ?>
<topic template="Default" status="" lasteditedby="TimMBP64" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../helpproject.xsd">
  <title>Welcome topic</title>
  <body>
    <header><para styleclass="Heading1">Welcome topic</para></header>
    <para styleclass="Normal">Enter topic text here.</para>
  </body>
</topic>
After editing, this changes to:

Code: Select all

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="../helpproject.xsl" ?>
<topic template="Default" lasteditedby="TimMBP64" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../helpproject.xsd">
  <title translate="true">Welcome topic</title>
  <body>
    <header>
      <para styleclass="Heading1"><text styleclass="Heading1" translate="true">Welcome topic</text></para>
    </header>
    <para styleclass="Normal"><text styleclass="Normal" translate="true">Enter topic text here. Now edited</text></para>
  </body>
</topic>
I doubt whether this is in any way problematic, but I'll run it past Alex. :)
Regards,
Tim (EC Software Documentation & User Support)

Private support:
Please do not email or PM me with private support requests -- post to the forum directly.
User avatar
Tim Green
Site Admin
Posts: 23156
Joined: Mon Jun 24, 2002 9:11 am
Location: Bruehl, Germany
Contact:

Re: A small bug of no consequence

Unread post by Tim Green »

Update: This is completely normal. Since there is no translate="false" the attribute isn't needed and isn't added until you have actually changed something in your text. It's assumed that you don't want anyone to translate the dummy text that is inserted when a new topic is generated with a new project. :)
Regards,
Tim (EC Software Documentation & User Support)

Private support:
Please do not email or PM me with private support requests -- post to the forum directly.
Post Reply