Showing posts with label framemaker. Show all posts
Showing posts with label framemaker. Show all posts

Monday, October 12, 2015

(Tip5) Show / Hide other tab components in left navigation pane of Responsive HTML5 output

While working with Responsive HTML5 Output the left pane comes with:

  • TOC
  • Index
  • Glossary
  • Search


and not every user wants to generate Index / Glossary for every output. To hide the empty tab from Responsive HTML5 outputs we need to disable the show setting of Index and Glossary respectively.

In Publish Pod >> Responsive HTML5 >> Manage Layout >> Edit

Hide Index and Glossary Tabs
This way your index and glossary tabs can be hidden easily in the responsive HTML5 output and the left navigation pane looks neater!

(Tip4) How to make a mini-TOC in Responsive HTML5 output

In FrameMaker 2015 there is a subtle way of creating a mini-TOC for each topic by just configuring "HTML Page Template". A mini-TOC appears on each topic and is recommended if your topics are large.

To quickly experience mini-toc feature of FM publish feature, please do these steps:
  1. FM > Help > UserGuide > Open UserGuide.book
  2. Open Publish Pod (Esc p h) >> Edit Responsive HTML5
  3. Check ON "Use HTML Page Template" >> Select HTMLTemplate.htm ($FMHOME\fminit\Publisher\Template\Document\PageTemplate\HTMLTemplate.htm)
  4. Save & Close
  5. Publish Responsive HTML5

A mini-TOC gets created in the output:
minitoc.PNG
Mini-TOC Example
How does the mapping work in miniTOC w.r.t the Para Tags?
The para tags that we define in HTML Page Template at level1, level2 etc are scanned from the FM document and are brought at the desired level in selected output.
To show it diagramatically - I have taken a screenshot:
minitocConcept.PNG
HTML Template to mini-TOC mapping

The concept of keeping it in HTML is to provide flexibility in terms of styling & customizations via CSS.

To create a Page Template for your FM file from scratch you may follow the link: Adobe FrameMaker (2015 release)


I apologize that we haven't done our bit to make this feature simple . But suggestions are always welcome 

Do let us know if this makes it easy for you to get started.

(Tip3) Types of display modes of TOC in Responsive HTML5



If you have generated responsive HTML5 output from FrameMaker 2015 you must have noticed the TOC automatically changes its behavior from desktop to mobile. Actually the TOC changes from tree-view behavior to drill-down behavior.

The 2 display views of the TOC:

Tree View (shows all levels in single view) - Present by default in the Desktop
Drill Down View (with 1 level in single view) - Present by default in Mobile and Tablet


Drill down TOC - only one level is shown 

Tree view TOC - multiple levels of TOC are shown




















Tree view TOC Drill down TOC
For bigger screens For Mobile screens
Takes more screen width Takes lesser screen width
Display all levels Display Single Level
Takes single click to explore Takes multiple clicks to explore

There are times when you would want to have tree-view TOC for the mobile mode as well. If you wish to see Tree View in all screens - you may follow these steps:

FM >> Publish Dialog >> Responsive HTML5 >> Edit Settings >> Manage Layout >> Edit >> TOC (Tablet/Mobile) >> Mobile TOC drill down >> false >> Save >> Publish Output

Do let me know if this helped!

(Tip2) Creating TOC navigation levels in DITA for FrameMaker 2015 published outputs

To create TOC navigation levels from DITA to FrameMaker published output we need to edit the ditafm-output.ini file present in Windows %appdata% folder.

The folder/file can be accessed via:
Windows > Run > (paste this) > %appdata%\Adobe\FrameMaker\13\ditafm-output.ini > {ENTER key}

In the file edit the section [BookWithFM-TOC] to add extra levels to the output TOC.

FrameMaker's DITAmap's output is currently controlled through 'ParaTags' setting present in 'BookWithFM-TOC' section of "ditafm-output.ini". It is shipped with default 2 levels with  title.0 (chapter title) and title.1(section title) that get included in the TOC. 

            [BookWithFM-TOC]
            Template=TOCTpl.fm
            ElementTags=
            ParaTags=title.0|title.1

To add more levels to the DITA published output we need to add more levels to the BookWithFM-TOC section.

Example to change it up to  4 levels:
                [BookWithFM-TOC]
                Template=TOCTpl.fm
                ElementTags=
                ParaTags=title.0|title.1|title.2|title.3|title-index
DITA output with navigation levels in TOC

Hope this helps you to add more power to your published outputs!

(Tip1) TOC nesting in Responsive HTML5 Publish output

The crux of any web output is its TOC (Table of Contents) - via which we navigate to the relevant topics. Hence creating a good TOC is an imminent part of FrameMaker outputs too.


When we create a TOC in FrameMaker - the initial TOC that gets created is flat. All topics appear at one level (and this is not what we would want:( )
Flat TOC :-(

To create TOC navigation levels in a TOC in FM Publish Outputs, we need to tweak the indenting, font size or weight property.

In FrameMaker published outputs TOC level is determined by any of these Para Tag properties:
First Indent,
- Font Size,
- Font weight

Para Styles with higher font size and weight would become a parent of styles with lower font size or weight. Para Styles with higher First indent would become a child of styles with lower First Indent. 

i.e. If you wish to have Heading3 appear inside Heading2 like this:
Heading3
     Heading2

In Para Designer >> Update Para Designer properties of these 2 tags (Heading2TOC, Heading3TOC):
-  First Indent of Heading2TOC greater than Heading3TOC
- Or Font Weight of Heading2TOC less than Heading3TOC
- Or Font Size of Heading2TOC less than Heading3TOC
Nested TOC :-)

Yes, this could appear a little cryptic at the first go but once you use it - it would make lot of sense of this implementation. Do try it out and let me know if it works for you!