Creole Bundle Laravel Package

Product Decisions This Supports

• Internal Documentation & Wiki Systems: Enable lightweight, self-hosted wiki functionality for internal documentation, knowledge bases, or team collaboration tools (e.g., replacing Confluence/Notion for low-cost, custom-branded solutions).
• Legacy System Integration: Modernize older PHP/Symfony 2 applications by adding wiki markup support without migrating to newer frameworks (e.g., for documentation embedded in legacy apps).
• Custom Markup Rendering: Build extensible content pipelines (e.g., parse Creole → transform to HTML/LaTeX/PDF) for niche use cases like academic papers, technical manuals, or internal reports.
• Roadmap for Deprecated Projects: Justify short-term adoption for projects stuck on Symfony 2 (e.g., "We’ll phase out this bundle when we migrate to Symfony 5+ in 2025").
• Build vs. Buy: Avoid vendor lock-in with proprietary wiki tools (e.g., MediaWiki) if Creole’s simplicity aligns with your markup needs and you can tolerate its limitations.

When to Consider This Package

• Avoid if:
  • You’re on Symfony 3+ (incompatible; no active maintenance).
  • You need images, tables, or advanced formatting (missing in Creole 1.0 support).
  • You require real-time collaboration (this is a static parser, not a live wiki).
  • You prioritize modern tooling (e.g., Markdown, CommonMark, or GitHub Flavored Markdown).
  • Your team lacks PHP/Symfony expertise (steep learning curve for custom renderers).
• Consider if:
  • You’re maintaining a Symfony 2 codebase and need lightweight wiki markup.
  • Your use case fits Creole 1.0’s limitations (e.g., simple text formatting, no media).
  • You can fork/maintain the package (MIT license allows this).
  • Performance is critical (serializable parsing + caching reduces reprocessing overhead).

How to Pitch It (Stakeholders)

For Executives: "This bundle lets us embed a lightweight, self-hosted wiki into our Symfony 2 app for internal docs—like a cheaper, customizable alternative to Confluence. It’s unmaintained, but since we’re on Symfony 2 anyway, it’s a low-risk way to add markup support without migrating. We’d own the codebase, so no vendor lock-in. Tradeoff: limited formatting (no images/tables), but good enough for basic use cases. Long-term, we’d phase it out during our Symfony upgrade."

For Engineering: *"CreoleBundle gives us a Creole 1.0 parser for Symfony 2 with two renderers (HTML/LaTeX). Key pros:

• Performance: Serializable output enables caching parsed markup (fast renders after initial parse).
• Extensible: Easy to write custom renderers (e.g., for PDFs or APIs).
• Reliable: 100% test coverage, including random markup validation. Cons:
• No images/tables in Creole 1.0 support (would need custom work).
• Symfony 2-only (blocker for new projects). Pitch: Use this for legacy docs or prototyping, but avoid for greenfield work. If we adopt, we’ll fork it to add missing features."*