Including html of bokeh javascript visualizations does not result in interactive plots on published simple pages

Using {{site.url}}{{site.baseurl}}

A recent PR adds Captcha v2 support, which we should document and update screenshots for alongside the next release.

New adapter option for ZendS3:

forceSSL: use HTTPS urls for files stored in S3. Useful to prevent mixed content errors/warnings when the Omeka site is accessed via HTTPS.

http://omeka.org/classic/docs/GettingStarted/Feature_List/

List of docs not referenced in the navigation generated by MkDocs

MkDocs supports links that will target=_blank with a little modification.

mkdocs/mkdocs#1958

I think it would be good for our user manuals to pop open external resources (DCMI guides, showcase sites, etc.) in separate tabs rather than take people away from the docs.

Any objections, or things to consider?

It just kind of looks like the case studies pages, or at least some of them, got kind of left by the wayside: they include old codex links and stuff like that.

• Content / Items

  • Edit an item section looks to be halfway through a rewrite
  • Batch Edit.png screenshot doesn't exist

• Admin / Plugin Shortcodes

  • Separating the plugin shortcodes from the others feels like a step backwards, plus now that big table has to be replicated

• Admin / Themes

  • Same screenshot used for "header and footer" and "homepage" options (homepage is the one that's missing)

• Admin / Search Settings

  • Image "Search settings page, with Item, File, and Collection checkboxes active" doesn't exist

• Plugins / Geolocation

  • Duplicate shortcode documentation

• Plugins / Shortcode Carousel

  • Duplicate shortcode documentation

• Troubleshooting / Troubleshooting

  • Fairly bad advice about checking for mod_rewrite (a holdover from the old docs, and the docs themselves even complain about it)

• General

  • No equivalent for "Report a Bug" page
  • Many (all?) shortcode pages maintain mediawiki definition list wikitext, resulting in colons and semicolons all over the place

Via the forums: https://forum.omeka.org/t/missing-tutorial-pages-on-omeka-docs/5588

Missing pages for

the Understanding Omeka_Record_AbstractRecord and the Understanding Omeka_Controller_AbstractActionController tutorial pages are completely blank

Hi,
nice to see an update for Omeka Classic.

I can't seem to find an upgrade guide from version 2 to 3. Only 1 to 2.
I am currently running 2.7.1.

Would be nice to have that in the Docs.

Thanks ahead

The Upgrading instructions have several caveats throughout that aren't really relevant for the vast majority of users.

We should probably just pull all those notes out into a separate heading, to say OK, if you're using 0.9 (!) then db.ini is here, if before 2.0 "files" is "archive", etc, without cluttering the basic instructions.

• Admin-selectable default query type for simple search (#797, contributed by @luku)

On this page:
https://omeka.org/classic/docs/

In this block of text:

The "appearance" and "site settings" links are broken.

Thought you guys would like to know. Thanks for all of your work!!

We link to the Mapbox docs which used to show this list, but they seem to have removed it from their docs, so maybe we should just list it ourselves:

mapbox.streets
mapbox.light
mapbox.dark
mapbox.satellite
mapbox.streets-satellite
mapbox.wheatpaste
mapbox.streets-basic
mapbox.comic
mapbox.outdoors
mapbox.run-bike-hike
mapbox.pencil
mapbox.pirates
mapbox.emerald
mapbox.high-contrast

This is one of the most important parts of the manual and seems to have lost a few things in translation.

There's quite a few broken links (a known issue, I think), but also some links to things that don't appear to be their own pages anymore, like Preparing to Install. There's also remaining references to distribution-specific instructions for Fedora, Ubuntu, etc., and I don't think those actually made it over into the new manual (with good cause, but then we should remove the references to them as well).

In GettingStarted/Searching the boolean mode is described as:

Boolean, in which you can add Boolean operators like AND and NOT

In reality, the boolean mode uses MySQL's syntax as described in their docs. The main options are to use + before terms to require them (effectively AND), and - before terms to require they not be present (NOT), though there are some other operators also.

Hi...this seems like a small issue, but, the PHP upgrade link is deprecated: http://www.php.net/manual/en/migration5.php

The link is under : Upgrading Your System with the link name Upgrading PHP

Perhaps a better link might be : https://www.php.net/manual/en/appendices.php --> this has all the various pages for different migrations ...ie 5.4 to 5.6 ... 7.0 to 7.1

Happy to fork and make changes as well.

Manu

I need to provide a listing of the OOTB item-type elements available in Omeka Classic. I've customized mine and can't remember 🧠 what the defaults were... I don't seem to be able to find a list of these anywhere in the Docs--might be helpful?

UPDATE I should be more specific, just in case-- I'm looking at the Omeka Classic User Manual (I *think this is the right place to post an issue...)

We've just upgraded a site to Silver Plan and I've been trying to add custom CSS but when I click save changes it doesn't seem to save them. Saving goes back to the Plug-in list page with the message "The CSS Editor plugin was successfully configured!" but when I go back into it again there is nothing saved in that textarea.

The site is http://travellercollection.omeka.net

Moving this over from https://github.com/omeka/omeka-org/issues/48.

In #44 I am making some preliminary changes to improve accessibility. This includes, so far:

• Increasing the main div max-width to 1400px, which makes our screenshots easier to read.
• Including title fields for all images, not just alt, so that users (who are not using assistive tech but may still be having trouble with our images) can mouse-over to get a description of the image.
• Increasing the size of the code snippets (they were set at 75%).

Currently our link colours are too low-contrast and will need to be changed. (https://wave.webaim.org/report#/https://omeka.org/classic/docs/Content/Items/)
WCAG requires:

• 4.5:1 text-to-background contrast;
• 3:1 link-to-regular-text contrast;
• something like an underline that appears on hover or focus.

I wouldn't mind adding something else on non-hover links, maybe increasing the font-weight a bit, but there aren't any gradients between regular and bold with our font. Other suggestions would be great.
(I'll replicate our stylistic decisions here on to the S and .net docs later.)

I know the colours are a branding issue so I'd love some feedback there.

How should we include our hosting in documentation?

• Getting Started> Hosting Solutions

Do we need a similar section & page for Omeka S?

Status of translations fluctuates with the code, so it may make sense to delete the status column from the page. We could, in fact, probably delete the entire table and replace it with a screencap of the Transifex page showing where the language codes are listed for each translation.

ref

• Plugin and theme update notifications (on their respective admin pages). config.ini setting versionNotifications set to false should disable the notifications
• Tag browse for items should sort alphabetical by default on public view
• New config.ini settings mail.force_from and mail.force_from_name: make all outgoing mail originate from the given address (and optionally the given "friendly" name)
• New config.ini setting sslTrustProxy: if the ssl setting is enabled, whether to trust the contents of the "X-Forwarded-Proto" HTTP header (useful if you want to use the ssl setting but are hosting Omeka behind a proxy server)

There's now a much more robust list of the available configuration keys in the developer documentation at http://omeka.org/s/docs/developer/reference/configuration/

The configuration page in the manual should probably link to that, explaining that the manual lists only some of the most commonly-used options, and that a more comprehensive list can be found there.

Right now it's just sort of... there

As far as I can tell, every single relative link (inside the docs) on this page, https://omeka.org/classic/docs/GettingStarted/Feature_List/, isn't working. All the external links, and the PDF link at the beginning (which is also relative) is working fine. This problem happens a lot across the docs.

Currently a lot of relative links look like this:

[Library of Congress Suggest](../Plugins/Library_of_Congress_Suggest/)
[Simple Vocab](Plugins/SimpleVocab/)
[Exhibit Builder](../Plugins/ExhibitBuilder)

Working links look like this:

[CSV Import](../Plugins/CSV_Import.md)
[editing](../../Content/Item_Types.md#edit-an-existing-item-type)

Two things to note:

• Hovering over a link in the docs won't actually show you what's happening behind the scenes; all the links look like "https://omeka.org/classic/docs/Plugins/ItemRelations/" and etc. even if they're actually ../Plugins/ItemRelations.md in the code.
• And a link that works on the github display version (https://github.com/omeka/classic-enduser/blob/master/docs/GettingStarted/Feature_List.md) may not work on the docs, and vice-versa.

I'm creating this issue as a sort of show-my-work, a place to refer back to my own instructions, and discussion space if needed. I'll introduce a big PR to fix links and some minor copyediting stuff across the whole of the user manual. I'm also checking and updating/removing external links, as in #42. And I'm making some style/syntax-guide edits to a copy of the staff "working with the user manuals" google doc that I'll merge when they're ready.

Let me know if I've missed anything or if this doesn't seem right. Thanks!

To avoid things like the current "Installation/Installation" page.