Skip to content

Commit 005197c

Browse files
authored
Fix broken images, add some missing classes, mention preference for singular object classes
2 parents d064bd0 + 938ecab commit 005197c

File tree

6 files changed

+24
-4
lines changed

6 files changed

+24
-4
lines changed

basics/writing-a-skin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The skin system is also a great way to get familiar with CSS in general or the A
2424

2525
Here we'll walk through a simple skin that modifies the Archive's default appearance by changing fonts and colors, adding images, and adjusting margins and borders.
2626

27-
![A user dashboard with our skin: a bright diagonal striped background, translucent white main content, and translucent yellow dashboard sections](/images/writing_a_skin_preview.png)
27+
![A user dashboard with our skin: a bright diagonal striped background, translucent white main content, and translucent yellow dashboard sections](../images/writing_a_skin_preview.png)
2828

2929
For our colors and images, we'll be using a stripe pattern called [sing together](https://www.colourlovers.com/pattern/850926/sing_together) and its color palette, [like fireflies](https://www.colourlovers.com/palette/1172215/like_fireflies), both of which are by [electroCUTE!](https://www.colourlovers.com/lover/electroCUTE%21). You'll need to save and upload the background image to an image host, but because you are the only one seeing your skin, you probably don't need to worry about running out of bandwidth.
3030

classes-taxonomy.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,8 @@ We can divide types into two abstract classes:
121121

122122
The abstract class `.object` encompasses classes that correspond with database records. These are typically a *type* of record that corresponds with a model name, such as `.work` or `.user`, but sometimes they're *specific* records, such as the `.rating-teen` class that corresponds with the [Teen and Up Audiences rating tag](https://archiveofourown.org/tags/Teen%20And%20Up%20Audiences).
123123

124+
These class names are almost always singular, with the exception of `tags`.
125+
124126
* .user
125127
* .work
126128
* .chapter
@@ -160,6 +162,7 @@ The abstract class `.object` encompasses classes that correspond with database r
160162
* .prompt
161163
* .item
162164
* .signup
165+
* .assignment
163166

164167
### data
165168

@@ -181,6 +184,7 @@ The abstract class `.data` encompasses classes that describe the type or format
181184
* .notice
182185
* .error
183186
* .icon
187+
* .rss
184188
* .symbol
185189
* .help
186190
* .question

patterns/blurb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The styles for blurbs are located in [the stylesheet named 13-group-blurb.css](h
2626

2727
The work blurb is the most used chunk of HTML code in the Archive, so we've revised it a lot. It has to contain lots of information and allow different ways of accessing its material. The blurb is flexible, accessible, and has multiple redundancies (says the same thing in different ways).
2828

29-
![Work blurb in the default Archive style](/images/workblurb.png)
29+
![Work blurb in the default Archive style](../images/workblurb.png)
3030

3131
Since we usually have many blurbs listed together, the index page that holds the blurbs is coded as an HTML list, and each blurb is coded as a list item. If a page will only ever contain one blurb (e.g., the adult content warning), the blurb can be coded as a different element, such as a `div`.
3232

@@ -217,7 +217,7 @@ While the HTML structure of the blurb is incredibly important and should not be
217217

218218
Here you see two different examples of the work blurb from the AO3, one using the default CSS and one using a skin, which have some of their fields mapped to the blurb diagram to help give you the idea.
219219

220-
![work blurbs](/images/blurb_diagram_mapping.png)
220+
![work blurbs](../images/blurb_diagram_mapping.png)
221221

222222
These blurbs use *the same HTML*. The only thing different is the CSS.
223223

patterns/comments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ An individual comment is always a `li` contained within an `ol`. These comment l
8080

8181
To illustrate the HTML for threads, we'll diagram the following example. Each `li` with the `comment` class contains the HTML diagramed in the previous section.
8282

83-
![Two top-level comments, with two direct reples to the second top-level comment. The second reply also has a reply.](/images/comment_thread_for_diagram.png)
83+
![Two top-level comments, with two direct reples to the second top-level comment. The second reply also has a reply.](../images/comment_thread_for_diagram.png)
8484

8585
<div class="diagram">
8686
<ol>

patterns/indexes.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,14 @@ An index can be any of the three kinds of HTML list.
3232

3333
You can **never** have **any** other kind of index.
3434

35+
#### HTML classes
36+
37+
An index usually has an [object type class](../class-taxonomy#types): `work index group`, `assignment index group`, `reading index group`.
38+
39+
These class names should almost always be singular. The main exception to this is tags: `tags index group`.
40+
41+
If you find a plural other than `tags`, it's probably a mistake that needs to be corrected.
42+
3543
### dl.index
3644

3745
`dl.index` is sometimes used to display simple paired data (e.g. on a [translated news post](https://archiveofourown.org/admin_posts/148)), but it more often functions as a sort of brief alternative to showing a full blurb (or a full list of blurbs).

patterns/listbox.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,14 @@ The following diagram is taken from [an index of fandoms for a specific media ty
101101
</ol>
102102
</div>
103103

104+
### HTML classes
105+
106+
A listbox usually has an [object type class](../class-taxonomy#types): `work listbox group`, `assignment listbox group`, `reading listbox group`.
107+
108+
These class names should almost always be singular. The main exception to this is tags: `tags index group`.
109+
110+
If you find a plural other than `tags`, it's probably a mistake that needs to be corrected.
111+
104112
## Notes
105113

106114
We call it listbox (instead of indexbox) because a listbox might be a dynamically inserted form or form component, and therefore would need managed focus. This seems most closely related to [the ARIA role listbox](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/listbox_role).

0 commit comments

Comments
 (0)