diff --git a/README.html b/README.html index 19a9e47..b5dc943 100644 --- a/README.html +++ b/README.html @@ -1,69 +1,69 @@ -

a command-line based blogging platform running on tilde.town

+

a command-line based blogging platform running on tilde.team

-

ttbp stands for “tilde.town blogging platform”, the original working name for +

ttbp stands for "tilde.team blogging platform", the original working name for this project.

-

ttbp main menu screenshot

+

ttbp main menu screenshot

-

ttbp entries view screenshot

+

ttbp entries view screenshot

-

ttbp compose view screenshot

+

ttbp compose view screenshot

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.team. 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.team's gopher server, or +keep all your entries private to the tilde.team server.

-

to use, run feels while logged in to tilde.town

+

to use, run feels while logged in to tilde.team

-

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 +

this is a project that runs on tilde.team, so all users of this program are +expected to operate under the tilde.team code of conduct. content/personal issues should be -worked out according to the CoC, with support from the administrative +worked out according to the CoC, with support from the administrative team if needed.

QUICK START

no coding or html experience is necessary to get started. just log in to your -tilde.town account and enter:

+tilde.team account and enter:

feels

ttbp will ask you a few questions to get you started. after that, writing and reading entries all happen within the program.

-

that’s it!

+

that's it!

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 +

if you're having trouble getting started, or run into program errors or strange +behavior, please ask on irc or send a +mail to sudoers@tilde.team and we'll try to sort things out!

-

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.

+

there's also a function from the main menu that lets you send feedback/inquiries +to me directly

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 +own entry, like a diary page. at midnight for whatever timezone you've set for +your user account on tilde.team, 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 -to the global feels list; if you’ve opted to publish your feels to html/gopher, -those files will update immediately. you can always go back to the current day’s -entry and edit/add as you’d like, but older entries will not be available for +to the global feels list; if you've opted to publish your feels to html/gopher, +those files will update immediately. you can always go back to the current day's +entry and edit/add as you'd like, but older entries will not be available for editing from ttbp.

-

(since files are just stored as plaintext in your directory, it’s possible to +

(since files are just stored as plaintext in your directory, it's possible to edit and move old entries directly from the command line. however, changing old entries might cause strange things to happen with timestamps. the main program looks at the filename first for setting the date, then the last modified time to -sort recent posts. it expects YYYMMDD.txt as the filename; anything else won’t +sort recent posts. it expects YYYMMDD.txt as the filename; anything else won't show up as a valid entry. yes, this means you can post things out of date order by creating files with any date you want.)

@@ -77,34 +77,33 @@ in the feed but not render in a browser (but people can still read them with view-source) -

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.team, 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 +

you can also pull up a list of a single user's feels through check out your neighbors, which displays all users who are writing on ttbp based on their -most recently updated entry, and a link to their public html blog if they’ve +most recently updated entry, and a link to their public html blog if they've opted to publish their posts.

please note! entries written on ttbp should be considered sensitive, 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 +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.team operates on a high level of mutual trust, and ttbp is designed to give individuals control over their content.

subscribing to users

the visit your subscriptions feature lets you view recent entries from a list -of users you’ve subscribed to, as well as manage your subscription list. your +of users you've subscribed to, as well as manage your subscription list. your list is saved to ~/.ttbp/config/subs, which gets automatically updated when you add or remove subscriptions from ttbp.

your subscription list is private; this means no one other than you can see who -you’re following. subscription view only shows the 50 most recent entries from +you're following. subscription view only shows the 50 most recent entries from your subscribe list; if you want to see more entries from an individual, you can navigate to their entries in `check out your neighbors from the main menu.

@@ -115,7 +114,7 @@ menu.

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.team network; other tilde.team users will still be able to read your entries through the ttbp interface, or by directly accessing your ~/.ttbp/entries directory.

@@ -124,14 +123,13 @@ 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.

+with your chosen blog directory.

you can also opt to publish to gopher, and the program will automatically generate a gophermap of your feels.

you can set publishing status on individual entries, or bury individual feels; -see “data management” below for details.

+see "data management" below for details.

data management

@@ -140,42 +138,42 @@ these are all actions you can perform manually from the command line, but doing them from within the program can help keep your files properly linked up.

-

settings

the settings menu lets you change specific options for handling your feels and using the interface.

    -
  • editor–set your text editor
  • -
  • gopher–opt in or out of automatically posting to gopher
  • -
  • post as nopub–set whether posts default to being published or not -published (if you’re not publishing your feels, this doesn’t matter)
  • -
  • publish dir–set the directory under you public_html where feels will be -published (if you’re not publishing your feels, this defaults to None)
  • -
  • publishing–opt in or out of automatically publishing entries to a +
  • editor--set your text editor
  • +
  • gopher--opt in or out of automatically posting to gopher
  • +
  • post as nopub--set whether posts default to being published or not +published (if you're not publishing your feels, this doesn't matter)
  • +
  • publish dir--set the directory under you public_html where feels will be +published (if you're not publishing your feels, this defaults to None)
  • +
  • publishing--opt in or out of automatically publishing entries to a world-readable html page
  • -
  • rainbows–opt in or out of having multicolored menu text
  • +
  • rainbows--opt in or out of having multicolored menu text
-

changing your page layout

you can modify how your blog looks by editing the stylesheet or header and @@ -213,28 +209,24 @@ your ~/.ttbp directory entirely. you might want to back up your

  • to modify your stylesheet, edit your ~/.ttbp/config/style.css
  • to modify the page header, edit your ~/.ttbp/config/header.txt -
      -
    • there’s a place marked off in the default header where you can safely put +
    • there's a place marked off in the default header where you can safely put custom HTML elements!
    • -
    -
  • +
  • to modify the page footer, edit your ~/.ttbp/config/footer.txt
  • -

    general tips/troubleshooting

      -
    • if the date looks like it’s ahead or behind, it’s because you haven’t set +
    • if the date looks like it's ahead or behind, it's because you haven't set your local timezone yet. here are some timezone setting instructions
    • the feels burying tool will effectively clear your post for the day; you can use this feature to start a fresh entry on a particular day by burying the -current day’s feels and then editing a new file
    • +current day's feels and then editing a new file
    -

    future features

    these are a few ideas being kicked around, or under active development:

    @@ -245,7 +237,6 @@ current day’s feels and then editing a new file
  • buried feels browser
  • -

    other ideas are listed on github as upcoming features or feature requests!

    @@ -260,17 +251,16 @@ instance of this yourself)

  • six
  • -

    contributing

    please check out my contributor guidelines -on github if you’d like to get involved with development!

    +on github if you'd like to get involved with development!

    if you find any bugs or strange behavior, please message me locally on tildemail -or open a github issue and i’ll get back to you as soon as i can.

    +or open a github issue and i'll get back to you as soon as i can.

    -

    if you’re interested in helping with the code, please drop me some tildemail!

    +

    if you're interested in helping with the code, please drop me some tildemail!

    i accept tips for development work on liberapay

    @@ -283,5 +273,5 @@ or open a github issue and i’ll get back to you as soon as i can.

  • ~vilmibm, packaging help and gopher support
  • ~sanqui, the bug swatter
  • ~sinacutie, for css updates
  • +
  • ~epicmorphism, for fixing pagination scrolling
  • - diff --git a/README.md b/README.md index d17d2b0..94bc760 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,33 @@ -*a command-line based blogging platform running on tilde.town* +*a command-line based blogging platform running on tilde.team* -`ttbp` stands for "tilde.town blogging platform", the original working name for +`ttbp` stands for "tilde.team blogging platform", the original working name for this project. -![ttbp main menu screenshot](http://tilde.town/~endorphant/ttbp/screenshots/ttbp-main.png) +![ttbp main menu screenshot](screenshots/ttbp-main.png) -![ttbp entries view screenshot](http://tilde.town/~endorphant/ttbp/screenshots/ttbp-entries.png) +![ttbp entries view screenshot](screenshots/ttbp-entries.png) -![ttbp compose view screenshot](http://tilde.town/~endorphant/ttbp/screenshots/ttbp-compose.png) +![ttbp compose view screenshot](screenshots/ttbp-compose.png) `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.team. 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.team's gopher server, or +keep all your entries private to the tilde.team server. -to use, run `feels` while logged in to tilde.town +to use, run `feels` while logged in to tilde.team -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.team, so all users of this program are +expected to operate under the tilde.team [code of +conduct](http://tilde.team/wiki/code-of-conduct). 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.team/wiki/code-of-conduct#9--contact-info) if needed. ### QUICK START no coding or html experience is necessary to get started. just log in to your -tilde.town account and enter: +tilde.team account and enter: `feels` @@ -39,19 +39,19 @@ that's it! ### 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 +behavior, please ask on [irc](https://web.tilde.chat/?join=team) or send a +mail to [sudoers@tilde.team](mailto:sudoers@tilde.team) and we'll try to sort things out! 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 ### 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.team, 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 @@ -79,7 +79,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.team, 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 @@ -91,7 +91,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.team operates on a high level of mutual trust, and `ttbp` is designed to give individuals control over their content. ### subscribing to users @@ -113,7 +113,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.team network; other tilde.team users will still be able to read your entries through the ttbp interface, or by directly accessing your `~/.ttbp/entries` directory. @@ -122,8 +122,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). +with your chosen blog directory. you can also opt to publish to gopher, and the program will automatically generate a gophermap of your feels. @@ -143,7 +142,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.team) * **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. diff --git a/doc/manual.html b/doc/manual.html index 3fe7787..eb24ca4 100644 --- a/doc/manual.html +++ b/doc/manual.html @@ -1,35 +1,45 @@

    FEELS MANUAL

    -

    ttbp stands for "tilde.town blogging platform", the original working name for + +

    ttbp stands for "tilde.team blogging platform", the original working name for this project. the complete codebase is available on -github.

    +tildegit.

    +

    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.team. 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.

    -

    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 +public html file hosted on your tilde page, to tilde.team's gopher server, or +keep all your entries private to the tilde.team server.

    + +

    this is a project that runs on tilde.team, so all users of this program are +expected to operate under the tilde.team code of conduct. content/personal issues should be -worked out according to the CoC, with support from the administrative +worked out according to the CoC, with support from the administrative team 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 +behavior, please ask on #team or send a mail +to sudoers@tilde.team and we'll try to sort things out!

    +

    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 us directly

    +

    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.team, 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 to the global feels list; if you've opted to publish your feels to html/gopher, those files will update immediately. you can always go back to the current day's entry and edit/add as you'd like, but older entries will not be available for editing from ttbp.

    +

    (since files are just stored as plaintext in your directory, it's possible to edit and move old entries directly from the command line. however, changing old entries might cause strange things to happen with timestamps. the main program @@ -37,134 +47,164 @@ looks at the filename first for setting the date, then the last modified time to sort recent posts. it expects YYYMMDD.txt as the filename; anything else won't show up as a valid entry. yes, this means you can post things out of date order by creating files with any date you want.)

    +

    general entry-writing notes

    +
    • you can use markdown
    • you can use html
    • you can also put things between <!-- comments --> to have them show up - in the feed but not render in a browser (but people can still read them with - view-source)
    • +in the feed but not render in a browser (but people can still read them with +view-source)
    +

    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.team, 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 neighbors, which displays all users who are writing on ttbp based on their most recently updated entry, and a link to their public html blog if they've opted to publish their posts.

    +

    please note! entries written on ttbp should be considered sensitive, 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.team operates on a high level of mutual trust, and ttbp is designed to give individuals control over their content.

    +

    privacy

    +

    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.team network; other tilde.team users will still be able to read your entries through the ttbp interface, or by directly accessing your ~/.ttbp/entries directory.

    +

    if you want to further protect your entries, you can chmod 700 your entries 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 +with your chosen blog directory. your blog will also be listed on the main ttbp page.

    +

    you can also opt to publish to gopher, and the program will automatically generate a gophermap of your feels.

    +

    you can set publishing status on individual entries, or bury individual feels; see "data management" below for details.

    +

    data management

    +

    the manage your feels menu provides several tools for organizing your feels. these are all actions you can perform manually from the command line, but doing them from within the program can help keep your files properly linked up.

    +
    • read over feels--a list of all your entries, which you can open and - read like any other feel
    • +read like any other feel
    • modify feels publishing--this lets you toggle privacy on individual - 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)
    • +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.team)
    • 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.
    • +copy to ~/.ttbp/backups/ with the current date, and a second copy to +your home directory for safekeeping.
    • import a feels backup--unpacks a backup file into your current feels - list. this tool checks the ~/.ttbp/backups directory for archives, and - expects a file created by the above backup utility. if it detects any file - collisions, it will preserve your current live copy and leave the backup - verison in a temp directory, and notify you that this happened. also, any - entries that were previously marked as (nopub) will retain their nopub - status.
    • +list. this tool checks the ~/.ttbp/backups directory for archives, and +expects a file created by the above backup utility. if it detects any file +collisions, it will preserve your current live copy and leave the backup +verison in a temp directory, and notify you that this happened. also, any +entries that were previously marked as (nopub) will retain their nopub +status.
    • bury some feels--hides individual feels from viewing; entries are - moved to ~/.ttbp/buried (and marked with a unique timestamp to prevent - file collision) with permissions set to 600, meaning no one except you - will be able to open that file. these entries are also hidden from your - own view from read over feels, and you'll have to open the files from - the command line if you want to see them. this is intended to be a - permament action, so you'll be asked to type the entry date once to load - the feel, then shown a preview of that feel, and then type the date again - to confirm burying.
    • +moved to ~/.ttbp/buried (and marked with a unique timestamp to prevent +file collision) with permissions set to 600, meaning no one except you +will be able to open that file. these entries are also hidden from your +own view from read over feels, and you'll have to open the files from +the command line if you want to see them. this is intended to be a +permament action, so you'll be asked to type the entry date once to load +the feel, then shown a preview of that feel, and then type the date again +to confirm burying.
    • delete feels by day--permanently removes individual entries, - including deleting published html/gopher files if needed. this action is - not recoverable, unless you have a backup to restore; you'll be asked to - type the entry date once to load the feel, then shown a preview of that - feel, and then type the date again to confirm deletion.
    • +including deleting published html/gopher files if needed. this action is +not recoverable, unless you have a backup to restore; you'll be asked to +type the entry date once to load the feel, then shown a preview of that +feel, and then type the date again to confirm deletion.
    • purge all feels--permanently removes all feels, including deleting - all published html/gopher files if needed. this action is not recoverable, - unless you have a backup to restore. you'll be asked to type a - one-time-use purge code to confirm this action.
    • +all published html/gopher files if needed. this action is not recoverable, +unless you have a backup to restore. you'll be asked to type a +one-time-use purge code to confirm this action.
    • wipe feels account--permanently removes all data associated with - feels, including deleting any published hmtl/gopher files and removing - your ~/.ttbp directory. any backups that you have in ~/.ttbp/backups - will also be deleted with this action (which is why the backup function - makes a second copy for safekeeping in your home directory). you will no - longer show up in any lists as a user.
    • +feels
      , including deleting any published hmtl/gopher files and removing +your ~/.ttbp directory. any backups that you have in ~/.ttbp/backups +will also be deleted with this action (which is why the backup function +makes a second copy for safekeeping in your home directory). you will no +longer show up in any lists as a user.
    +

    settings

    +

    the settings menu lets you change specific options for handling your feels and using the interface.

    +
    • editor--set your text editor
    • gopher--opt in or out of automatically posting to gopher
    • post as nopub--set whether posts default to being published or not - published (if you're not publishing your feels, this doesn't matter)
    • +published (if you're not publishing your feels, this doesn't matter)
    • publish dir--set the directory under you public_html where feels will be - published (if you're not publishing your feels, this defaults to None)
    • +published (if you're not publishing your feels, this defaults to None)
    • publishing--opt in or out of automatically publishing entries to a - world-readable html page
    • +world-readable html page
    • rainbows--opt in or out of having multicolored menu text
    +

    changing your page layout

    +

    you can modify how your blog looks by editing the stylesheet or header and footer files. the program sets you up with basic default. if you break your page somehow, you can force the program to regenerate your configuration by deleting your ~/.ttbp directory entirely. you might want to back up your ~/.ttbp/entries directory before you do this.

    +
    • to modify your stylesheet, edit your ~/.ttbp/config/style.css
    • -
    • to modify the page header, edit your ~/.ttbp/config/header.txt
    • +
    • to modify the page header, edit your ~/.ttbp/config/header.txt +
      • there's a place marked off in the default header where you can safely put - custom HTML elements!
      • +custom HTML elements! +
    • to modify the page footer, edit your ~/.ttbp/config/footer.txt
    +

    general tips/troubleshooting

    +
    • if the date looks like it's ahead or behind, it's because you haven't set - your local timezone yet. here are some - timezone setting instructions
    • +your local timezone yet. here are some +timezone setting instructions
    • the feels burying tool will effectively clear your post for the day; you can - use this feature to start a fresh entry on a particular day by burying the - current day's feels and then editing a new file
    • +use this feature to start a fresh entry on a particular day by burying the +current day's feels and then editing a new file
    +

    future features

    +

    these are a few ideas being kicked around, or under active development:

    +
    • stylesheet/theme selector
    • better entry display within ttbp (currently just offloads to less)
    • buried feels browser
    +

    other ideas are listed on github as -upcoming features or feature requests!

    \ No newline at end of file +upcoming features or feature requests!

    diff --git a/doc/manual.md b/doc/manual.md index a09ec22..8d96513 100644 --- a/doc/manual.md +++ b/doc/manual.md @@ -1,37 +1,37 @@ -# FEELS MANUAL # +# FEELS MANUAL -`ttbp` stands for "tilde.town blogging platform", the original working name for +`ttbp` stands for "tilde.team blogging platform", the original working name for this project. the complete codebase is available on -[github](https://github.com/modgethanc/ttbp). +[tildegit](https://tildegit.org/team/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.team. 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.team's gopher server, or +keep all your entries private to the tilde.team 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.team, so all users of this program are +expected to operate under the tilde.team [code of +conduct](http://tilde.team/wiki/code-of-conduct). 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.team/wiki/code-of-conduct#9--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 +behavior, please ask on [#team](https://web.tilde.chat/?join=team) or send a mail +to [sudoers@tilde.team](mailto:sudoers@tilde.team) and we'll try to sort things out! 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 us directly ### 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.team, 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 +59,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.team, 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 +71,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.team operates on a high level of mutual trust, and `ttbp` is designed to give individuals control over their content. ### privacy @@ -80,7 +80,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.team network; other tilde.team users will still be able to read your entries through the ttbp interface, or by directly accessing your `~/.ttbp/entries` directory. @@ -90,7 +90,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.team/~ben/ttbp). you can also opt to publish to gopher, and the program will automatically generate a gophermap of your feels. @@ -110,7 +110,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.team) * **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. diff --git a/setup.py b/setup.py index 5fb662a..6b87c47 100644 --- a/setup.py +++ b/setup.py @@ -5,8 +5,8 @@ from setuptools import setup setup( name='ttbp', version='0.12.2', - description='command line social blogging tool used on tilde.town', - url='https://github.com/modgethanc/ttbp', + description='command line social blogging tool used on tilde.team', + url='https://tildegit.org/team/ttbp', author='~endorphant', author_email='endorphant@tilde.town', license='MIT', diff --git a/ttbp/chatter.py b/ttbp/chatter.py index ed2bbda..d2d7188 100644 --- a/ttbp/chatter.py +++ b/ttbp/chatter.py @@ -16,7 +16,7 @@ DEFAULT_LANG = { ], "bye":[ "see you later, space cowboy", - "bye, townie", + "bye, teammate", "until next time, friend", "come back whenever" ], @@ -24,7 +24,7 @@ DEFAULT_LANG = { "friend", "pal", "buddy", - "townie" + "teammate" ], "months":{ "01":"january", diff --git a/ttbp/config/__init__.py b/ttbp/config/__init__.py index 9a9d5d2..30b96b2 100644 --- a/ttbp/config/__init__.py +++ b/ttbp/config/__init__.py @@ -3,7 +3,7 @@ import os import sys import time -from .. import util +import ttbp.util ## System config @@ -24,8 +24,8 @@ if not os.path.isdir(VAR): if not os.path.isdir(VAR_WWW): os.mkdir(VAR_WWW) -LIVE = 'https://tilde.town/~' -FEEDBOX = "endorphant@tilde.town" +LIVE = 'https://tilde.team/~' +FEEDBOX = "sudoers@tilde.team" USERFILE = os.path.join(VAR, "users.txt") GRAFF_DIR = os.path.join(VAR, "graffiti") WALL = os.path.join(GRAFF_DIR, "wall.txt") @@ -45,7 +45,7 @@ DEFAULT_HEADER = '''
    @@ -83,7 +83,7 @@ SUBS = os.path.join(USER_CONFIG, 'subs') BANNER = ''' ___________________________________________________________ | | -| the tilde.town | +| the tilde.team | | ____ ____ ____ _ ____ ____ _ _ ____ _ _ _ ____ | | |___ |___ |___ | [__ |___ |\ | | __ | |\ | |___ | | | |___ |___ |___ ___] |___ | \| |__] | | \| |___ | @@ -98,9 +98,9 @@ ___________________________________________________________ intro_prompt = """ i don't recognize you, stranger. let's make friends. -the feels engine is an internal blogging platform on tilde.town. it assists you +the feels engine is an internal blogging platform on tilde.team. it assists you in recording your feels, giving you the option to publish to html or gopher, and -read the feels of other users on tilde.town. +read the feels of other users on tilde.team. press to set up an account, or to quit. """.lstrip() @@ -109,6 +109,8 @@ credits = """ ttbp was written for tilde.town by ~endorphant in python. the codebase is publicly available on github at https://github.com/modgethanc/ttbp +the tilde.team fork is maintained here: https://tildegit.org/team/ttbp + tips for development are accepted at https://liberapay.com/modgethanc/ other contributors: @@ -210,7 +212,7 @@ version 0.9.3 features: ~[version 0.10.1 features]~ * thanks to help from ~vilmibm, ttbp now supports publishing to gopher! * if you enable gopher publishing, feels will automatically publish to - gopher://tilde.town/1/~{user}/feels + gopher://tilde.team/1/~{user}/feels * if you don't know what gopher is, it's fine to opt-out; ask around on irc if you'd like to learn more! * the settings menu has been reworked to be less clunky""", @@ -297,7 +299,7 @@ version 0.9.3 features: ~[version 0.12.1 update]~ new feature: "visit your subscriptions" - * view recent entries from a list of townies you've subscribed to + * view recent entries from a list of teammates you've subscribed to * subscription list is private; no one else can see who you're following * add/remove users from the subscription menu diff --git a/ttbp/config/banner-beta.txt b/ttbp/config/banner-beta.txt index d38790f..9f5b705 100644 --- a/ttbp/config/banner-beta.txt +++ b/ttbp/config/banner-beta.txt @@ -1,6 +1,6 @@ __________________________________________________________ | | -| the tilde.town | +| the tilde.team | | ____ ____ ____ _ ____ ____ _ _ ____ _ _ _ ____ | | |___ |___ |___ | [__ |___ |\ | | __ | |\ | |___ | | | |___ |___ |___ ___] |___ | \| |__] | | \| |___ | diff --git a/ttbp/config/defaults/header.txt b/ttbp/config/defaults/header.txt index 4f97989..8b62b81 100644 --- a/ttbp/config/defaults/header.txt +++ b/ttbp/config/defaults/header.txt @@ -6,7 +6,7 @@
    diff --git a/ttbp/config/defaults/style.css b/ttbp/config/defaults/style.css index 204eec7..ec67514 100644 --- a/ttbp/config/defaults/style.css +++ b/ttbp/config/defaults/style.css @@ -1,6 +1,6 @@ body { background-color: #E0B0FF; - font-family: courier + font-family: courier, monospace; } #meta { diff --git a/ttbp/core.py b/ttbp/core.py index d35db94..3059dc9 100644 --- a/ttbp/core.py +++ b/ttbp/core.py @@ -6,6 +6,8 @@ ttbp: tilde town blogging platform a console-based blogging program developed for tilde.town copyright (c) 2016 ~endorphant (endorphant@tilde.town) +forked for tilde.team by ~ben (ben@tilde.team) + core.py: this is a core handler for some ttbp standalone/output functions @@ -30,6 +32,8 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. the complete codebase is available at: https://github.com/modgethanc/ttbp +and +https://tildegit.org/team/ttbp ''' import os @@ -39,12 +43,12 @@ import re import mistune import json -from . import chatter -from . import config -from . import gopher -from . import util +import chatter +import config +import gopher +import util -FEED = os.path.join("/home", "endorphant", "public_html", "ttbp", "index.html") +FEED = os.path.join("/home", "ben", "public_html", "ttbp", "index.html") SETTINGS = {} HEADER = "" @@ -142,7 +146,7 @@ def write_html(outurl="default.html"): outfile = open(os.path.join(config.WWW, outurl), "w") - outfile.write("\n\n") + outfile.write("\n\n") for line in HEADER: outfile.write(line) @@ -174,7 +178,7 @@ def write_page(filename): outurl = os.path.join(config.WWW, "".join(util.parse_date(filename))+".html") outfile = open(outurl, "w") - outfile.write("\n\n") + outfile.write("\n\n") for line in HEADER: outfile.write(line) @@ -247,18 +251,18 @@ def write_global_feed(blogList): - tilde.town feels engine + tilde.team feels engine
    -

    tilde.town feels engine

    +

    tilde.team feels engine

    github repo | state of the ttbp

    -

     

    """) diff --git a/ttbp/gopher.py b/ttbp/gopher.py index 17f02a3..a671faa 100644 --- a/ttbp/gopher.py +++ b/ttbp/gopher.py @@ -6,9 +6,8 @@ import os import time import subprocess -from . import util -from . import config -#from .core import parse_date +import util +import config GOPHER_PROMPT = """ @@ -41,7 +40,7 @@ GOPHERMAP_HEADER = """ this file is automatically generated by ttbp. -0(about ttbp)\t/~endorphant/ttbp.txt\ttilde.town\t70 +0(about ttbp)\t/ttbp.txt\ttilde.team\t70 1(back to user's home)\t/~{user} entries: diff --git a/ttbp/ttbp.py b/ttbp/ttbp.py index 7df3f6e..4b27bae 100644 --- a/ttbp/ttbp.py +++ b/ttbp/ttbp.py @@ -30,6 +30,8 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. the complete codebase is available at: https://github.com/modgethanc/ttbp +and +https://tildegit.org/team/ttbp ''' from __future__ import absolute_import @@ -45,11 +47,11 @@ from six.moves import input import inflect -from . import config -from . import core -from . import chatter -from . import gopher -from . import util +import config +import core +import chatter +import gopher +import util __version__ = "0.12.2" __author__ = "endorphant @@ -611,7 +613,7 @@ def feedback_menu(): if choice in ['0', '1', '2', '3']: cat = SUBJECTS[int(choice)] entered = input(""" -composing a {mail_category} to ~endorphant. +composing a {mail_category} to tilde.team admins. press to open an external text editor. mail will be sent once you save and quit. @@ -806,7 +808,7 @@ def view_neighbors(users, prompt, page=0): sortedUsers.append(user[0]) userIndex.append(user[2]) - ans = menu_handler(sortedUsers, "pick a townie to browse their feels, or type 'q' to go home: ", 15, page, SETTINGS.get("rainbows", False), prompt) + ans = menu_handler(sortedUsers, "pick a teammate to browse their feels, or type 'q' to go home: ", 15, page, SETTINGS.get("rainbows", False), prompt) if ans is not False: (page, choice) = ans @@ -819,7 +821,7 @@ def view_neighbors(users, prompt, page=0): def view_feels(townie): ''' - generates a list of all feels by given townie and displays in + generates a list of all feels by given teammate and displays in date order; allows selection of one feel to read. ''' @@ -1286,7 +1288,7 @@ def send_feedback(entered, subject="none"): id = "#"+util.genID(3) mail = MIMEText(message) mail['To'] = config.FEEDBOX - mail['From'] = config.USER+"@tilde.town" + mail['From'] = config.USER+"@tilde.team" mail['Subject'] = " ".join(["[ttbp]", subject, id]) m = os.popen("/usr/sbin/sendmail -t -oi", 'w') m.write(mail.as_string()) @@ -1358,9 +1360,9 @@ def view_subscribed_feed(subs, prompt=""): def feed_list(townies, delta=30): ''' - given a list of townies, generate a list of 50 most recent entries within + given a list of teammates, generate a list of 50 most recent entries within given interval (default 30 days; 0 days for no limit). validates against - townies with ttbp config files. + teammates with ttbp config files. returns a tuple of (entries, metas) ''' @@ -1425,11 +1427,11 @@ def subscription_manager(subs, intro=""): if choice is not False: if choice == 0: - prompt = "list of townies recording feels:" + prompt = "list of teammates recording feels:" redraw(prompt) subs = subscribe_handler(subs, prompt) elif choice == 1: - prompt = "list of townies you're subscribed to:" + prompt = "list of teammates you're subscribed to:" redraw(prompt) subs = unsubscribe_handler(subs, prompt) else: @@ -1446,7 +1448,7 @@ def unsubscribe_handler(subs, prompt, page=0): subs.sort() - ans = menu_handler(subs, "pick a pal to unsubscribe (or 'q' to cancel): ", 15, page, SETTINGS.get("rainbows", False), "list of townies recording feels:") + ans = menu_handler(subs, "pick a pal to unsubscribe (or 'q' to cancel): ", 15, page, SETTINGS.get("rainbows", False), "list of teammates recording feels:") if ans is not False: (page,choice) = ans @@ -1473,7 +1475,7 @@ def subscribe_handler(subs, prompt, page=0): candidates.sort() - ans = menu_handler(candidates, "pick a townie to add to your subscriptions (or 'q' to cancel): ", 15, page, SETTINGS.get("rainbows", False), "list of townies recording feels:") + ans = menu_handler(candidates, "pick a teammate to add to your subscriptions (or 'q' to cancel): ", 15, page, SETTINGS.get("rainbows", False), "list of teammates recording feels:") if ans is not False: (page, choice) = ans @@ -1659,7 +1661,7 @@ if yes, your feels will be published to a directory of your choice in your public_html. i'll confirm the location of that directory in a moment. -if not, your feels will only be readable from within the tilde.town +if not, your feels will only be readable from within the tilde.team network. if you already have a publishing directory, i'll remove it for you (don't worry, your written entries will still be saved!) @@ -1842,7 +1844,7 @@ def update_user_version(): print(""" * thanks to help from ~vilmibm, ttbp now supports publishing to gopher! * if you enable gopher publishing, feels will automatically publish to - gopher://tilde.town/1/~"""+config.USER+"""/feels + gopher://tilde.team/1/~"""+config.USER+"""/feels """) SETTINGS.update({'gopher': gopher.select_gopher()}) @@ -1877,7 +1879,7 @@ def update_user_version(): }""") print(""" -you're all good to go, """+chatter.say("friend")+"""! please contact ~endorphant if +you're all good to go, """+chatter.say("friend")+"""! please contact the tilde.team admins if something strange happened to you during this update. """)