ساختار (Structure)

برای ساخت پوسته خود، باید ساختار زیر را رعایت کنید:

├── static
│   ├── css
│   └── images
└── templates
    ├── archives.html         // to display archives
    ├── article.html          // processed for each article
    ├── author.html           // processed for each author
    ├── authors.html          // must list all the authors
    ├── categories.html       // must list all the categories
    ├── category.html         // processed for each category
    ├── index.html            // the index (list all the articles)
    ├── page.html             // processed for each page
    ├── period_archives.html  // to display time-period archives
    ├── tag.html              // processed for each tag
    └── tags.html             // must list all the tags. Can be a tag cloud.

متغیرهای رایج (Common Variables)

تمام این تنظیمات برای همه قالب‌ها در دسترس خواهند بود.

هر فراداده‌ای که در سرآیند فایل منبع مقاله قرار دهید، به عنوان فیلدهایی روی شیء article در دسترس خواهد بود. نام فیلد همان نام فیلد فراداده خواهد بود، با این تفاوت که تمام نویسه‌ها به حروف کوچک تبدیل می‌شوند.

برای نمونه، می‌توانید فیلدی به نام FacebookImage به فراداده‌های مقالهٔ خود اضافه کنید، همان‌طور که در زیر نشان داده شده است:

Title: I love Python more than music
Date: 2013-11-06 10:06
Tags: personal, python
Category: Tech
Slug: python-je-l-aime-a-mourir
Author: Francis Cabrel
FacebookImage: http://franciscabrel.com/images/pythonlove.png

این فرادادهٔ جدید به عنوان article.facebookimage در قالب article.html شما در دسترس خواهد بود. این کار به شما امکان می‌دهد، به عنوان مثال، تصویری را برای برچسب‌های Open Graph فیس‌بوک تعیین کنید که برای هر مقاله تغییر می‌کند:

<meta property="og:image" content="{{ article.facebookimage }}"/>

page.html

این قالب برای هر برگه پردازش خواهد شد و خروجی مطابق با تنظیم PAGE_SAVE_AS (پیش‌فرض: pages/{slug}.html) تولید می‌شود. متغیرهای زیر هنگام رندر کردن در دسترس هستند.

می‌توانید نمونه‌ای از نحوه استفاده از period را در قالب period_archives.html پوسته "simple" مشاهده کنید: https://github.com/getpelican/pelican/blob/main/pelican/themes/simple/templates/period_archives.html.

فهرست‌بندی و پیوند دادن به آرشیوهای دوره‌ای (Listing and Linking to Period Archives)

متغیر period_archives می‌تواند برای تولید فهرستی از پیوندها به مجموعه آرشیوهای دوره‌ای که Pelican می‌سازد استفاده شود. این متغیر به عنوان یک متغیر عمومی در تمام قالب‌ها در دسترس است، بنابراین می‌توانید چنین فهرستی را در یک قالب مستقیم (direct template) سفارشی یا در یک نوار کناری که در صفحات مختلف سایت نمایش داده می‌شود، پیاده‌سازی کنید.

متغیر period_archives یک دیکشنری (dict) است که بسته به فعال بودن تنظیمات *_ARCHIVE_SAVE_AS، می‌تواند شامل کلیدهای year، month و/یا day باشد. مقدار متناظر، فهرستی از دیکشنری‌ها است که هر کدام به نوبه خود یک دوره زمانی را (مرتب‌شده بر اساس تنظیم NEWEST_FIRST_ARCHIVES) با کلیدها و مقادیر زیر مشخص می‌کنند:

در اینجا نمونه‌ای از نحوه استفاده از period_archives در یک قالب آورده شده است:

<ul>
{% for archive in period_archives.month %}
    <li>
        <a href="{{ SITEURL }}/{{ archive.url }}">
            {{ archive.period | reverse | join(' ') }} ({{ archive.articles|count }})
        </a>
    </li>
{% endfor %}
</ul>

می‌توانید بسته به سطح جزئیات دوره زمانی مورد نظر، period_archives.month را در دستور for به period_archives.year یا period_archives.day تغییر دهید..SS اشیاء (Objects)

ویژگی‌های اشیائی که در قالب‌ها در دسترس و مفید هستند را با جزئیات شرح می‌دهد. همهٔ ویژگی‌ها در اینجا فهرست نشده‌اند؛ این گزیده‌ای از ویژگی‌هایی است که در یک قالب مفید در نظر گرفته شده‌اند.

مقاله (Article)

نمایش رشته‌ای یک Article، ویژگی source_path است.

[1]

برای شیء Author، برگرفته از :authors: یا AUTHOR.

صفحه (Page)

نمایش رشته‌ای یک Page، صفت source_path است.