FAQ

   1 Gruta FAQ
   2 =========
   3
   4 This is a list of Frequently Asked Questions about the Gruta web
   5 content management system.
   6
   7 Story formatting
   8 ----------------
   9
  10 What is this Grutatxt format?
  11 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  12
  13 Grutatxt is a special plain text format that is designed to be as intuitive
  14 as possible oriented to web publising. Basicly, just separate paragraphs
  15 with an empty line, mark bold text enclosed in asterisks and italic
  16 enclosed in underscores. URLs are automatically formatted. Headings are
  17 defined by underlining phrases with equal signs, hyphens and tildes.
  18
  19 Grutatxt is a very rich specification that allows even creating visually
  20 appealing lists and tables. Please consult the following two documents:
  21
  22  * http://triptico.com/docs/grutatxt_markup.html
  23  * http://triptico.com/docs/grutatxt_markup_source.html
  24
  25 The first one is a demo of all things doable in Grutatxt format and the
  26 second one is how they are written. You'll find it's really easy and
  27 powerful.
  28
  29 What are "pseudo-URLs"?
  30 ~~~~~~~~~~~~~~~~~~~~~~~
  31
  32 These are special character strings that can be inserted in story texts and
  33 be interpreted by Gruta. The format is very similar to URLs (that's the
  34 reason of the naming) and are formed by a special keyword, followed by
  35 the usual :// mark, then by the arguments separated by slashes.
  36
  37  * story: includes a link to a story. Must be followed by the topic
  38    and the story id separated by slashes.
  39  * topic: includes a link to a topic. Must be followed by the topic id.
  40  * abstract: inserts the abstract of a story into the current one. Same
  41    as for *story*.
  42  * body: inserts the full body of a story into the current one. Same as
  43    for *story*.
  44  * img: inserts a link to an image. Must be followed by the image file
  45    name, with an optional alignment (left or right) separated by a slash.
  46  * thumb: inserts a thumbnail to an image, that can be clicked to be
  47    seen in full size. Format is the same as for `img'.
  48
  49 If any of the story links fail (i.e. they do not point to an existing
  50 story), an error is inserted instead.
  51
  52 How can I control which portion of each post is listed in the indexes?
  53 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  54
  55 The piece of a story that is listed in indexes (being the topic page or an
  56 RSS feed) is called the _abstract_ and is by default the text from the top
  57 of the story down to the end of the first paragraph after the title. This
  58 can be changed by introducing a special set of characters, <->
  59 (familiarily called "the UFO"), alone in a line, marking the end of the
  60 abstract (it always starts at the top of the story).
  61
  62 Since version 2.3.2, a new checkbox exists for each story to list its
  63 full content in indexes (so the abstract is the same as the body).
  64
  65 How can I insert a table of contents in a story?
  66 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  67
  68 Since version 2.3.1, stories can include an automatically generated table
  69 of contents, built using the story headings. Tables of contents are
  70 inserted after the abstract.
  71
  72 The special character string <?> can be inserted (alone in a line) to
  73 force a TOC creation in ad-hoc places.
  74
  75 User management
  76 ---------------
  77
  78 How many user levels exist in Gruta?
  79 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  80
  81 There are three main user levels: those having administrator capabilities
  82 (that can do everything), those that not (but can be set as "editors" for
  83 special topics, see below) and the rest of the world, that visit Gruta
  84 sites without being identified.
  85
  86 How can I give topic maintenance capabilities to specific users?
  87 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  88
  89 Topics can have what it's called "editors", that is, plain users that have
  90 administrator capabilities on it, meaning that they can add, modify and
  91 delete stories.
  92
  93 To add an editor to a topic, just write its name in the appropriate field
  94 in the topic modification form.
  95
  96 How can I maintain a paid-by-content site with Gruta?
  97 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  98
  99 The Gruta web CMS includes the following features to implement a
 100 commercial site:
 101
 102  * Users with an expiration date
 103  * Posts with a subscriber-only limit date
 104
 105 Only identified users can access subscriber-only articles.
 106
 107 Subscriptions are managed by creating users with an expiration date (as,
 108 for example, using a yearly fee). If the expiration date is over, the user
 109 will no longer be able to login.
 110
 111 If a non-identified user tries to access a post with a subscriber-only
 112 limit date, a special message suggesting him to subscribe will be shown
 113 instead.
 114
 115 After a post's subscriber date is due, the article will be available to
 116 everyone. Consider using a short time for subscriber only article (like a
 117 week or two), because you will benefit from search engines when they'll
 118 become free for everyone.
 119
 120 Contribution
 121 ------------
 122
 123 How can I add a new translation to Gruta?
 124 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 125
 126 If you want to add your own translation to Gruta, please follow these
 127 steps:
 128
 129  # Create an empty file named `lang_XX', where `XX' is the two-letter
 130    identifier for the language, on the `templates/art5' directory of a
 131    Gruta distribution.
 132  # Execute the command `art5 -l' (this program is part of the _Artemus_
 133    template toolkit package) there. The new file will be filled with all
 134    the translateable strings.
 135  # Fill it with appropriate strings in your language. The format of
 136    the file should be straightforward.
 137  # Do a `make install' and the new language will be available for
 138    selection.
 139
 140 If you do that, please send your file to mailto:angel@triptico.com (me)
 141 to add it to the main Gruta distribution.
 142
 143 ----
 144 Angel Ortega <angel@triptico.com>