# strings URL: /api/rendering/template_functions/strings/ Section: template_functions -------------------------------------------------------------------------------- strings - Bengal window.BENGAL_THEME_DEFAULTS = { appearance: 'dark', palette: 'snow-lynx' }; // Progressive Enhancement System Configuration window.Bengal = window.Bengal || {}; window.Bengal.enhanceBaseUrl = '/bengal/assets/js/enhancements'; window.Bengal.watchDom = true; window.Bengal.debug = false; (function () { try { var defaults = window.BENGAL_THEME_DEFAULTS || { appearance: 'system', palette: '' }; var defaultAppearance = defaults.appearance; if (defaultAppearance === 'system') { defaultAppearance = (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'; } var storedTheme = localStorage.getItem('bengal-theme'); var storedPalette = localStorage.getItem('bengal-palette'); var theme = storedTheme ? (storedTheme === 'system' ? defaultAppearance : storedTheme) : defaultAppearance; var palette = storedPalette ?? defaults.palette; document.documentElement.setAttribute('data-theme', theme); if (palette) { document.documentElement.setAttribute('data-palette', palette); } } catch (e) { document.documentElement.setAttribute('data-theme', 'light'); } })(); Skip to main content Magnifying Glass ESC Recent Clear Magnifying Glass No results for "" Try different keywords or check your spelling Start typing to search... ↑↓ Navigate ↵ Open ESC Close Powered by Lunr ᓚᘏᗢ Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Magnifying Glass Search ⌘K Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal List ᓚᘏᗢ Magnifying Glass Search X Close Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal API Reference __main__ bengal Caret Right Folder Analysis community_detection graph_analysis graph_reporting graph_visualizer knowledge_graph link_suggestions link_types page_rank path_analysis performance_advisor results Caret Right Folder Assets manifest pipeline Caret Right Folder Autodoc base config docstring_parser utils virtual_orchestrator Caret Right Folder Extractors cli openapi python Caret Right Folder Models cli common openapi python Caret Right Folder Cache asset_dependency_map cache_store cacheable compression dependency_tracker page_discovery_cache query_index query_index_registry taxonomy_index utils Caret Right Folder Build Cache autodoc_tracking core file_tracking fingerprint parsed_content_cache rendered_output_cache taxonomy_index_mixin validation_cache Caret Right Folder Indexes author_index category_index date_range_index section_index Caret Right Folder Cli __main__ base site_templates utils Caret Right Folder Commands assets build clean collections config debug explain fix health init perf project serve site skeleton sources theme utils validate Caret Right Folder Graph __main__ bridges communities orphans pagerank report suggest Caret Right Folder New config presets scaffolds site wizard Caret Right Folder Helpers cli_app_loader cli_output config_validation error_handling menu_config metadata progress site_loader traceback validation Caret Right Folder Skeleton hydrator schema Caret Right Folder Templates base registry Caret Right Folder Blog template Caret Right Folder Changelog template Caret Right Folder Default template Caret Right Folder Docs template Caret Right Folder Landing template Caret Right Folder Portfolio template Caret Right Folder Resume template Caret Right Folder Collections errors loader schemas validator Caret Right Folder Config defaults deprecation directory_loader env_overrides environment feature_mappings hash loader merge origin_tracker validators Caret Right Folder Content Layer entry loaders manager source Caret Right Folder Sources github local notion rest Caret Right Folder Content Types base registry strategies Caret Right Folder Core build_context cascade_engine menu section theme Caret Right Folder Asset asset_core css_transforms Caret Right Folder Page computed content metadata navigation operations page_core proxy relationships utils Caret Right Folder Site core data discovery factories page_caches properties section_registry theme Caret Right Folder Debug base config_inspector content_migrator delta_analyzer dependency_visualizer explainer incremental_debugger models reporter shortcode_sandbox Caret Right Folder Discovery asset_discovery content_discovery Caret Right Folder Fonts downloader generator Caret Right Folder Health autofix base health_check report Caret Right Folder Linkcheck async_checker ignore_policy internal_checker models orchestrator Caret Right Folder Validators anchors assets cache config connectivity cross_ref fonts links menu navigation output performance rendering rss sitemap taxonomy tracks Caret Right Folder Directives analysis checkers constants Caret Right Folder Orchestration asset content full_to_incremental incremental menu postprocess related_posts render section static streaming taxonomy Caret Right Folder Postprocess html_output redirects rss sitemap special_pages Caret Right Folder Output Formats index_generator json_generator llm_generator lunr_index_generator txt_generator utils Caret Right Folder Rendering api_doc_enhancer asset_extractor errors jinja_utils link_transformer link_validator pygments_cache renderer template_context template_profiler validator Caret Right Folder Parsers base factory mistune native_html pygments_patch python_markdown Caret Right Folder Pipeline core output thread_local toc transforms Caret Right Folder Plugins badges cross_references inline_icon term variable_substitution Caret Right Folder Directives _icons admonitions badge base button cache cards checklist code_tabs container contracts data_table dropdown embed errors example_label fenced figure glossary icon include list_table literalinclude marimo navigation options rubric steps tabs target term terminal tokens utils validator video Caret Right Folder Template Engine asset_url core environment manifest menu url_helpers Caret Right Folder Template Functions advanced_collections advanced_strings autodoc collections content crossref data dates debug files get_page i18n icons images math_functions navigation pagination_helpers seo strings tables taxonomies theme urls Caret Right Folder Server build_handler component_preview constants dev_server live_reload pid_manager reload_controller request_handler request_logger resource_manager utils Caret Right Folder Services validation Caret Right Folder Themes config Caret Right Folder Utils atomic_write autodoc build_context build_stats build_summary cli_output css_minifier dates dotdict error_handlers file_io file_lock hashing incremental_constants js_bundler live_progress logger metadata observability page_initializer pagination path_resolver paths performance_collector performance_report profile progress retry rich_console sections swizzle text theme_registry theme_resolution thread_local traceback_config traceback_renderer url_normalization url_strategy Rendering Template Functions ᗢ Caret Down Link Copy URL External Open LLM text Copy Copy LLM text Share with AI Ask Claude Ask ChatGPT Ask Gemini Ask Copilot Module rendering.template_functions.strings String manipulation functions for templates. Provides 14 essential string functions for text processing in templates. Many of these functions are now thin wrappers around bengal.utils.text utilities to avoid code duplication and ensure consistency. View source 17 Functions Functions register Register string functions with Jinja2 environment. 2 None Caret Right def register(env: Environment, site: Site) -> None Register string functions with Jinja2 environment. Parameters 2 Name Type Default Description env Environment — site Site — dict_get Safe get supporting dict-like objects for component preview contexts. 3 Any Caret Right def dict_get(obj: Any, key: str, default: Any = None) -> Any Safe get supporting dict-like objects for component preview contexts. Parameters 3 Name Type Default Description obj Any — key str — default Any None Returns Any truncatewords Truncate text to a specified number of words. Uses bengal.utils.text.truncate_words internally. 3 str Caret Right def truncatewords(text: str, count: int, suffix: str = '...') -> str Truncate text to a specified number of words. Uses bengal.utils.text.truncate_words internally. Parameters 3 Name Type Default Description text str — Text to truncate count int — Maximum number of words suffix str '...' Text to append when truncated (default: "...") Returns str — Truncated text with suffix if needed truncatewords_html Truncate HTML text to word count, preserving HTML structure. Uses a tag-aware approach that: 1. Co… 3 str Caret Right def truncatewords_html(html: str, count: int, suffix: str = '...') -> str Truncate HTML text to word count, preserving HTML structure. Uses a tag-aware approach that: Counts only text content words (not tag content) Keeps track of open tags Closes any unclosed tags at truncation point Parameters 3 Name Type Default Description html str — HTML text to truncate count int — Maximum number of words suffix str '...' Text to append when truncated Returns str — Truncated HTML with properly closed tags slugify Convert text to URL-safe slug. Uses bengal.utils.text.slugify internally. Converts to lowercase, r… 1 str Caret Right def slugify(text: str) -> str Convert text to URL-safe slug. Uses bengal.utils.text.slugify internally. Converts to lowercase, removes special characters, replaces spaces with hyphens. Parameters 1 Name Type Default Description text str — Text to convert Returns str — URL-safe slug _convert_docstring_to_markdown Convert Google/NumPy-style docstrings to markdown. Handles: - Indented lists ( - Item) → proper… 1 str Caret Right def _convert_docstring_to_markdown(text: str) -> str Convert Google/NumPy-style docstrings to markdown. Handles: Indented lists ( - Item) → proper markdown lists Section headers (Section:) → bold labels or headings Preserves code blocks Parameters 1 Name Type Default Description text str — Docstring text Returns str — Markdown-formatted text markdownify Render Markdown text to HTML. Pre-processes Google-style docstrings to markdown, then converts to … 1 str Caret Right def markdownify(text: str) -> str Render Markdown text to HTML. Pre-processes Google-style docstrings to markdown, then converts to HTML using mistune (production dependency) with table support. Parameters 1 Name Type Default Description text str — Markdown or docstring text Returns str — Rendered HTML strip_html Remove all HTML tags from text. Uses bengal.utils.text.strip_html internally. 1 str Caret Right def strip_html(text: str) -> str Remove all HTML tags from text. Uses bengal.utils.text.strip_html internally. Parameters 1 Name Type Default Description text str — HTML text Returns str — Text with HTML tags removed truncate_chars Truncate text to character length. Uses bengal.utils.text.truncate_chars internally. 3 str Caret Right def truncate_chars(text: str, length: int, suffix: str = '...') -> str Truncate text to character length. Uses bengal.utils.text.truncate_chars internally. Parameters 3 Name Type Default Description text str — Text to truncate length int — Maximum character length suffix str '...' Text to append when truncated Returns str — Truncated text with suffix if needed replace_regex Replace text using regular expression. 3 str Caret Right def replace_regex(text: str, pattern: str, replacement: str) -> str Replace text using regular expression. Parameters 3 Name Type Default Description text str — Text to search in pattern str — Regular expression pattern replacement str — Replacement text Returns str — Text with replacements made pluralize Return singular or plural form based on count. Uses bengal.utils.text.pluralize internally. 3 str Caret Right def pluralize(count: int, singular: str, plural: str | None = None) -> str Return singular or plural form based on count. Uses bengal.utils.text.pluralize internally. Parameters 3 Name Type Default Description count int — Number to check singular str — Singular form plural str | None None Plural form (default: singular + 's') Returns str — Appropriate form based on count reading_time Calculate reading time in minutes. 2 int Caret Right def reading_time(text: str, wpm: int = 200) -> int Calculate reading time in minutes. Parameters 2 Name Type Default Description text str — Text to analyze wpm int 200 Words per minute reading speed (default: 200) Returns int — Reading time in minutes (minimum 1) word_count Count words in text. Strips HTML tags before counting. Uses same logic as reading_time. 1 int Caret Right def word_count(text: str) -> int Count words in text. Strips HTML tags before counting. Uses same logic as reading_time. Parameters 1 Name Type Default Description text str — Text to count (can contain HTML) Returns int — Number of words excerpt Extract excerpt from text, optionally respecting word boundaries. 3 str Caret Right def excerpt(text: str, length: int = 200, respect_word_boundaries: bool = True) -> str Extract excerpt from text, optionally respecting word boundaries. Parameters 3 Name Type Default Description text str — Text to excerpt from length int 200 Maximum length in characters respect_word_boundaries bool True Don't cut words in half (default: True) Returns str — Excerpt with ellipsis if truncated strip_whitespace Remove extra whitespace (multiple spaces, newlines, tabs). Uses bengal.utils.text.normalize_whites… 1 str Caret Right def strip_whitespace(text: str) -> str Remove extra whitespace (multiple spaces, newlines, tabs). Uses bengal.utils.text.normalize_whitespace internally. Replaces all whitespace sequences with a single space. Parameters 1 Name Type Default Description text str — Text to clean Returns str — Text with normalized whitespace first_sentence Extract first sentence from text, or truncate if too long. Useful for generating short description… 2 str Caret Right def first_sentence(text: str, max_length: int = 120) -> str Extract first sentence from text, or truncate if too long. Useful for generating short descriptions from longer text blocks. Looks for sentence-ending punctuation (. ! ?) followed by whitespace. Parameters 2 Name Type Default Description text str — Text to extract first sentence from max_length int 120 Maximum length before truncation (default: 120) Returns str — First sentence or truncated text with ellipsis filesize Format bytes as human-readable file size. Wraps bengal.utils.text.humanize_bytes for template use. 1 str Caret Right def filesize(size_bytes: int) -> str Format bytes as human-readable file size. Wraps bengal.utils.text.humanize_bytes for template use. Parameters 1 Name Type Default Description size_bytes int — Size in bytes Returns str — Human-readable size string (e.g., "1.5 MB", "256 KB") ← Previous seo Next → tables List © 2025 Bengal ᓚᘏᗢ window.BENGAL_LAZY_ASSETS = { tabulator: '/bengal/assets/js/tabulator.min.js', dataTable: '/bengal/assets/js/data-table.js', mermaidToolbar: '/bengal/assets/js/mermaid-toolbar.9de5abba.js', mermaidTheme: '/bengal/assets/js/mermaid-theme.344822c5.js', graphMinimap: '/bengal/assets/js/graph-minimap.cc7e42e3.js', graphContextual: '/bengal/assets/js/graph-contextual.440e59c6.js' }; window.BENGAL_ICONS = { close: '/bengal/assets/icons/close.911d4fe1.svg', enlarge: '/bengal/assets/icons/enlarge.652035e5.svg', copy: '/bengal/assets/icons/copy.3d56e945.svg', 'download-svg': '/bengal/assets/icons/download.04f07e1b.svg', 'download-png': '/bengal/assets/icons/image.c34dfd40.svg', 'zoom-in': '/bengal/assets/icons/zoom-in.237b4a83.svg', 'zoom-out': '/bengal/assets/icons/zoom-out.38857c77.svg', reset: '/bengal/assets/icons/reset.d26dba29.svg' }; Arrow Up X -------------------------------------------------------------------------------- Metadata: - Author: lbliii - Word Count: 2044 - Reading Time: 10 minutes