|
112 | 112 | </li> |
113 | 113 | <li class="toctree-l2"><a class="reference internal" href="#extended-collage-object-v499">Extended collage object (v4.99+)</a> |
114 | 114 | </li> |
| 115 | + <li class="toctree-l2"><a class="reference internal" href="#collage-frames-and-backgrounds-name-changes">Collage Frames and Backgrounds: Name Changes</a> |
| 116 | + <ul> |
| 117 | + <li class="toctree-l3"><a class="reference internal" href="#how-name-changes-work">How Name Changes Work</a> |
| 118 | + </li> |
| 119 | + <li class="toctree-l3"><a class="reference internal" href="#supported-layout-prefixes-default-templates">Supported Layout Prefixes / Default Templates</a> |
| 120 | + </li> |
| 121 | + <li class="toctree-l3"><a class="reference internal" href="#user-guidelines">User Guidelines</a> |
| 122 | + <ul> |
| 123 | + <li class="toctree-l4"><a class="reference internal" href="#example-workflow">Example Workflow</a> |
| 124 | + </li> |
| 125 | + </ul> |
| 126 | + </li> |
| 127 | + </ul> |
| 128 | + </li> |
115 | 129 | </ul> |
116 | 130 | </li> |
117 | 131 | <li class="toctree-l1"><a class="reference internal" href="../kiosk-mode/">Kiosk mode</a> |
@@ -290,6 +304,94 @@ <h2 id="extended-collage-object-v499">Extended collage object (v4.99+)</h2> |
290 | 304 | <li><code>placeholder</code> uses <code>placeholderpath</code> at <code>placeholderposition</code>.</li> |
291 | 305 | </ul> |
292 | 306 | <p>Single framed images only work when <code>apply_frame</code> is <code>always</code>.</p> |
| 307 | +<hr /> |
| 308 | +<h2 id="collage-frames-and-backgrounds-name-changes">Collage Frames and Backgrounds: Name Changes</h2> |
| 309 | +<p>This guide explains how layout-specific frames and backgrounds are applied automatically if they exist. The system supports <strong>default templates</strong> with specific layout prefixes.</p> |
| 310 | +<h3 id="how-name-changes-work">How Name Changes Work</h3> |
| 311 | +<p>When you select a collage layout, the system looks for <strong>layout-specific files</strong>:</p> |
| 312 | +<ul> |
| 313 | +<li><strong>Frames:</strong> <code><layout>_<frame_filename></code></li> |
| 314 | +<li><strong>Backgrounds:</strong> <code><layout>_<background_filename></code></li> |
| 315 | +</ul> |
| 316 | +<p>If the layout-specific file exists, it replaces the default. If it does <strong>not exist</strong>, the system uses the default file.</p> |
| 317 | +<p><strong>Example:</strong></p> |
| 318 | +<ul> |
| 319 | +<li>Default frame: <code>basic.png</code></li> |
| 320 | +<li>Layout: <code>1+2-1</code></li> |
| 321 | +<li>System checks for: <code>1+2-1_basic.png</code><ul> |
| 322 | +<li>If exists → used automatically</li> |
| 323 | +<li>If not → falls back to <code>basic.png</code></li> |
| 324 | +</ul> |
| 325 | +</li> |
| 326 | +</ul> |
| 327 | +<hr /> |
| 328 | +<h3 id="supported-layout-prefixes-default-templates">Supported Layout Prefixes / Default Templates</h3> |
| 329 | +<p>The following prefixes can be used when naming layout-specific frame or background files (based on default available templates):</p> |
| 330 | +<ul> |
| 331 | +<li><code>1+2-1</code></li> |
| 332 | +<li><code>1+3-1</code></li> |
| 333 | +<li><code>1+3-2</code></li> |
| 334 | +<li><code>2+1-1</code></li> |
| 335 | +<li><code>2+2-1</code></li> |
| 336 | +<li><code>2+2-2</code></li> |
| 337 | +<li><code>2x3-1</code></li> |
| 338 | +<li><code>2x3-2</code></li> |
| 339 | +<li><code>2x4-1</code></li> |
| 340 | +<li><code>2x4-2</code></li> |
| 341 | +<li><code>2x4-3</code></li> |
| 342 | +<li><code>2x4-4</code></li> |
| 343 | +<li><code>3+1-1</code></li> |
| 344 | +<li><code>collage.json</code></li> |
| 345 | +</ul> |
| 346 | +<hr /> |
| 347 | +<h3 id="user-guidelines">User Guidelines</h3> |
| 348 | +<ul> |
| 349 | +<li><strong>Upload layout-specific files</strong> using the pattern: <code><layout>_<filename></code><ul> |
| 350 | +<li>Example: <code>2+2-1_frame.png</code> or <code>2+4-2_background.jpg</code> or <code>collage.json_background.jpg</code></li> |
| 351 | +</ul> |
| 352 | +</li> |
| 353 | +<li><strong>Keep default files</strong> in place for fallback.<ul> |
| 354 | +<li>Example: <code>frame.png</code>, <code>background.jpg</code></li> |
| 355 | +</ul> |
| 356 | +</li> |
| 357 | +<li><strong>Automatic selection:</strong><ul> |
| 358 | +<li>When a layout is selected, the system checks if a layout-specific file exists.<ul> |
| 359 | +<li>If it exists, it replaces the default automatically.</li> |
| 360 | +<li>If not, the default is used.</li> |
| 361 | +</ul> |
| 362 | +</li> |
| 363 | +</ul> |
| 364 | +</li> |
| 365 | +</ul> |
| 366 | +<hr /> |
| 367 | +<h4 id="example-workflow">Example Workflow</h4> |
| 368 | +<table> |
| 369 | +<thead> |
| 370 | +<tr> |
| 371 | +<th>Selected Layout</th> |
| 372 | +<th>Default Frame</th> |
| 373 | +<th>Layout-Specific Frame Used</th> |
| 374 | +</tr> |
| 375 | +</thead> |
| 376 | +<tbody> |
| 377 | +<tr> |
| 378 | +<td><code>2+2-1</code></td> |
| 379 | +<td><code>basic.png</code></td> |
| 380 | +<td><code>2+2-1_basic.png</code></td> |
| 381 | +</tr> |
| 382 | +<tr> |
| 383 | +<td><code>2x4-2</code></td> |
| 384 | +<td><code>basic.png</code></td> |
| 385 | +<td><code>2x4-2_basic.png</code></td> |
| 386 | +</tr> |
| 387 | +</tbody> |
| 388 | +</table> |
| 389 | +<ul> |
| 390 | +<li>Backgrounds follow the <strong>same naming convention</strong>.<ul> |
| 391 | +<li>Example: <code>2x3-1_white.png</code> replaces <code>white.png</code> if it exists.</li> |
| 392 | +</ul> |
| 393 | +</li> |
| 394 | +</ul> |
293 | 395 |
|
294 | 396 | </div> |
295 | 397 | </div><footer> |
|
0 commit comments