Re: [ww-users] And another change, in the future

[Lee W. <wor...@gm...>]

Friends:

I've committed several changes to the WorkingWiki code.  One of them is 
important for site administrators to know about before you upgrade your 
wikis, and some of the others are important for wiki users as well.

1. For site administrators: from revision 873 on, the directory 
structure where the project files are stored is changed.  It will take 
care of moving the directories from the old locations on its own, but 
there is one exception: all your background jobs will be abandoned.  So 
you'll need to make sure everyone's background jobs are finished and 
merged or destroyed before you upgrade.

2. There are no more "implicit project descriptions".  What this means 
to you is mainly that certain pages that used to just work will now have 
warnings saying "Source file X does not belong to project Y.  Click here 
to add it to the project."  Since you may not want these messages to 
show on pages you show to the public, you'll want to look over those 
pages and fix these complaints.

3. Instead of ".latexml.xhtml" files we now use ".latexml.html5" files 
to display LaTeX documents in the wiki pages.  In most cases this is 
taken care of for you, but if you're explicitly asking for 
.latexml.xhtml files on certain pages (some people are), you'll need to 
switch to asking for .latexml.html5 instead.

4. When you save after editing and previewing, we used to do a slow 
process of comparing all the project files and copying the ones that 
were changed into the permanent project directory.  Now we just replace 
the permanent directory by the complete preview copy of the directory. 
This is massively faster.  But you should know about it, because if you 
remove files in the preview directory, they'll end up being removed in 
the permanent one.  I mention it because you might have gotten used to 
removing things during a preview without consequences.

There are details, and other changes, on 
http://lalashan.mcmaster.ca/theobio/projects/index.php/WorkingWiki/ChangeLog.

The new version of WorkingWiki is committed to the Subversion 
repository, and also uploaded to 
https://sourceforge.net/projects/workingwiki/files/ for admins who 
install from tarfiles.

As always, let me know if anything is puzzling or wrong.

LW

On 03/02/2012 05:16 PM, Lee Worden wrote:
> And secondly, a change in the internals of the system that I want to
> write about before it happens, to allow you to raise objections.
>
> We've been working out the bugs on out McMaster wikis on a change that
> reorganizes the cache directory where the project files are stored. This
> makes it easier for humans to navigate the cache files if needed, and
> removes some redundancy in the filenames.
>
> For the most part, changing to the new system will make no difference,
> as WW will silently move your files to their new locations as it comes
> across them.  The one exception is that existing background jobs will
> not be compatible with the new system, meaning that it won't recognize
> that they exist, and it won't be able to tell you their status or merge
> their files into the persistent project directories.
>
> In case you're wondering: background jobs are listed in a special box at
> the top of your wiki pages, and they have to be explicitly created by a
> user: unless you have a user who's making background jobs on purpose,
> you don't have any background jobs.  You can find out for sure by
> looking in your cache directory (the one that has a subdirectory called
> "persistent/") and seeing if it has any subdirectories whose names start
> with "background_".
>
> So you'll need to make sure all background jobs are merged or destroyed
> before updating your WW installation to the new source code.  I'm
> writing to find out whether that'll be a problem, and whether I should
> roll out the new code at a particular time.  Also, you should be warned,
> because there might be bugs in the code, and you should upgrade at a
> time when there's breathing room to discover and fix them, not like the
> day before a major deadline.
>
> Please let me know if you have any thoughts about that.  Otherwise I'll
> go ahead and make a decision.  Thanks!
> Lee