Remove Temporary Files Automatically

[Cal Wilson]

Is there a way to eliminate the saving of temporary files automatically.

Using Clean Project is not an option for reasons to lengthy to explain here.

After compiling a project, I see a number of files in C:ProjectName\Output\cwilson\TEMPORARY\ImageRightCHM.

I suspect there also temporary files related to web help which means there are two sets of temporary files (larger project size being the result).

What's the purpose of the files?

These files add unnecessary size to the project.

Is it okay to delete the files in TEMPORARY?

Is there a way to prevent the saving of these files and have them purged automatically after the project is built, viewed, or published?

Thanks in advance for assistance.

[SteveS]

I'm pretty certain the temp files are created when you preview a topic.

You should be able to delete the temp stuff (make a copy first if you don't want to take a chance) but all you are doing is manually cleaning the project.

[Msquared]

Yes, everything below /Output can be deleted with no ill effects. These files are regenerated when you build the outputs.

[Cal Wilson]

@SteveS

@ Msquared

Thanks for taking the time to reply. I appreciate your help.

It's good to know that I can clean the project manually and remove the temp files.

However, my question is actually, can the files be cleaned automatically?

I think the files should be removed automatically after a build process. At least there should be option that can be set if needed by someone.

The presence of the files affects the source control system that I use. If I forget to manually clean the project, add the project to source control, then the temp files are in source control increasing the overall project size needlessly. To remove the files from source control and the project afterward means more work. It's necessary to remove temp files every time the project is checked in, another unnecessary step.

So I am looking for a way to ensure the files are removed automatically so that the project is clean when added or checked in to source control without my manual intervention.

Any suggestions? I suspect this is yet another of Flare's shortcomings, i.e., not cleaning up automatically.

Thanks again.

[Msquared]

Depending on your source control system, you may be able to specify a list of files that are ignored at checkin.

We use Perforce, and my ignore list looks like this. Yours may look slightly different for another tool, but these are the files you probably want to include in the ignore list.

Code: Select all

# Perforce Ignore file for Flare projects

# Ignore all standard auto-generated Flare files 
Analyzer\*.*
FileSync\*.*
Output\*.*
Project\Reports\*.*
Project\Users\*.*
SourceControl\*.*

# Ignore any files with the ZZTEMP_ prefix
ZZTEMP_*

# Ignore the English (UK) dictionary. This one isn't used by the project but sometimes
# gets updated by mistake if the language isn't correctly set to English (US).
English (United Kingdom) Dictionary.mcdic

[Cal Wilson]

@Msquared,

I use Microsoft Source Safe. I will check with someone who knows more about Source Safe than I to see if an approach similar to yours would work.

Thanks again.

[atomdocs]

The temporary files are for performance. They are generated when you open topics in Flare, and when you build outputs. The temporary files from output seem to be what trigger the "Output is up-to-date" message if no files have changed. When I delete just the Temporary folder after a build I get an error on the next build, so they are probably doing something more important than just being temporary. Flare gives us the Clean Project option to manage this properly, and when using source control, these files/folders can be added to the exclude list. I don't think this is a shortcoming.

[Cal Wilson]

@atomdocs

Thanks for taking time to help!

Now it sounds as if the temp files shouldn't be deleted.

My understanding of all the functions of Microsoft SourceSafe is limited to a degree.

Can you help me by explaining how to exclude the files/folders form SourceSafe, i.e., add the files/folders to a SourceSafe exclude list?

Thanks again.

[atomdocs]

Hi Cal, no problem. Yes, I agree, I think that the temp files (if generated) are required to keep the Flare output environment present and correct while it is running. But I don't really know. I just know I got errors when I deleted just the temporary folder manually (and extrapolating, an auto-delete of just that folder will probably also generate an error).

My experience is with Subversion, not SourceSafe unfortunately. I found this link: http://msdn.microsoft.com/en-us/library/ms173809.aspx - but it only talks about files, I assume you need to exclude everything under Temporary, or even everything under Output. Do you have a system administrator that could help?

[Cal Wilson]

@atomdocs

Thanks for the link to the article.

I do have a system adminstrator that will help.

I will explore the possibilities.

Thanks again.

[SteveS]

..However, my question is actually, can the files be cleaned automatically?...

...Any suggestions? I suspect this is yet another of Flare's shortcomings, i.e., not cleaning up automatically...

Thanks again.

Bit harsh, Cal.

The clean project option is there to do that, although you indicate you can't use the function.

If you want a semi-automatic solution you can write a batch file or other script that you can run from outside of Flare to remove the folders.

Some of the other posts seems to allude to you using source control. Are you? If the extra files are generated outside of Flare then you will need to look at the software creating them.

Deleting temp files in Flare won't hurt, next time you preview the file will be recreated, taking a fraction of the time to create the entire project.

HTH

[NorthEast]

Did you bind the project to source safe using Flare?

Just I use Visual SourceSafe for some projects, and Flare doesn't actually include the temporary folder (or anything in the Output folder).

[Cal Wilson]

@SteveS

Before I continue, let me say that I value and appreciate all the help I receive in the forum.

I guess my comments did sound a bit harsh, and if anyone is offended, I apologize.

Now for some more detail that might help you understand my frustration.

I am converting a number of projects from RoboHelp (RH) to Flare.

I have been using and studying Flare for over a year, and I am still amazed at how much behind the scenes work is often needed to get a project completed (either new or imported). I suppose I am too comfortable with RH and Microsoft Office, applications in which typical users like me can find the options needed.

While Flare does offer a great deal of functionality, I am often digging my way out of a dark area because there are so many different ways to accomplish tasks, like defining styles, style classes, etc. As another example, I am just beginning to get a decent handle on the naming conventions used throughout Flare, for example, indentation in some places and padding in others, so there’s hope.

I also find myself wondering how much of the functionality the majority of writers use. Do the majority of writers work behind the scenes as opposed to using dialog boxes, etc? I suppose I could be in the minority.

Because I am very comfortable with the RH and Office approaches, which I am sure other people find not so good, when I can’t find the same or similar functionality in Flare, I am left scratching my head. And I know the toolsets are different, but I did say similar.

I am primarily a WYSIWYG writer. While my writing skills are strong, my technical skills related to HTML, XML, changing the code in a CSS, code, batch files, writing script and the like are lacking. So, when I learn that I have to work behind the scenes, it’s frustrating. In searching through the forum, I see that many suggestions relate to making changes behind the scenes. I submit that using an authoring tool shouldn’t require so much behind the scenes work, scripts, batch files, etc.

I suspect in time, that using Flare will become easier. I am just not there yet.

Now for some information regarding my dilemma with the temp files.

I don’t want to belabor the point by describing my workflow and how the presence of the temp file creates unnecessary work, concern, overhead, and file size.

I was simply hoping to find a way to handle something automatically within the Flare interface without adding undue overhead in the form of a batch file, script, or other similar approach.

I apologize again if I offended anyone.

I have to say one more time that I appreciate all the help I receive when I post questions. If it weren’t for people like you taking the time to help, I would still be struggling with a number of other issues.

[Msquared]

So, coming back to your temporary files . . .

Flare's folder structure does take a bit of getting used to, I agree.

If you build a target <targetname>, you should find everything you require for that target below C:ProjectName\Output\<yourname>\<targetname>. This applies for any sort of target. So when you publish a target, you should never need to include any of the temporary files, just the files below the target folder. And those temporary files don't need to be stored with the project source in source control either, as they are always regenerated as Flare requires them.

I don't store any of my target outputs in source control - they are built automatically as part of our build system which builds our software. If you do need to store your targets in source control, then they are really quite a different sort of beastie from the project sources, so would normally be stored in an output area, rather than the source area (where your project source files would belong).

If you look at it like this, you may see that

• files below /Project and /Content are your sources (except /Project/Users, which is another set of temporary files), which you and other tech authors need read/write access to.
• files below /Output/<yourname>/<targetname> are the generated files which anyone who reads your content needs read-only access to, but they almost certainly won't want to access them where Flare puts them, in a folder local to you in the middle of your working project.
• all other files (including /Analyzer, /Output/username/Temporary, /Filesync, /Source Control are working files that are local to your use of Flare on your PC

The first lot go in source control, the second lot go wherever your outputs need to go (Flare does provide a Publish option when you build, which takes the stuff you have built locally and publishes it to wherever your outputs belong for everyone to access them). The third lot is just what you need while you're using Flare and doesn't need to be saved anywhere, ever.

So, rather than looking at saving your whole project in one place, then having the grief of getting rid of lots of unnecessary files, could you look at just saving the two bits you do need, the sources, and the output targets? Would that help?

[Cal Wilson]

@Msquared

Thanks for the idea. I just might be able to work with this. I will have to be selective when I first add the project to SourceSafe, but I think subsequent check ins/outs will only affect what I added initially (added files not included the temp files).

Thanks again.

[SteveS]

@SteveS

Before I continue, let me say that I value and appreciate all the help I receive in the forum.

I guess my comments did sound a bit harsh, and if anyone is offended, I apologize...

No offence taken!

[Cal Wilson]

@Msquared

Can you spare some time for one more question?

I have tried your approach, and I think it will accomplish my goals.

Do you see anything wrong with my approach of adding the name.flprj to source control as noted below? The approach seems to be working, but I thought you might see a problem.

Here’s what I did for anyone who might be trying to keep temporary files out of source control.

I created a SourceSafe project (a target) to contain the Flare project.
I added the Project and Content folders to the target and was sure to select Recursive to get all the subfolders. This created the folders and their subfolders in the SS target.

I added the name.flprj to the SS target (not in the Project or Content folder). This ensures that the .flprj is available if I need to get the latest version from SS to make a copy of an existing project.

If the .flprj is not added also, it won’t be available when I get latest for a copy. Without the .flprj, I couldn’t find a way to open the copy of the project.

I am also guessing that the .flprj must be versioned to ensure it is compatible with the items in the Project and Content folders, but perhaps not.

Thanks

[Msquared]

You are quite correct - you will definitely need the .flprj file in source control. Sorry I didn't think to mention that.

You probably don't want /Project/Users or /Project/Reports though.

[NorthEast]

Is there any reason why you're not binding the project to SourceSafe using Flare? You don't have to do anything manually in SourceSafe itself.

If you bind the projects from Flare, it will include all the necessary files, and not include temporary files, etc.

[Cal Wilson]

@Dave Lee

Thanks for the suggestion. I have tried binding within Flare, and your approach seems to also produce the desired results.

Thanks for the taking the time to reply.