social-doc/README.md

GNU social: The Unofficial Manuals

This is an effort to produce high quality HTML documentation for GNU social in English.

To build the documentation simply run php render.php. The output HTML will be in the rendered/ subfolder.

Rendered versions are available online:

• User Guide - https://karp.id.au/social/user/
• Admin Guide - https://karp.id.au/social/admin/

Editing

• Add or edit HTML in html/user/ or html/admin
• Add or edit images, etc., in resources/user/ or resources/admin
• Ensure the page listing is up-to-date in configs/user.config.php and configs/admin.config.php
• Run php render.php and check it worked
• Submit a pull request so everybody gets smarter

Various template substitutions are available. These are the most important ones.

{HEADING:SECTION:section:My Heading}             -- becomes an <h2> with internal name "section"
{HEADING:SUBSECTION:subsection:My subheading}    -- becomes an <h3> with internal name "subsection"
{LINK:section}                                   -- becomes an <a> to appropriate_page.html#section
<img src="{RES:foo.png}" />                      -- src is set to correct path for resource "foo.png"

License

• Copyright 2016 Thomas Karpiniec tk@1.21jiggawatts.net. (If this ever becomes official documentation then obviously copyright will be assigned to the FSF.)
• Copyright 2015 Free Software Foundation, Inc.
• Copyright 2015 StatusNet, Inc

This documentation (under html/ and resources/) is made available under the terms of the Creative Commons Attribution 3.0 Unported license. See http://creativecommons.org/licenses/by/3.0/ for details.

The renderer render.php is made available under the terms of the GNU General Public License version 3. See https://www.gnu.org/licenses/gpl-3.0.html for details.

Acknowledgements

Much of the initial content is copied and adapted from the documentation in the main GNU social project at https://git.gnu.io/gnu/gnu-social/ under the terms of Creative Commons Attribution 3.0 Unported license.