omeka / plugin-Timeline

Create TimelineJS timelines accessible via ExhibitBuilder blocks or shortcode.
0 stars 1 forks source link

Documentation: Timeline Plugin #3

Closed matthewjmckinley closed 1 year ago

matthewjmckinley commented 1 year ago

Testing Issue #1 for reference--let me know if I can assist or explain something, thanks!

katknow commented 1 year ago

@allanaaa I'm currently working on this, but if you think we need a screenshot of the interval would you mind taking one since they don't appear for me? If you don't think we need one no worries

katknow commented 1 year ago

Here's a draft I'm still working on, but quick question before I continue--does the section on timeline compatibility with exhibit builder go in this documentation or in the exhibit builder documentation (I'm thinking back to this issue: https://github.com/omeka-s-modules/Mapping/issues/92? Or maybe does it go in both?

sharonmleon commented 1 year ago

This is likely a good question for @allanaaa

allanaaa commented 1 year ago

I would just say "Timeline integrates with the [Exhibit Builder plugin](), by adding a new Timeline block option to exhibit pages." on the Timeline page. I'd add subsections for it and Geolocation (and Exhibit Image Annotation too I guess) on the Exhibit Builder page in the "Additional layouts" section (and then use that heading link). There isn't anything you can really do in the Exhibits interface, in terms of settings, so it doesn't need much detail on either page, maybe just a screengrab of the New Block frame on the Timeline page.

Geolocation has the same problem, and I'd say it's a bit too repetitive on both pages: https://omeka.org/classic/docs/Plugins/Geolocation/#geolocation-and-exhibit-builder

You'll also need to add a Timeline section to the Plugin Shortcodes page, same deal: https://omeka.org/classic/docs/Content/Shortcodes/#plugin-shortcodes

katknow commented 1 year ago

I created a new branch in the enduser repo that includes the Timeline documentation draft. I've also made edits to the Exhibit Builder page and the Shortcodes page. @allanaaa once we decide its good I can pare down the Geolocation page to match it if you want and its section on Exhibit Builder (I can also add info on Annotation)

One thing that we might want changed is that I just noticed in exhibit builder when you go to add a new timeline block it says timeline twice:

image

allanaaa commented 1 year ago

That "Timeline timeline" is fixed now. If you're happy with your documentation, go ahead and make a pull request and I'll do one last review of your changes. I just did some last testing in themes but I think we're good to go on this.

katknow commented 1 year ago

@allanaaa just to clarify, am I making a pull request to merge it with the main branch?

matthewjmckinley commented 1 year ago

@allanaaa @katknow I think this plugin is ready to go now from a testing perspective--is the documentation ready also?

katknow commented 1 year ago

@matthewjmckinley I think it is! There is a timeline branch on the documentation repo