iInitial guideline for publishing - gopher-tutorials - The gopher tutorials project.	Err	bitreich.org	70
hgit clone git://bitreich.org/gopher-tutorials/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/gopher-tutorials/	URL:git://bitreich.org/gopher-tutorials/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/gopher-tutorials/	bitreich.org	70
1Log	/scm/gopher-tutorials/log.gph	bitreich.org	70
1Files	/scm/gopher-tutorials/files.gph	bitreich.org	70
1Refs	/scm/gopher-tutorials/refs.gph	bitreich.org	70
1Tags	/scm/gopher-tutorials/tag	bitreich.org	70
i---	Err	bitreich.org	70
1commit 389858fe316692d3f34db820c55a547157356d8f	/scm/gopher-tutorials/commit/389858fe316692d3f34db820c55a547157356d8f.gph	bitreich.org	70
1parent 385a02079d7706da0700db3a53dcd83005db032d	/scm/gopher-tutorials/commit/385a02079d7706da0700db3a53dcd83005db032d.gph	bitreich.org	70
hAuthor: Christian Kellermann <ckeen@pestilenz.org>	URL:mailto:ckeen@pestilenz.org	bitreich.org	70
iDate:   Thu, 29 Mar 2018 22:24:21 +0200	Err	bitreich.org	70
i	Err	bitreich.org	70
iInitial guideline for publishing	Err	bitreich.org	70
i	Err	bitreich.org	70
iSigned-off-by: Christoph Lohmann <20h@r-36.net>	Err	bitreich.org	70
i	Err	bitreich.org	70
iDiffstat:	Err	bitreich.org	70
i  A publishing-guideline.txt            |      69 ++++++++++++++++++++++++++++++	Err	bitreich.org	70
i	Err	bitreich.org	70
i1 file changed, 69 insertions(+), 0 deletions(-)	Err	bitreich.org	70
i---	Err	bitreich.org	70
1diff --git a/publishing-guideline.txt b/publishing-guideline.txt	/scm/gopher-tutorials/file/publishing-guideline.txt.gph	bitreich.org	70
i@@ -0,0 +1,69 @@	Err	bitreich.org	70
i+This document will give you a few hints about publishing through	Err	bitreich.org	70
i+gopher.	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+Line length	Err	bitreich.org	70
i+===========	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+The rendering of content is client specific. However most clients	Err	bitreich.org	70
i+will present the user with a text based interface, so you should be	Err	bitreich.org	70
i+conservative on the maximum line length in your menus. As clients	Err	bitreich.org	70
i+will add a couple of characters to mark item types, a line width of	Err	bitreich.org	70
i+69 characters is recommended.	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+The menu	Err	bitreich.org	70
i+========	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+The main entry point and user interface between your readers and your	Err	bitreich.org	70
i+content is the gopher menu item (item '1' as you may recall).  The	Err	bitreich.org	70
i+selectors in a menu will define the information hierarchy. Choose a	Err	bitreich.org	70
i+flat hierarchy if you can so readers will get to the content easily	Err	bitreich.org	70
i+and without traversing too many menus.	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+Use helpful item descriptions for your selectors, this will aid both	Err	bitreich.org	70
i+human and nonhuman readers: indexers will most likely index menu	Err	bitreich.org	70
i+items only.  Be as specific as possible. If it is a binary item type	Err	bitreich.org	70
i+hint at its intended format, so your readers will know what to	Err	bitreich.org	70
i+expect. Using a useful filename scheme for selectors is also helpful.	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+You may decorate your menus with informational items (item 'i').	Err	bitreich.org	70
i+Clients will display them as is without additional tags.  Around the	Err	bitreich.org	70
i+gopherspace a lot of ASCII art is used to create a pleasant	Err	bitreich.org	70
i+appearance of a gopher site. Some services also include explanations	Err	bitreich.org	70
i+for the specific menu, and use 'i' items for grouping selectors.	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+There are clients that do not offer a 'back' button. Be kind to those	Err	bitreich.org	70
i+users and provide navigational selectors in your menus.  Make the	Err	bitreich.org	70
i+journey through your gopher space easy!	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+On your travels through gopher sites, you will encounter gopher sites	Err	bitreich.org	70
i+that use menu and informational items to mimick a page with embedded	Err	bitreich.org	70
i+links.  There is an ongoing dispute whether this is good style. We do	Err	bitreich.org	70
i+not recommend this style as it delutes the meaning of the menu item.	Err	bitreich.org	70
i+For starters you should stick to single file items to store your	Err	bitreich.org	70
i+content. Once you gain more experience with publishing content in	Err	bitreich.org	70
i+gopher you can always change your mind later!	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+Selector hierarchy	Err	bitreich.org	70
i+==================	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+By design a gopher site should present a hierarchy of content	Err	bitreich.org	70
i+selectors to the user.  These mimick a file system by intention.	Err	bitreich.org	70
i+However this does not need to mtch the real hierarchy of your storage	Err	bitreich.org	70
i+filesystem.  An example:	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+Alicia has a gopher blog (aka 'phlog'). She writes daily posts.  To	Err	bitreich.org	70
i+make it easy on her users she has a menu item on the phlog/ selector	Err	bitreich.org	70
i+that presents the latest 5 posts and a selector to an archive menu	Err	bitreich.org	70
i+linking to all her posts.  On disk however both the menus and the	Err	bitreich.org	70
i+articles reside in the same directory. A script creates the	Err	bitreich.org	70
i+selectors in the menu files and rotates them. The post files however	Err	bitreich.org	70
i+remain untouched and their selectors will not change over time.  This	Err	bitreich.org	70
i+means that external links to her post will still be valid later.	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+Site generators	Err	bitreich.org	70
i+===============	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+The easiest creation of content is done manually. If you would like	Err	bitreich.org	70
i+to automate some task then there are site generators. Most of these	Err	bitreich.org	70
i+consists of a collection of shell scripts you can adapt to your	Err	bitreich.org	70
i+needs. Search veronica for cl-yag or burrow for starters.	Err	bitreich.org	70
.