Inline image and lightbox template files #84

pierresaramito · 2023-03-02T17:57:52Z

Hi all !

In brief:

support for optional "inline_image.html" and "image_lightbox.html" templates
SITEURL is now replaced in all "inline_*.html" templates

In order to increase the flexibility of inline images and lightboxes,
I've introduced two template file provided by default as:
PHOTO_INLINE_IMAGE_TEMPLATE = "inline_image.html"
PHOTO_INLINE_LIGHTBOX_TEMPLATE = "image_lightbox.html"
Indeed, these two files was suggested in the photos.py code,
but not used in practice: perhaps it was planed for future works?
This is now achieved and the README.md doc is completed accordingly.

Also, the SITEURL variable was not propagated in "inline_gallery.html"
ind thus, it was complicated to compute full path files.
Now, SITEURL is propagated in this template file
and, moreover, it honors the RELATIVE_URLS variable from pelicanconf.py:
when RELATIVE_URLS is True, then SITEURL is propagated as ".".

Pirogh [email protected]

…date

pierresaramito · 2023-03-09T19:08:53Z

Hi all !

Yet another new patch, in brief:

the PHOTO_INLINE_GALLERY_PATTERN python regex also define an "options"
dict that is transmitted to the inline_gallery.html template file

Both this patch and the previous one are 100% backward-compatible.

In order to increase the flexibility of inline galleries,
I've introduced an optional "options" in the
PHOTO_INLINE_GALLERY_PATTERN python regex. When detected, the
options are transmitted to the inline_gallery.html file as
a python dict of pairs of key-value.

Hope you will enjoy it!

Pirogh [email protected]

pierresaramito · 2023-03-26T11:12:44Z

Hi all !

Is there somebody alive here ?

Pierre

pierresaramito · 2023-04-01T19:39:01Z

re-open, hope that something new could happen ?

Ockenfuss · 2023-05-03T09:47:05Z

@pierresaramito I am a user of this plugin and have the problem, that the SITEURL is not substituted in inline_gallery.html. I guess this is a bug, which is fixed by your PR? The other features you included look pretty amazing to me as well!

Unfortunately, I don't know if this repo is still alive (would be very sad if not!). Have you opened an issue regarding the bugs you fixed? Maybe this will create some attention and document the currently existing bugs. Let`s hope it will be merged soon!

Paul

Ockenfuss · 2023-06-01T13:23:58Z

I opened an issue for this now: #87

offbyone

There are a few small things that should change before landing this, but by and large this looks solid.

if you can, some tests for the options parser would be awesome.
tests for the template loader aren't a bad idea either.
log when templates can't be loaded please

offbyone · 2023-10-29T15:45:46Z

README.md

@@ -220,6 +223,162 @@ For example, add the following to the template `index.html`, inside the `entry-c
 {% endif %}
 ```

+## The new optional templates files for inline galleries, images and lightboxes


Suggested change

## The new optional templates files for inline galleries, images and lightboxes

## Optional templates files for inline galleries, images and lightboxes

offbyone · 2023-10-29T15:46:09Z

README.md

+
+The template file to render inline galleries is loaded.
+The name of this file is by default ``"inline_gallery.html"```
+and could be changed with the  `PHOTO_INLINE_GALLERY_TEMPLATE`  variable.


Suggested change

and could be changed with the `PHOTO_INLINE_GALLERY_TEMPLATE` variable.

and can be changed with the `PHOTO_INLINE_GALLERY_TEMPLATE` variable.

offbyone · 2023-10-29T15:47:46Z

README.md

+</div>
+```
+
+The ``options`` variable is a python ``dict``:


Suggested change

The ``options`` variable is a python ``dict``:

The ``options`` variable is a python ``dict[str,Union[str,bool]]``:

offbyone · 2023-10-29T15:49:31Z

README.md

+When there is no explicit value, the value is a ``bool``, set to ``True``.
+When the value is explicitely ``False``, it is also converted to ``bool``,
+otherwise it is left as a ``string``.
+


It would be helpful to list the context variables available to the template here, the way you've done for the image template, below.

offbyone · 2023-10-29T15:50:22Z

pelican/plugins/photos/photos.py

+            gallery_name = m.group("gallery_name")
+            options_strg = m.group("options")
+            options = {}
+            if options_strg is not None:
+                options_list = re.compile(r"[\^,]+").split(options_strg)
+                r_pair = re.compile(r"(?P<variable>\w+)=(?P<value>\w+)")
+                r_flag = re.compile(r"(?P<flag>\w+)")
+                for opt in options_list:
+                    m_pair = r_pair.match(opt)
+                    m_flag = r_flag.match(opt)
+                    if m_pair:
+                        d = m_pair.groupdict()
+                        value = d["value"]
+                        # convert string to bool when possible
+                        if value == "True":
+                            value = True
+                        elif value == "False":
+                            value = False
+                        options[d["variable"]] = value
+                    elif m_flag:
+                        d = m_flag.groupdict()
+                        options[d["flag"]] = True
+                    else:
+                        logger.error(
+                            f"unexpected inline gallery <options> = {options_strg}"
+                        )


Can you split this parsing out into a function? It would be easier to test (and if you put a test in for it, that'd be grand, too)

offbyone · 2023-10-29T15:51:20Z

pelican/plugins/photos/photos.py

+        except Exception:
+            template = None


In this case at least please log a warning or error about the issue, rather than silently bailing.

offbyone · 2023-10-29T15:52:32Z

pelican/plugins/photos/photos.py

                    )
-                ),
+                lightbox_attrs = " ".join(lightbox_attr_list)
+                content._content = content._content.replace(


I gotta wonder... would it make sense to define these as template strings in the package somewhere, and then just have one path through here (if a template is set, load it, otherwise load the default template, and then render them both)?

justinmayer · 2024-02-03T07:47:17Z

Hi Pierre. Thanks for submitting this pull request. Could you take a moment to address the feedback that @offbyone provided so we can get your contribution merged?

justinmayer · 2024-03-02T16:38:38Z

Hi Pierre. Just checking in about your contribution. What do you think?

phibos · 2024-03-05T21:30:56Z

I do not recommend merging this PR because it has some drawbacks.

Use deprecated gallery include

First of all it tries to improve a deprecated feature, the 'gallery' pattern. If the galleries are included into a page or article in the old way, like in the example below.

gallery::name_of_the_gallery

The markdown parser adds a <p> tag around the pattern. So the result will look like.

<p>gallery::name_of_the_gallery</p>

In the next step the photos plugin replaces the gallery pattern with the inline gallery template. This will result in a gallery inside a <p> tag.

<p>
    <div class="my-gallery">
        <ul>
            <li><img src=""/></li>
            <li><img src=""/></li>
        </ul>
    </div>
</p>

This might result in structural issues in the browser. Also if the photos plugin can't find the gallery it will result in the gallery pattern displayed on the output.

<p>gallery::name_of_the_gallery</p>

New pattern

Just use the pattern introduced in version 1.1.0

<div gallery="name_of_the_gallery"></div>

This pattern is not modified by the markdown parser and the photos plugin can replace it with the correct inline gallery template.

<div class="my-gallery">
    <ul>
        <li><img src=""/></li>
        <li><img src=""/></li>
    </ul>
</div>

If something went wrong and the photos plugin can't find the gallery. The div tag is still present in the output but won't be visible for your readers.

Additional parameters

By default PHOTO_INLINE_PARSE_HTML is set to true. See the example below.

<div gallery="name_of_the_gallery" profile="profile_name" additional_attribute="test123"></div>

This will use the inline_gallery template and the image profile from your settings. Also this will make the attribute additional_attribute available in the template as {{ html_attributes.additional_attributes }}

Inline Gallery, Image or lightbox

Just use one of the patterns.

<div gallery="name_of_the_gallery"></div>
<div image="image.jpg"></div>
<div lightbox="name_of_the_gallery"></div>

You can provide additional attributes/values by following the instructions from the additional parameters example.

pierresaramito added 4 commits March 2, 2023 18:17

Add optional inline_image.html and inline_lightbox.html

f1406b6

README.md : documentation fix

57e6970

photo.py: add exf in inline_xxx.html substitution + README.mds doc up…

1e93cfe

…date

Add "options" to PHOTO_INLINE_GALLERY_PATTERN

015435b

pierresaramito closed this Apr 1, 2023

pierresaramito reopened this Apr 1, 2023

Ockenfuss mentioned this pull request Jun 1, 2023

SITEURL not replaced in inline_gallery.html #87

Closed

justinmayer requested a review from phibos October 29, 2023 08:44

offbyone reviewed Oct 29, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Inline image and lightbox template files #84

Inline image and lightbox template files #84

pierresaramito commented Mar 2, 2023

pierresaramito commented Mar 9, 2023

pierresaramito commented Mar 26, 2023

pierresaramito commented Apr 1, 2023

Ockenfuss commented May 3, 2023 •

edited

Loading

Ockenfuss commented Jun 1, 2023

offbyone left a comment

offbyone Oct 29, 2023

offbyone Oct 29, 2023

offbyone Oct 29, 2023

offbyone Oct 29, 2023

offbyone Oct 29, 2023

offbyone Oct 29, 2023

offbyone Oct 29, 2023

justinmayer commented Feb 3, 2024

justinmayer commented Mar 2, 2024

phibos commented Mar 5, 2024

	## The new optional templates files for inline galleries, images and lightboxes
	## Optional templates files for inline galleries, images and lightboxes

	and could be changed with the `PHOTO_INLINE_GALLERY_TEMPLATE` variable.
	and can be changed with the `PHOTO_INLINE_GALLERY_TEMPLATE` variable.

	The ``options`` variable is a python ``dict``:
	The ``options`` variable is a python ``dict[str,Union[str,bool]]``:

Inline image and lightbox template files #84

Are you sure you want to change the base?

Inline image and lightbox template files #84

Conversation

pierresaramito commented Mar 2, 2023

pierresaramito commented Mar 9, 2023

pierresaramito commented Mar 26, 2023

pierresaramito commented Apr 1, 2023

Ockenfuss commented May 3, 2023 • edited Loading

Ockenfuss commented Jun 1, 2023

offbyone left a comment

Choose a reason for hiding this comment

offbyone Oct 29, 2023

Choose a reason for hiding this comment

offbyone Oct 29, 2023

Choose a reason for hiding this comment

offbyone Oct 29, 2023

Choose a reason for hiding this comment

offbyone Oct 29, 2023

Choose a reason for hiding this comment

offbyone Oct 29, 2023

Choose a reason for hiding this comment

offbyone Oct 29, 2023

Choose a reason for hiding this comment

offbyone Oct 29, 2023

Choose a reason for hiding this comment

justinmayer commented Feb 3, 2024

justinmayer commented Mar 2, 2024

phibos commented Mar 5, 2024

Use deprecated gallery include

New pattern

Additional parameters

Inline Gallery, Image or lightbox

Ockenfuss commented May 3, 2023 •

edited

Loading