newPackage(String) -- package item: start a new package

Synopsis

• Usage:

  newPackage ( title )

• Function: newPackage
• Inputs:

  • title, a string, the name of the new package
• Consequences:

  • a package is created
• Optional inputs:

  • Version => a string, default value 0.0, the version number of the package
  • Date => a string, default value null, the date of this version of the package
  • InfoDirSection => a string, default value Macaulay 2 and its packages, the title of the section in the info page directory where the menu entry for this package should be made
  • Headline => a string, default value null, a brief (5-10 words) description of the package
  • Authors => a list, default value {}, a list of lists of options, one for each author. The suboptions are of the form Name => x, Email => x, or HomePage => x, where x is a string.
  • HomePage => a string, default value null, the URI pointing to the home page of the package, if any
  • DebuggingMode => a Boolean value, default value false, whether debuggingMode should be true during package loading

Description

i1 : newPackage("Foo", Version => "1.1", Headline => "making Foo")

o1 = Foo

o1 : Package

i2 : endPackage "Foo"

o2 = Foo

o2 : Package

i3 : options Foo

o3 = OptionTable{Authors => {}                                }
                 Date => 
                 DebuggingMode => false
                 Headline => making Foo
                 HomePage => 
                 InfoDirSection => Macaulay 2 and its packages
                 Version => 1.1

o3 : OptionTable

i4 : oo.Headline

o4 = making Foo

i5 : (options Core).Version

o5 = 0.9.20

newPackage("PACKAGENAME",
    Headline => "one line description",
    Version => 1.0,
    Date => "month XX, 20XX",
    Authors => {
         {Name => "author1", Email => "email1", HomePage => "url1"}
         {Name => "author2", Email => "email2", HomePage => "url2"},
         },
    DebuggingMode => true
    )

See also

• packages