5ac27d676c
- Add MIT LICENSE (Thorsten Buss) with attribution to the upstream MIT-licensed greyshirtguy/ProPresenter7-Proto definitions. - Add comprehensive README.md: badges, feature matrix, install, seven runnable getting-started examples (read/modify/generate songs, playlists, bundles, global libraries), CLI tool reference, documentation index, project structure, caveats. - Update composer.json with package name (bussnet/propresenter7-php-api), MIT license, keywords, author, homepage, support URLs, dev autoload, and a `composer test` script. - Polish doc/INDEX.md, doc/keywords.md, and doc/CONTRIBUTING.md so they read well for both humans and AI assistants; remove README-duplicate content from INDEX.md and link to the top-level README instead. - Expand .gitignore to cover IDE/OS metadata and agent workspaces. All 370 tests still pass (9,200 assertions). README examples #3 and #5 verified end-to-end (generate -> read back -> assert metadata).
12 KiB
12 KiB
Keyword Index
Search this file (Ctrl+F / Cmd+F) to jump to the right document for a topic.
File Formats
| Keyword | Document |
|---|---|
.pro |
formats/pp_song_spec.md |
.proplaylist |
formats/pp_playlist_spec.md |
.probundle |
formats/pp_bundle_spec.md |
| protobuf | formats/pp_song_spec.md |
| ZIP | formats/pp_bundle_spec.md, formats/pp_playlist_spec.md |
| ZIP64 | formats/pp_playlist_spec.md, formats/pp_bundle_spec.md |
| binary format | formats/pp_song_spec.md, formats/pp_playlist_spec.md, formats/pp_bundle_spec.md |
| JSON | api/communication-devices.md |
Song Structure
| Keyword | Document |
|---|---|
| song | api/song.md |
| group | api/song.md, api/groups.md, formats/pp_song_spec.md Section 4 |
| slide | api/song.md, formats/pp_song_spec.md Section 5 |
| arrangement | api/song.md, formats/pp_song_spec.md Section 6 |
| translation | api/song.md, formats/pp_song_spec.md Section 7 |
| verse | api/song.md |
| chorus | api/song.md |
| lyrics | api/song.md |
| CCLI | api/ccli.md, api/song.md, formats/pp_song_spec.md Section 3 |
Bundle Structure
| Keyword | Document |
|---|---|
| bundle | api/bundle.md, api/theme.md, formats/pp_bundle_spec.md |
| probundle | api/bundle.md, formats/pp_bundle_spec.md |
| pro6x | formats/pp_bundle_spec.md Section 1 |
| LocalRelativePath | formats/pp_bundle_spec.md Section 3 |
| absolute path | formats/pp_bundle_spec.md Section 2 |
| theme | api/theme.md |
| theme folder | api/theme.md |
| assets | api/theme.md, api/bundle.md |
Playlist Structure
| Keyword | Document |
|---|---|
| playlist | api/playlist.md |
| entry | api/playlist.md |
| header | api/playlist.md |
| presentation | api/playlist.md |
| placeholder | api/playlist.md |
| embedded | api/playlist.md |
Text Handling
| Keyword | Document |
|---|---|
| RTF | formats/pp_song_spec.md Section 9 |
| text | api/song.md, formats/pp_song_spec.md Section 5 |
| plain text | api/song.md |
| Unicode | formats/pp_song_spec.md Section 9 |
| encoding | formats/pp_song_spec.md Section 9 |
| Windows-1252 | formats/pp_song_spec.md Section 9 |
| German characters | formats/pp_song_spec.md Section 9 |
| umlauts | formats/pp_song_spec.md Section 9 |
Actions
| Keyword | Document |
|---|---|
| macro | api/macros.md, api/song.md, formats/pp_song_spec.md Section 5 |
| Macros file | api/macros.md |
| MacroCollection | api/macros.md |
| MacroLibrary | api/macros.md |
| media | api/song.md, api/bundle.md, api/theme.md |
| image | formats/pp_song_spec.md Section 5, formats/pp_bundle_spec.md Section 3, api/theme.md |
| video | formats/pp_song_spec.md Section 5, formats/pp_bundle_spec.md Section 6 |
| cue | formats/pp_song_spec.md Section 5, api/props.md |
| label | api/labels.md, api/song.md, formats/pp_song_spec.md Section 5 |
| Labels file | api/labels.md |
| LabelLibrary | api/labels.md |
| LabelsFileReader | api/labels.md |
| color | api/labels.md, api/macros.md, api/groups.md, api/clear-groups.md |
Global library files
PHP API
Protobuf
| Keyword | Document |
|---|---|
| Presentation | formats/pp_song_spec.md Section 3 |
| CueGroup | formats/pp_song_spec.md Section 4 |
| Cue | formats/pp_song_spec.md Section 5, api/props.md |
| Action | formats/pp_song_spec.md Section 5 |
| Playlist | formats/pp_playlist_spec.md Section 3 |
| PlaylistItem | formats/pp_playlist_spec.md Section 5 |
| UUID | formats/pp_song_spec.md, formats/pp_playlist_spec.md |
| field number | formats/pp_song_spec.md Appendix |
| proto | formats/pp_song_spec.md |
| Template.Document | api/theme.md |
| ProPresenterWorkspace | api/workspace.md |
| ProGroupsDocument | api/groups.md |
| ClearGroupsDocument | api/clear-groups.md |
| MessageDocument | api/messages.md |
| TimersDocument | api/timers.md |
| Stage.Document | api/stage.md |
| PropDocument | api/props.md |
| TestPatternDocument | api/test-patterns.md |
| CalendarDocument | api/calendar.md |
| KeyMappingsDocument | api/key-mappings.md |
| CCLIDocument | api/ccli.md |
Troubleshooting
| Keyword | Document |
|---|---|
| error | api/song.md, api/playlist.md, api/bundle.md |
| exception | api/song.md, api/playlist.md, api/bundle.md |
| empty file | formats/pp_song_spec.md Section 8 |
| edge case | formats/pp_song_spec.md Section 8, formats/pp_playlist_spec.md Section 9 |
| ZIP64 bug | formats/pp_playlist_spec.md Section 4, formats/pp_bundle_spec.md Section 4, api/playlist.md |
| round-trip | internal/learnings.md |
| fidelity | internal/issues.md |
Development
| Keyword | Document |
|---|---|
| TDD | internal/learnings.md |
| PHPUnit | internal/learnings.md |
| composer | internal/learnings.md |
| architecture | internal/decisions.md |
| decision | internal/decisions.md |
| convention | internal/learnings.md |
| issue | internal/issues.md |
| gotcha | internal/issues.md |