Skip to content

Commit 0adfdb3

Browse files
committed
docs: layout specifix collage frames & backgrounds
Change-Id: I0a4add8906d495cf649fdd3fa2f07567e8b1d047
1 parent c06a1ae commit 0adfdb3

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

docs/faq/custom-collage.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,3 +129,74 @@ Notes:
129129
- `placeholder` uses `placeholderpath` at `placeholderposition`.
130130

131131
Single framed images only work when `apply_frame` is `always`.
132+
133+
## Collage Frames and Backgrounds: Name Changes
134+
135+
This guide explains how layout-specific frames and backgrounds are applied automatically if they exist. The system supports **default templates** with specific layout prefixes.
136+
137+
---
138+
139+
### How Name Changes Work
140+
141+
When you select a collage layout, the system looks for **layout-specific files**:
142+
143+
- **Frames:** `<layout>_<frame_filename>`
144+
- **Backgrounds:** `<layout>_<background_filename>`
145+
146+
If the layout-specific file exists, it replaces the default. If it does **not exist**, the system uses the default file.
147+
148+
**Example:**
149+
150+
- Default frame: `basic.png`
151+
- Layout: `1+2-1`
152+
- System checks for: `1+2-1_basic.png`
153+
- If exists → used automatically
154+
- If not → falls back to `basic.png`
155+
156+
---
157+
158+
### Supported Layout Prefixes / Default Templates
159+
160+
The following prefixes can be used when naming layout-specific frame or background files (based on default available templates):
161+
162+
- `1+2-1`
163+
- `1+3-1`
164+
- `1+3-2`
165+
- `2+1-1`
166+
- `2+2-1`
167+
- `2+2-2`
168+
- `2x3-1`
169+
- `2x3-2`
170+
- `2x4-1`
171+
- `2x4-2`
172+
- `2x4-3`
173+
- `2x4-4`
174+
- `3+1-1`
175+
- `collage`
176+
177+
---
178+
179+
### User Guidelines
180+
181+
1. **Upload layout-specific files** using the pattern: `<layout>_<filename>`
182+
Example: `2+2-1_frame.png` or `2+4-2_background.jpg`
183+
184+
2. **Keep default files** in place for fallback.
185+
Example: `frame.png`, `background.jpg`
186+
187+
3. **Automatic selection:**
188+
- When a layout is selected, the system checks if a layout-specific file exists.
189+
- If it exists, it replaces the default automatically.
190+
- If not, the default is used.
191+
192+
---
193+
194+
#### Example Workflow
195+
196+
| Selected Layout | Default Frame | Layout-Specific Frame Used |
197+
|-----------------|---------------|---------------------------|
198+
| `2+2-1` | `basic.png` | `2+2-1_basic.png` |
199+
| `2x4-2` | `basic.png` | `2x4-2_basic.png` |
200+
201+
- Backgrounds follow the **same naming convention**.
202+
Example: `2x3-1_white.png` replaces `white.png` if it exists.

0 commit comments

Comments
 (0)