Referencing a single sentence from a document for many other

This forum is for Single-Sourcing your Flare content to multiple outputs.
Post Reply
sdcinvan
Propellus Maximus
Posts: 1260
Joined: Wed Aug 21, 2013 11:46 am
Location: Vancouver, Canada

Referencing a single sentence from a document for many other

Post by sdcinvan »

Greetings all,

I think this is a great example of single sourcing.

I have created a legal document and one line, for example, needs to be quoted in a few other documents. The reason why I wish to reference this one line, rather than simply copy/paste it is that if that legal sentence changes some day, it will be exceedingly difficult to remember where that sentence is used in other documents.

One idea is to turn that sentence into a Snippet.

The problem with this idea is that same really annoying habit in that Flare insists on making a copy of the Snippet... therefore, eliminating the whole reason to employ single-sourcing. Well, at least with images, Flare offers a kluggy option of synchronizing the copy to the source, not so with a Snippet. :x The 'outsourced' Snippet doesn't even show up in the Flare file mappings!

But perhaps there is a better method to accomplish this goal?

Thank you
Shawn in Vancouver, Canada
Main tools used: Flare 11.x, InDesign, Google Docs, Lectora, Captivate.
Report bugs: https://www.madcapsoftware.com/feedback/bugs.aspx ▪ Feature requests: https://www.madcapsoftware.com/feedback ... quest.aspx[/i]
whunter
Sr. Propeller Head
Posts: 429
Joined: Thu Mar 12, 2009 4:49 pm
Location: Portland, OR

Re: Referencing a single sentence from a document for many other

Post by whunter »

Not totally clear on why you are getting a copy of the snippet, so perhaps you can provide more detail on what you are doing that causes the copy?

If the snippet is being used within the same project, then certainly copies aren't made of it every time you use it. So are you importing it via External Resources, or Global Project Linking? In both cases there is still the option to synchronize it with the source; I have done it both ways before.
wclass
Propellus Maximus
Posts: 1238
Joined: Mon Feb 27, 2006 5:56 am
Location: Melbourne, Australia

Re: Referencing a single sentence from a document for many other

Post by wclass »

We use a snippet for Copyright information and similar text. We don't have a problem with copies. If the text changes we just update the snippet directly.
However, we have it installed as part of our project template and we don't try and import it via project linking - does not change often enough.
Margaret Hassall - Melbourne
Msquared
Propellus Maximus
Posts: 848
Joined: Mon Aug 06, 2012 10:19 am
Location: Southampton, UK

Re: Referencing a single sentence from a document for many other

Post by Msquared »

I use snippets all the time, including for various "legalese" things like copyrights.

My content references the snippet, and if I change the snippet source the text in the content changes. Some of my snippets (like the "legalese" ones, the company address and other boiler-plate stuff) are in my Global project, which I pull in using Global Project Linking (which at last I have got working, sort of as I want it :-) ).

I never have any problems with changes being replicated.

Perhaps give some more details about how you created the snippet, and what the result was, so we can understand your problem better?
Marjorie

My goal in life is to be as good a person as my dogs already think I am.
ChoccieMuffin
Senior Propellus Maximus
Posts: 2650
Joined: Wed Apr 14, 2010 8:01 am
Location: Surrey, UK

Re: Referencing a single sentence from a document for many other

Post by ChoccieMuffin »

We have a project that contains all the bits and pieces that are used in our other projects - stylesheets, page layouts, common content such as copyright text, and snippets. This project is imported into other projects, so these items are only updated in a single place, and it keeps projects in sync. In the Import filter in the target projects we have the "Auto-reimport before Generate Output" option checked.

So rather than keeping your single snippet in your legal topic, move it to your Global topic and import it into whatever projects need it.
Started as a newbie with Flare 6.1, now using Flare 2024r2.
Report bugs at http://www.madcapsoftware.com/bugs/submit.aspx.
Request features at https://www.madcapsoftware.com/feedback ... quest.aspx
sdcinvan
Propellus Maximus
Posts: 1260
Joined: Wed Aug 21, 2013 11:46 am
Location: Vancouver, Canada

Re: Referencing a single sentence from a document for many other

Post by sdcinvan »

whunter wrote:Not totally clear on why you are getting a copy of the snippet, so perhaps you can provide more detail on what you are doing that causes the copy?

If the snippet is being used within the same project, then certainly copies aren't made of it every time you use it. So are you importing it via External Resources, or Global Project Linking? In both cases there is still the option to synchronize it with the source; I have done it both ways before.
Thanks for your reply.

Perhaps I should have been more clear. I am pulling the snippet from a different document. The moment you do that (for any Flare object), Flare insists on making a copy in the local project folder.

This is the project folder hierarchy I use:

Code: Select all

_projects
      flare
         common_images
              [various image folders]
         legal_docs      
              [folders for each legal document]
         user_guide
             install_guide
             update_guide
...............
So the document I am working on is the update guide, however, the snippet is coming from a legal_docs folder. This is why Flare insists on making a copy of it. I have the exact same problem when using images from my common images folder.

Why don't I just place all documents in one folder? I hope that isn't what you are asking. LOL
The reason I don't want to do that is because I do not want a long list of TOCs and Targets. It is already [almost] overwhelming in the User Guide hierarchy because each related document adds three targets each (web, PDF, and epub).

For over a year, I have argued that Flare should accommodate dynamic linking of resources across folders outside of the main project folder. At least ask me, do I want to link to an external resource or make a copy.
Shawn in Vancouver, Canada
Main tools used: Flare 11.x, InDesign, Google Docs, Lectora, Captivate.
Report bugs: https://www.madcapsoftware.com/feedback/bugs.aspx ▪ Feature requests: https://www.madcapsoftware.com/feedback ... quest.aspx[/i]
NorthEast
Master Propellus Maximus
Posts: 6426
Joined: Mon Mar 05, 2007 8:33 am

Re: Referencing a single sentence from a document for many other

Post by NorthEast »

If you want the snippet to automatically update in your projects when you change the original, then use a project import (global project linking) to include it (in each project), and set the project import to Auto-reimport before "Generate Output".

For example, each project might have a Legal project import, that gets that snippet (any anything else) from the legal_docs project.
sdcinvan
Propellus Maximus
Posts: 1260
Joined: Wed Aug 21, 2013 11:46 am
Location: Vancouver, Canada

Re: Referencing a single sentence from a document for many other

Post by sdcinvan »

whunter wrote:Not totally clear on why you are getting a copy of the snippet, so perhaps you can provide more detail on what you are doing that causes the copy?
I have since learned a little bit about Global Project Linking.... wish I would have known more about this a long time ago.

So, the correct way to get that Snippet is by:
Setting the different project folder's resources/snippets as an External Resource
View > External Resources > (add folder to external resources)
Then browse and select snippet (from the External Resources folder)
> right-click on snippet > copy to project > select "Keep file(s) synchronized (create mapping)".

Global project linking allows you to import content and project files contained in another Flare project, thus allowing you to maintain the information in one location but reuse it in any other project.

I am going to start using this process for all my documents.
Shawn in Vancouver, Canada
Main tools used: Flare 11.x, InDesign, Google Docs, Lectora, Captivate.
Report bugs: https://www.madcapsoftware.com/feedback/bugs.aspx ▪ Feature requests: https://www.madcapsoftware.com/feedback ... quest.aspx[/i]
sdcinvan
Propellus Maximus
Posts: 1260
Joined: Wed Aug 21, 2013 11:46 am
Location: Vancouver, Canada

Re: Referencing a single sentence from a document for many other

Post by sdcinvan »

Dave Lee wrote:If you want the snippet to automatically update in your projects when you change the original, then use a project import (global project linking) to include it (in each project), and set the project import to Auto-reimport before "Generate Output".

For example, each project might have a Legal project import, that gets that snippet (any anything else) from the legal_docs project.
Thanks Dave.

That is what I am doing now. I think this answers and solves a few grievances I have with Flare. Big shinny light experience! :D
Shawn in Vancouver, Canada
Main tools used: Flare 11.x, InDesign, Google Docs, Lectora, Captivate.
Report bugs: https://www.madcapsoftware.com/feedback/bugs.aspx ▪ Feature requests: https://www.madcapsoftware.com/feedback ... quest.aspx[/i]
Msquared
Propellus Maximus
Posts: 848
Joined: Mon Aug 06, 2012 10:19 am
Location: Southampton, UK

Re: Referencing a single sentence from a document for many other

Post by Msquared »

Oh Shawn - I see what you mean now. Global Project Linking is really Global Project Copying, isn't it? In an ideal world, I'd prefer not to have duplicates even if there is a clear re-import path, and one is nominated the master. But I've got a workflow that works, at last, so I guess I'll live with it.
Marjorie

My goal in life is to be as good a person as my dogs already think I am.
sdcinvan
Propellus Maximus
Posts: 1260
Joined: Wed Aug 21, 2013 11:46 am
Location: Vancouver, Canada

Re: Referencing a single sentence from a document for many other

Post by sdcinvan »

Msquared wrote:Oh Shawn - I see what you mean now. Global Project Linking is really Global Project Copying, isn't it? In an ideal world, I'd prefer not to have duplicates even if there is a clear re-import path, and one is nominated the master. But I've got a workflow that works, at last, so I guess I'll live with it.
Although I am relatively 'happy' with this new approach of using Global Project Linking, I am still troubled by two issues that are unique to Flare (compared to competitors):

1) Flare's insistence on making copies, of the master resource, into the local project folder. I know disk space is inexpensive but all these copies become more overwhelming as my projects expand. Can I trust Flare to always make the appropriate updates?
I would much rather Flare simply link to the master resource. I image maintenance is easier for everyone, this way!

2) Flare's use of absolute file paths, as opposed to relative file paths. This is fine as long as you never ever change drive letters or move content up/down a nested folder path.
What was the logic in using absolute file paths? This is a royal pain if I am taking work home (different drive letters). I know the 'work-around' is by using Export Project but unless there is an important technical reason, absolute paths do not make sense.
Shawn in Vancouver, Canada
Main tools used: Flare 11.x, InDesign, Google Docs, Lectora, Captivate.
Report bugs: https://www.madcapsoftware.com/feedback/bugs.aspx ▪ Feature requests: https://www.madcapsoftware.com/feedback ... quest.aspx[/i]
ToddPh
Sr. Propeller Head
Posts: 140
Joined: Wed Jan 30, 2013 2:41 pm
Location: Kirkland, Washington

Re: Referencing a single sentence from a document for many other

Post by ToddPh »

+1 for Choccie's method.

I keep a global project for my projects that contain everything that I would want to reuse in a standard project (stylesheet, snippets, variables, images, etc.), and then I import the elements into each project as I work on them. It can be a headache if the global content is changing as you need to remember to reimport, but now that I have things settled it really is easy to maintain.
Todd
Image
When puns are outlawed, only outlaws will have puns.
whunter
Sr. Propeller Head
Posts: 429
Joined: Thu Mar 12, 2009 4:49 pm
Location: Portland, OR

Re: Referencing a single sentence from a document for many other

Post by whunter »

I have since learned a little bit about Global Project Linking.... wish I would have known more about this a long time ago.

So, the correct way to get that Snippet is by:
Setting the different project folder's resources/snippets as an External Resource
View > External Resources > (add folder to external resources)
Then browse and select snippet (from the External Resources folder)
> right-click on snippet > copy to project > select "Keep file(s) synchronized (create mapping)".

Global project linking allows you to import content and project files contained in another Flare project, thus allowing you to maintain the information in one location but reuse it in any other project.
Just to clarify -- External Resources and Global Project Linking are different. I won't go into all the differences, but for example, when using External Resources the files do not need to be in a project. They can just be sitting in a folder somewhere. Also, you have to manually synchronize the files, there is no way to automatically synch them.

When using Global Project Linking, the files *have* to be in a Flare project, and you import them into other projects using Import files. You can configure the import so that it happens automatically when output is generated, so you don't have to remember to synchronize them.

I have done it both ways and there are pros and cons with both. I'm currently using External Resources because I'm a lone writer and I like the flexibility of being able to edit the file from wherever it is used and then push the change out (as opposed to GPL, where you have to edit the file in the source project and then reimport).
sdcinvan
Propellus Maximus
Posts: 1260
Joined: Wed Aug 21, 2013 11:46 am
Location: Vancouver, Canada

Re: Referencing a single sentence from a document for many other

Post by sdcinvan »

whunter wrote:
I have since learned a little bit about Global Project Linking.... wish I would have known more about this a long time ago.

So, the correct way to get that Snippet is by:
Setting the different project folder's resources/snippets as an External Resource
View > External Resources > (add folder to external resources)
Then browse and select snippet (from the External Resources folder)
> right-click on snippet > copy to project > select "Keep file(s) synchronized (create mapping)".

Global project linking allows you to import content and project files contained in another Flare project, thus allowing you to maintain the information in one location but reuse it in any other project.
Just to clarify -- External Resources and Global Project Linking are different. I won't go into all the differences, but for example, when using External Resources the files do not need to be in a project. They can just be sitting in a folder somewhere. Also, you have to manually synchronize the files, there is no way to automatically synch them.

When using Global Project Linking, the files *have* to be in a Flare project, and you import them into other projects using Import files. You can configure the import so that it happens automatically when output is generated, so you don't have to remember to synchronize them.

I have done it both ways and there are pros and cons with both. I'm currently using External Resources because I'm a lone writer and I like the flexibility of being able to edit the file from wherever it is used and then push the change out (as opposed to GPL, where you have to edit the file in the source project and then reimport).

Thank you for the clarification. I need to do some more reading. :)
Shawn in Vancouver, Canada
Main tools used: Flare 11.x, InDesign, Google Docs, Lectora, Captivate.
Report bugs: https://www.madcapsoftware.com/feedback/bugs.aspx ▪ Feature requests: https://www.madcapsoftware.com/feedback ... quest.aspx[/i]
Post Reply