Re: [Framers] Converting a structured FM 9 guide to FM 11

[Scott Prentice]

You need a structure application to open XML files in FM. Do you still have the 
FM 9 installation? What XML model are you using? Open the XML file in notepad 
and send the top line (starts with "DOCTYPE"). 

...scott

Sent from my phone. Please excuse any typos or unexpected brevity. 

> On May 18, 2016, at 6:06 PM, yvette  wrote:
> 
> Hi Scott,
> 
> Unfortunately, I have no experience with structured Frame and the previous
> writer did not leave the app definition file. I inherited only the FM9
> files which consists of a book file with a few .xml files. Is there no
> other way to do this without it? I only have Frame11.
> 
> Thanks,
> Yvette 
> 
>> On 5/18/16, 5:40 PM, "Scott Prentice"  wrote:
>> 
>> No conversion. Just "install" the structured application you're using on
>> FM9 into FM11. Then you should be able to open the XML files.
>> 
>> Should be able to copy the app files to FM11 in a similar location to
>> where they are in FM9. Then copy the structure app definition from FM9 to
>> FM11. 
>> 
>> ...scott
>> 
>> Sent from my phone. Please excuse any typos or unexpected brevity.
>> 
>>> On May 18, 2016, at 5:24 PM, yvette  wrote:
>>> 
>>> Hi All,
>>> 
>>> Does anyone have any knowledge/tips/suggestions on how to convert a
>>> structured book authored in Frame 9 to Frame 11? When I try to open the
>>> .xml
>>> files (in Structured Frame 11) I get a ³Validation of XML failed.²
>>> 
>>> Thanks in advance for any help on thisŠ
>>> ~yvette
> 
> 
___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com

Re: [Framers] Converting a structured FM 9 guide to FM 11

[yvette]

Hi Scott,

Unfortunately, I have no experience with structured Frame and the previous
writer did not leave the app definition file. I inherited only the FM9
files which consists of a book file with a few .xml files. Is there no
other way to do this without it? I only have Frame11.

Thanks,
Yvette 

On 5/18/16, 5:40 PM, "Scott Prentice"  wrote:

>No conversion. Just "install" the structured application you're using on
>FM9 into FM11. Then you should be able to open the XML files.
>
>Should be able to copy the app files to FM11 in a similar location to
>where they are in FM9. Then copy the structure app definition from FM9 to
>FM11. 
>
>...scott
>
>Sent from my phone. Please excuse any typos or unexpected brevity.
>
>> On May 18, 2016, at 5:24 PM, yvette  wrote:
>> 
>> Hi All,
>> 
>> Does anyone have any knowledge/tips/suggestions on how to convert a
>> structured book authored in Frame 9 to Frame 11? When I try to open the
>>.xml
>> files (in Structured Frame 11) I get a ³Validation of XML failed.²
>> 
>> Thanks in advance for any help on thisŠ
>> ~yvette
>> 
>> 


___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com

Re: [Framers] Converting a structured FM 9 guide to FM 11

[Scott Prentice]

No conversion. Just "install" the structured application you're using on FM9 
into FM11. Then you should be able to open the XML files. 

Should be able to copy the app files to FM11 in a similar location to where 
they are in FM9. Then copy the structure app definition from FM9 to FM11. 

...scott

Sent from my phone. Please excuse any typos or unexpected brevity. 

> On May 18, 2016, at 5:24 PM, yvette  wrote:
> 
> Hi All,
> 
> Does anyone have any knowledge/tips/suggestions on how to convert a
> structured book authored in Frame 9 to Frame 11? When I try to open the .xml
> files (in Structured Frame 11) I get a ³Validation of XML failed.²
> 
> Thanks in advance for any help on thisŠ
> ~yvette
> 
> 
___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com

[Framers] Converting a structured FM 9 guide to FM 11

[yvette]

Hi All,

Does anyone have any knowledge/tips/suggestions on how to convert a
structured book authored in Frame 9 to Frame 11? When I try to open the .xml
files (in Structured Frame 11) I get a ³Validation of XML failed.²

Thanks in advance for any help on thisŠ
~yvette


___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com

Re: [Framers] framescript now FM2015 savvy? WAS: Alignment in Sidehead Paragraphs (ANN: Bottlenecks for the Ride for Roswell)

[Rick Quatro]

Yes, FrameScript 6 includes support for FrameMaker 2015's new features.
FrameScript is still alive and well.

Rick Quatro
Carmen Publishing Inc.
585-366-4017
r...@frameexpert.com



-Original Message-
From: Framers
[mailto:framers-bounces+rick=rickquatro@lists.frameusers.com] On Behalf
Of Craig Ede
Sent: Wednesday, May 18, 2016 4:42 PM
To: framers
Subject: Re: [Framers] framescript now FM2015 savvy? WAS: Alignment in
Sidehead Paragraphs (ANN: Bottlenecks for the Ride for Roswell)

I guess a more focused question would be: Does FrameScript 6 (or whatever it
is up to now) allow scripting of the new features in FM 2015?


Craig



From: John Sgammato 
Sent: Wednesday, May 18, 2016 2:25 PM
To: Craig Ede
Subject: Re: [Framers] framescript now FM2015 savvy? WAS: Alignment in
Sidehead Paragraphs (ANN: Bottlenecks for the Ride for Roswell)

I'm using FrameScript with Fm2015

On Wed, May 18, 2016 at 3:24 PM, Craig Ede
> wrote:
Is FrameScript now FM2015 savvy?  (I know I can go look this up somewhere,
but others might want to know too).

Craig
_



--

[http://www.actifio.com/assets/sig_logo.png]
John Sgammato, Documentation Architect
e john.sgamm...@actifio.com  c
508.927.2083 t @actifiodocs

333 Wyman Street, Waltham, MA 02451


[http://www.actifio.com/assets/twitter1.png]
[http://www.actifio.com/assets/linkedin1.png]

[http://www.actifio.com/assets/googleplus.png]

[http://www.actifio.com/assets/youtube1.png]

[http://www.actifio.com/assets/rss1.png] 


Manage, access, and protect your data with a single platform that saves you
time, money, and complexity.
___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com Visit the list's homepage at
http://www.frameusers.com Archives located at
http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com

___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com

Re: [Framers] framescript now FM2015 savvy? WAS: Alignment in Sidehead Paragraphs (ANN: Bottlenecks for the Ride for Roswell)

[Art Campbell]

It's been working fine for months, including in pre-release FM betas.


Art Campbell
  art.campb...@gmail.com
  "... In my opinion, there's nothing in this world beats a '52 Vincent and
a redheaded girl." -- Richard Thompson
  No disclaimers apply.
   DoD 358

I support www.TheGrotonLine.com, hyperlocal news for Groton MA.

On Wed, May 18, 2016 at 4:41 PM, Craig Ede  wrote:

> I guess a more focused question would be: Does FrameScript 6 (or whatever
> it is up to now) allow scripting of the new features in FM 2015?
>
>
> Craig
>
>
> 
> From: John Sgammato 
> Sent: Wednesday, May 18, 2016 2:25 PM
> To: Craig Ede
> Subject: Re: [Framers] framescript now FM2015 savvy? WAS: Alignment in
> Sidehead Paragraphs (ANN: Bottlenecks for the Ride for Roswell)
>
> I'm using FrameScript with Fm2015
>
> On Wed, May 18, 2016 at 3:24 PM, Craig Ede > wrote:
> Is FrameScript now FM2015 savvy?  (I know I can go look this up somewhere,
> but others might want to know too).
>
> Craig
> _ listad...@frameusers.com>
>
>
>
> --
>
> [http://www.actifio.com/assets/sig_logo.png]
>John Sgammato, Documentation Architect
> e john.sgamm...@actifio.com  c
> 508.927.2083
> t @actifiodocs
>
> 333 Wyman Street, Waltham, MA 02451
>
>
> [http://www.actifio.com/assets/twitter1.png]
>  [http://www.actifio.com/assets/linkedin1.png] <
> http://www.linkedin.com/company/399246>[
> http://www.actifio.com/assets/googleplus.png] <
> https://plus.google.com/102870897962348937868/posts>[
> http://www.actifio.com/assets/youtube1.png] <
> http://www.youtube.com/user/actifio>[
> http://www.actifio.com/assets/rss1.png] 
>
>
> Manage, access, and protect your data with a single platform that saves
> you time, money, and complexity.
> ___
>
> This message is from the Framers mailing list
>
> Send messages to framers@lists.frameusers.com
> Visit the list's homepage at  http://www.frameusers.com
> Archives located at
> http://www.mail-archive.com/framers%40lists.frameusers.com/
> Subscribe and unsubscribe at
> http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
> Send administrative questions to listad...@frameusers.com
>
___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com

Re: [Framers] framescript now FM2015 savvy? WAS: Alignment in Sidehead Paragraphs (ANN: Bottlenecks for the Ride for Roswell)

[Craig Ede]

I guess a more focused question would be: Does FrameScript 6 (or whatever it is 
up to now) allow scripting of the new features in FM 2015?


Craig



From: John Sgammato 
Sent: Wednesday, May 18, 2016 2:25 PM
To: Craig Ede
Subject: Re: [Framers] framescript now FM2015 savvy? WAS: Alignment in Sidehead 
Paragraphs (ANN: Bottlenecks for the Ride for Roswell)

I'm using FrameScript with Fm2015

On Wed, May 18, 2016 at 3:24 PM, Craig Ede 
> wrote:
Is FrameScript now FM2015 savvy?  (I know I can go look this up somewhere, but 
others might want to know too).

Craig
_



--

[http://www.actifio.com/assets/sig_logo.png]   
John Sgammato, Documentation Architect
e john.sgamm...@actifio.com  c 508.927.2083
t @actifiodocs

333 Wyman Street, Waltham, MA 02451


[http://www.actifio.com/assets/twitter1.png]   
[http://www.actifio.com/assets/linkedin1.png] 

[http://www.actifio.com/assets/googleplus.png] 

[http://www.actifio.com/assets/youtube1.png] 

[http://www.actifio.com/assets/rss1.png] 


Manage, access, and protect your data with a single platform that saves you 
time, money, and complexity.
___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com

[Framers] framescript now FM2015 savvy? WAS: Alignment in Sidehead Paragraphs (ANN: Bottlenecks for the Ride for Roswell)

[Craig Ede]

Is FrameScript now FM2015 savvy?  (I know I can go look this up somewhere, but 
others might want to know too).

Craig
___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com

Re: [Framers] reused content for different products - best practices ?

[Syed Zaeem Hosain]

Yes, indeed!

BookVars is my most used tool in FrameMaker ...

Z

> -Original Message-
> You might also want to look at using the popular BookVars plugin. It lets you 
> easily define a set of variables (one for each product), then pop them into 
> the book with a couple of clicks. It's easy and a real timesaver.
> 
> http://leximation.com/tools/info/bookvars.php
> http://docs.leximation.com/bookvars/2.00/
> 
> Mike Wickham 
___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com

Re: [Framers] structured content - not always called for

[Pat Christenson]

Hi Monique -

What a very interesting and helpful post.

Do you plan to offer your presentation as a webex? I'd be very interesting in 
seeing it.

I was at VMware too, as a consultant during the changeover to structure. Did 
our paths cross? 

Pat Christenson

-Original Message-
From: Framers 
[mailto:framers-bounces+pat.christenson=morningstar@lists.frameusers.com] 
On Behalf Of Monique Semp
Sent: Tuesday, May 17, 2016 5:20 PM
To: framers@lists.frameusers.com
Subject: [Framers] structured content - not always called for

> But then, working with unstructured FM content in the 21st century is really 
> not done, if you ask me. Converting is fairly easy - we do it all the time - 
> so if you do not have structured content yet, look in that direction for your 
> best practices.

Oh, I disagree strongly with this. Working with unstructured content is done 
often, although I'll grant you with varying degrees of success :-).

I've worked with DITA—including at VMware, where I got to work directly with 
some of the thought leaders in structured content—and definitely see the great 
advantages **but only if appropriate **.

In my current assignment, I'm the sole writer (and part-time at that), for an 
organization that doesn't have very many products, that has no need for 
localization, and that has independent streams for Marketing and Tech Pubs 
deliverables (and no need to combine them or share actual content files). I've 
worked on-and-off at this company for 10+ years, and it's only now that I'm 
even looking into any sort of "reuse strategy". And truthfully, if I hadn't 
recently spent several years in a heavily structured-content environment, I 
doubt I'd have even thought of it. It's not too much content that I can't just 
copy/paste, make a few notes in the wiki about "if you change this in doc A, be 
sure to make the parallel change in doc B", and be done with it. But being a 
trainable monkey (as "they" say), I figured the docs (and I) would benefit from 
a bit of forethought.

I've seen conversions done, and yes, they're fairly easy. But there's no need 
to invest the time to migrate content, possibly purchase additional tools (at 
my own expense because I'm a consultant, not a direct employee), or develop new 
templates for publishing from structured FrameMaker. As well, doing so would 
make it even harder for my client to bring in another tech writer who's 
appropriately skilled in the tools with which I've created their docs, and 
experienced enough to figure things out (given the lack of detail in the Tech 
Pubs Processes and Procedures, which are lacking detail because there's no need 
for the client to pay for more detailed versions).

 I'm not anti-DITA, anti-structure, or anything like that. In fact, I took 
a recent 18-month contract in large part because I'd get to keep working in the 
structured content world. In addition to the oft-cited benefits (reuse, 
localization, topic-based writing, semantic-styling), I found that I could 
write much more accurate content, much more quickly than otherwise. And when 
reviewers focused on minutia such as an occasional bad break in a PDF, I could 
just say, "sorry, nothing I can do about it" :-). 

But structured authoring/DITA, is simply overkill for many situations, and is 
typically best with *at least* one "pubs tools guy/gal" in addition to the 
dedicated writers. I feel strongly about this, and in fact am developing a 
presentation along the lines of "Adopting the Best Practices of Structured 
Authoring—In Any Toolset". I'll be presenting nuts-and-bolts examples of how to 
do a bunch of "structured/DITA things" in Word, FrameMaker, Doxygen/Javadoc, 
and MadCap Flare. Word-for-word, this is how I pitched the presentation topic, 
which was very well received by the STC-Berkeley programs team:
  --
  All too often the “experts” seem to imply that you must use some giant system 
with lots of overhead (I’m thinking DITA at VMware or Salesforce, of the big 
Ponydocs ecosystem at Splunk) in order to get any of the benefits of 
structured/DITA writing. But that’s just not true. There are lots of things 
that are about writing technique and simple style management in whatever tool 
you’re using. But nobody presents it that way. They just shake their heads at 
the practicalities of needing to use cheap/free tools at a shop that’s not 
interested in investing in tools for writers. And I’d like to show that this 
needn’t prevent writers from gaining the benefits of structure and style that 
DITA enforces.
  --
Just some long rambling thoughts for consideration, -Monique 
___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com Visit the list's homepage at  
http://www.frameusers.com Archives located at 
http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 

Re: [Framers] Rick's Ride and Suggestions for Plugin

[Monique Semp]

  * FrameInside/FrameOutside (or FrameLeft/FrameRight, if other settings

  switch inside/outside to left/right) - Similar to
  FrameAbove/FrameBelow, this would basically be a way to define in a
  Paragraph Style that a reference-page graphic is to float out of the
  text frame to the inside/outside (left/right) of the paragraph to which
  the style is applied.


  I could have used such functionality SO MANY TIMES with various

  admonishment styles (e.g., caution) or form-creation tricks (e.g., Done
  checkboxes nextt to major steps in a procedure).

I'm not sure I'm understanding this exactly, but perhaps this is similar to 
Chris Despopoulos' RefIcons plugin? Although it's not supported anymore (I 
don't see it on the CudSpan site, http://cudspan.net/plugins/), I've been 
using it for years to create great looking "alerts" (caution, note, tip, 
warning, etc.). So perhaps RefIcons can serve as a starting point for an 
updated tool?


-Monique 


___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com

Re: [Framers] Rick's Ride and Suggestions for Plugin

[David Artman]

   OK, I thought of another one after I posted:

   * FrameInside/FrameOutside (or FrameLeft/FrameRight, if other settings
   switch inside/outside to left/right) - Similar to
   FrameAbove/FrameBelow, this would basically be a way to define in a
   Paragraph Style that a reference-page graphic is to float out of the
   text frame to the inside/outside (left/right) of the paragraph to which
   the style is applied.

   I could have used such functionality SO MANY TIMES with various
   admonishment styles (e.g., caution) or form-creation tricks (e.g., Done
   checkboxes nextt to major steps in a procedure).

   Yes, one can hand-place an anchored frame each time to do that, but
   it's annoyingly manual.

   Yes, one can do a monochrome 'bullet' of some type (ding) with
   auto-numbering tricks.

   But if you want a multicolor graphic every time, floating automatically
   to the appropriate side, without hand-placing them each para... no
   option (of which I'm aware).

   Not sure if that's "scriptable," per se. Perhaps as a "burst" of
   automatically inserted, anchor-framed graphics prior to publish...?

   Again: Awesome way to volunteer!

   David
___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com

Re: [Framers] reused content for different products - best practices ?

[Monique Semp]

Yep, I participated in the "beta testing" for the most recent version of 
BookVars, which works with FrameMaker 2015, and manages markers as well 
(although I haven't tried that part yet).


And yes, BookVars is why I'm not minding a proliferation of variables in my 
docs :-).


-Monique

-Original Message- 
From: Mike Wickham

Sent: Wednesday, May 18, 2016 6:06 AM
To: framers@lists.frameusers.com
Subject: Re: [Framers] reused content for different products - best 
practices ?


You might also want to look at using the popular BookVars plugin. It
lets you easily define a set of variables (one for each product), then
pop them into the book with a couple of clicks. It's easy and a real
timesaver.

http://leximation.com/tools/info/bookvars.php
http://docs.leximation.com/bookvars/2.00/

Mike Wickham

___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at 
http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com 


___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com

Re: [Framers] Rick's Ride and Suggestions for Plugin

[Mike Wickham]

Hi, Rick,

I found some old information on the CleanImport plugin. Apparently, 
there was no documentation with the zip file of the plugin, but I had 
made a PDF of an earlier version of the website page which had minimal 
instructions that might be of use to you. I'll email it to you


Mike Wickham

On 5/17/2016 6:18 PM, Rick Quatro wrote:

Does anyone have documentation for the original CleanImports plugin?





___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com

Re: [Framers] structured content - not always called for

[Keith Soltys]

Good points Monique. I'm in a similar situation, being a lone writer, and not 
having the time or resources to implement a structured workflow.

I deal with two main streams of documentation. For my operations guides and 
online help I use FrameMaker and WebWorks ePublisher. There's little reuse 
involved and I can use text insets to manage that. For our last major platform 
upgrade, I did a content analysis using DITA's concept/task/reference model to 
restructure the documentation and got good comments on the approach.

The other stream involves many technical specifications which go out to our 
clients. For these, I have to use Word. I've found that Thirty Six Software's 
SmartDocs tool gives me most of the benefits I'd get from moving to DITA and is 
much easier to set up and use. Yes, if I had a group of four or five writers, 
I'd probably move to DITA, but that's not going to happen.

Regards
Keith

--
Keith Soltys
Senior Technical Writer
Architecture
TMX Group
(416) 947-4397
http://www.tmx.com/


-Original Message-
From: Framers 
[mailto:framers-bounces+keith.soltys=tmx@lists.frameusers.com] On Behalf Of 
Monique Semp
Sent: Tuesday, May 17, 2016 6:20 PM
To: framers@lists.frameusers.com
Subject: [Framers] structured content - not always called for

> But then, working with unstructured FM content in the 21st century is really 
> not done, if you ask me. Converting is fairly easy - we do it all the time - 
> so if you do not have structured content yet, look in that direction for your 
> best practices.

Oh, I disagree strongly with this. Working with unstructured content is done 
often, although I'll grant you with varying degrees of success :-).

I've worked with DITA—including at VMware, where I got to work directly with 
some of the thought leaders in structured content—and definitely see the great 
advantages **but only if appropriate **.

In my current assignment, I'm the sole writer (and part-time at that), for an 
organization that doesn't have very many products, that has no need for 
localization, and that has independent streams for Marketing and Tech Pubs 
deliverables (and no need to combine them or share actual content files). I've 
worked on-and-off at this company for 10+ years, and it's only now that I'm 
even looking into any sort of "reuse strategy". And truthfully, if I hadn't 
recently spent several years in a heavily structured-content environment, I 
doubt I'd have even thought of it. It's not too much content that I can't just 
copy/paste, make a few notes in the wiki about "if you change this in doc A, be 
sure to make the parallel change in doc B", and be done with it. But being a 
trainable monkey (as "they" say), I figured the docs (and I) would benefit from 
a bit of forethought.

I've seen conversions done, and yes, they're fairly easy. But there's no need 
to invest the time to migrate content, possibly purchase additional tools (at 
my own expense because I'm a consultant, not a direct employee), or develop new 
templates for publishing from structured FrameMaker. As well, doing so would 
make it even harder for my client to bring in another tech writer who's 
appropriately skilled in the tools with which I've created their docs, and 
experienced enough to figure things out (given the lack of detail in the Tech 
Pubs Processes and Procedures, which are lacking detail because there's no need 
for the client to pay for more detailed versions).

 I'm not anti-DITA, anti-structure, or anything like that. In fact, I took 
a recent 18-month contract in large part because I'd get to keep working in the 
structured content world. In addition to the oft-cited benefits (reuse, 
localization, topic-based writing, semantic-styling), I found that I could 
write much more accurate content, much more quickly than otherwise. And when 
reviewers focused on minutia such as an occasional bad break in a PDF, I could 
just say, "sorry, nothing I can do about it" :-). 

But structured authoring/DITA, is simply overkill for many situations, and is 
typically best with *at least* one "pubs tools guy/gal" in addition to the 
dedicated writers. I feel strongly about this, and in fact am developing a 
presentation along the lines of "Adopting the Best Practices of Structured 
Authoring—In Any Toolset". I'll be presenting nuts-and-bolts examples of how to 
do a bunch of "structured/DITA things" in Word, FrameMaker, Doxygen/Javadoc, 
and MadCap Flare. Word-for-word, this is how I pitched the presentation topic, 
which was very well received by the STC-Berkeley programs team:
  --
  All too often the “experts” seem to imply that you must use some giant system 
with lots of overhead (I’m thinking DITA at VMware or Salesforce, of the big 
Ponydocs ecosystem at Splunk) in order to get any of the benefits of 
structured/DITA writing. But that’s just not true. There are lots of things 
that are about writing technique and simple style management in whatever tool 
you’re using. But 

Re: [Framers] reused content for different products - best practices ?

[Mike Wickham]

You might also want to look at using the popular BookVars plugin. It 
lets you easily define a set of variables (one for each product), then 
pop them into the book with a couple of clicks. It's easy and a real 
timesaver.


http://leximation.com/tools/info/bookvars.php
http://docs.leximation.com/bookvars/2.00/

Mike Wickham

___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com

Re: [Framers] reused content for different products - best practices ?

[Shmuel Wolfson]

I don't think you need structured FM for this. You can share the 
appendix chapter in all the relevant books and mark the differences 
between the products with conditional text. As far as variables, you can 
either have multiple variables for the different products (product1, 
product2, product3) and mark them with conditional text, or you can use 
the same variable name for all products and import a "template" for each 
product that contains the variable definitions for each product. I 
usually prefer the 1st option.


I would only use text insets for parts of a chapter, not an entire 
chapter. You can use conditional text in text insets as well.


If you do localization (translation), than it makes sense to go with 
structured FM.


--
Shmuel Wolfson
Technical Writer
058-763-7133

On 17-May-16 10:01 PM, Monique Semp wrote:

Hello, Framers,

I’ve got an appendix that now should be shared among three different products’ 
docs, and among multiple docs for the same product, and I’m looking for best 
practices re: conditions vs. variables vs. text insets.

(Sorry this is a long post. Just click delete if you’re not into the minutia of 
this stuff. Otherwise, you’ll see my specific questions marked by “**Q”.)

The relevant diffs in this appendix are:

   1. Product name—Scattered throughout the content, where it talks about things such as 
“ scripts” and “ script entry”.

   2. Doc part number—Appears in headers. I already have a variable that’s 
different in every doc, so this is taken care of.

   3. Info that’s only for the original product in which this appendix 
appeared—Phrases and standalone sentences in almost every reference entry for a 
script element. But the point isn’t that it’s only for the first product, but for 
when we’re describing lower-level code details, which we do for some products but not 
all. I’ve used a condition, __INCLUDE__info, which seems 
straight-forward and easily extended for future products without getting into exactly 
which products need this content.

   4. Sample script file—Different for each product.
So two are easily managed, and I’m looking for advice on the other two:

* Item 1 (product name): Conditionals would be a real pain, and I’d have to add 
a new condition every time I needed this appendix for another product/doc. A 
variable could be used, which I guess would be .fm file-specific.

But the odd thing here is that I already have a variable for one of the products (for 
which there are two docs), but this variable isn’t named generically; it’s name is 
“_prod_name_” because there’s a space in the actual product 
name, and I wanted to ensure that the product name didn’t break across lines. So if I 
wanted a variable for this new use—to control which product name is included in the 
content—I’d either have to commit variable abuse (assigning a value that contradicts 
the actual variable name) or add a new variable.

**Q: Adding a new variable seems best, with a generic name. But should that 
variable be just for this file, or should I make it more general and use it 
across all files in a book?

* Item 4 (different script file): This wouldn’t be hard to manage with 
conditions—just add a condition for each product or product-component—but I’m 
concerned with proliferating conditions. I’ve tried hard to keep the conditions 
to a minimum to avoid getting into complex condition evaluation and usage. And 
I just don’t know what the future will bring.

So an alternative thought is to have a separate .fm file for each book (for 
each product or product-component, that is), which would include a text inset 
that contains only the common content (with variables and conditions as 
described above), and then directly include the specific script sample.

**Q: Are there issues I should look out for in terms of using variables and 
conditions (the __INCLUDE__info) in a text inset? Perhaps it’s 
best to create a set of conditions now for each product/product-component on the 
assumption that they’ll likely turn out useful in the future? Are there 
easier/better-suited mechanisms that I’m just overlooking?

Thanks for the advice,
-Monique



___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com


___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to 

Re: [Framers] Alignment in Sidehead Paragraphs (ANN: Bottlenecks for the Ride for Roswell)

[Mueller, Klaus]

Hi Urszula, 

> How about paragraph alignment towards spine and away from spine?

You may want to take a look at the free FrameScript "AlignSideHeads" 
http://www.i-frame.itl.info/en/feature-description/free-scripts/align-side-heads.html

Kind regards

Klaus Müller
Consulting & Process Automation

itl AG, Munich, Germany
Phone: +49 89 892623-660


-Original Message-
From: Framers 
[mailto:framers-bounces+klaus.mueller=itl...@lists.frameusers.com] On Behalf Of 
Urszula
Sent: Tuesday, May 17, 2016 3:18 AM
To: Rick Quatro
Cc: framers@lists.frameusers.com
Subject: Re: [Framers] ANN: Bottlenecks for the Ride for Roswell

Hi Rick,

How about paragraph alignment towards spine and away from spine? Anchored 
frames can be flexibly aligned this way, but not paragraphs! It would open 
great layout options both on master and body pages.

Thanks for your offer to contribute your time.

Urszula

Urszula Witherell
www.jetsetcom.net | www.trainingonsite.com
301.524.3165



___

This message is from the Framers mailing list

Send messages to framers@lists.frameusers.com
Visit the list's homepage at  http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at 
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listad...@frameusers.com