search

ReadAlongs / Studio-Web-archived

ReadAlong Studio Web Interface
Other
2 stars 2 forks source link

Document the plain text format #12

Closed joanise closed 1 year ago

joanise commented 2 years ago

The Studio-Web app should document our plain-text format: 1 newline marks sentence break; 2 mark paragraph break; 3 mark page break.

joanise commented 2 years ago

This documentation should be visible on the Step 1 page, or else there could be a help button in the Text widget (or component, or div, whatever you call it...) to display it. The help button could be labelled Formatting rules?

Right now that format is documented in the CLI in readalongs align -h in the most details, and more briefly in readalongs make-xml -h, but those two sources are not available to the web app.

It's also documented here: https://readalong-studio.readthedocs.io/en/latest/cli-guide.html#getting-from-txt-to-xml-with-readalongs-make-xml but that's another source that's not super helpful.