Ce qu'il faut savoir pour bien utiliser Twiki

  • Twiki propose de simples raccourcis pour formater et structurer les contenus. Dans dans les cas pour des raisons de lisibilité, lors de l'écriture dans la zone texte du formulaire, vous devez simplement :
    • commencer chaque ligne au bord, sans laisser d'espaces (sauf pour les puces et les directives) ;
    • separer chaque paragraphe par une ligne vide.

  • Lorsque vous capitalises (première lettre en majuscule) et accollez plusieurs éléments à suivre d'une phrase, comme MotWiki, vous :
    • créez automatiquement un lien hypertexte ;
    • devez faire attention à ce qu'il soit bref et lisible (ce n'est pas forcément simple!)
    • Wiki Words has name-creation tips that may help

  • If a discussion is going on:
    • separate each follow-up with a space
    • add your Wiki Name and the date at the end. Example:
      -- Accueil.WikiGuest - 20 Feb 2019
    • OR, by all means, insert your comment where it seems to fit best:
      • you may want to inset it with a bullet and/or set it in italics so it's clear (always sign and date)
    • if you'd like to use an initial, use a link with label. Example:
      -- [[Accueil.WikiGuest][ZXQ]] - 20 Feb 2019
      • To automate that, add a bullet like * Initials: ZXQ to your home page.

  • A good format for a new topic is "dissertation followed by discussion":
    • start with a brief, factual introduction, followed by double horizontal rules
    • let the discussion begin

  • When a discussion dies down and the page becomes static, if you're clear on your course, feel free to refactor mercilessly:
    • fearlessly edit down to capture the key points
    • reduce the noise without losing the facts or the flavor
    • if you merge or delete comments, group credit Contributors: at the end of the page
    • This is how Wiki content matures and grows in value over time.

  • For external site links, you can type URLs directly into the text - http://etcete.ra/... - it'll be clear to anyone where they're headed on click.

  • TWiki is intended for world-wide use, and an internationally understood date format like 01 Sep 2003 or 2003/09/01 is preferred. It's clearer than the xx/xx/xx format, where a date like 9/1/01 can mean either Jan or Sep, depending on the local conventions of the readers. For months, use the first three letters: Jan, Feb, Mar, Apr,...

  • TIP: Check the source when you want to find out how something is formatted: click Edit on the lower toolbar. To see earlier versions, click More, then check Raw text format and click View revision. A bit of HTML experience can't hurt, but you'll soon see with ShortHand how far that is from necessary.


-- TWiki:Main.MikeMannix - 01 Dec 2001
-- TWiki:Main.PeterThoeny - 13 Mar 2004

Traduction de Good Style

-- Thierry Pasquier - 28 May 2005
Topic revision: r6 - 04 Oct 2010, UnknownUser
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Telem? Send feedback