WordPress HelpHub

https://github.com/wordpress/helphub
Admin
HelpHub is the new portal for all WordPress user documentation, managing the development of this new...
Tokens:10,962
Snippets:23
Trust Score:9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start Vagrant Environment

Source: https://github.com/wordpress/helphub/wiki/Using-Chassis-to-develop-HelpHub

This command starts the Vagrant virtual machine, which provides the development environment for HelpHub.

```shell
vagrant up
```

--------------------------------

### GPL Interactive Program Startup Notice

Source: https://github.com/wordpress/helphub/blob/master/plugins/support-helphub/inc/helphub-contributors/LICENSE.txt

An example of a short notice that an interactive program should display upon starting. It informs users about the program's version, copyright, warranty status, and how to view licensing details.

```text
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### Import Database

Source: https://github.com/wordpress/helphub/wiki/Using-Chassis-to-develop-HelpHub

Instructions to follow for importing the project's database, referencing an external guide.

```shell
# Follow the import database instructions:
# https://github.com/Kenshino/HelpHub/blob/master/CONTRIBUTING.md#import-database
```

--------------------------------

### WordPress Login and Setup

Source: https://github.com/wordpress/helphub/wiki/Using-Chassis-to-develop-HelpHub

Details for logging into the WordPress dashboard, activating necessary plugins, setting the theme, and configuring permalinks.

```wordpress
Login URL: http://helphub.local/wp/wp-login.php
Username: admin
Password: password

Activate Plugins:
- bbPress
- Support HelpHub

Activate Theme:
- WordPress.org Support

Settings -> Permalinks -> Change to "Post Name" and save.
```

--------------------------------

### Install and Build Dependencies

Source: https://github.com/wordpress/helphub/wiki/Using-Chassis-to-develop-HelpHub

This section covers installing project dependencies using npm and running the build process with Grunt.

```shell
cd wp-content
npm install
grunt
cd ..
```

--------------------------------

### Clone Chassis and HelpHub Repositories

Source: https://github.com/wordpress/helphub/wiki/Using-Chassis-to-develop-HelpHub

This snippet outlines the initial steps to clone the Chassis project and the HelpHub WordPress content into the local development environment.

```shell
git clone --recursive https://github.com/Chassis/Chassis chassis-helphub
cd chassis-helphub
git clone https://github.com/Kenshino/HelpHub.git wp-content
```

--------------------------------

### Verify PHP Settings

Source: https://github.com/wordpress/helphub/wiki/Using-Chassis-to-develop-HelpHub

Access the phpinfo page to confirm that `allow_url_fopen` and `allow_url_include` are enabled.

```php
http://helphub.local/phpinfo.php
```

--------------------------------

### Install Project Dependencies with npm

Source: https://github.com/wordpress/helphub/blob/master/CONTRIBUTING.md

Installs all necessary project dependencies defined in the `package.json` file. This command creates a `node_modules` folder containing the required tools for running Grunt tasks.

```shell
npm install
```

--------------------------------

### Provision Vagrant Environment

Source: https://github.com/wordpress/helphub/wiki/Using-Chassis-to-develop-HelpHub

This command re-runs the Vagrant provisioning process, applying the new configuration changes.

```shell
vagrant up --provision
```

--------------------------------

### Configure Local Settings

Source: https://github.com/wordpress/helphub/wiki/Using-Chassis-to-develop-HelpHub

This involves copying a local configuration file and creating a custom INI file to enable specific PHP settings required for the project.

```shell
# Copy config.local.yaml to the chassis-helphub folder
# Create custom.ini in wp-content directory with content:
# allow_url_include = On
```

--------------------------------

### Standard GPL Source File Header

Source: https://github.com/wordpress/helphub/blob/master/plugins/support-helphub/inc/helphub-contributors/LICENSE.txt

This is a standard notice to be attached to the start of each source file when distributing software under the GNU General Public License. It includes copyright information and a summary of licensing terms.

```text
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year>  <name of author>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
```

--------------------------------

### Enable PHP URL Wrappers

Source: https://github.com/wordpress/helphub/blob/master/CONTRIBUTING.md

Essential PHP configuration settings required in `php.ini` to enable URL wrappers, which are necessary for certain file operations during local setup.

```ini
allow_url_fopen = On
allow_url_include = On
```

--------------------------------

### Watch Sass Files for Changes with Grunt

Source: https://github.com/wordpress/helphub/blob/master/CONTRIBUTING.md

Starts the Grunt `watch` task, which monitors all `.scss` files for modifications. It automatically recompiles `style.css` whenever a Sass file is saved, streamlining the development workflow.

```shell
grunt watch
```

--------------------------------

### WordPress Theme Activation

Source: https://github.com/wordpress/helphub/blob/master/README.md

Instructions for setting up the HelpHub project locally. After cloning the repository into the WordPress `wp-content` folder, the `wprog-support` theme must be activated in the admin area for the site to function correctly.

```wordpress
Activate the "wprog-support" theme in the WordPress admin area.
```

--------------------------------

### Clone HelpHub Repository

Source: https://github.com/wordpress/helphub/blob/master/CONTRIBUTING.md

Instructions for cloning the HelpHub GitHub repository to your local machine. This is the first step in setting up a local development environment.

```shell
$ git clone https://github.com/WordPress/HelpHub.git wp-content
```

--------------------------------

### GPL Copyright Disclaimer Sample

Source: https://github.com/wordpress/helphub/blob/master/plugins/support-helphub/inc/helphub-contributors/LICENSE.txt

A sample copyright disclaimer that an employer or institution might sign to disclaim copyright interest in a program written by an employee or student.

```text
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.

<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
```

--------------------------------

### WordPress Localization Text Domain

Source: https://github.com/wordpress/helphub/blob/master/README.md

Guideline for localizing text strings within the HelpHub project. All text strings intended for translation should use `wporg-forums` as the text domain to ensure proper internationalization and localization management.

```php
esc_html_e( 'Your text string', 'wporg-forums' );
__('Your text string', 'wporg-forums');
```

--------------------------------

### Compile Sass to CSS with Grunt

Source: https://github.com/wordpress/helphub/blob/master/CONTRIBUTING.md

Executes the Grunt `sass` task to compile all `.scss` files into the main `style.css` file. This task overrides the existing `style.css` with the latest compiled code from the theme's Sass directory.

```shell
grunt sass
```

--------------------------------

### Access php.ini in VVV

Source: https://github.com/wordpress/helphub/blob/master/CONTRIBUTING.md

Steps to access and modify the `php.ini` file within a Vagrant (VVV) environment, specifically navigating to the PHP FPM configuration directory.

```shell
$ cd <your-path-to-VVV>/vagrant-local
$ vagrant ssh
$ cd /etc/php/7.0/fpm
```

--------------------------------

### WordPress Development Branching Strategy

Source: https://github.com/wordpress/helphub/blob/master/README.md

Defines the branching strategy for feature development and bug fixes within the HelpHub project. Features should be developed in branches prefixed with 'feature-' and bug fixes in branches prefixed with 'fix-'. All branches are submitted via pull request to the 'master' branch.

```git
git checkout -b feature-new-feature-name
# ... develop feature ...
git commit -m "feat: Add new feature"
git push origin feature-new-feature-name

git checkout -b fix-bug-description
# ... fix bug ...
git commit -m "fix: Resolve bug"
git push origin fix-bug-description
```

--------------------------------

### Helphub Codex Languages Shortcode Usage

Source: https://github.com/wordpress/helphub/blob/master/plugins/support-helphub/inc/helphub-codex-languages/readme.txt

Demonstrates how to use the 'codex_languages' shortcode to link to translated articles. It accepts language keywords and article titles as attributes. The shortcode maps language keywords to specific Codex URLs, with special handling for certain languages like Brazilian Portuguese and Chinese due to shortcode restrictions.

```WordPress Shortcode
[codex_languages en="Version 4.6" codex_ja="version 4.6"]
```

--------------------------------

### Helphub Codex Languages - Language Mappings

Source: https://github.com/wordpress/helphub/blob/master/plugins/support-helphub/inc/helphub-codex-languages/readme.txt

This list details the supported language keywords and their corresponding URL structures for linking to translated articles on the WordPress Codex. Note that some language codes are modified (e.g., 'pt-br' becomes 'ptbr_codex') to comply with shortcode restrictions.

```APIDOC
HelphubCodexLanguages:
  SupportedLanguages:
    - Language: Arabic
      Keyword: ar_codex
      URL: codex.wordpress.org/ar:<article>
    - Language: Azerbaijani
      Keyword: azr_codex
      URL: codex.wordpress.org/azr:<article>
    - Language: Azeri
      Keyword: azb_codex
      URL: codex.wordpress.org/azb:<article>
    - Language: Bulgarian
      Keyword: bg_codex
      URL: codex.wordpress.org/bg:<article>
    - Language: Bengali
      Keyword: bn_codex
      URL: codex.wordpress.org/bn:<article>
    - Language: Bosnian
      Keyword: bs_codex
      URL: codex.wordpress.org/bs:<article>
    - Language: Catalan
      Keyword: ca_codex
      URL: codex.wordpress.org/ca:<article>
    - Language: Czech
      Keyword: cs_codex
      URL: codex.wordpress.org/cs:<article>
    - Language: Danish
      Keyword: da_codex
      URL: codex.wordpress.org/da:<article>
    - Language: German
      Keyword: de_codex
      URL: codex.wordpress.org/de:<article>
    - Language: Greek
      Keyword: el_codex
      URL: wpgreece.org/<article>
    - Language: Spanish
      Keyword: es_codex
      URL: codex.wordpress.org/es:<article>
    - Language: Finnish
      Keyword: fi_codex
      URL: codex.wordpress.org/fi:<article>
    - Language: French
      Keyword: fr_codex
      URL: codex.wordpress.org/fr:<article>
    - Language: Croatian
      Keyword: hr_codex
      URL: codex.wordpress.org/hr:<article>
    - Language: Hebrew
      Keyword: he_codex
      URL: codex.wordpress.org/he:<article>
    - Language: Hindi
      Keyword: hi_codex
      URL: codex.wordpress.org/hi:<article>
    - Language: Hungarian
      Keyword: hu_codex
      URL: codex.wordpress.org/hu<article>
    - Language: Indonesian
      Keyword: id_codex
      URL: id.wordpress.net/codex/<article>
    - Language: Italian
      Keyword: it_codex
      URL: codex.wordpress.org/it:<article>
    - Language: Japanese
      Keyword: ja_codex
      URL: wpdocs.sourceforge.jp/<article>
    - Language: Georgian
      Keyword: ka_codex
      URL: codex.wordpress.org/ka:<article>
    - Language: Khmer
      Keyword: km_codex
      URL: khmerwp.com/<article>
    - Language: Korean
      Keyword: ko_codex
      URL: wordpress.co.kr/codex/<article>
    - Language: Lao
      Keyword: lo_codex
      URL: www.laowordpress.com/<article>
    - Language: Macedonian
      Keyword: mk_codex
      URL: codex.wordpress.org/mk:<article>
    - Language: Moldavian
      Keyword: md_codex
      URL: codex.wordpress.org/md:<article>
    - Language: Mongolian
      Keyword: mn_codex
      URL: codex.wordpress.org/mn:<article>
    - Language: Myanmar
      Keyword: mya_codex
      URL: www.myanmarwp.com/<article>
    - Language: Dutch
      Keyword: nl_codex
      URL: codex.wordpress.org/nl:<article>
    - Language: Persian
      Keyword: fa_codex
      URL: codex.wp-persian.com/<article>
    - Language: Farsi
      Keyword: fax_codex
      URL: www.isawpi.ir/wiki/<article>
    - Language: Polish
      Keyword: pl_codex
      URL: codex.wordpress.org/pl:<article>
    - Language: Portuguese_Português
      Keyword: pt_codex
      URL: codex.wordpress.org/pt:<article>
    - Language: Brazilian Portuguese
      Keyword: ptbr_codex
      URL: codex.wordpress.org/pt-br:<article>
    - Language: Romanian
      Keyword: ro_codex
      URL: codex.wordpress.org/ro:<article>
    - Language: Russian
      Keyword: ru_codex
      URL: codex.wordpress.org/ru:<article>
    - Language: Serbian
      Keyword: sr_codex
      URL: codex.wordpress.org/sr:<article>
    - Language: Slovak
      Keyword: sk_codex
      URL: codex.wordpress.org/sk:<article>
    - Language: Slovenian
      Keyword: sl_codex
      URL: codex.wordpress.org/sl:<article>
    - Language: Albanian
      Keyword: sq_codex
      URL: codex.wordpress.org/al:<article>
    - Language: Swedish
      Keyword: sv_codex
      URL: wp-support.se/dokumentation/<article>
    - Language: Tamil
      Keyword: ta_codex
      URL: codex.wordpress.com/ta:<article>
    - Language: Telugu
      Keyword: te_codex
      URL: codex.wordpress.org/te:<article>
    - Language: Thai
      Keyword: th_codex
      URL: codex.wordthai.com/<article>
    - Language: Turkish
      Keyword: tr_codex
      URL: codex.wordpress.org/tr:<article>
    - Language: Ukrainian
      Keyword: uk_codex
      URL: codex.wordpress.org/uk:<article>
    - Language: Vietnamese
      Keyword: vi_codex
      URL: codex.wordpress.org/vi:<article>
    - Language: Chinese
      Keyword: zhcn_codex
      URL: codex.wordpress.org/zh-cn:<article>
    - Language: Chinese (Taiwan)
      Keyword: zhtw_codex
      URL: codex.wordpress.org/zh-tw:<article>
    - Language: Kannada
      Keyword: kn_codex
      URL: codex.wordpress.org/kn:<article>
  ShortcodeRestrictions:
    - Reason: Hyphen character in language codes (e.g., pt-br) is not well-handled by the shortcode API.
    - Solution: Prefixing with 'codex_' and modifying codes (e.g., 'ptbr_codex', 'zhcn_codex', 'zhtw_codex').
    - Reference: https://codex.wordpress.org/Shortcode_API#Hyphens
```

--------------------------------

### Display Post Read Time

Source: https://github.com/wordpress/helphub/blob/master/plugins/support-helphub/inc/helphub-read-time/readme.txt

Provides PHP functions to display a calculated read time estimate for WordPress posts. The `hh_the_read_time()` function can be used within the WordPress loop or with a specific post ID. Read time calculation considers word count, with words within `<pre>` tags weighted double by default. Customization is available via filters like `read_time_types`, `read_time_average`, and `read_time_offset_weight`.

```PHP
<?php hh_the_read_time(); ?>
```

```PHP
<?php hh_the_read_time( $post->ID ); ?>
```
Tokens:
Raw