Copyedits #44
Copyedits #44
Conversation
First pass. Note:s - I'm working on standardizing headers in terms of Title Cases. Some things that are just bold (e.g. Feature List headings) are being taken down to Sentence case. I think H2 through H4 can also come down to Sentence case (Questions to ask while planning; Try Omeka Classic before installing) but haven't inputted it yet. - Standardizing when things have periods at the end (paragraph yes, title no, last item of list yes, items of lists if they are complete sentences yes). Still deciding on when to use colons (e.g. "Scholars:"). - Moved the "How to spot an Omeka site" down in the "Examples" page. I might even put it further down, after the teaching section. - Used cached versions of those links. - Technically, 508 is a section of the "Rehabilitation Act" not the ADA? News to me. - There is a Classic_vs_Net.md page in the GettingStarted/ folder that appears not to be linked anywhere. Should it be deleted, or added to the nav? - There is a MkDocs video plugin we can add that will allow us to embed our screencasts (or some of them at least) on the Screencasts page and throughout the docs. Could make those videos more used. - Did some misc clarification and specification of language used. Minor testing like "Does the exhibits dropdown in the advanced search show only public exhibits" and etc.? - I am biased but I prefer the term "database" or "collections" or etc. instead of "archive" wherever it's used to refer to items added.
|
Oh yeah, and jury's still out on whether you should capitalize "boolean." |
Notes: I added "admonitions" to the site so we can do big WARNING boxes on the docs, etc. site_url is supposed to be required in MkDocs. I think we may be able to have a link in the docs back to the Classic website, which is something I'm very much for. I added a warning on the system requirements page about plugin dependencies, using one example I was aware of. Will add more, ideally all of them, over time. Because I mention PdfText in the sysreqs page, I edited the plugin page too. I will do more when I get to that section properly (updating images, etc.). Sysreqs now has the upgrade-your-dependencies info from Installation - made more sense there I think. Setting Directory Permissions should be expanded more - with examples, screenshots of where to look for permissions, etc. - just did a short intro to what the heck we're talking about for now. That or we find a reliable external resource to send people to. Updated the language page, but cutoff at 5% interface translation. Should be higher perhaps? Maybe as much as 50% or more? Installation: I cut "LAMP server setup". Unless there is an alternative process, this is THE installation method, it doesn't need a name. Clarified some one-click install stuff. More soon, but mentioning it here makes sense (not Dreamhost anymore). Removed some deprecated language here about there being 2 .htaccess files? Downloaded the 1.3.1 package to be sure how that worked. Happy to be corrected if what I've written is inaccurate. Clarified that you have to recompress your updated files and then upload that, if you have command line access. Do we want to institute a cutoff for mentions of older versions? Like anything before 2.0 doesn't need to be mentioned in the docs? Or we could fork this doc for a new 3.+ version and cut all the old mentions out of that.
|
Fixes #32 now too. |
New link colours, new link border-bottoms to match our S docs. New code snippet colour. Still 1400px wide. Resized a few images while thinking about how to deal with image viewability.
Mostly just link cleanup. Some redundant image removal. One obsolete plugin removal.
|
A recap of the major stuff:
More detailed notes with each commit. The easiest way to see it all is to skim the changes https://github.com/omeka/classic-enduser/pull/44/files and see if anything jumps out at you for review. I did some testing to verify some of the early pages, stuff in Content and Admin, so if there are meaningful language changes to check up on, they'll be there. I didn't do any technical stuff on the plugins page or after, so those can be skimmed quickly. |
|
Re: Database vs. collections vs. archive. As much as possible we would like to eliminate the use of the word archive. Generally I like collection, but that can be confusing in the context of Omeka Classic where Collections are a feature. As a result, I tend to default to repository of items. |
|
Question about the specifying the colors of the elements of the interface in the narrative documentation: does this create accessibility confusion based on the perception of the color names? I.e. does teal mean too many different things to too many different people? |
|
On the styling for feature lists, etc.: In some cases you’ve converted colons to periods, but not all (see Admin General Settings). So changing
To
We have tended to use the colon, but I’m happy to go with the change if it’s consistent |
|
I think that we're okay with the redundancy in the Item Type Element Set documentation because the edit interface does engages both in the left hand navigation and in the General Settings section. |
Fair question. The original alt text referred to a red arrow, which I suppose was from a previous image version, so I just updated it. I don't find the teal arrows very visible either. Might be best to redo some of the image annotations in higher contrast and redo the alt text again. (I assume teal was chosen from the branding colours....) |
Whoops!
I can't see what this refers to. Can you tell me the page you were on? Or I can make a note to cover it in the next update. |
Same for this comment - there are quite a few mentions left, not sure which one in particular this refers to, but I've made a note to be more comprehensive on the next pass, unless you'd rather I zap them all now. |
|
Those "here" comments from Sharon look like they're supposed to be line comments on the diff... Github can see that they're "reviews" but isn't showing what lines they go with for some reason. |
|
That's super annoying. I'm working in the Github app which appears to let me comment on individual line diffs, as John suggests. I'll have to figure out some other way to do this. |
|
If it helps, for me they show up attached to the lines when you look at the list of file changes.... |
I figured it must have been something like that. If you want to just write in some extra details manually about what files & lines, I can hunt them down and we can figure out the app-to-website issue later. |
|
I'll circle back after I review some other stuff and make a list of the files and lines. |
|
Looks great, thanks! I'll get on these ASAP. Could you also merge #42 if you're happy with it for now? |
|
I haven't looked at that one yet, but I'll get there ASAP. |
|
@sharonmleon @zerocrates Anything else to add to or remove from this PR before it gets merged? The only outstanding is whether you want me to do a sweep to remove contractions. |
|
No worries on the contractions. |
First pass.
Notes:
Fixes Broken links in the docs #43 .