TildeClub/ttbp
1
0
Fork 0
mirror of https://github.com/tildeclub/ttbp.git synced 2026-01-24 02:40:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

tilde.club fork

Browse Source
This commit is contained in:
Ben Harris
2020-06-23 14:05:14 -04:00
parent 0aaedaff5a
commit 530f078744
13 changed files with 191 additions and 263 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
doc/manual.html
View File

@@ -1,29 +1,27 @@
<h1>FEELS MANUAL</h1>
<p><code>ttbp</code> stands for "tilde.town blogging platform", the original working name for
this project. the complete codebase is available on
<a href="https://github.com/modgethanc/ttbp">github</a>.</p>
<a href="https://github.com/tildeclub/ttbp">github</a>.</p>
<p><code>ttbp</code> runs from the command line, providing a hub for writing personal blog
posts and reading posts written by other users of tilde.town. it's a little bit
posts and reading posts written by other users of tilde.club. it's a little bit
like livejournal or dreamwidth or tumblr. you can opt to publish your posts to a
public html file hosted on your tilde page, to tilde.town's gopher server, or
keep all your entries private to the tilde.town server.</p>
<p>this is a project that runs on tilde.town, so all users of this program are
expected to operate under the tilde.town <a href="http://tilde.town/wiki/conduct.html">code of
public html file hosted on your tilde page, to tilde.club's gopher server, or
keep all your entries private to the tilde.club server.</p>
<p>this is a project that runs on tilde.club, so all users of this program are
expected to operate under the tilde.club <a href="http://tilde.club/wiki/code-of-conduct.html">code of
conduct</a>. content/personal issues should be
worked out according to the CoC, with support from the <a href="http://tilde.town/wiki/administration/index.html">administrative
worked out according to the CoC, with support from the <a href="https://tilde.club/wiki/code-of-conduct.html#contact-info">administrative
team</a> if needed.</p>
<h3>support</h3>
<p>if you're having trouble getting started, or run into program errors or strange
behavior, please send internal tilde.town mail to ~endorphant and i'll try to
sort things out!</p>
behavior, please hop on irc and contact ben or deepend.</p>
<p>there's also a function from the main menu that lets you send feedback/inquiries
to me directly; this uses internal tilde.town mail, which is what i'll respond
to.</p>
to me directly; this uses email, which is what i'll respond to.</p>
<h3>writing entries</h3>
<p>entries are recorded as plaintext files in your <code>~/.ttbp/entries</code> directory.
<code>ttbp</code> will use your selected editor to open and write files; each day is its
own entry, like a diary page. at midnight for whatever timezone you've set for
your user account on tilde.town, you'll get a fresh entry. if you don't write
your user account on tilde.club, you'll get a fresh entry. if you don't write
any feels on a particular day, no entries will show up there.</p>
<p>when you save and quit the text editor, your entry will automatically propagate
to the global feels list; if you've opted to publish your feels to html/gopher,
@@ -47,7 +45,7 @@ by creating files with any date you want.)</em></p>
</ul>
<h3>reading other feels</h3>
<p>the <code>browse global feels</code> feature shows the ten most recent entries that anyone
has written on ttbp. this list is only accessible from within tilde.town,
has written on ttbp. this list is only accessible from within tilde.club,
although individual entries may be posted to html or gopher.</p>
<p>you can also pull up a list of a single user's feels through <code>check out your
neighbors</code>, which displays all users who are writing on <code>ttbp</code> based on their
@@ -57,20 +55,20 @@ opted to publish their posts.</p>
private information, even if a particular user is publishing entries in a
world-viewable way! please be respectful about having access to other people's
feels, and do not copy/repeat any information without getting their explicit
permission. tilde.town operates on a high level of mutual trust, and <code>ttbp</code> is
permission. tilde.club operates on a high level of mutual trust, and <code>ttbp</code> is
designed to give individuals control over their content.</p>
<h3>privacy</h3>
<p>when you start your ttbp, you have the option of publishing or not publishing
your blog.</p>
<p>if you opt to not publish, your entires will never be accessible from outside of
the tilde.town network; other tilde.town users will still be able to read your
the tilde.club network; other tilde.club users will still be able to read your
entries through the ttbp interface, or by directly accessing your
<code>~/.ttbp/entries</code> directory.</p>
<p>if you want to further protect your entries, you can <code>chmod 700</code> your entries
directory.</p>
<p>if you opt to publish, the program creates a directory <code>~/.ttbp/www</code> where it
stores all html files it generates, and symlinks this from your <code>~/public_html</code>
with your chosen blog directory. your blog will also be listed on the <a href="https://tilde.town/~endorphant/ttbp">main ttbp
with your chosen blog directory. your blog will also be listed on the <a href="https://tilde.club/wiki/ttbp.html">main ttbp
page</a>.</p>
<p>you can also opt to publish to gopher, and the program will automatically
generate a gophermap of your feels.</p>
@@ -87,7 +85,7 @@ them from within the program can help keep your files properly linked up.</p>
posts. entries marked <code>(nopub)</code> will not get written to html or gopher,
and toggling them from this menu will immediately publish or unpublish
that entry (if you're not publishing your posts at all, these settings
won't matter, since your feels will never show up outside of tilde.town)</li>
won't matter, since your feels will never show up outside of tilde.club)</li>
<li><strong>backup your feels</strong>--makes a .tar.gz of all your entries, saving one
copy to <code>~/.ttbp/backups/</code> with the current date, and a second copy to
your home directory for safekeeping.</li>

34
doc/manual.md
View File

@@ -2,36 +2,34 @@
`ttbp` stands for "tilde.town blogging platform", the original working name for
this project. the complete codebase is available on
[github](https://github.com/modgethanc/ttbp).
[github](https://github.com/tildeclub/ttbp).
`ttbp` runs from the command line, providing a hub for writing personal blog
posts and reading posts written by other users of tilde.town. it's a little bit
posts and reading posts written by other users of tilde.club. it's a little bit
like livejournal or dreamwidth or tumblr. you can opt to publish your posts to a
public html file hosted on your tilde page, to tilde.town's gopher server, or
keep all your entries private to the tilde.town server.
public html file hosted on your tilde page, to tilde.club's gopher server, or
keep all your entries private to the tilde.club server.
this is a project that runs on tilde.town, so all users of this program are
expected to operate under the tilde.town [code of
conduct](http://tilde.town/wiki/conduct.html). content/personal issues should be
this is a project that runs on tilde.club, so all users of this program are
expected to operate under the tilde.club [code of
conduct](http://tilde.club/wiki/code-of-conduct.html). content/personal issues should be
worked out according to the CoC, with support from the [administrative
team](http://tilde.town/wiki/administration/index.html) if needed.
team](https://tilde.club/wiki/code-of-conduct.html#contact-info) if needed.
### support
if you're having trouble getting started, or run into program errors or strange
behavior, please send internal tilde.town mail to ~endorphant and i'll try to
sort things out!
behavior, please hop on irc and contact ben or deepend.
there's also a function from the main menu that lets you send feedback/inquiries
to me directly; this uses internal tilde.town mail, which is what i'll respond
to.
to me directly; this uses email, which is what i'll respond to.
### writing entries
entries are recorded as plaintext files in your `~/.ttbp/entries` directory.
`ttbp` will use your selected editor to open and write files; each day is its
own entry, like a diary page. at midnight for whatever timezone you've set for
your user account on tilde.town, you'll get a fresh entry. if you don't write
your user account on tilde.club, you'll get a fresh entry. if you don't write
any feels on a particular day, no entries will show up there.
when you save and quit the text editor, your entry will automatically propagate
@@ -59,7 +57,7 @@ by creating files with any date you want.)*
### reading other feels
the `browse global feels` feature shows the ten most recent entries that anyone
has written on ttbp. this list is only accessible from within tilde.town,
has written on ttbp. this list is only accessible from within tilde.club,
although individual entries may be posted to html or gopher.
you can also pull up a list of a single user's feels through `check out your
@@ -71,7 +69,7 @@ opted to publish their posts.
private information, even if a particular user is publishing entries in a
world-viewable way! please be respectful about having access to other people's
feels, and do not copy/repeat any information without getting their explicit
permission. tilde.town operates on a high level of mutual trust, and `ttbp` is
permission. tilde.club operates on a high level of mutual trust, and `ttbp` is
designed to give individuals control over their content.
### privacy
@@ -80,7 +78,7 @@ when you start your ttbp, you have the option of publishing or not publishing
your blog.
if you opt to not publish, your entires will never be accessible from outside of
the tilde.town network; other tilde.town users will still be able to read your
the tilde.club network; other tilde.club users will still be able to read your
entries through the ttbp interface, or by directly accessing your
`~/.ttbp/entries` directory.
@@ -90,7 +88,7 @@ directory.
if you opt to publish, the program creates a directory `~/.ttbp/www` where it
stores all html files it generates, and symlinks this from your `~/public_html`
with your chosen blog directory. your blog will also be listed on the [main ttbp
page](https://tilde.town/~endorphant/ttbp).
page](https://tilde.club/wiki/ttbp.html).
you can also opt to publish to gopher, and the program will automatically
generate a gophermap of your feels.
@@ -110,7 +108,7 @@ them from within the program can help keep your files properly linked up.
posts. entries marked `(nopub)` will not get written to html or gopher,
and toggling them from this menu will immediately publish or unpublish
that entry (if you're not publishing your posts at all, these settings
won't matter, since your feels will never show up outside of tilde.town)
won't matter, since your feels will never show up outside of tilde.club)
* **backup your feels**--makes a .tar.gz of all your entries, saving one
copy to `~/.ttbp/backups/` with the current date, and a second copy to
your home directory for safekeeping.