Skip to content

Commit 37065d2

Browse files
authored
Contents edited to consolidate instructions within the Wiki and bring more attention to its existence (#1055)
1 parent 1c29766 commit 37065d2

File tree

1 file changed

+6
-90
lines changed

1 file changed

+6
-90
lines changed

Diff for: README.md

+6-90
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Add writers as bylines without creating WordPress user accounts. Simply [create
1919

2020
On the frontend, use the [Co-Authors Plus template tags](https://github.com/Automattic/Co-Authors-Plus/wiki/Template-tags) to list co-authors anywhere you'd normally list the author.
2121

22-
This plugin is an almost complete rewrite of the [Co-Authors](https://wordpress.org/plugins/co-authors/) plugin originally developed by Weston Ruter (2007). The original plugin was inspired by the '[Multiple Authors](https://txfx.net/2005/08/16/new-plugin-multiple-authors/)' plugin by Mark Jaquith (2005).
22+
**For more detailed documentation refer to [the GitHub Wiki for this plugin](https://github.com/Automattic/Co-Authors-Plus/wiki).**
2323

24-
Refer to our [wiki](https://github.com/Automattic/Co-Authors-Plus/wiki) for detailed documentation.
24+
Co-Authors Plus is an almost complete rewrite of the [Co-Authors](https://wordpress.org/plugins/co-authors/) plugin originally developed by Weston Ruter (2007). The original plugin was inspired by the '[Multiple Authors](https://txfx.net/2005/08/16/new-plugin-multiple-authors/)' plugin by Mark Jaquith (2005).
2525

2626
## Installation
2727

@@ -48,7 +48,7 @@ When a user is deleted from WordPress, they will be removed from all posts for w
4848

4949
### Can I use Co-Authors Plus with WordPress multisite?
5050

51-
Yes! Co-Authors Plus can be activated on a site-by-site basis or network-activated. If you create guest authors, however, those guest authors will exist on a site-by-site basis.
51+
Yes! You can [use Co-Authors Plus on WordPress multisite](https://github.com/Automattic/Co-Authors-Plus/wiki#wordpress-multisites). Co-Authors Plus can be activated on a site-by-site basis or network-activated. If you create guest authors, however, those guest authors will exist on a site-by-site basis.
5252

5353
### Who needs permission to do what?
5454

@@ -58,97 +58,13 @@ A WordPress user will need the `list_users` capability to create new guest autho
5858

5959
### Can I easily create a list of all co-authors?
6060

61-
Yes! A template tag called `coauthors_wp_list_authors()` accepts many of the same arguments as `wp_list_authors()`. Look in `template-tags.php` for more details.
61+
Yes! You can [create a list of all co-authors with a template tag](https://github.com/Automattic/Co-Authors-Plus/wiki/Template-tags#create-a-list-of-all-co-authors) `coauthors_wp_list_authors()` template tag. This template tag accepts many of the same arguments as `wp_list_authors()`. Look in `template-tags.php` for more details.
6262

6363
### Can I disable Guest Authors?
6464

65-
Yes! Guest authors can be disabled entirely through a filter. Having the following line load on `init` will do the trick:
65+
Yes! You can disable guest authors entirely through a filter. Having the following line load on `init` will do the trick:
6666
`add_filter( 'coauthors_guest_authors_enabled', '__return_false' )`
6767

6868
## Change Log
6969

70-
[View the change log](https://github.com/Automattic/Co-Authors-Plus/blob/master/CHANGELOG.md).
71-
72-
## Blocks
73-
74-
### Co-Authors
75-
76-
Use this block to create a repeating template that displays the co-authors of a post. By default it contains the Co-Author Name block, but you can add any other block you want to the template. If you choose another Co-Author block like avatar, biography or image it will automatically be supplied the author `context` that it needs. This works similarly to creating a Post Template in a Query Loop block.
77-
78-
The Co-Authors Block supports two layouts:
79-
80-
#### Inline Layout
81-
82-
Use the inline layout to display co-authors in a list on a single wrapping line.
83-
84-
You can control the characters displayed before, between and after co-authors in the list using the block settings, or change the defaults using the following server-side filters:
85-
86-
```
87-
coauthors_default_before
88-
coauthors_default_between
89-
coauthors_default_between_last
90-
coauthors_default_after
91-
```
92-
93-
#### Block Layout
94-
95-
Use the block layout to display co-authors in a vertical stack. While using the block layout you can use block spacing settings to control the vertical space between co-authors.
96-
97-
Then you can create your own layout using blocks like group, row or stack and it will be applied to each co-author, similar to applying a layout to each post in a query loop.
98-
99-
### Co-Author Name
100-
101-
This block displays a co-author's `Display Name` and optionally turns it into a link to their author archive.
102-
103-
Using the block's advanced settings you can select which HTML element is used to output the name. This is useful in contexts such as an author archive where you might want their name to be a heading.
104-
105-
### Co-Author Avatar
106-
107-
Like the post author avatar, or comment author avatar, this block displays a small scale square image of a co-author and utilizes the Gravatar default avatars as configured in your site's discussion options.
108-
109-
To customize the available sizes, use the [rest_avatar_sizes](https://developer.wordpress.org/reference/hooks/rest_avatar_sizes/) filter.
110-
111-
### Co-Author Biography
112-
113-
This block outputs the biographical information for a co-author based on either their user or guest author data.
114-
115-
The content is wrapped in paragraph elements using `wpautop` and is escaped using `wp_kses_post`.
116-
117-
### Co-Author Featured Image
118-
119-
This block requires the use of Guest Authors. Because guest author avatars are uploaded to the WordPress media library, there are more options for displaying these images.
120-
121-
This block utilizes the image sizes configured in your theme and your site's media settings to present a guest author's avatar at a larger scale or higher resolution. It does not support Gravatars.
122-
123-
## Block Context
124-
125-
### Post, Page, Query Loop
126-
127-
By default, all blocks receive the post context. The job of the Co-Authors Block is to use this context to find the relevant authors and provide context to its inner blocks.
128-
129-
### Author Archive
130-
131-
If you want to display data about the author on their own archive, use the individual co-author blocks directly without wrapping them in the Co-Authors Block. During requests for an author archive the correct context is derived from the `author_name` query variable and provided to all blocks that declare their use of the context `co-authors-plus/author`.
132-
133-
### Extending
134-
135-
If you make a custom block and want to use the author context, add `co-authors-plus/author` to the `usesContext` property in your block.json file.
136-
137-
Example:
138-
```json
139-
{
140-
"usesContext": ["co-authors-plus/author"]
141-
}
142-
```
143-
144-
## Block Example Data
145-
146-
When working with Full Site Editing, or in the post editor before the authors are loaded, example data is used. The example data provided with the co-author blocks resembles a response to the `/coauthors/v1/coauthors/:user-nicename` REST API endpoint.
147-
148-
### Extending
149-
150-
If you have written a plugin that modifies the REST API response, you can similarly modify the example data either on the server-side using the filter `coauthors_blocks_store_data` or the client-side using the filter `co-authors-plus.author-placeholder`.
151-
152-
## Block Non-support
153-
154-
To declare a lack of support for Co-Author Plus blocks on your site, use the filter `coauthors_plus_support_blocks` to return `false`.
70+
[View the change log](https://github.com/Automattic/Co-Authors-Plus/blob/master/CHANGELOG.md).

0 commit comments

Comments
 (0)