Plugin Directory

Changeset 3710122


Ignore:
Timestamp:
09/23/2026 08:12:22 PM (5 weeks ago)
Author:
akirk
Message:

Update README + blueprint

Location:
travel-app
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • travel-app/assets/blueprints/blueprint.json

    r3710086 r3710122  
    22        "landingPage": "/travel-app/",
    33        "steps": [
     4                {
     5                        "step": "mkdir",
     6                        "path": "/wordpress/wp-content/plugins/travel-app/playground"
     7                },
    48                {
    59                        "step": "writeFile",
  • travel-app/tags/1.0.0/README.md

    r3709879 r3710122  
    22
    33- Contributors: akirk
    4 - Tags: travel, itinerary, trip-planner, travel-journal, wp-app
     4- Tags: itinerary, trip-planner, wp-app
    55- Requires at least: 6.0
    66- Requires PHP: 7.4
    … …  
    1717· [Try it with demo data](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/akirk/travel-app/main/demo.json)
    1818
    19 [Try it in OpenStation](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/akirk/travel-app/main/blueprint-openstation.json) — the same app opened in desktop mode with the [OpenStation](https://github.com/WordPress/openstation) plugin.
     19Travel App is a [WP App](https://wpapps.kirk.at/), an app for WordPress with the primary focus of being
     20used by yourself, or your family or social group. It can only be accessed logged-in
     21and adds a menu entry to the Masterbar to be reached.
    2022
    21 Travel App is a private travel organizer that lives on your own WordPress. Paste or
    22 upload booking confirmations, calendar exports and itinerary notes, and Travel App
    23 turns them into a structured trip: flights, lodging, trains, rental cars,
    24 activities and anything else you want to keep track of. Built on
    25 [WpApp](https://github.com/akirk/wp-app), so it runs as its own app at
    26 `/travel-app/` instead of inside wp-admin.
     23Travel App is a private travel organizer that allows you to organize travel itineraries
     24as timelines. You can paste booking confirmations, calendar exports and itinerary notes,
     25and Travel App turns them into a structured trip: flights, lodging, trains, rental cars,
     26activities and anything else you want to keep track of.
    2727
    28 Nothing leaves your site unless you decide it should. Trips are stored in your
    29 own database, and every sharing feature is opt-in and revocable.
     28There are lots of other small features:
     29- map view (with Open Street Map),
     30- journal entries per day,
     31- you can share your trip with a link,
     32- subscribe to your trips in your Calendar,
     33- access your trips (including reservation files) offline, and
     34- delegate another user on your site to create or edit trips on your behalf.
    3035
    31 ### Import instead of retype
     36As every WP App, Travel App comes with support for the Abilities API by providing all
     37the abilities necessary to use the app with an AI.
    3238
    33 Paste or upload booking confirmations, TripIt-style calendar exports, and plain
    34 itinerary notes to turn them into structured trip timelines.
    35 
    36 - ICS calendar files are read by a dedicated calendar parser, so recurring
    37   formats come in reliably without any external service.
    38 - Other text is handed to the WordPress AI Client (`wp_ai_client_prompt()`) when
    39   an AI connector is configured, and falls back to a built-in local parser when
    40   it is not — so the plugin still works with no AI at all.
    41 - A quick-plan parser understands short one-line notes ("Train to the coast,
    42   Friday 9:40") for entries you type by hand.
    43 - On a phone the app registers as a Web Share Target, so a confirmation e-mail
    44   or a booking page can be shared straight into Travel App from another app.
    45 - Imports land on a review screen first, so you can correct what the parser got
    46   wrong before anything is saved.
    47 
    48 ### A timeline you can actually follow
    49 
    50 Each trip has a day-by-day timeline of itinerary items, each with a stable ID
    51 and its own edit page. While a trip is running, the timeline highlights what is
    52 happening now and what comes next, and the WordPress toolbar shows the trip you
    53 are currently on.
    54 
    55 - Items carry times, locations, end locations, booking references, notes, links
    56   and file attachments.
    57 - Links get a preview (title, description, image) fetched from the linked page,
    58   so a booking URL turns into something recognisable.
    59 - A lodging check compares the nights your trip spans against the lodging you
    60   have booked and points out the nights that are not covered yet.
    61 
    62 ### Route map
    63 
    64 Every trip has a route map built from the locations in the itinerary, drawn with
    65 a bundled copy of Leaflet on OpenStreetMap tiles. Places are geocoded in the
    66 browser through OpenStreetMap's Nominatim service, and the coordinates are
    67 cached on your site so the same itinerary does not have to be looked up again on
    68 the next visit or on another device. When a place name is ambiguous you can pick
    69 the right match from a list. A playback mode walks the route step by step.
    70 
    71 ### Travel journal
    72 
    73 Turn a trip into a diary: each day gets a journal entry that starts from what
    74 was on the itinerary that day, and entries can be prepared as blog post drafts
    75 with a category and tags of your choosing, ready for you to publish.
    76 
    77 ### Sharing, on your terms
    78 
    79 - Generate a share link for a trip, in a read-only "fellow traveller" view or a
    80   public one, and revoke it whenever you want.
    81 - Subscribe to a trip as an ICS calendar feed, or to all of your trips at once,
    82   so the itinerary shows up in your usual calendar app.
    83 - Download a trip as a single self-contained HTML file to keep or hand on.
    84 - Delegate: let another user on the site create or edit trips on your behalf,
    85   with the capability required for that under your control.
    86 
    87 ### Works offline
    88 
    89 Travel App installs as a Progressive Web App. The timeline, its assets and its
    90 attachments are cached for offline use, and edits made while offline are queued
    91 and synced when the connection comes back.
    92 
    93 ### AI Assistant
    94 
    95 When the AI Assistant plugin is active, Travel App registers WordPress Abilities
    96 for listing, creating, importing, inspecting, renaming, sharing and editing
    97 travel plans and their itinerary items, so an assistant can work with your trips
    98 without a separate integration.
    99 
    100 ### How it is stored
    101 
    102 Trips are `travel_app_trip` taxonomy terms. Itinerary entries are first-class
    103 `travel_app_item` posts assigned to the trip term, so each entry has a stable ID
    104 and a dedicated edit page. Journal entries are `travel_app_journal` posts. No
    105 custom database tables are created; remove the plugin and your WordPress is as
    106 slim as it was before.
    107 
    108 ### External services
    109 
    110 Travel App works without any third-party service, but two optional features talk
    111 to the outside world:
    112 
    113 - The route map loads map tiles from [OpenStreetMap](https://www.openstreetmap.org/)
    114   and geocodes place names through its [Nominatim](https://nominatim.org/)
    115   service, from your browser. See the
    116   [OSMF privacy policy](https://wiki.osmfoundation.org/wiki/Privacy_Policy).
    117 - Link previews fetch the page behind a URL you entered on an itinerary item, to
    118   read its title, description and preview image.
    119 
    120 If an AI connector is configured for the WordPress AI Client, imported text is
    121 sent to whichever provider you configured there. Without a connector, importing
    122 uses the built-in local parsers and nothing is sent anywhere.
     39If WordPress has AI Connectors configured, it will use them to better parse your pasted
     40booking confirmations.
    12341
    12442## Installation
Note: See TracChangeset for help on using the changeset viewer.