Skip to content

Releases: jkuczm/mmacells

0.3.2

03 Jan 19:14
Compare
Choose a tag to compare

Bugs fixed

  • #32 Using \mmaInlineCell as first mmacells "construct" no longer causes errors.

0.3.1

26 Jun 19:02
Compare
Choose a tag to compare

Bugs fixed

  • #28 @ is now an "other" character.

0.3.0

21 May 08:51
Compare
Choose a tag to compare

Backward incompatible changes

  • #26 All formatting commands now process all arguments in text mode.
    So first argument of \mmaSup, \mmaSub, \mmaSubSup, \mmaUnder, \mmaOver, \mmaUnderOver, \mmaSqrt, \mmaRadical are no longer processed in math mode.
    If math mode is required use it explicitly, so change e.g. \mmaSup{\alpha}{2} to \mmaSup{\(\alpha\)}{2}.
    If sub- or super-script is required to be right next to first argument, use corresponding \...M commands, e.g. \mmaSubSupM{\int}{r}{∞}
  • #23 # is now considered a letter character, so it can be used in identifier names.
  • #27 Default formatting is no longer set using listings basicstyle, instead it's set using fancyvrb formatcom and default color is set using formatline.
  • #27 Commands given in formatline option are now used also in inline cells.
  • #24 \mmacells_define_annotation_keys:nnnnnn command was removed.

New features

  • #25 uselistings key

    If set to false cells will not use listings interface, just pure fancyvrb.

    listings interface to fancyvrb is buggy and listings support for Unicode is very limited.

    With listings switched off, syntax highlighting, based purely on annotations, can be used, and auto-generated by Mathematica.

  • #24 New annotations
    \mmaStr and \mmaCmt for annotating strings and comments respectively.
    stringstyle and commentstyle keys for setting apropriate styles.

  • #26 New formatting commands
    \mmaSupM, \mmaSubM, \mmaSupSubM that process their first argument in math mode.

  • #24 \mmacells_define_idlistless_annotation:nnnn macro defining annotation without accompanying keys setting identifier lists.

0.2.0

08 Apr 14:47
Compare
Choose a tag to compare

Backward incompatible changes

Renamed key:

  • messagecolorchangeliterate -> messagecolorchange

Changed key usage:

  • messagelinkliterate and messagelinkliterate=true -> messagelinktype=builtin
  • messagelinkliterate=false -> messagelinktype=none

Removed macro:

  • \mmacells_lst_set_literate:n

New features

Inline cells

  • \mmaInlineCell command that allows putting cells inline with surrounding text.
  • \mmaInlineCellNonVerb non-verbatim variant, for use inside arguments of other macros.

messagelinktype key

It accepts: builtin, local and none values.

  • With messagelinktype=builtin, >> is replaced by link to Mathematica built-in documentation, it supersedes messagelinkliterate=true.
  • With messagelinktype=local, >> is replaced by link to local target, inside document.
  • With messagelinktype=none, >> is not replaced, it supersedes messagelinkliterate=false.

uselist key

It enables switching off list wrappers, that provide labels and consistent spacing for cells.

Bugs fixed

  • pattern variables, with default patternstyle, used inside math mode, no longer cause warnings.

0.1.1

06 Mar 18:58
Compare
Choose a tag to compare

Bug fixed:

  • Package keyval Error: morefvcmdparams undefined. is no longer printed when first cell is a formatted one.

0.1.0

05 Mar 21:05
Compare
Choose a tag to compare

Backward incompatible changes

Renamed keys:

  • xleftmargin -> leftmargin,
  • graphics -> ig,
  • dynamic -> functionlocal,
  • lexical -> local,
  • argument -> pattern,
  • error -> excessargument,
  • ...* -> more....

Changed key usage:

  • mathreplacements -> mathreplacements=light,
  • mathreplacementsbold -> mathreplacements=bold.

Renamed commands:

  • \mmaDyn -> \mmaFnc,
  • \mmaLex -> \mmaLoc,
  • \mmaArg -> \mmaPat,
  • \mmaErr -> \mmaExc,
  • \mmaLinkTarget -> \mmaLnT,
  • \mmaLinkLocal -> \mmaLnL,
  • \mmaLinkBuiltin -> \mmaLnB.

Renamed colors:

  • mmaDynamic -> mmaFunctionLocal,
  • mmaLexical -> mmaLocal.

New features

Graphics support

  • \mmaGraphics command to include inline graphics inside code.
  • ig key passing key values to \includegraphics command.
  • pole1, pole2, xoffset and yoffset keys used as arguments for typesetting coffins containing graphics.
  • cellgraphics and graphics keys storing default key values for corresponding commands

addtoindex key

Takes integer that will be added to current cell index.

Using addtoindex should be preferred to using index when purpose of manual index tweaking is compensation of Null returning line (i.e. situation in which cell index in FronEnd is incremented, but no output cell is produced).

verbatimenv key

Takes name of verbatim environment to be used by mmaCell.

Can accept any verbatim environment from fancyvrb package, or custom environment based on one of fancyvrbs environments.

Can also be empty, then no verbatim environment is used and contents of mmaCell environment are used in ordinary text mode.

postwidelabel key

Takes arbitrary tokens that will be expanded after cell label, when it's too wide.

formatline key

Takes arbitrary command that will be called for each line, with argument being result of calling \FancyVerbFormatLine on line contents.

mathreplacements changed to choice key

It accepts: light, bold and none values.

New supported syntax elements

Mathematica name command key
LocalScopeConflict \mmaLCn localconflict
GlobalToLocalScopeConflict \mmaGCn globalconflict
UnknownOption \mmaOpt unknownoption
UnwantedAssignment \mmaAsg unwantedassignment
SymbolShadowing \mmaShd shadowing
SyntaxError \mmaSnt syntaxerror
EmphasizedSyntaxError \mmaEmp emphasizedsyntaxerror
FormattingError \mmaFmt formattingerror

All elements have accompanying more..., delete... and ...style keys.

New colors

  • mmaSyntaxError,
  • mmaEmphasizedError,
  • mmaEmphasizedErrorBackground,
  • mmaFormattingError,
  • mmaFormattingErrorBackground.

Boolean keys

formatted, annotations, messagelinkliterate, messagecolorchangeliterate are now boolean keys, so can be easily unset with e.g. formatted=false, which was impossible before.

delete... keys

...* keys (now renamed to more... keys) acquired corresponding delete... keys.

Custom annotation definitions

\mmaDefineAnnotation command defining command and key allowing marking of code fragments, together with corresponding more..., delete... and ...style keys.

\mmaDefineFrontEndInStyle command automatically taking into account annotations defined with \mmaDefineAnnotation command.

\mmaHl command

"Verbatim-safe" highlighting.

Bugs fixed

  • Fixed spacing after Message cell.
  • Added graphicx to required packages.

0.0.1

04 Feb 21:37
Compare
Choose a tag to compare

Initial development release.