GaTeX: An ASCII Document Formatting System

Miscellaneous programs and scripts, opensource or not, and sometimes, random mathematical stuff.
User avatar
Gamall
Hic sunt dracones
Posts: 4132
Joined: Fri May 26, 2006 11:09 pm
Contact:

GaTeX: An ASCII Document Formatting System

Postby Gamall » Tue May 22, 2007 3:14 pm

BETA VERSION: Release Gamma (stable)

Download here (latest version):
GaTeX Gamma.zip
(252.26 KiB) Downloaded 836 times
Format.ini with extra styles (wiwiland, filefront):
format.ini
(5.82 KiB) Downloaded 674 times

Code: Select all

{===============================================================}
{          GaTeX: An ASCII Document Formatting System           }
{---------------------------------------------------------------}
{                        Version: Gamma                         }
{                 Author: Gamall Wednesday Ida                  }
{                      Web: gamall-ida.com                      }
{===============================================================}
 
 
{===============================================================}
{                         Introduction                          }
{===============================================================}
 
 Oftentimes, one needs to write documents in raw text format. For
 instance,  documentation for mods or programs is best written in
 plain text, since it is the only  truly  universal  format.  The
 problem  is, raw text documentation looks ugly, unless you spend
 a ridiculous amount  of  time  fine-tuning  your  ASCII  layout.
 
 This   program  proposes  a  way  to  typeset  acceptable  ASCII
 documents almost as quickly and effortlessly as  if  you  didn't
 have to worry about the layout at all.                         
 
 Please  note  that  this program is still in Beta version, which
 means it is absolutely not finalized yet. As it  stands,  it  is
 more of a proof of concept or a trailer ;-)                     
 
{===============================================================}
{                      How does it work ?                       }
{===============================================================}
 
o==--~~ Structure of the files                                   
o--------------------------------------------------o              
 
 The program depends on the file "format.ini", which contains the
 formatting  specifications  for at least one style : the DEFAULT
 style, with which the file you are presently  reading  has  been
 generated.  Please  open  "format.ini" right now, and try to see
 how it is structured... Let us consider  the  part  "header_in",
 which should look quite like that:                             
 
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
       { header_in
          
          $type   =   text      
          %width  =   65
          $align  =   CENTER
          $left   =   "{ "
          $right  =   " }"
          $()in   =   \opacc\rep{=}\closeacc
          $()out  =   \opacc\rep{-}\closeacc
       }
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
 
 These lines describe the way text belonging to the first part of
 the header, called "header_in", will be displayed. Now, open the
 source text for this file, "Readme.gat", with your favourite raw
 text editor. Look at the few first lines :                     
 
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
       \header_in
          GaTeX: An ASCII Document Formatting System
       \end
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
 
 And  now,  compare the data in both format.ini and Readme.gat to
 the three very first lines of this file:                       
 
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
       {=============...=======}
       {   GaTeX: ect...       }
       {-------------...-------}
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
 
 Note that the name "header_in" is specific to the style DEFAULT.
 You can very well change it or / and  define  styles  where  the
 logical parts have completely different names...               
 
o==--~~ How do I get started ?                                   
o--------------------------------------------------o              
 
 First,  you  have to make sure that a correct format.ini file is
 in the same directory than GaTeX.exe. Then you can go ahead  and
 create  a  file  for  GaTeX.  You  can  use any extension, but I
 recommend '.gat', for obvious reasons. The gat file must contain
 both  a  valid  \style  and  a   valid   \output   instructions.
 
 A good starting point would be the demo file generated by GaTeX:
 Just start GaTeX.exe without arguments, and enter a name for it.
 This  demo  file  is  not  much,  but  it is ready to compile...
 
 It is also warmly recommended to mess  around  with  Readme.gat,
 the GaTeX source for the present file.                         
 
 To  compile  a  gat file, just drag and drop it onty GaTeX.exe's
 icon. Or use the command line. The compiled file will be created
 as a sibling of the gat file.                                   
 
{===============================================================}
{                         GaTeX syntax                          }
{===============================================================}
 
o==--~~ In format.ini                                           
o--------------------------------------------------o              
 
 -> Execution parameters.                                       
 
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
       $version   =  "BETA"
       %popup     =  1
       %terminate =  1
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
 
 The version statement is important, since if it is  not  defined
 (or  void:  ""),  GaTeX  will  deem format.ini inappropriate and
 refuse to work.                                                 
 
 If 'popup' is not set to 0, the compiled plain text file will be
 displayed as soon as created. It is very strongly recommended to
 leave that at 1.                                               
 
 If 'terminate' is not set to 0, the program  will  terminate  as
 soon  as  its  job  is  done, unless of course there are errors.
 
 -> Creating and altering styles                                 
 
 I won't document the styling aspect of format.ini  yet  for  the
 following reasons:                                             
 
      1° The format used is utterly straightforward. I don't     
 think a documentation is really needed. Anyone messing with the
 files for ten minutes should be ready to go.                   
                                                                 
      2° As GaTeX is still in Beta stage, it may evolve. There is
 little point in writing now a lengthy documentation which may   
 become partly obsolete shortly.                                 

 This  being  said,  for the time being, in stead of an extensive
 documentation, I offer support to  whomever  might  need  it  to
 create  and  debug  their  styles. See the section about support
 below.                                                         
 
o==--~~ In the gat file                                         
o--------------------------------------------------o              
 
 Note  that  unless  explicitly  stated  otherwise,  a  'command'
 occupies  a  whole  line.  Commands  always start with a '\'. As
 mentioned before, the first two commands in a GaTeX  input  file
 must  be  \style{YOUR_STYLE}  and  \output{PATH_TO_OUTPUT_FILE}.
 
 After that, everything needs to be in  a  block,  starting  with
 \BLOCKS_NAME and ending with \end. In the very special case of a
 verbatim-type  block,  the  \end  command  must  have the escape
 string of the verbatim block as an argument,  else  it  will  be
 ignored.   \end{verb},   for   instance,   if  $escape  =  verb.
 
 The 'line' command is an exception to this rule: it will  create
 a  new line when used in a text-type block, but can also be used
 on its own between blocks. It will also work used at the end  of
 a  line  of  text,  unlike  most commands which need to have the
 whole line for themselves.                                     
 
 In text blocks, the 'tab' command, which  should  be  used  very
 sparingly,  if  at  all,  is replaced by the content of the $tab
 variable in  format.ini.  Note  that  this  is  NOT  a  standard
 tabulation.  Those  should never be used, since there are no two
 software which display them the same  way.  Using  the  tab  key
 means  broken  layout.  'tab'  can  be  used  inline, of course.
 
 The '-' command (pseudo-hyphen) can be used once in  every  work
 of  your  text.  It  won't be displayed, but it just tells GaTeX
 that the word can be cut there. For instance,  you  could  write
 
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
          His tactless floccinaucinihi\-lipilifications were... etc
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
 
 (Yes,  this  is  a  real word, by the way) and it will either be
 displayed in full or cut in two. You cannot cut a word  in  more
 than one place though.                                         
 
 
o==--~~ In both                                                 
o--------------------------------------------------o              
 
 -> Special characters commands:                                 
 
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
       \\        stands for '\'
       \opacc    stands for '{'
       \closeacc stands for '}'
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
 
 Those  commands  are  necessary  to  allow  use  of  the special
 characters used to denote GaTeX commands: the commands in  GaTeX
 look  very  much  like  those  in  LaTeX:  an expression such as
 
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
       \cmd{arg1}{arg2}...{argn}
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
 
 stands for a call of the function 'cmd', with  arguments  'arg1'
 to  'argn'. Note that such an expression will be parsed by GaTeX
 everywhere but in a 'verbatim' block.                           
 
{===============================================================}
{                         Miscellaneous                         }
{===============================================================}
 
o==--~~ Why such a strange name: 'GaTeX' ?                       
o--------------------------------------------------o              
 
 I am a fan of the LaTeX  typesetting  system.  It  is  extremely
 popular  in  the  mathematical  community, but unfortunately not
 very well-known outside of it. It  is  most  excellent  for  any
 document  with  mathematical  formulae  in  it, but it really is
 suitable for pretty much anything.  Except  for  making  coffee,
 perhaps.  Give it a try if you get bored with Word and its awful
 equation editor. It is free software, of course.               
 
 Anyway, I named my ASCII typesetting system 'GaTeX' as a bow and
 pun directed towards TeX and LaTeX :-) GaTeX's syntax will  also
 look    strangely    familiar    to   weathered   LaTeX   users.
 
o==--~~ Are there any other plain text formatters ?             
o--------------------------------------------------o              
 
 There is troff, groff, unroff and all that  tribe...  I  am  not
 sure  whether  there  are  windows  implementations. Probably. I
 didn't look very hard. These have their roots in good old  UNIX.
 So,  without  having  tried  them,  I feel quite safe making the
 following assumptions:                                         
 
      1° They are powerful. Much more powerful than I need an   
 ASCII text processor to be.                                     

      2° The syntax will kill you...                             

 If you have been  using  these,  or  any  other  formatter,  I'd
 welcome your opinion about them, whether they are easy to use or
 not,  which features they have (or not) that make them efficient
 and 'cool' etc...                                               
 
o==--~~ The 'File generated by...' notice                       
o--------------------------------------------------o              
 
 A kind of stamp is automatically generated by GaTeX at  the  end
 of  each  compiled  file,  which  looks  more  or less like that
 
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
         +-----------------------------+
         | File generated with 'GaTeX',|
         | an ASCII typesetting system |
         | by  Gamall  Wednesday  Ida. |
         |   http://gamall-ida.com     |
         +-----------------------------+
         Build: < Time at which the file was compiled>
         File : YourFile.gat
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     
 
 You are  free  to  remove  that  if  you  deem  it  annoying  or
 unsightly.  However,  I would be tempted to understand that as a
 way of saying "I don't like that software enough to recommend it
 to anybody else". Then it would  seem  logical  to  either  stop
 using  the  program altogether (why use something you dislike ?)
 or take the time to post on my forum the nature of your  grudges
 against   it,  so  I  may  have  a  shot  at  improving  it  ;-)
 
o==--~~ Is it stable ?                                           
o--------------------------------------------------o              
 
 In the process of writing that lengthy readme file,  which  uses
 nearly  every  feature of GaTeX, I have only had to fix ONE easy
 bug  in  the  program.  So  I  think   it   is   quite   stable.
 
o==--~~ Are there any known bugs ?                               
o--------------------------------------------------o              
 
 There  is  no  way  to  display commands such as 'line' with a \
 outside  of  a  verbatim  block.  \\  is  expanded   too   soon.
 
{===============================================================}
{        Getting Support / Contributing / Reporting bugs        }
{===============================================================}
 
 The place for support etc is the forum at gamall-ida.com, in the
 sub-forum  "Freewares",  on  the topic pertaining to GaTeX. (and
 certainly NOT by mail or private message ;-))                   
 
o==--~~ Getting Support / Reporting bugs                         
o--------------------------------------------------o              
 
 If GaTeX gives you trouble, be it its fault  or  yours,  do  not
 hesitate  to  post  on  the  support  topic.  In  order to be as
 efficient as possible, it is  warmly  suggested  to  attach  the
 following to the description of the problem:                   
 
 - Your format.ini file.                                         
 
 - The smallest compilable subset of your gat file with which the
 bug can be reproduced.                                         
 
 I'll  then  tell you if something is wrong with your files or if
 it is a bug in GaTeX, in which case I'll try and fix it quickly.
 
o==--~~ Ways to contribute                                       
o--------------------------------------------------o              
 
 -> Submit a style                                               
 
 GaTeX is presently shipped with the 'DEFAULT' style, which is my
 creation and development guinea-pig. I am not much of  an  ASCII
 artist,  however,  and  would be absolutely delighted to include
 styles made by people more skilled than I am. In order to submit
 a style you must post:                                         
 
 - A working format.ini file, with just the  style  in  it,  with
 popup = 1 and terminate = 0. It must have support for every type
 of   environment   working  in  GaTeX's  latest  version  (text,
 verbatim, etc...).                                             
 
 - A working demo (gat file) of your style, of reasonable  length
 (even  if  that  length  is achieved through 'lorem ipsum'-style
 fill-in),   demonstrating   every   aspect   of   your    style.
 
 -  Your  internet  name  and  some  contact info, so that proper
 credit can be given to you.                                     
 

 ->  Hunt  for  bugs  and  typos,  suggest  apt  features,  offer
 constructive criticism and so on :p                             
 
{===============================================================}
{                       Versions history                        }
{===============================================================}
 
 Alpha:  Proof of concept version. Lived a day. Not a single code
 line from that version runs in Beta.                           
                                                                 
 Beta : Completely recoded. A stable base to add more on, or so I
 hope.                                                           
                                                                 
 Gamma: Fixed a bug with \rep: repeating a space caused a  crash.
 Added   some   verbosity.   Added   the  $()leftin,  $()leftout,
 $()rightin,  $()rightout  arrays,  which   allow   sophisticated
 decorating  motives  left  and  right of the running text in the
 same  way  $()in  and  $()out  do  for  headers   and   footers.
 (horizontal layout in other words)                             
                                                                 
 Features  planned for future versions: user-defined macros; list
 environments; table of contents support; ignore  blocks;  upper-
 case  and  lower-case  enforcement  in  styles;  multiple  \rep.
 


{===============================================================}
{                          END OF FILE                          }
{===============================================================}
 





























  +-----------------------------+
  | File generated with 'GaTeX',|
  | an ASCII typesetting system |
  | by  Gamall  Wednesday  Ida. |
  |   http://gamall-ida.com     |
  +-----------------------------+
  Build: Fri May 25 12:21:58 2007
  File : Readme.gat


(fr) Voir aussi le sujet sur Wiwiland : http://forum.wiwiland.net/index.php?showtopic=39700
Attachments
gatexdemo.PNG
{<§ Gamall Wednesday Ida §>}
{ Mods and Programs - Mods TES-IV Oblivion }

User avatar
Gamall
Hic sunt dracones
Posts: 4132
Joined: Fri May 26, 2006 11:09 pm
Contact:

Re: GaTeX: An ASCII Document Formatting System

Postby Gamall » Sun May 27, 2007 3:46 pm

I have made a JK3files style for GaTeX. It will be useful to me or anyone else submitting mods there :lol

Code: Select all

*****************************************************************
**                  JEDI KNIGHT: Jedi Academy                  **
*****************************************************************
 
  #-----------------------------------------------------------# 
  #                   TITLE : Moronic Skin                    # 
  #                      TYPE : JK3 Skin                      # 
  #                     VERSION : 3.1415                      # 
  #               AUTHOR : Gamall Wednesday Ida               # 
  #               E-MAIL : gamall.ida@gmail.com               # 
  #              WEBSITE : http://gamall-ida.com              # 
  #                                                           # 
  #              FILENAME Windows : yourmod.pk3               # 
  #               FILENAME Linux : yourmod.pk3                # 
  #                     FILESIZE : < 1 Go                     # 
  #                 RELEASE DATE : April 2007                 # 
  #-----------------------------------------------------------# 
 
 
 
+   DESCRIPTION                                                 
+=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-o          +
 
 I  would  describe  my  file here, as clearly and completely as
 possible.   This   helps   people   understand   what   they're
 downloading.                                                   
 
 
   -   This is a random subsection                               
   -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~o          -
 
    With some text....                                           
 
 
+   INSTALLATION INSTRUCTIONS                                   
+=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-o          +
 
 I  would  explain  how  to install your mod here. Believe it or
 not, there  are  still  people  out  there  who  have  not  the
 slightest clue how to install PK3s.                             
 
 
+   BUGS                                                         
+=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-o          +
 
 You  may  want  to  list  any  bugs  here, if your mod has any.
 
 
+   COMMENTS                                                     
+=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-o          +
 
 List your comments here. Make sure not to use obscene language.
 
 
+   CREDITS                                                     
+=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-o          +
 
 I would give credits to anyone whose work I used  or  borrowed,
 including  graphics  and models (or any type of voice acting or
 in-game acting, for videos).                                   
 
 
+   LEGAL STUFF                                                 
+=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-o          +
 
 THIS MODIFICATION IS NOT MADE,  DISTRIBUTED,  OR  SUPPORTED  BY
 ACTIVISION,  RAVEN,  OR  LUCASARTS  ENTERTAINMENT  COMPANY LLC.
 ELEMENTS TM & © LUCASARTS ENTERTAINMENT COMPANY LLC AND/OR  ITS
 LICENSORS.     


style here:

Code: Select all

{ FILEFRONT

   $tab      =   "    "
      
      
      { header
      
         $type   =   text
         %width   =   65
         $align   =   CENTER
         $left   =   "**  "
         $right   =   "  **"
         $()in   =   "*\rep{*}"
         $()out   =   "\rep{*}*"
                  " "      
      }
      
      { section
      
         $type   =   text
         %width   =   65
         $align   =   LEFT
         $left   =   "+   "
         $right   =   "    "
         $()in   =   " "
         $()out   =   "+\rep{=-}o          +"
                  " "      
      }
      
      { subsec
      
         $type   =   text
         %width   =   65
         $align   =   LEFT
         $left   =   "   -   "
         $right   =   "    "
         $()in   =   " "
         $()out   =   "   -\rep{~}o          -"
                  " "      
      }
      
      { sbody
      
         $type   =   text
         %width   =   65
         $align   =   JUST
         $left   =   "    "
         $right   =   " "
         $()in   =   ""
         $()out   =   " "      
      }
      
      { body
      
         $type   =   text
         %width   =   65
         $align   =   JUST
         $left   =   " "
         $right   =   " "
         $()in   =   ""
         $()out   =   " "      
      }
      
      { modinfos
      
         $type   =   text
         %width   =   65
         $align   =   CENTER
         $left   =   "  #  "
         $right   =   "  #  "
         $()in   =   "  #\rep{-}#  "
         $()out   =   "  #\rep{-}#  "   
                  " "   
                  " "
      }
      
      
      
      { verb
      
         $type      =   verb
         $left      =   "       "
         $right      =   ""
         %width      =   65
         $()in      =   "      \rep{~}      "
         $()out      =   "      \rep{~}      "
                     " "
         $escape      =   "verb"
      }
      
}


edit: and default template, previously forgotten:

Code: Select all

// Readme template for jk3files
//
// Gamall Wednesday Ida

\style{FILEFRONT}
\output{jk3-readme.txt}

\header
   JEDI KNIGHT: Jedi Academy
\end

\modinfos
   TITLE   : Moronic Skin            \line
   TYPE    : JK3 Skin               \line
   VERSION : 3.1415               \line
   AUTHOR  : Gamall Wednesday Ida      \line
   E-MAIL  : gamall.ida@gmail.com      \line
   WEBSITE : http://gamall-ida.com      \line
   \line
   
   FILENAME Windows  : yourmod.pk3      \line
   FILENAME Linux    : yourmod.pk3      \line
   FILESIZE          : < 1 Go         \line
   RELEASE DATE      : April 2007      \line
\end



\section
   DESCRIPTION
\end
\body
    I would describe my file here, as clearly and completely as possible.
    This helps people understand what they're downloading.
\end

\subsec
   This is a random subsection
\end
\sbody
   With some text....
\end



\section
   INSTALLATION INSTRUCTIONS
\end
\body
   I would explain how to install your mod here.
   Believe it or not, there are still people out there who have
   not the slightest clue how to install PK3s.
\end




\section
   BUGS
\end
\body
    You may want to list any bugs here, if your mod has any.
\end




\section
   COMMENTS
\end
\body
     List your comments here. Make sure not to use obscene language.
\end








\section
   CREDITS
\end
\body
     I would give credits to anyone whose work I used or borrowed,
     including graphics and models (or any type of voice acting or in-game acting, for videos).
\end












\section
   LEGAL STUFF
\end
\body
   THIS MODIFICATION IS NOT MADE, DISTRIBUTED, OR SUPPORTED BY ACTIVISION, RAVEN, OR
   LUCASARTS ENTERTAINMENT COMPANY LLC. ELEMENTS TM & © LUCASARTS
   ENTERTAINMENT COMPANY LLC AND/OR ITS LICENSORS.
\end
{<§ Gamall Wednesday Ida §>}
{ Mods and Programs - Mods TES-IV Oblivion }

User avatar
Gilgamesh
Posts: 1
Joined: Sat May 26, 2007 6:30 pm
Location: Bezons [95]
Contact:

Re: GaTeX: An ASCII Document Formatting System

Postby Gilgamesh » Tue May 29, 2007 8:02 pm

En plus d'être le fruit d'une excellente idée, c'est vraiment un excellent programme ! En quelques secondes, j'ai eu un read-me agréable et lisible. De plus, il est a noter que le texte est justifié, chose que j'adore ! ^^

Voici mon essais :
-> http://dumahim.free.fr/Divers/default.txt
Image

User avatar
Gamall
Hic sunt dracones
Posts: 4132
Joined: Fri May 26, 2006 11:09 pm
Contact:

Re: GaTeX: An ASCII Document Formatting System

Postby Gamall » Tue May 29, 2007 9:34 pm

Le texte est justifié parce que le style par défaut justifie le texte des balises \body :P

Code: Select all

{ body
      
         $type   =   text
         %width   =   65
         $align   =   JUST                // ICI ;)
         $left   =   " "
         $right   =   ""
         $()in   =   ""
         $()out   =   " "      
      }


Par rapport à notre discussion par MP, j'aimerais que tu m'aides à améliorer ce style que j'ai fait pour Wiwiland: (les grelots sont de sent)

Code: Select all

 
                                      ###     
                        ####      ##########   
                     #########  #############   
                    #########################   
                   #####################  ####
                   ### #################   ###
                   ###  ################   ##   
                    ##  ###############    ##   
                    #    ##############     # 
                  ###### #############   ######
                  #####                    ####
          0O=========================================O0         
0O=============================================================O0
o                  Mon Super Mod de la Morkitu                  o
0O=============================================================O0
o                      Auteur: Gros Billou                      o
o                     Mail: bigboy@big.big                      o
0O=============================================================O0
          0O=========================================O0         
 
 
Oo                                                             oO
0O                     DESCRIPTION DU MOD                      O0
0O=============================================================O0
 
  Mon  mod  est  un  super  mod  qui  ajout des zibulons et des 
  claquezibules à la Guilde des Nébuleux de Cloud  City.  Outre 
  le caractère purement esthétique de cet ajout, cela permet au 
  joueur  de  se  téléporter automatiquement dans le lupanar le 
  plus proche (à moins qu'il  ne  soit  atteint  d'une  maladie 
  incurable).                                                   
 
  Note: Ce mod pourrait heurter la sensibilité d'un bébé kwama. 
 
 
Oo                                                             oO
0O                INSTALLATION / COMPATIBILITE                 O0
0O=============================================================O0
 
          0               Installation                0         
      -----------------------------------------------------     
 
  Ajoutez  le  fichier  esp du mod dans le répertoire 'Bethesda 
  Softworks\Oblivion\Data'.   Dans   le   menu   de   démarrage 
  d'Oblivion,  allez  dans  'Data  Files',  puis  'Fichiers  de 
  données', et cochez la case correspondante.                   
 
  Décochez cette même case pour désinstaller.                   
 
          0               Compatibilité               0         
      -----------------------------------------------------     
 
  Ce mod  nécessite  le  jeu  Oblivion  en  version  Française. 
 
  Compatible avec la VO ?                                       
 
  Ce   mod  est  compatible  avec  les  mods  X,  Y,  Z  et  T. 
 
  Ce mod est incompatible avec les  mods  X',  Y',  Z'  et  T'. 
 
  Ce  mod  altère les cellules AnvilGamallsManor, AutreCellule, 
  Etc...                                                         
 
  Ce   mod   altère   les   objets    DisgutingRottenIronSword, 
  MegaSpellOfWormingDeath, GarrettNPC.                           
 
          0                Bugs connus                0         
      -----------------------------------------------------     
 
  De  temps  en temps, le mod se met en boule et efface tout le 
  contenu de votre ordinateur. Lancer  une  boule  de  feu  sur 
  l'unité centrale règle parfois le problème.                   
 
 
Oo                                                             oO
0O                 HISTOIRE / CONTEXTE RP etc                  O0
0O=============================================================O0
 
  Dans  une  galaxie  lointaine, très lointaine, un chasseur de 
  Kwama entreprend une quête qui... etc. Elle avait pris ce pli 
  dans son âge enfantin De venir dans ma chambre un peu  chaque 
  matin;  Je  l'attendais  ainsi qu'un rayon qu'on espère; Elle 
  entrait, et disait: Bonjour, mon  petit  père  ;  Prenait  ma 
  plume, ouvrait mes livres, s'asseyait Sur mon lit, dérangeait 
  mes  papiers,  et  riait,  Puis  soudain s'en allait comme un 
  oiseau qui passe                                               
 
 
Oo                                                             oO
0O                        REMERCIEMENTS                        O0
0O=============================================================O0
 
  L'ONU et Mère Thérèsa.                                         
 
 
Oo                                                             oO
0O                       FIN DU FICHIER                        O0
0O=============================================================O0
 


Le code du style (à modifier pour améliorer le style, donc...) est :

Code: Select all

{ WIWILAND
   
   $tab = "    "
   
   { titre
   
         $type   =   text
         %width   =   65
         $align   =   CENTER
         $left   =   "o "
         $right   =   " o"
         $()in   =   " "
                  "                                      ###     "
                  "                        ####      ##########   "
                  "                     #########  #############   "
                  "                    #########################   "
                  "                   #####################  #### "
                  "                   ### #################   ### "
                  "                   ###  ################   ##   "
                  "                    ##  ###############    ##   "
                  "                    #    ##############     #  "
                  "                  ###### #############   ######"
                  "                  #####                    ####"
                  "          0O\rep{=}O0          "
                  "0O\rep{=}O0"
         $()out   =   "0O\rep{=}O0"
   }
   
   { demo
         $type   =   text
         %width   =   65
         $align   =   CENTER
         $left   =   "   "
         $()leftin =      " a "
                     " b "
                     " c "
         $()leftout =   " e "
                     " f "
                     " g "
                  
         $right   =   ""
         $()in   =   ""
         $()out   =   ""
   }
   
   { infos2
         $type   =   text
         %width   =   65
         $align   =   CENTER
         $left   =   "   "
         $()leftin =   "                                  "
                  "                     ###          "
                  "       ####      ##########       "
                  "    #########  #############      "
                  "   #########################      "
                  "  #####################  ####     "
                  "  ### #################   ###     "
                  "  ###  ################   ##      "
                  "   ##  ###############    ##      "
                  "   #    ##############     #      "
                  " ###### #############   ######    "
                  " #####                    ####    "
   
   }
   
   { auteur
         $type   =   text
         %width   =   65
         $align   =   CENTER
         $left   =   "o "
         $right   =   " o"
         $()in   =   ""
         $()out   =   0O\rep{=}O0
                  "          0O\rep{=}O0          "
                  " "
                  
   }
   
   { section
   
      $type   =   text
      %width   =   65
      $align   =   CENTER
      $left   =   "0O "
      $right   =   " O0"
      $()in   =   " "
               "Oo\rep{ }oO"
      $()out   =   "0O\rep{=}O0"
               " "
   }
   
   { subsec
   
      $type   =   text
      %width   =   65
      $align   =   CENTER
      $left   =   "          0 "
      $right   =   " 0          "
      $()in   =   ""
      $()out   =   "      \rep{-}      "
               " "
   }
   
   { texte
      
      $type   =   text
      %width   =   65
      $align   =   JUST
      $left   =   "  "
      $right   =   "  "
      $()in   =   ""
      $()out   =   " "      
   }
}


Voilà :)

Quand le style sera totalement prêt, je posterai tout sur wiwiland et il y aura probablement un councours ouvert à tous les wiwilandais pour faire de meilleurs styles fin bref...

Si tu te sens inspiré pour améliorer ça (ou en faire un autre de A à Z)... :foufou
{<§ Gamall Wednesday Ida §>}
{ Mods and Programs - Mods TES-IV Oblivion }

User avatar
Gamall
Hic sunt dracones
Posts: 4132
Joined: Fri May 26, 2006 11:09 pm
Contact:

Re: GaTeX: An ASCII Document Formatting System

Postby Gamall » Sun Jun 17, 2007 4:16 pm

Bha, en fait on vient de poster ça sur Wiwiland :)

-> http://forum.wiwiland.net/index.php?showtopic=39700
{<§ Gamall Wednesday Ida §>}
{ Mods and Programs - Mods TES-IV Oblivion }

User avatar
Hendrixxx
Posts: 11
Joined: Sun May 27, 2007 11:58 pm

Re: GaTeX: An ASCII Document Formatting System

Postby Hendrixxx » Tue Jun 26, 2007 1:07 am

super :D
Image

User avatar
N.tox
Posts: 4
Joined: Fri Jun 29, 2007 3:47 pm

Re: GaTeX: An ASCII Document Formatting System

Postby N.tox » Fri Jun 29, 2007 3:55 pm

Excellent soft :love , mais...(c'en est pas vraiment un...) il crée un fichier texte ASCII, pourquoi pas unicode (qui supporte plus de cractères...) :ange ?
Ceci dit c'est du chipotage que j'fais là...

User avatar
Gamall
Hic sunt dracones
Posts: 4132
Joined: Fri May 26, 2006 11:09 pm
Contact:

Re: GaTeX: An ASCII Document Formatting System

Postby Gamall » Fri Jun 29, 2007 4:36 pm

Coucou :)

Pour une raison simple: Unicode n'est pas un format vraiment universel à ce stade. Le but du prog est de produire des documents (typiquement des readme) bien formatés et utilisables dans toutes circonstances. Donc que ça reste lisible et relativement clean si copié-collé dans un forum, un blog, vu sous DOS, sous console *nix, et j'en passe.

Pour cette raison, unicode n'est pas acceptable.

Et unicode n'apporterait pas grand-chose de toutes façons, parce que le but du programme n'est pas de réaliser de jolis dessins avec des caractères, même si ça peut être un plus, mais bel et bien de formater du texte :lol

Donc je dois avouer qu'implémenter unicode est le cadet de mes soucis pour GaTeX. Ce sera plus utilie d'ajouter des \rep multiples, des macros utilisateur, des environnements de listes etc. :foufou


N.tox wrote: mais...(c'en est pas vraiment un...)

Qu'est-ce qui n'est pas vraiment un quoi ? :D
{<§ Gamall Wednesday Ida §>}
{ Mods and Programs - Mods TES-IV Oblivion }

User avatar
N.tox
Posts: 4
Joined: Fri Jun 29, 2007 3:47 pm

Re: GaTeX: An ASCII Document Formatting System

Postby N.tox » Fri Jun 29, 2007 10:59 pm

Suite au rapide échange d'MP, j'expose donc le problème que j'ai renontré qui est le suivant :

Code: Select all

{ cesjust         
   $type   =   text
   %width   =   65
   $align   =   JUST
   $left   =   " "
   $right   =   " "
   //$()leftin   =   "     "
   //$()rightin   =   "                 "
   $()in   =   ""
   $()out   =   " "      
}


lorsque j'ai testé ce bloc la première fois, $()rightin n'y était pas. Et j'ai vu que dans la première ligne de texte, la partie de droite n'était pas aligné au reste du texte. Je me suis donc dit que je pouvais rétablir ce non-alignement grace à une entrée $()rightin avec le même nombre d'espacement que $right :baton . Seulement là j'ai constaté que $()rightin agit sur toutes les lignes, au lieu de la première uniquement :banghead ... J'ai ici exagéré le nombre d'espacements dans $()rightin pour que ce que j'affirme soit plus criant. J'ai effectué plusieurs tests avant de t'exposer le problème, je peux donc affirmer qu'il existe bien chez moi ; pourtant dans ton tuto sur wiwiland tu n'as pas l'air d'avoir rencontré le problème. Le mystère s'épaissit... :bobo

mais...(c'en est pas vraiment un...)

Qu'est-ce qui n'est pas vraiment un quoi ? :D

Un "mais" tout simplement... :nanan???re
Last edited by N.tox on Fri Jun 29, 2007 11:58 pm, edited 1 time in total.

User avatar
Gamall
Hic sunt dracones
Posts: 4132
Joined: Fri May 26, 2006 11:09 pm
Contact:

Re: GaTeX: An ASCII Document Formatting System

Postby Gamall » Fri Jun 29, 2007 11:34 pm

Coucou :)

En fait, il n'y a pas de mystère ; c'est dû à la façon dont GaTeX gère les instructions right/leftin/out.

Il faut savoir que, comme je n'en avais jamais eu besoin personellement, ces instructions n'étaient pas dans la version Beta . Je les ai rajoutées après-coup.

Or, l'algorithme de formatage de texte, déjà écrit, suppose que toutes les lignes d'un même bloc de texte aient la même largeur. C'était une supposition parfaitement valide avant l'introduction de leftin et cie. Et puis, c'est une supposition qui est en accord avec la première priorité du programme, qui est de produire un texte "clean", et non pas une oeuvre d'art abstrait. De plus, dans mon esprit les $()left(in/out) et $left avait la même largeur, idem à droite.

Donc, j'ai-je fait ? J'ai pris le maximum des largeurs de $()left(in/out) et $left, même chose à droite, et %width - ça me donne la largeur effective du bloc de texte.

Donc c'est pour ça que $()rightin a une influence sur tout le reste: ton entrée diminue la largeur effective de tout le reste ;) Et c'est d'autant plus visible dans ton exemple.

Pour être sûr que tout soit toujours parfaitement aligné, il suffit de faire gaffe à toujours avoir des entrées gauches de même largeur x et des entrées droites de même largeur y.

Voilà, j'espère avoir répondu à ta question :)
{<§ Gamall Wednesday Ida §>}
{ Mods and Programs - Mods TES-IV Oblivion }

User avatar
N.tox
Posts: 4
Joined: Fri Jun 29, 2007 3:47 pm

Re: GaTeX: An ASCII Document Formatting System

Postby N.tox » Sat Jun 30, 2007 12:33 am

Et puis, c'est une supposition qui est en accord avec la première priorité du programme, qui est de produire un texte "clean", et non pas une oeuvre d'art abstrait.


Ok, ok, j'ai compris :garde . Cecit dit, tu remarqueras qu'un texte comportant des césures est tout de même plus clair et lisible (donc clean (je suis tenté de croire que nous n'avons pas la même approche de ce mot, ton approche de clean est très...mathématique :P )) que du texte en bloc, mon objectif n'était donc pas de faire une oeuvre abstraite :huhu. Bon, c'est pas possible :snif...donc tant pis :soupir. En tout cas grâce à tes explications, je comprend maintenant mieux le fonctionnement du soft :)
Merciiii :huhu

User avatar
Gamall
Hic sunt dracones
Posts: 4132
Joined: Fri May 26, 2006 11:09 pm
Contact:

Re: GaTeX: An ASCII Document Formatting System

Postby Gamall » Sat Jun 30, 2007 1:20 am

N.tox wrote:qu'un texte comportant des césures est tout de même plus clair et lisible

Tu veux dire des indentations, je suppose :? C'est possible d'en faire: il suffit d'écrire \tab en début de texte... en revanche
en mode justifié, comme le tab est considéré comme un mot, il y aura un petit décalage d'un paragraphe à l'autre, quand les espaces de justification se rajouteront...

N.tox wrote:ton approche de clean est très...mathématique :P

Ouups, je suis découverte :fear

N.tox wrote: Bon, c'est pas possible :snif

En mode $align = left, tu peux utiliser \tab autant que tu veux. En mod just tu peux essayer, si tes paragraphes sont assez gros, il y a peu de chances que qui que ce soit remarque que l'indentation varie d'un ou deux crans d'un paragraphe à l'autre. :?

Mais j'avoue que là, GaTeX ne fait objectivement pas du bon boulot, tout simplement parce que je n'avais pas pensé à ça en l'écrivant.

Je pense qu'un de ces jours, je vais repartir de zéro et tout réécrire de manière nettement plus abstraite (ce que j'avais déjà fait entre Alpha et Beta) parce que là je me rends compte que certains choix que j'ai fait rendent très difficile l'ajout de fonctions pourtant simples, mais d'une nature que je n'avais pas prévue. :O:

En tous les cas, merci de tes commentaires pertinents, N.tox :)
{<§ Gamall Wednesday Ida §>}
{ Mods and Programs - Mods TES-IV Oblivion }

User avatar
N.tox
Posts: 4
Joined: Fri Jun 29, 2007 3:47 pm

Re: GaTeX: An ASCII Document Formatting System

Postby N.tox » Mon Jul 02, 2007 4:24 pm

Tu veux dire des indentations, je suppose :?


Je dirais que tu suppose juste, puique l'effet obtenu avec \tab est l'effet recherché :) (j'ai du mal à me rapeler de mes cours de maquette...).
Et suite à un test rapide avec sulement un \tab dans des blocs de textes aligné à gauche et justifiés, tout marche nickel :ouais! ! Meci Gamall :love .
Enfin, si je puis me permettre une dernière suggestion, ce serais pas mal (si évidemment tu en as le temps et le courage...) de rajouter sur ton tuto d'utilisation de GaTeX sur Wiwiland, une liste des commandes possibles (dans le style des \tab, \line etc...). Si c'est déjà dans le read-me, désolé je l'ai pas lu :tomates .
@ +++ :)

User avatar
Gamall
Hic sunt dracones
Posts: 4132
Joined: Fri May 26, 2006 11:09 pm
Contact:

Re: GaTeX: An ASCII Document Formatting System

Postby Gamall » Mon Jul 02, 2007 7:17 pm

N.tox wrote:Enfin, si je puis me permettre une dernière suggestion, ce serais pas mal (si évidemment tu en as le temps et le courage...) de rajouter sur ton tuto d'utilisation de GaTeX sur Wiwiland, une liste des commandes possibles (dans le style des \tab, \line etc...). Si c'est déjà dans le read-me, désolé je l'ai pas lu :tomates .
@ +++ :)


Normalement tout est quelque-part dans le readme :P

Ceci dit, la liste est vite faite:

Code: Select all

\tab   : tabulation définie dans $tab
\line  : aller à la ligne
\-  : couper un mot en deux si besoin

Je crois bien que c'est tout :?
{<§ Gamall Wednesday Ida §>}
{ Mods and Programs - Mods TES-IV Oblivion }

User avatar
Hendrixxx
Posts: 11
Joined: Sun May 27, 2007 11:58 pm

Re: GaTeX: An ASCII Document Formatting System

Postby Hendrixxx » Tue Aug 14, 2007 2:23 pm

mince :D
Image


Return to “Freewares, game mods, Java, C++, OCaml & Maths”

Who is online

Users browsing this forum: No registered users and 41 guests