Seqular Blog Tools - Comprehensive Usage Guide
The Seqular blog platform offers 6 powerful tools for managing blog content. In this guide, we'll explore each tool's features, use cases, and practical examples in detail.
Introduction to Blog Tools
Seqular blog tools provide a comprehensive solution for creating, editing, listing, and searching blog posts. These tools work with similar logic to document management tools (doc_store, doc_edit, etc.) but offer features specific to the blog platform.
Why Seqular Blog Tools?
- Easy to Use: Simple API for blog operations
- Automation: Auto-pagination and slug generation
- SEO Support: Metadata and excerpt management
- Mastodon Integration: Author profiles and social media connections
- Security: OAuth2-based authentication
Tool List
We'll cover 6 tools in this guide:
- seqular_blog_write - Publish blog posts
- seqular_blog_read - Read blog posts
- seqular_blog_edit - Edit blog posts
- seqular_blog_list_posts - List blog posts
- seqular_blog_list_authors - List blog authors
- seqular_blog_search - Search blog content
Each tool will be examined in detail with practical examples.
seqular_blog_write - Publishing Blog Posts
The first tool, seqular_blog_write, handles publishing blog posts. This tool can create single or multi-page posts.
Basic Usage
The simplest usage is creating a draft post:
seqular_blog_write(
title="My First Blog Post",
content="# Hello World\n\nThis is my first blog post."
)
This code automatically generates a slug, extracts the excerpt from content, and saves the post as draft.
Publish Mode
To publish the post immediately, use the status parameter:
seqular_blog_write(
title="New Feature Announcement",
content="# New Feature\n\nToday we released a new feature!",
status="published"
)
Tags and Metadata
To categorize the post, use the tags parameter:
seqular_blog_write(
title="Python Tutorial",
content="# Getting Started with Python",
tags="python,tutorial,beginner"
)
For SEO, metadata can also be added:
seqular_blog_write(
title="Python Tutorial",
content="# Getting Started with Python",
metadata='{"canonical_url":"https://example.com/python-tutorial","topic":"programming","language":"en"}'
)
Auto-Pagination Feature
One of the most powerful features of Seqular blog tools is the auto-pagination capability. Long content can be automatically split into pages by the server.
How Auto-Pagination Works
Auto-pagination is handled server-side based on admin panel settings. You simply send the full content, and the server splits it automatically if needed.
seqular_blog_write(
title="Long Article",
content="# Introduction\n\n... # Section 1\n\n... # Section 2\n\n..."
)
The server will automatically split the content into pages based on the configured settings. You don't need to manually manage pagination.
Auto-Pagination Benefits
- Simplicity: Just send full content
- Flexibility: Server-side configuration
- Consistency: Uniform pagination across all posts
- Maintenance: Easy to adjust settings
Auto-Pagination vs Manual Pages
Auto-Pagination (Recommended):
seqular_blog_write(
title="Blog Series",
content="# Part 1\n\n... # Part 2\n\n... # Part 3\n\n..."
)
The server automatically splits based on headings and content length.
Manual Pages (Explicit Control):
seqular_blog_write(
title="Blog Series",
pages='["# Part 1: Introduction", "# Part 2: Details", "# Part 3: Conclusion"]'
)
Each page is exactly the specified content.
seqular_blog_write Features
Slug Management
Slug is automatically generated from the title, but can also be defined manually:
seqular_blog_write(
title="Python Tutorial",
slug="python-tutorial-2024" # Manual slug
)
Cover Image
A cover image can be added to the post:
seqular_blog_write(
title="Software Development",
content="...",
cover_image="https://example.com/cover.jpg"
)
Excerpt
Excerpt is automatically generated, but can also be defined manually:
seqular_blog_write(
title="Python Tutorial",
excerpt="In this post, we'll get started with Python..."
)