Minimum files to upload after a single topic change

This forum is for discussions on the Help & Manual Premium Pack and the Premium Pack Toolbox configuration utility introduced with Premium Pack 3

Moderators: Alexander Halser, Tim Green

Minimum files to upload after a single topic change

Unread postby Mark Wilsdorf » Wed Aug 02, 2017 10:42 pm

I maintain a Web site with H&M. Sometimes I need to make only a minor change to one or a couple pages, publish WebHelp locally, then refresh the copy on the site via FTP.

My question: supposing I don't care about having the changed page(s) included in the site's index, what are the minimum files I would have to upload to get the change reflected in the site? Just the main HTML file and its corresponding /jstopics/*.js file?

(Sorry if this isn't specifically a PP topic, but I wondered if output might be affected in this regard by using a PP skin.)
Mark Wilsdorf
 
Posts: 105
Joined: Thu Dec 24, 2009 8:41 pm

Re: Minimum files to upload after a single topic change

Unread postby Tobias Escher » Thu Aug 03, 2017 9:33 am

I'm wondering the same.
I have found that I always need to re-upload everything, otherwise there are wrong pages, etc...
There seem to be multiple cache files, etc.
Tobias Escher
 
Posts: 181
Joined: Mon Dec 28, 2015 7:32 pm

Re: Minimum files to upload after a single topic change

Unread postby Tim Green » Thu Aug 03, 2017 10:56 am

As so often, the answer here is "it depends". Here are some basic rules of thumb:

  • If you change or update the skin you are using, it's best to upload everything.
  • If you add new topics or make changes in the TOC, it's best to upload everything.
  • If you update Help+Manual itself, it's best to upload everything.
  • If you only make changes in individual topics and nowhere else, then you may be able to get away with uploading the corresponding HTML and jstopics files and all the zoom search files (the search index changes whenever you change anything).
The bottom line is, if you have a fast upstream, it's always easiest and most reliable to upload everything. There are no "cache" files as such, but there is a lot of interrelation. :?
Regards,
Tim (EC Software Documentation & User Support)

Private support:
Please do not email or PM me with private support requests -- post to the forum directly.
User avatar
Tim Green
Site Admin
 
Posts: 19414
Joined: Mon Jun 24, 2002 9:11 am
Location: Bruehl, Germany

Re: Minimum files to upload after a single topic change

Unread postby Tim Frost » Thu Aug 03, 2017 11:09 am

I use the invaluable Beyond Compare utility from scootersoftware.com to upload to our website, configured to display only "orphans and newer" files on my machine, compared against the (FTP) files on the website, with the folder structure maintained. I think it would be harder to replicate this safely if I did FTP uploads manually.

To make it work, I need to keep to the following simple rules.

1. Make no new help changes between building the help and uploading. Our web server sets the file time to the time of upload.

2. Make sure that H&M is set to transfer the timestamp of the source to the destination. This has to be done in the PP skin as well as in the main project.

3. In our case, one topic shows a version number from a variable held in a file, which gets updated on each build: so in our Finalbuilder project I 'touch' the timestamp of the XML file for this topic (which rarely needs editing otherwise) before the help build, to ensure that its HTML file gets a new timestamp.

4. Set Beyond Compare to ignore the file sizes: they are always different because the upload changes the end-of-line sequences.

After this it is only necessary to open the Beyond Compare saved task and copy everything visible as unmatched or newer from the left to the right, which usually takes under a minute, most of which is uploading new index files. Never had a problem yet. I only ever need to re-upload everything after an H&M upgrade, or if I make a style change or other change which is clearly going to affect all topics. Beyond Compare is very affordable and has a demo version available.
Tim Frost
 
Posts: 212
Joined: Mon Nov 22, 2004 11:45 pm

Re: Minimum files to upload after a single topic change

Unread postby Mark Wilsdorf » Thu Aug 03, 2017 3:36 pm

Tim & Tim,

Thanks to you both.
Mark Wilsdorf
 
Posts: 105
Joined: Thu Dec 24, 2009 8:41 pm


Return to Premium Pack and PP Toolbox

Who is online

Users browsing this forum: No registered users and 1 guest