WordPress.org
Get WordPress

Plugin Directory

Changeset 3404760


Ignore:
Timestamp:
11/28/2025 07:12:58 AM (3 months ago)
Author:
codoc
Message:

modify readme.txt

File:
1 edited

Legend:

Unmodified
Added
Removed

  • codoc/trunk/readme.txt

    r3404641 r3404760  
    22Contributors: codoc
    33Donate link: https://codoc.jp
    4 Tags: codoc, paywall, editor, subscription
     4Tags: codoc, paywall, editor, subscription, reader plans, membership, tipping, monetization, content sales
    55Requires at least: 4.6
    66Tested up to: 6.8.2
    … …  
    1010License URI: https://www.gnu.org/licenses/gpl-2.0.html
    1111
    12 A WordPress plugin for monetizing websites by enabling paid articles, subscriptions(memberships), and tipping.
     12A WordPress plugin for monetizing your website with paid articles, Reader Plans, and tipping.
    1313
    1414== Description ==
    1515
    16 With this plugin, you can quickly implement the sale of paid articles, subscription services, and tipping on your WordPress website.
    17 
    18 After configuring the plugin, it provides the codoc block※ on the post editor screen for selling articles.
    19 ※The codoc block is compatible with both the Gutenberg block editor and the Classic Editor (TinyMCE).
    20 
    21 The sales mechanism is simple. Blocks (or text) placed below the codoc block in the post content can only be accessed by users who have made a payment (credit card transaction). Conversely, blocks placed above are accessible to all users for free. The codoc block not only displays product information for purchasing articles but also manages authentication for users who have purchased the articles. Pricing, subscription specifications, and other sales conditions can be specified on a per-article basis within the block settings.
    22 
    23 Additionally, all the necessary features for content sales, such as revenue management and customer management, are available on the codoc website. Purchase history and subscription management for customers who have made article purchases are also provided on the codoc website.
     16codoc is a simple and powerful WordPress paywall plugin that enables creators to sell paid articles, offer **Reader Plans (Subscription / Membership)**, and accept tips.
     17
     18Originally built for Japanese creators, codoc is also fully compatible with users in the US/EU. 
     19Payment is processed via Stripe, and buyers worldwide can purchase using a valid credit card (currency: JPY).
     20
     21After setup, the plugin adds a **codoc block※** to the post editor. 
     22※Compatible with both Gutenberg and the Classic Editor (TinyMCE).
     23
     24### How it works
     25Content placed **below** the codoc block becomes the paid section and is hidden from non-buyers. 
     26Content placed **above** remains freely available.
     27
     28The codoc block:
     29- displays the purchase interface 
     30- handles buyer authentication 
     31- allows per-article settings such as price or Reader Plan availability 
     32- all revenue/customer management is available on codoc.jp
     33
     34More details : 
     35https://codoc.jp/en/lp_wp
     36
     37Help center : 
     38https://codoc.jp/en/enquiries/create
     39
     40== Features ==
     41
     42- Article paywall 
     43- One-time purchases 
     44- **Reader Plans (Subscription / Membership)** 
     45- Tipping support 
     46- Stripe payments (Credit card / Apple Pay / Google Pay / BNPL) 
     47- Gutenberg & Classic Editor support 
     48- Featured image support 
     49- Revenue & customer management via codoc.jp 
     50- Insert custom HTML before/after codoc tags 
     51- CSS override support 
     52- Team/multi-creator support 
     53- Safe authentication & Stripe-level fraud prevention
    2454
    2555== Installation ==
    2656
    27 1. Search for the "codoc" plugin from "Plugins → Add Plugin" in your WordPress dashboard.
    28 
    29 2. Install and activate the codoc plugin.
    30 
    31 3. Go to "Settings → codoc Settings" and log in or register for a codoc account.
    32 
    33 4. Proceed to the codoc blog integration feature and click "Authenticate".
    34 
    35 5. Go to the codoc Settings page in WordPress and confirm the display of "your@address authenticated" message.
    36 
    37 Once the above settings are complete, you can start using the codoc block by searching for "codoc" in the "Add Block" section of the post editor※.
    38 ※For users of the Classic Editor, a codoc configuration button will be added.
     571. Go to **Plugins → Add New** and search for “codoc”.
     582. Install and activate the plugin.
     593. Go to **Settings → codoc** and log in or register for a codoc account.
     604. Continue to the codoc integration page and click **Authenticate**.
     615. Return to the codoc settings page and verify that your account shows "**authenticated**".
     62
     63After setup, search for **codoc** in the block inserter. 
     64※Classic Editor users will see a codoc button added to the toolbar.
    3965
    4066== FAQ ==
    4167
    42 = What are the conditions for creators to sell content using codoc? =
    43 
    44 The current requirement is to have a residence and a bank account within Japan and United States.
    45 
    46 = What are the conditions for users to purchase content?
    47 
    48 Users who can use a credit card, including those outside of Japan, can make purchases. The currency used is only yen.
    49 
    50 = Where are the free and paid parts of the articles stored? =
    51 
    52 All article content is saved in both WordPress and codoc.
    53 
    54 = Will the publication status be reflected in codoc? =
    55 
    56 Yes, it will be reflected. It will only be published on the codoc side if it is published on the WordPress side. (Otherwise, it will be set as unpublished on codoc.)
    57 
    58 = What happens to the codoc articles if I delete them in WordPress? =
    59 
    60 They will become unpublished.
    61 
    62 = How can I see how the article appears to buyers and non-buyers? =
    63 
    64 The view for buyers will be the same as when they log in with their codoc account by clicking "Already purchased, log in" displayed in the article. (The purchase button will disappear, and they can access the paid area.) The view for non-buyers will be the same as the state before logging in (not logged in). When you log in with an account other than your own, only the login button will not be displayed.
    65 
    66 = I can see the paid area of the article even though I haven't purchased it. Why is that? =
    67 
    68 It is because you are logged in as the codoc creator, who is the author of the relevant article being sold on the website.
    69 
    70 = Can I use the plugin in the Classic Editor? =
    71 
    72 Yes, it is possible. After completing the integration settings, a codoc logo button will be added to the editor toolbar. You can use this button to add codoc blocks and configure article settings such as pricing in the main text. We also recommend enabling the "keep paragraph tags in the Classic block and the Classic Editor" option in the settings of the TinyMCE Advanced plugin that is installed for use.
    73 
    74 = Can I specify a featured image? =
    75 
    76 The featured image specified in the WordPress post will be used as the codoc featured image.
    77 
    78 = Can I customize the CSS? =
    79 
    80 You can override the CSS by specifying the custom CSS path in the codoc settings screen. Please import the original CSS file from https://codoc.jp/css/paywall.css and overwrite the relevant parts. Note that the HTML output generated by codoc may be subject to changes without prior notice, so please be aware of that.
     68= What are the requirements for creators to use codoc? =
     69Creators must have a residence and bank account in **Japan or the United States**.
     70
     71= Can users outside Japan purchase content? =
     72Yes. Anyone with a valid credit card can purchase. 
     73Transactions are processed in **JPY**.
     74
     75= Where are article contents stored? =
     76All content is stored on **both WordPress and codoc**.
     77
     78= Will publication status sync to codoc? =
     79Yes. 
     80If the WordPress article is **published**, it is published on codoc as well. 
     81Otherwise, it remains **unpublished**.
     82
     83= What happens to codoc content if the WordPress article is deleted? =
     84It becomes **unpublished** on codoc.
     85
     86= How can I preview the article as buyers/non-buyers? =
     87- As buyer: Click **"Already purchased, log in"** and authenticate with your codoc account. 
     88- As non-buyer: Log out and view the article normally.
     89
     90= I can see paid content even without purchasing. Why? =
     91You are logged in as the **codoc creator**, who authored the article.
     92
     93= Can I use the Classic Editor? =
     94Yes. 
     95After integration, a codoc button is added to the toolbar.
     96
     97If TinyMCE Advanced is installed, enable: 
     98**"keep paragraph tags in the Classic block and the Classic Editor"**
     99
     100= Can I use featured images? =
     101Yes. 
     102The WordPress featured image is used on codoc.
     103
     104= Can I customize CSS? =
     105Yes. 
     106Specify your custom CSS file in **Settings → codoc**. 
     107Base stylesheet: https://codoc.jp/css/paywall.css 
     108※HTML output may change without notice.
     109
     110You can see sample customized css on this screen.(sign-in is required)
     111https://codoc.jp/me/widgets?mode=theme
    81112
    82113= Can I change the permalink registered in codoc? =
    83 
    84 The links are obtained from get_permalink(). If it is different from what is expected, such as when running WordPress under a reverse proxy, you can change it using the replacement settings in the codoc settings screen.
    85 
    86 = The codoc block displays "This block contains unexpected or invalid content." =
    87 
    88 Please perform "Recover Block" from the settings button in the upper right corner of the block.
    89 
    90 = Does JavaScript code work? =
    91 
    92 Since April 22, 2020, the specification has been changed to allow script tags for external JavaScript loading to work. This supports embedding blocks for platforms like Twitter and Instagram in Gutenberg.
    93 
    94 = I want to add a button at the end of the article body. =
    95 
    96 If you add a block below the codoc tags, it will be hidden. Therefore, if you want to add social sharing buttons or advertisements, etc., please use the "Insert HTML before and after codoc tags" feature in the "Settings → codoc" section, instead of doing it directly on the post editor.
    97 
    98 = Shortcodes are being displayed as they are in the paid part. =
    99 
    100 In the "Settings → codoc" section, specify the following in the debug parameter. If it doesn't work, increase the number:
    101 
    102 { "the_content_filter_priority": 1000000 }
     114Permalinks are retrieved via `get_permalink()`. 
     115If running through reverse proxies or special routing, adjust via codoc’s “Replacement Settings”.
     116
     117= “This block contains unexpected or invalid content.” appears =
     118Click **“Attempt Block Recovery”** in the block settings menu.
     119
     120= Do script tags work? =
     121Yes. 
     122External script tags have been supported since April 22, 2020 (Twitter/Instagram embeds, etc.)
     123
     124= I want to add buttons at the end of the article =
     125Blocks added **below** the codoc tag are hidden. 
     126Use: 
     127**Settings → codoc → Insert HTML before/after codoc tags**
     128
     129= Shortcodes are shown as plain text inside paid areas =
     130Add this to the debug settings:
     131
     132  { “the_content_filter_priority”: 1000000 }
     133
     134Increase the value if needed.
    103135
    104136== Screenshots ==
Note: See TracChangeset for help on using the changeset viewer.