ipublishing-guideline.txt - 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
ipublishing-guideline.txt (3117B)	Err	bitreich.org	70
i---	Err	bitreich.org	70
i     1 This document will give you a few hints about publishing through	Err	bitreich.org	70
i     2 gopher.	Err	bitreich.org	70
i     3 	Err	bitreich.org	70
i     4 Line length	Err	bitreich.org	70
i     5 ===========	Err	bitreich.org	70
i     6 	Err	bitreich.org	70
i     7 The rendering of content is client specific. However most clients	Err	bitreich.org	70
i     8 will present the user with a text based interface, so you should be	Err	bitreich.org	70
i     9 conservative on the maximum line length in your menus. As clients	Err	bitreich.org	70
i    10 will add a couple of characters to mark item types, a line width of	Err	bitreich.org	70
i    11 69 characters is recommended.	Err	bitreich.org	70
i    12 	Err	bitreich.org	70
i    13 The menu	Err	bitreich.org	70
i    14 ========	Err	bitreich.org	70
i    15 	Err	bitreich.org	70
i    16 The main entry point and user interface between your readers and your	Err	bitreich.org	70
i    17 content is the gopher menu item (item '1' as you may recall).  The	Err	bitreich.org	70
i    18 selectors in a menu will define the information hierarchy. Choose a	Err	bitreich.org	70
i    19 flat hierarchy if you can so readers will get to the content easily	Err	bitreich.org	70
i    20 and without traversing too many menus.	Err	bitreich.org	70
i    21 	Err	bitreich.org	70
i    22 Use helpful item descriptions for your selectors, this will aid both	Err	bitreich.org	70
i    23 human and nonhuman readers: indexers will most likely index menu	Err	bitreich.org	70
i    24 items only.  Be as specific as possible. If it is a binary item type	Err	bitreich.org	70
i    25 hint at its intended format, so your readers will know what to	Err	bitreich.org	70
i    26 expect. Using a useful filename scheme for selectors is also helpful.	Err	bitreich.org	70
i    27 	Err	bitreich.org	70
i    28 You may decorate your menus with informational items (item 'i').	Err	bitreich.org	70
i    29 Clients will display them as is without additional tags.  Around the	Err	bitreich.org	70
i    30 gopherspace a lot of ASCII art is used to create a pleasant	Err	bitreich.org	70
i    31 appearance of a gopher site. Some services also include explanations	Err	bitreich.org	70
i    32 for the specific menu, and use 'i' items for grouping selectors.	Err	bitreich.org	70
i    33 	Err	bitreich.org	70
i    34 There are clients that do not offer a 'back' button. Be kind to those	Err	bitreich.org	70
i    35 users and provide navigational selectors in your menus.  Make the	Err	bitreich.org	70
i    36 journey through your gopher space easy!	Err	bitreich.org	70
i    37 	Err	bitreich.org	70
i    38 On your travels through gopher sites, you will encounter gopher sites	Err	bitreich.org	70
i    39 that use menu and informational items to mimick a page with embedded	Err	bitreich.org	70
i    40 links.  There is an ongoing dispute whether this is good style. We do	Err	bitreich.org	70
i    41 not recommend this style as it delutes the meaning of the menu item.	Err	bitreich.org	70
i    42 For starters you should stick to single file items to store your	Err	bitreich.org	70
i    43 content. Once you gain more experience with publishing content in	Err	bitreich.org	70
i    44 gopher you can always change your mind later!	Err	bitreich.org	70
i    45 	Err	bitreich.org	70
i    46 Selector hierarchy	Err	bitreich.org	70
i    47 ==================	Err	bitreich.org	70
i    48 	Err	bitreich.org	70
i    49 By design a gopher site should present a hierarchy of content	Err	bitreich.org	70
i    50 selectors to the user.  These mimick a file system by intention.	Err	bitreich.org	70
i    51 However this does not need to mtch the real hierarchy of your storage	Err	bitreich.org	70
i    52 filesystem.  An example:	Err	bitreich.org	70
i    53 	Err	bitreich.org	70
i    54 Alicia has a gopher blog (aka 'phlog'). She writes daily posts.  To	Err	bitreich.org	70
i    55 make it easy on her users she has a menu item on the phlog/ selector	Err	bitreich.org	70
i    56 that presents the latest 5 posts and a selector to an archive menu	Err	bitreich.org	70
i    57 linking to all her posts.  On disk however both the menus and the	Err	bitreich.org	70
i    58 articles reside in the same directory. A script creates the	Err	bitreich.org	70
i    59 selectors in the menu files and rotates them. The post files however	Err	bitreich.org	70
i    60 remain untouched and their selectors will not change over time.  This	Err	bitreich.org	70
i    61 means that external links to her post will still be valid later.	Err	bitreich.org	70
i    62 	Err	bitreich.org	70
i    63 Site generators	Err	bitreich.org	70
i    64 ===============	Err	bitreich.org	70
i    65 	Err	bitreich.org	70
i    66 The easiest creation of content is done manually. If you would like	Err	bitreich.org	70
i    67 to automate some task then there are site generators. Most of these	Err	bitreich.org	70
i    68 consists of a collection of shell scripts you can adapt to your	Err	bitreich.org	70
i    69 needs. Search veronica for cl-yag or burrow for starters.	Err	bitreich.org	70
.