[Framers] [FrameMaker 2019] Customizing responsive HTML5 output: best practices and good documentation?

Reng Winfried w.reng at carecom-solutions.com
Tue Apr 30 02:28:23 PDT 2019


Hi Dieter,

Thank you very much for your detailed info! Very good!
Here are some comments.

1.) "I do not know which font will be used. "
Font substitution you may define in the resulting CSS. Once defined you can use the CSS as part of the general conversion settings
WR: Yes. Caroline Tabach answered this here:
https://forums.adobe.com/message/11052723

4:) "I do not know how I can define which text goes into a topic title.   E.g. when my paragraph to start a new topic has a table anchor, then   the whole anchor paragraph and the whole table text will be in the topic title."
  Well that's clear, as the table anchor defines the position of the content of the table within the text flow. This table anchor is a DTP relict. 
  Therefore in my templates tables must be anchored in an separate paragraphs called table anchor.
In addition topic title" is a very difficult term which is often misunderstood: For a customer a topic title always is the first paragraph in a HTML Topic and therefore it shall start with a heading. 
If the topic content does not start with a heading the technical writer created a structural mistake.
In technical aspects the topic title might be interpreted as the HTML title tag. Therefore the conversion or topic creation process clearly must take into account that the first paragraph (heading) and the topic title will get the identical content.
A third aspect might be seen in the filename of the HTML topic: This can be but only "by accident" identical with the topic title but never should be taken as the standard topic title!
WR: Very good. I am sure that I can adapt this.

5.) "Most of our products have order codes like 123.4567. When I want  to search for such order codes, the . is interpreted as separator between   two words. As if I want to search for 123 and 4567. I do not know a solution."
6.) In my tests (FM 2019) using "wx.yz" seems to work, but highlighting didn't work - I'll ask the FM development team regarding this issue
WR: The issue is: We have many order codes which start e.g. with 125.
When I enter "125.xyz" as search string, then _all_ order codes with "125" will be found.
However, only 125.xyz should have been found.
It does not matter, if I change the option "Enable Substring Search" in the Search settings.
Or in the converted HTML5 change "Display results with all search words".
The solution user has to enclose the whole text in double quotes. Then this works.

Best regards

Winfried

-----Original Message-----
From: Framers <framers-bounces+w.reng=carecom-solutions.com at lists.frameusers.com> On Behalf Of Gust, Dieter
Sent: Tuesday, April 30, 2019 10:56 AM
To: An email list for people using Adobe FrameMaker software. <framers at lists.frameusers.com>
Subject: Re: [Framers] [FrameMaker 2019] Customizing responsive HTML5 output: best practices and good documentation?

Hi Winfried,
you recognized the different layout/formatting concept between Desktop FrameMaker with Paper/PDF Editing view and the different HTML layout and box model.
1.) "I do not know which font will be used. "
Font substitution you may define in the resulting CSS. Once defined you can use the CSS as part of the general conversion settings
2.) a) "Graphics conversion with SVG is best"
Sure it remains SVG
2.b) "However, if you have   some other objects in the same anchored frame, then you should  convert to raster images. I find the results much better than I expected."
This is the standard approach as the layer concept (as defined in FM) is not supported by the HTML conversion process The quality has been dramatically improved upon the several updates
3.) "When you have tables with table titles with several paragraphs, then  you have to use a work-around. HTML allows only a single paragraph."
    See here: https://forums.adobe.com/message/10987920#10987920 
4:) "I do not know how I can define which text goes into a topic title.   E.g. when my paragraph to start a new topic has a table anchor, then   the whole anchor paragraph and the whole table text will be in the topic
  title."
  Well that's clear, as the table anchor defines the position of the content of the table within the text flow. This table anchor is a DTP relict. 
  Therefore in my templates tables must be anchored in an separate paragraphs called table anchor.
In addition topic title" is a very difficult term which is often misunderstood: For a customer a topic title always is the first paragraph in a HTML Topic and therefore it shall start with a heading. 
If the topic content does not start with a heading the technical writer created a structural mistake.
In technical aspects the topic title might be interpreted as the HTML title tag. Therefore the conversion or topic creation process clearly must take into account that the first paragraph (heading) and the topic title will get the identical content.
A third aspect might be seen in the filename of the HTML topic: This can be but only "by accident" identical with the topic title but never should be taken as the standard topic title!
5.) "Most of our products have order codes like 123.4567. When I want  to search for such order codes, the . is interpreted as separator between   two words. As if I want to search for 123 and 4567. I do not know a solution."

6.) In my tests (FM 2019) using "wx.yz" seems to work, but highlighting didn't work - I'll ask the FM development team regarding this issue Regards Dieter Gust Aufsichtsrat, Leitung Forschung & Entwicklung itl AG, München
+49 89 892623-600
-----Ursprüngliche Nachricht-----
Von: Framers <framers-bounces+dieter.gust=itl.eu at lists.frameusers.com> Im Auftrag von Reng Winfried
Gesendet: Montag, 29. April 2019 12:00
An: An email list for people using Adobe FrameMaker software. <framers at lists.frameusers.com>
Betreff: Re: [Framers] [FrameMaker 2019] Customizing responsive HTML5 output: best practices and good documentation?

Hi Yves,

I also started to convert my unstructured documentation to HTML5.
And I do not have any tutorials or best practices. I am still experimenting.
I will look for more information in the online help and in the various forums and blogs.
My first impressions and questions:

o Default settings are good.

o I do not know which font will be used. Probably my font will be replaced
  by something else. However, I do not know, which fonts are on Android
  or iOS. Is there are default replacement?

o Graphics conversion with SVG is best. However, if you have
  some other objects in the same anchored frame, then you should
  convert to raster images. I find the results much better than I expected.

o When you have tables with table titles with several paragraphs, then
  you have to use a work-around. HTML allows only a single paragraph.
  See here: https://forums.adobe.com/message/10987920#10987920

o I do not know how I can define which text goes into a topic title.
  E.g. when my paragraph to start a new topic has a table anchor, then
  the whole anchor paragraph and the whole table text will be in the topic
  title.

o Most of our products have order codes like 123.4567. When I want
  to search for such order codes, the . is interpreted as separator between
  two words. As if I want to search for 123 and 4567. I do not know a solution.

o Of course I had written documents with a certain layout. I have to find
  solutions for some of my paragraph layouts (e.g. right-aligned tab stops).

o I adapt a copy of the regular settings file on our network. I do not know,
  if there is a standard solution, where this settings file should reside.

Best regards

Winfried

-----Original Message-----
From: Framers <framers-bounces+w.reng=carecom-solutions.com at lists.frameusers.com> On Behalf Of Yves Barbion
Sent: Friday, April 26, 2019 10:58 AM
To: framers at lists.frameusers.com
Subject: [Framers] [FrameMaker 2019] Customizing responsive HTML5 output: best practices and good documentation?

Hi group

I'm looking for best practices and good documentation (or user groups) on how to use and customize FrameMaker 2019 responsive HTML5 output, generated from unstructured Fm files and from ditamaps. The FrameMaker "Help" does not help me very much:

https://help.adobe.com/en_US/framemaker/2019/using/framemaker_help.pdf

Thanks

Yves 


More information about the Framers mailing list