iAdd files, to give hints in how to contribute. - 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 12d4f2a6057e3143bdbf2cd53ab3489ba8af93b3 /scm/gopher-tutorials/commit/12d4f2a6057e3143bdbf2cd53ab3489ba8af93b3.gph bitreich.org 70 1parent 6a7a956f93c5884dbf7a9d297a3a5c093aeb227d /scm/gopher-tutorials/commit/6a7a956f93c5884dbf7a9d297a3a5c093aeb227d.gph bitreich.org 70 hAuthor: Christoph Lohmann <20h@r-36.net> URL:mailto:20h@r-36.net bitreich.org 70 iDate: Mon, 24 Dec 2018 12:20:54 +0100 Err bitreich.org 70 i Err bitreich.org 70 iAdd files, to give hints in how to contribute. Err bitreich.org 70 i Err bitreich.org 70 i* Add alpha stage comment to main index. Err bitreich.org 70 i Err bitreich.org 70 iDiffstat: Err bitreich.org 70 i A dynamic-publishing.txt | 7 +++++++ Err bitreich.org 70 i A gopher-history.txt | 7 +++++++ Err bitreich.org 70 i A gopher-ml.txt | 7 +++++++ Err bitreich.org 70 i M index.gph | 7 +++++++ Err bitreich.org 70 i A irc.txt | 7 +++++++ Err bitreich.org 70 i A lynx-w3m.txt | 7 +++++++ Err bitreich.org 70 i A menu-types.txt | 7 +++++++ Err bitreich.org 70 i A overbite.txt | 7 +++++++ Err bitreich.org 70 i A protocol-introduction.txt | 7 +++++++ Err bitreich.org 70 i A protocol-search.txt | 7 +++++++ Err bitreich.org 70 i A proxy.txt | 7 +++++++ Err bitreich.org 70 i A publish-geomyidae.txt | 7 +++++++ Err bitreich.org 70 i M publish-gophernicus.txt | 55 +++---------------------------- Err bitreich.org 70 i A publish-pygopherd.txt | 7 +++++++ Err bitreich.org 70 i M publishing-guideline.txt | 70 ++----------------------------- Err bitreich.org 70 i A sacc.txt | 7 +++++++ Err bitreich.org 70 i A server.txt | 7 +++++++ Err bitreich.org 70 i Err bitreich.org 70 i17 files changed, 113 insertions(+), 117 deletions(-) Err bitreich.org 70 i--- Err bitreich.org 70 1diff --git a/dynamic-publishing.txt b/dynamic-publishing.txt /scm/gopher-tutorials/file/dynamic-publishing.txt.gph bitreich.org 70 i@@ -0,0 +1,7 @@ Err bitreich.org 70 i+This is a to be done tutorial. Err bitreich.org 70 i+ Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. Err bitreich.org 70 i+ Err bitreich.org 70 i+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! Err bitreich.org 70 i+ Err bitreich.org 70 1diff --git a/gopher-history.txt b/gopher-history.txt /scm/gopher-tutorials/file/gopher-history.txt.gph bitreich.org 70 i@@ -0,0 +1,7 @@ Err bitreich.org 70 i+This is a to be done tutorial. Err bitreich.org 70 i+ Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. Err bitreich.org 70 i+ Err bitreich.org 70 i+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! Err bitreich.org 70 i+ Err bitreich.org 70 1diff --git a/gopher-ml.txt b/gopher-ml.txt /scm/gopher-tutorials/file/gopher-ml.txt.gph bitreich.org 70 i@@ -0,0 +1,7 @@ Err bitreich.org 70 i+This is a to be done tutorial. Err bitreich.org 70 i+ Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. Err bitreich.org 70 i+ Err bitreich.org 70 i+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! Err bitreich.org 70 i+ Err bitreich.org 70 1diff --git a/index.gph b/index.gph /scm/gopher-tutorials/file/index.gph.gph bitreich.org 70 i@@ -7,6 +7,13 @@ The following files will help to understand how to use Gopher. The Err bitreich.org 70 i different documents target different kinds of users with different Err bitreich.org 70 i ttechnical skill levels. Err bitreich.org 70 i Err bitreich.org 70 i+ Err bitreich.org 70 i+____________________________A_L_P_H_A__S_T_A_G_E_________________________ Err bitreich.org 70 i+ Err bitreich.org 70 i+Gopher Tutorials is in an alpha stage. You will see, which tutorials need Err bitreich.org 70 i+additional input. Please help us in making this complete! See below, how Err bitreich.org 70 i+to contribute. Err bitreich.org 70 i+ Err bitreich.org 70 i ___________________________U_S_I_N_G__G_O_P_H_E_R________________________ Err bitreich.org 70 i Err bitreich.org 70 i [0|Tutorial for absolute beginners.|/tutorials/beginners.txt|server|port] Err bitreich.org 70 1diff --git a/irc.txt b/irc.txt /scm/gopher-tutorials/file/irc.txt.gph bitreich.org 70 i@@ -0,0 +1,7 @@ Err bitreich.org 70 i+This is a to be done tutorial. Err bitreich.org 70 i+ Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. Err bitreich.org 70 i+ Err bitreich.org 70 i+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! Err bitreich.org 70 i+ Err bitreich.org 70 1diff --git a/lynx-w3m.txt b/lynx-w3m.txt /scm/gopher-tutorials/file/lynx-w3m.txt.gph bitreich.org 70 i@@ -0,0 +1,7 @@ Err bitreich.org 70 i+This is a to be done tutorial. Err bitreich.org 70 i+ Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. Err bitreich.org 70 i+ Err bitreich.org 70 i+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! Err bitreich.org 70 i+ Err bitreich.org 70 1diff --git a/menu-types.txt b/menu-types.txt /scm/gopher-tutorials/file/menu-types.txt.gph bitreich.org 70 i@@ -0,0 +1,7 @@ Err bitreich.org 70 i+This is a to be done tutorial. Err bitreich.org 70 i+ Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. Err bitreich.org 70 i+ Err bitreich.org 70 i+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! Err bitreich.org 70 i+ Err bitreich.org 70 1diff --git a/overbite.txt b/overbite.txt /scm/gopher-tutorials/file/overbite.txt.gph bitreich.org 70 i@@ -0,0 +1,7 @@ Err bitreich.org 70 i+This is a to be done tutorial. Err bitreich.org 70 i+ Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. Err bitreich.org 70 i+ Err bitreich.org 70 i+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! Err bitreich.org 70 i+ Err bitreich.org 70 1diff --git a/protocol-introduction.txt b/protocol-introduction.txt /scm/gopher-tutorials/file/protocol-introduction.txt.gph bitreich.org 70 i@@ -0,0 +1,7 @@ Err bitreich.org 70 i+This is a to be done tutorial. Err bitreich.org 70 i+ Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. Err bitreich.org 70 i+ Err bitreich.org 70 i+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! Err bitreich.org 70 i+ Err bitreich.org 70 1diff --git a/protocol-search.txt b/protocol-search.txt /scm/gopher-tutorials/file/protocol-search.txt.gph bitreich.org 70 i@@ -0,0 +1,7 @@ Err bitreich.org 70 i+This is a to be done tutorial. Err bitreich.org 70 i+ Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. Err bitreich.org 70 i+ Err bitreich.org 70 i+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! Err bitreich.org 70 i+ Err bitreich.org 70 1diff --git a/proxy.txt b/proxy.txt /scm/gopher-tutorials/file/proxy.txt.gph bitreich.org 70 i@@ -0,0 +1,7 @@ Err bitreich.org 70 i+This is a to be done tutorial. Err bitreich.org 70 i+ Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. Err bitreich.org 70 i+ Err bitreich.org 70 i+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! Err bitreich.org 70 i+ Err bitreich.org 70 1diff --git a/publish-geomyidae.txt b/publish-geomyidae.txt /scm/gopher-tutorials/file/publish-geomyidae.txt.gph bitreich.org 70 i@@ -0,0 +1,7 @@ Err bitreich.org 70 i+This is a to be done tutorial. Err bitreich.org 70 i+ Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. Err bitreich.org 70 i+ Err bitreich.org 70 i+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! Err bitreich.org 70 i+ Err bitreich.org 70 1diff --git a/publish-gophernicus.txt b/publish-gophernicus.txt /scm/gopher-tutorials/file/publish-gophernicus.txt.gph bitreich.org 70 i@@ -1,54 +1,7 @@ Err bitreich.org 70 i-Gophernicus is quite fussy about permissions, to minimise the risk of Err bitreich.org 70 i-accidentally serving files not intended for public consumptions. Only Err bitreich.org 70 i-world accessible content will be served, so chmod files o+r and Err bitreich.org 70 i-directories o+rw. This is a common cause of confusion and frustration Err bitreich.org 70 i-for beginners. Err bitreich.org 70 i+This is a to be done tutorial. Err bitreich.org 70 i Err bitreich.org 70 i-Gophernicus supports so-called "personal gopherspaces". If a user Err bitreich.org 70 i-"bob" has a directory named "public_gopher" in their home directory, Err bitreich.org 70 i-then the file /home/bob/public_gopher/foo/bar/baz.ext will be Err bitreich.org 70 i-accessible via the selector ~bob/foo/bar/baz.ext (if permissions Err bitreich.org 70 i-allow). The name of the "public_gopher" directory can be changed via Err bitreich.org 70 i-the -u option. This is a convenient feature for those who want to Err bitreich.org 70 i-host multiple users, although it can of course be emulated with Err bitreich.org 70 i-symlinks for other server software. Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. Err bitreich.org 70 i Err bitreich.org 70 i-Automatically generated directory listings list files in alphabetical Err bitreich.org 70 i-order. This is less than ideal for phloggers who usually want the Err bitreich.org 70 i-most recent entry to appear at the top. The conventional workaround Err bitreich.org 70 i-for this seems to be to prefix filenames with some kind of timestamp Err bitreich.org 70 i-that sorts nicely alphabetically. YYYYMMDD timestamps obviously work Err bitreich.org 70 i-nicely, but a three-character alphanumeric code also sees some use, Err bitreich.org 70 i-see e.g. gopher://grex.org:70/0/~tfurrows/phlog_filename.txt. Err bitreich.org 70 i+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! Err bitreich.org 70 i Err bitreich.org 70 i-Automatically generated menus can be overridden by creating a file Err bitreich.org 70 i-named "gophermap" in any directory. Menu items are specified with Err bitreich.org 70 i-lines of the type: Err bitreich.org 70 i- Err bitreich.org 70 i-Xnameselectorhostport Err bitreich.org 70 i- Err bitreich.org 70 i-where X is the gopher item type. The host and port may be omitted, Err bitreich.org 70 i-in which case they will be set to the same host and port that the Err bitreich.org 70 i-server is running on (the server's idea of its own hostname can be Err bitreich.org 70 i-forced with the -h option). The selector may also be omitted, in Err bitreich.org 70 i-which case it will be set equal to the name. Lines not beginning Err bitreich.org 70 i-with a valid item type or with one of Gophernicus' own non-standard Err bitreich.org 70 i-control characters are treated as information lines (type i). Err bitreich.org 70 i- Err bitreich.org 70 i-It is important to note that selectors which do not begin with a / Err bitreich.org 70 i-will be interpreted as *relative* links, e.g. a selector of "bar" Err bitreich.org 70 i-specified in "foo/gophermap" will point to "foo/bar". Selectors Err bitreich.org 70 i-beginning with / are treated as absolute links. Some other gopher Err bitreich.org 70 i-servers with seemingly compatible gophermap syntax (e.g. PyGopherd) Err bitreich.org 70 i-treat all selectors as absolute and this can cause headaches when Err bitreich.org 70 i-attempting to port gophermaps from one server to another. Err bitreich.org 70 i- Err bitreich.org 70 i-Dynamically generated menus are possible by making the "gophermap" Err bitreich.org 70 i-file a world-executable script which produces output on stdout of Err bitreich.org 70 i-exactly the same format as a static gophermap. Err bitreich.org 70 i- Err bitreich.org 70 i-As a lightweight alternative to gophermaps, a file named "gophertag" Err bitreich.org 70 i-may be placed in any directory containing a "user friendly" name for Err bitreich.org 70 i-that directory to be used in automatically generated listings (e.g. Err bitreich.org 70 i-you could placed a gophertag file containing the text Err bitreich.org 70 i-"Miscellaneous photographs" in the directory "misc_photos"). Err bitreich.org 70 1diff --git a/publish-pygopherd.txt b/publish-pygopherd.txt /scm/gopher-tutorials/file/publish-pygopherd.txt.gph bitreich.org 70 i@@ -0,0 +1,7 @@ Err bitreich.org 70 i+This is a to be done tutorial. Err bitreich.org 70 i+ Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. Err bitreich.org 70 i+ Err bitreich.org 70 i+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! 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@@ -1,69 +1,7 @@ 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+This is a to be done tutorial. Err bitreich.org 70 i Err bitreich.org 70 i-Line length Err bitreich.org 70 i-=========== Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. 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+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! 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 1diff --git a/sacc.txt b/sacc.txt /scm/gopher-tutorials/file/sacc.txt.gph bitreich.org 70 i@@ -0,0 +1,7 @@ Err bitreich.org 70 i+This is a to be done tutorial. Err bitreich.org 70 i+ Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. Err bitreich.org 70 i+ Err bitreich.org 70 i+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! Err bitreich.org 70 i+ Err bitreich.org 70 1diff --git a/server.txt b/server.txt /scm/gopher-tutorials/file/server.txt.gph bitreich.org 70 i@@ -0,0 +1,7 @@ Err bitreich.org 70 i+This is a to be done tutorial. Err bitreich.org 70 i+ Err bitreich.org 70 i+If you want to help us, making this reality, follow the instructions below. Err bitreich.org 70 i+ Err bitreich.org 70 i+Please check out git://bitreich.org/gopher-tutorials and go on #bitreich-en on Err bitreich.org 70 i+freenode, to send us the patch. All patches are welcome! Err bitreich.org 70 i+ Err bitreich.org 70 .