[daisy] Search and replace

[Bruno Dumon]

Hi Karel,

On Thu, 2008-04-24 at 11:52 +0200, Karel Vervaeke wrote:
> Dear list,
> 
> as you who read the commit messages have picked up, I have just merged
> the search and replace branch to trunk.
> 
> To get an idea of what looks like, check the documentation:
> http://cocoondev.org/daisydocs-2_3/374-cd/602-cd.html
> 
> Feedback is always welcome.

I have some feedback on the docs:

* a more explicit description of what 'case sensible' search and replace
is would be helpful.

* I would also give some more information about the regex search and
replace:
    - what regex language is being used + link to docs (i.e. link to
Pattern javadoc)
    - mention that replacement string supports back-references, and what
characters require escaping (\ and $). Maybe include the example Marc
gave in the office of appending "TM" to a product name.

* mention that it is based on document tasks (with link to doctasks
docs). This also helps answering questions like: what if I accidently
close my browser window during search-and-replace? What if the
repository was restarted while a search-and-replace operation was
running?

* I assume the search and replace happens in the last version, though
it's not explicitely mentioned (one might think it depends on the
query). In this light, maybe also mention the limitations of starting
from a fulltext query (works on filtered content of live versions)

* for the newly created version, mention what's done with version mode,
version comment and change type (if anything)

* some details on the search and replace within HTML documents would be
interesting: is it smart enough to find words if there are tags embedded
in them, what if tags partly overlap the searched string, ...

I'd keep the current run-through sample light, and add these extra
details in a second section (if you have time and find them useful).

Now that I think of it, it might also be useful to search without
replacing. This is possible right now, but it might be confusing since
the replace string is required.

-- 
Bruno Dumon                             http://outerthought.org/
Outerthought                            http://www.daisycms.org/
bruno at outerthought.org              http://www.kauriproject.org/