Volunteer to write new Chapter on Python Function Replace for Sigil User Guide

[KevinH]

Hi @Turtle91 and All,

I am kind of hoping once this gets into final form, that some kind soul will volunteer to create a new chapter documenting it for our Sigil User's Guide - hint, hint, Turtle91 ... cough cough.

Well that time has come and I am looking for a volunteer or volunteers to create a new "Advanced Search - Python Function Replace" chapter that documents the new Sigil Python Function Replace tool that was available in the Betas (which can be used for screenshots) and will be available in the upcoming Sigil 2.5.0 release (real soon now!).

Please warn users as this is a very advanced techniques that requires knowledge of the Python programming language, regular expressions, etc.

Please include the screen caps to make it clear how to use it, when to use it, etc. And please document the new debug log file environment variable to capture debug output when trying to debug your python function.
And maybe include a simple trivial example.

If this is something you are willing to take a shot at, please let me know. If multiple people are interested we can use this thread to share xhtml source and screencaps.

Please use the styles already defined in the Sigil User Guide.

And when final, please make sure it passes epubcheck.

Thanks!

Kevin

[Turtle91]

Oh dang! I completely forgot about volunteering for this after my hard drive crash, and the (literal) train wreck. I’ll need to download the beta again.

[KevinH]

No rush. The user's guide update can come after the new Sigil release too.

[Turtle91]

Workin it...

Question though:
Is the function result referenceable in the replace field?

If I enter the find field with a normal search and use the regex function (as below) the function works, replacing the grouped section with the function result.

<h2>SUPER DUPER</h2>

returns

<h2>Super Duper</h2>

However, if I try and add any string before or after it in the replace field it simply treats the function as a string.

<h2>SUPER DUPER</h2>

returns

<h3>\F<titlecase_ignore_tags></h3>

Is there a way to treat the returned value like a normal \1 in the replace field so we can adjust the string around the function result?

Something like:

Replace: <h3>\1:F<titlecase_ignore_tags></h3>

to achieve

<h3>Super Duper</h3>

[KevinH]

No the function replace is the only thing specified in the replace field. It is not a substring replacement, it is a function doing the replacement.

All search match groups are provided to your function. So you get the entire string that was matched, plus all of the values for each match group to use as you see fit in your function.

So can use your own python code to replace anything you want with anything you want. You can build the entire replacement value. You just can not try to squeeze it into the replace field, your function should handle that.

[Turtle91]

okay. thanks!