ntg-context - mailing list for ConTeXt users
 help / color / mirror / Atom feed
From: Wolfgang Schuster <wolfgang.schuster@gmail.com>
To: mailing list for ConTeXt users <ntg-context@ntg.nl>
Subject: Re: New module: crossref
Date: Sun, 4 Nov 2012 15:43:03 +0100	[thread overview]
Message-ID: <0B148105-6D80-4B2B-A1BC-14ABC1E219DC@gmail.com> (raw)
In-Reply-To: <20121102002830.03c75c53@zenlima.eu>


Am 02.11.2012 um 00:28 schrieb Zenlima <post@zenlima.eu>:

> @Philipp
> I like to put into a public vcs like github. I think it should be
> something general for all modules (maybe a github like installation on
> contextgarden?

There was discussion about this in a small group but we never came
to a conclusion because everyone has it’s own habits how to organize
module files and where to store it, e.g. a few people use github, others
use bitbucket etc.

> @Philipp and Wolfgang
> Is there any quick to understand doc for s-mod?

All normal code and also normal comments (lines beginning with %)
are printed as normal verbatim code.

When you want examples and text to explain it just add “%D” at the
begin of each line. When you need a module (even the module you’re
documenting) or other definitions add “%M” at the begin of the line.
For comments and other texts (e.g. the license text) which shouldn’t
appear in the output use “%C” at the begin of the line.

You can use nearly any command for the documentation as you do
in a regular document.

You can find a example for a documented module below.

> @Wolfgang
> I did not understood your "helpers example". Maybe you can show me a
> point where it would make sense in this crossref module?


Take a look at the MkII and MkIV version of my fancybreak module

MkII: http://bit.ly/YErXvF
MkIV: http://bit.ly/WmtlWf

One difference in both modules are the names for the macros but this
of no importance for now. The big difference between both is that I have
to create the \definefancybreak, \setupfancybreak and \fancybreakparameter
commands for MkII myself while in MkIV the \installcommandhandler
creates all three commands with a single line of code. This command
in MkIV is one of the helpers I mean.

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

maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage  : http://www.pragma-ade.nl / http://tex.aanhet.net
archive  : http://foundry.supelec.fr/projects/contextrev/
wiki     : http://contextgarden.net
___________________________________________________________________________________


  parent reply	other threads:[~2012-11-04 14:43 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-11-01 23:28 Zenlima
2012-11-02  9:17 ` Procházka Lukáš Ing. - Pontex s. r. o.
2012-11-04 14:43 ` Wolfgang Schuster [this message]
  -- strict thread matches above, loose matches on Subject: below --
2012-11-01 23:20 Zenlima

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=0B148105-6D80-4B2B-A1BC-14ABC1E219DC@gmail.com \
    --to=wolfgang.schuster@gmail.com \
    --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).