ntg-context - mailing list for ConTeXt users
 help / color / mirror / Atom feed
From: Henning Hraban Ramm <texml@fiee.net>
To: ntg-context@ntg.nl
Subject: [NTG-context] Re: Wiki - test/proposal to further clarify documentation
Date: Thu, 18 Apr 2024 08:32:38 +0200	[thread overview]
Message-ID: <ea6181b1-fb38-4122-aecc-9409db571c2f@fiee.net> (raw)
In-Reply-To: <1b017921-f945-467c-a3a5-4e9d6adbcb68@azules.eu>

Am 17.04.24 um 23:25 schrieb Garulfo:
> - exactly, it's not a question of proposing new documents, but of 
> proposing another complementary way of accessing and browsing existing 
> ones.
> 
> - Actually, the wiki is (or can be) a hub for the 4 needs:
>    - "Reference" like https://wiki.contextgarden.net/Command/setuphead
>    - "How-To Guides" like https://wiki.contextgarden.net/Titles
>    - "Tutorials":
>      - hosted https://wiki.contextgarden.net/Detailed_Example
>      - linked https://github.com/mpsmath/stepbystep
>    - "Explanation" : mostly linked manuals and books
> 
> 
> https://wiki.contextgarden.net/Command/setuphead
> and https://wiki.contextgarden.net/Titles
> are examples of how difficult it can be to understand where to find a 
> particular information.
> 
> It might be worth keeping only the key examples on reference pages
> like https://wiki.contextgarden.net/Command/***
> and moving the "how-to" examples to a separate page (or pages).

I agree. Let’s accept this as a rule for further wiki editing.

Also, explain parameters with top priority in Command/setup* pages 
(keeping them in Command/define* pages etc. doesn’t hurt, but at least 
experienced users should know where to find something without searching).

Hraban
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!

maillist : ntg-context@ntg.nl / https://mailman.ntg.nl/mailman3/lists/ntg-context.ntg.nl
webpage  : https://www.pragma-ade.nl / https://context.aanhet.net (mirror)
archive  : https://github.com/contextgarden/context
wiki     : https://wiki.contextgarden.net
___________________________________________________________________________________

  reply	other threads:[~2024-04-18  6:34 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-14 11:21 [NTG-context] " garulfo
2024-04-14 14:14 ` [NTG-context] " Henning Hraban Ramm
2024-04-14 19:45   ` Peter Hopcroft via ntg-context
2024-04-16 19:07     ` Henning Hraban Ramm
2024-04-16 19:56       ` Peter Hopcroft via ntg-context
2024-04-17  6:32         ` Thomas A. Schmitz
2024-04-17  8:36           ` Hans Hagen
2024-04-17  8:47             ` Henning Hraban Ramm
2024-04-17  9:10               ` Joaquín Ataz López
2024-04-17  9:32                 ` jbf
2024-04-17 11:57 ` Bruce Horrocks
2024-04-17 12:17   ` Henning Hraban Ramm
2024-04-18 12:48     ` Bruce Horrocks
2024-04-17 21:25   ` Garulfo
2024-04-18  6:32     ` Henning Hraban Ramm [this message]
2024-05-17 20:40 ` garulfo
2024-05-18 11:27   ` Bruce Horrocks
2024-05-19 12:44     ` garulfo

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ea6181b1-fb38-4122-aecc-9409db571c2f@fiee.net \
    --to=texml@fiee.net \
    --cc=ntg-context@ntg.nl \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).