<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][13769] trunk/docs: Improve contributor & developer documentation fixing some typos</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/13769">13769</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/13769","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-03-10 14:44:38 +0000 (Sun, 10 Mar 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Improve contributor & developer documentation fixing some typos
Props shailu25
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/9120">#9120</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkdocscontributorcodeREADMEmd">trunk/docs/contributor/code/README.md</a></li>
<li><a href="#trunkdocsdevelopercomponentbuildcomponentmd">trunk/docs/developer/component/build-component.md</a></li>
<li><a href="#trunkdocsdevelopergroupextensionREADMEmd">trunk/docs/developer/group-extension/README.md</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkdocscontributorcodeREADMEmd"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/docs/contributor/code/README.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/contributor/code/README.md 2024-03-10 14:35:31 UTC (rev 13768)
+++ trunk/docs/contributor/code/README.md 2024-03-10 14:44:38 UTC (rev 13769)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -234,7 +234,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> # Git using Pull Requests
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> # First make sure your origin master branch is up to date with BuddyPress remote one.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-git fetch usptream/master
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+git fetch upstream/master
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> # If you need to include some changes which happened upstream, merge them!
</span><span class="cx" style="display: block; padding: 0 10px"> git merge origin/master
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -415,7 +415,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> git pull origin master
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> # Git using Pull Requests
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-git fetch usptream/master
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+git fetch upstream/master
</ins><span class="cx" style="display: block; padding: 0 10px"> git merge origin/master
</span><span class="cx" style="display: block; padding: 0 10px"> git push origin master
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunkdocsdevelopercomponentbuildcomponentmd"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/docs/developer/component/build-component.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/developer/component/build-component.md 2024-03-10 14:35:31 UTC (rev 13768)
+++ trunk/docs/developer/component/build-component.md 2024-03-10 14:44:38 UTC (rev 13769)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -113,7 +113,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'has_directory' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // BP Specigic globals.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // BP Specific globals.
</ins><span class="cx" style="display: block; padding: 0 10px"> parent::setup_globals( $bp_globals );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Your component's globals (if needed).
</span></span></pre></div>
<a id="trunkdocsdevelopergroupextensionREADMEmd"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/docs/developer/group-extension/README.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/developer/group-extension/README.md 2024-03-10 14:35:31 UTC (rev 13768)
+++ trunk/docs/developer/group-extension/README.md 2024-03-10 14:44:38 UTC (rev 13769)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -125,7 +125,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - `edit` – Config options for the ‘edit’ screen, a sub item of the Group's Manage item on the front-end.
</span><span class="cx" style="display: block; padding: 0 10px"> - `submit_text` – The text of the submit button on the edit screen. Defaults to 'Edit'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- - `enabled` – `true` if you want your group extension to have a subtab in the Group Adimn area, otherwise `false`. Defaults to `true`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ - `enabled` – `true` if you want your group extension to have a subtab in the Group Admin area, otherwise `false`. Defaults to `true`.
</ins><span class="cx" style="display: block; padding: 0 10px"> - `name` – The text that appears in the navigation tab for the group extension’s Edit screen. Defaults to the general `name` value described above.
</span><span class="cx" style="display: block; padding: 0 10px"> - `slug` – The string used to create the URL of the admin tab. Defaults to the general `slug` value described above.
</span><span class="cx" style="display: block; padding: 0 10px"> - `screen_callback` – The function BuddyPress will call to display the content of your admin tab. BuddyPress attempts to determine this function automatically;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -175,7 +175,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> - `settings_screen()`: outputs the fallback markup for your `create` / `edit` / `admin` screens.
</span><span class="cx" style="display: block; padding: 0 10px"> - `settings_screen_save()`: called after changes are submitted from the `create` / `edit` / `admin` screens. This method should contain the logic necessary to catch settings form submits, validate submitted settings, and save them to the database.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-**NB**: these 2 methods include the `$group_id` argument so that you can customize your output/handler according to the current group being created, edited or adminstrated.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+**NB**: these 2 methods include the `$group_id` argument so that you can customize your output/handler according to the current group being created, edited or administrated.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> Let's improve our example of basic group extension including a feature to let the creator/administrator of the group decide whether they want to "activate" the group extension main tab for their group.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -192,7 +192,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'nav_item_position' => 105,
</span><span class="cx" style="display: block; padding: 0 10px"> 'access' => 'anyone',
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Set the callback function definining the `$show_tab` argument dynamically.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Set the callback function defining the `$show_tab` argument dynamically.
</ins><span class="cx" style="display: block; padding: 0 10px"> 'show_tab_callback' => array( $this, 'show_tab' ),
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Define the screens using default screen settings.
</span></span></pre>
</div>
</div>
</body>
</html>