# text URL: /api/utils/text/ Section: utils -------------------------------------------------------------------------------- text - 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 API Reference Utils ᗢ 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 utils.text Text processing utilities. Provides canonical implementations for common text operations like slugification, HTML stripping, truncation, and excerpt generation. These utilities consolidate duplicate implementations found throughout the codebase. Example: from bengal.utils.text import slugify, strip_html, truncate_words slug = slugify("Hello World!") # "hello-world" text = strip_html("<p>Hello</p>") # "Hello" excerpt = truncate_words("Long text here...", 10) View source 13 Functions Functions slugify Convert text to URL-safe slug with Unicode support. Preserves Unicode word characters (letters, di… 4 str Caret Right def slugify(text: str, unescape_html: bool = True, max_length: int | None = None, separator: str = '-') -> str Convert text to URL-safe slug with Unicode support. Preserves Unicode word characters (letters, digits, underscore) to support international content. Modern web browsers and servers handle Unicode URLs. Consolidates implementations from: bengal/rendering/parser.py:629 (_slugify) bengal/rendering/template_functions/strings.py:92 (slugify) bengal/rendering/template_functions/taxonomies.py:184 (tag_url pattern) Parameters 4 Name Type Default Description text str — Text to slugify unescape_html bool True Whether to decode HTML entities first (e.g., &amp; -> &) max_length int | None None Maximum slug length (None = unlimited) separator str '-' Character to use between words (default: '-') Returns str — URL-safe slug (lowercase, with Unicode word chars and separators) strip_html Remove all HTML tags from text. Consolidates implementation from: - bengal/rendering/template_func… 2 str Caret Right def strip_html(text: str, decode_entities: bool = True) -> str Remove all HTML tags from text. Consolidates implementation from: bengal/rendering/template_functions/strings.py:157 (strip_html) Parameters 2 Name Type Default Description text str — HTML text to clean decode_entities bool True Whether to decode HTML entities (e.g., &lt; -> <) Returns str — Plain text with HTML tags removed truncate_words Truncate text to specified word count. Consolidates pattern from: - bengal/rendering/template_func… 3 str Caret Right def truncate_words(text: str, word_count: int, suffix: str = '...') -> str Truncate text to specified word count. Consolidates pattern from: bengal/rendering/template_functions/strings.py (truncatewords) Parameters 3 Name Type Default Description text str — Text to truncate word_count int — Maximum number of words suffix str '...' Suffix to append if truncated Returns str — Truncated text with suffix if shortened truncate_chars Truncate text to specified character length (including suffix). 3 str Caret Right def truncate_chars(text: str, length: int, suffix: str = '...') -> str Truncate text to specified character length (including suffix). Parameters 3 Name Type Default Description text str — Text to truncate length int — Maximum total length (including suffix if truncated) suffix str '...' Suffix to append if truncated Returns str — Truncated text with suffix if shortened, never exceeding length truncate_middle Truncate text in the middle (useful for file paths). 3 str Caret Right def truncate_middle(text: str, max_length: int, separator: str = '...') -> str Truncate text in the middle (useful for file paths). Parameters 3 Name Type Default Description text str — Text to truncate max_length int — Maximum total length separator str '...' Separator to use in middle Returns str — Truncated text with separator in middle generate_excerpt Generate plain text excerpt from HTML content. Combines strip_html and truncate_words for common u… 3 str Caret Right def generate_excerpt(html: str, word_count: int = 50, suffix: str = '...') -> str Generate plain text excerpt from HTML content. Combines strip_html and truncate_words for common use case. Consolidates pattern from: bengal/postprocess/output_formats.py:674 Various template functions Parameters 3 Name Type Default Description html str — HTML content word_count int 50 Maximum number of words suffix str '...' Suffix to append if truncated Returns str — Plain text excerpt normalize_whitespace Normalize whitespace in text. 2 str Caret Right def normalize_whitespace(text: str, collapse: bool = True) -> str Normalize whitespace in text. Parameters 2 Name Type Default Description text str — Text to normalize collapse bool True Whether to collapse multiple spaces to single space Returns str — Text with normalized whitespace escape_html Escape HTML entities. Converts special characters to HTML entities: - < becomes &lt; - > becomes &… 1 str Caret Right def escape_html(text: str) -> str Escape HTML entities. Converts special characters to HTML entities: < becomes &lt; becomes &gt; & becomes &amp; " becomes &quot; ' becomes &#x27; Parameters 1 Name Type Default Description text str — Text to escape Returns str — HTML-escaped text unescape_html Unescape HTML entities. Converts HTML entities back to characters: - &lt; becomes < - &gt; becomes… 1 str Caret Right def unescape_html(text: str) -> str Unescape HTML entities. Converts HTML entities back to characters: &lt; becomes < &gt; becomes > &amp; becomes & &quot; becomes " Parameters 1 Name Type Default Description text str — HTML text with entities Returns str — Unescaped text pluralize Return singular or plural form based on count. 3 str Caret Right def pluralize(count: int, singular: str, plural: str | None = None) -> str Return singular or plural form based on count. Parameters 3 Name Type Default Description count int — Count value singular str — Singular form plural str | None None Plural form (default: singular + 's') Returns str — Appropriate form for the count humanize_bytes Format bytes as human-readable string. 1 str Caret Right def humanize_bytes(size_bytes: int) -> str Format bytes as human-readable string. Parameters 1 Name Type Default Description size_bytes int — Size in bytes Returns str — Human-readable string (e.g., "1.5 KB", "2.3 MB") humanize_number Format number with thousand separators. 1 str Caret Right def humanize_number(num: int) -> str Format number with thousand separators. Parameters 1 Name Type Default Description num int — Number to format Returns str — Formatted string with commas humanize_slug Convert slug or filename stem to human-readable title. Transforms kebab-case and snake_case identi… 1 str Caret Right def humanize_slug(slug: str) -> str Convert slug or filename stem to human-readable title. Transforms kebab-case and snake_case identifiers into Title Case strings suitable for display in navigation, page titles, and other user-facing contexts. Consolidates pattern from: bengal/core/page/metadata.py (title property) bengal/discovery/content_discovery.py (fallback titles) bengal/rendering/template_functions/navigation.py (breadcrumbs) bengal/cli/helpers/menu_config.py (menu titles) Various Jinja templates Parameters 1 Name Type Default Description slug str — Slug or filename stem (e.g., "my-page-name", "data_model") Returns str — Human-readable title (e.g., "My Page Name", "Data Model") ← Previous swizzle Next → theme_registry 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: 1911 - Reading Time: 10 minutes