lightspeedwp / tour-operator

The LSX Tour Operators Plugin provides 3 post types (Accommodations, Destinations and Tours) that are the core of any Tour Operator. Use them to build day-by-day itineraries for tours.
https://lsx.design/products/tour-operator/
GNU General Public License v3.0
10 stars 0 forks source link

Custom Pre-Publish Checklist Integration into core plugin #389

Open ashleyshaw opened 6 days ago

ashleyshaw commented 6 days ago

Summary:
Integrate a custom pre-publish checklist directly into the Tour Operator plugin's block editor backend. This feature will ensure that users fill in all the essential information specific to tour listings and prompt them to include additional content that enhances the quality of the listing before publishing.

Details

This feature will be built into the LSX Tour Operator plugin to provide a seamless, tailored experience without relying on third-party plugins. The checklist will guide users through completing all required fields while encouraging them to add nice-to-have content, all specific to the plugin's custom content types, fields, and taxonomies.

Key Features to Implement

  1. Custom Mandatory Fields Validation

    • Enforce that key fields like "Tour Title," "Description," "Destination," "Dates," "Pricing," and other critical fields specific to the LSX Tour Operator are completed before publication.
    • Display clear error messages highlighting which fields are incomplete or missing.
  2. Prompts for Additional Content (Nice-to-Have)

    • Include prompts for non-mandatory but valuable content, such as "Gallery Images," "Video Links," "Tour Highlights," "Customer Reviews," and "Travel Tips," to enhance the listing.
    • These prompts will not block the publishing process but will act as recommendations to improve the listing's quality.
  3. Tailored Checklist Customisation

    • Allow site admins to adjust the checklist requirements based on their specific needs, marking fields as either "Required" or "Optional" as necessary.
    • Customise the checklist to align directly with the LSX Tour Operator's content types, fields, and taxonomies.
  4. Progress Tracking and User-Friendly Interface

    • Implement a visual progress indicator within the block editor sidebar to show how much of the required information has been completed.
    • Use intuitive validation messages to warn users if any critical information is missing before they can proceed with publication.
  5. Integration with LSX Tour Operator Specific Elements

    • Ensure that the checklist integrates directly with the LSX Tour Operator blocks, content types, and taxonomies for a smooth and consistent user experience.

Reference for Implementation

For inspiration on the technical implementation, review Human Made's Publication Checklist on GitHub, which provides a framework for building a customised pre-publication checklist.

Acceptance Criteria

Additional Notes:
This feature is intended to enhance the overall user experience and quality of tour listings created using the Tour Operator plugin by guiding users through a structured content completion process.