String -- the class of all strings

i1 : "abcd"

o1 = abcd

Functions and methods returning a string :

• "ascii(List)" -- see ascii -- ASCII character conversion
• "Database # String" -- see BasicList # ZZ -- get value from list, hash table, database, or string
• "concatenate(BasicList)" -- see concatenate -- join strings
• "concatenate(Nothing)" -- see concatenate -- join strings
• "concatenate(String)" -- see concatenate -- join strings
• "concatenate(Symbol)" -- see concatenate -- join strings
• "concatenate(ZZ)" -- see concatenate -- join strings
• format -- format a string or a real number
• "format(CC)" -- see format -- format a string or a real number
• "format(RR)" -- see format -- format a string or a real number
• "format(String)" -- see format -- format a string or a real number
• "get(File)" -- see get -- get the contents of a file
• "get(String)" -- see get -- get the contents of a file
• "getc(File)" -- see getc -- get a byte
• "getenv(String)" -- see getenv -- get value of environment variable
• html -- convert to html format
• info -- convert hypertext to info format
• mathML -- convert to MathML format
• "String | String" -- see Net | Net -- join strings or nets
• "String | ZZ" -- see Net | Net -- join strings or nets
• "ZZ | String" -- see Net | Net -- join strings or nets
• "pad(String,ZZ)" -- see pad -- pad a string or net with spaces
• "pad(ZZ,String)" -- see pad -- pad a string or net with spaces
• read(File) -- read from a file
• read(File,ZZ) -- read from a file
• read(Sequence) -- read from a file
• read(String) -- read from a file
• regexQuote -- escape special characters in regular expressions
• replace(String,String,String) -- replace substrings matching a regular expression
• String _ Sequence -- substring
• String _ ZZ -- get element from string
• "substring(Sequence,String)" -- see substring -- extract part of a string
• "substring(String,ZZ)" -- see substring -- extract part of a string
• "substring(String,ZZ,ZZ)" -- see substring -- extract part of a string
• "substring(ZZ,String)" -- see substring -- extract part of a string
• "substring(ZZ,ZZ,String)" -- see substring -- extract part of a string
• tex -- convert to $\TeX$ format
• texMath -- convert to TeX math format
• toExternalString -- convert to a readable string
• toString -- convert to a string

Methods that use a string :

• "# String" -- see # BasicList -- length or cardinality
• "Database #? String" -- see #? -- check existence of value in a list, hash table, database, or string
• "String #? ZZ" -- see #? -- check existence of value in a list, hash table, database, or string
• - String (missing documentation)
• - String = Thing (missing documentation)
• "Net == String" -- see == -- equality
• "String == Net" -- see == -- equality
• "String == String" -- see == -- equality
• "about(String)" -- see about -- search the documentation
• "apropos(String)" -- see apropos -- symbols matching a pattern
• "arXiv(String)" -- see arXiv -- link to an arXiv article
• "arXiv(String,String)" -- see arXiv -- link to an arXiv article
• "ascii(String)" -- see ascii -- ASCII character conversion
• "autoload(Symbol,String)" -- see autoload -- arrange for a function to be loaded automatically
• "String # ZZ" -- see BasicList # ZZ -- get value from list, hash table, database, or string
• "capture(String)" -- see capture -- evaluate Macaulay2 code and capture the output
• "characters(String)" -- see characters -- get characters from a string
• "check(String)" -- see check -- perform tests of a package
• "check(ZZ,String)" -- see check -- perform tests of a package
• copyDirectory(String,String)
• copyFile(String,String)
• "depth(String)" -- see depth -- depth of a net
• "dismiss(String)" -- see dismiss -- dismiss a package
• "doc(String)" -- see doc -- a simple documentation function
• "makeDocumentTag(String)" -- see DocumentTag -- the class of all document tags
• "endPackage(String)" -- see endPackage -- end a new package
• "EXAMPLE(String)" -- see EXAMPLE -- hypertext EXAMPLE item
• "export(String)" -- see export -- export symbols from a package
• "exportMutable(String)" -- see exportMutable -- export mutable symbols from a package
• "File << String" -- see File << Thing -- print to a file
• "String << Thing" -- see File << Thing -- print to a file
• "fileExecutable(String)" -- see fileExecutable
• fileMode(String) -- get file mode
• fileMode(ZZ,String) -- set file mode
• "fileReadable(String)" -- see fileReadable
• "fileWritable(String)" -- see fileWritable
• "findFiles(String)" -- see findFiles -- find files recursively
• "findProgram(String,List)" -- see findProgram -- load external program
• "findProgram(String,String)" -- see findProgram -- load external program
• "generateAssertions(String)" -- see generateAssertions -- generate assert statements from experimental input
• "getWWW(String)" -- see getWWW -- get a web page
• "getWWW(String,Nothing)" -- see getWWW -- get a web page
• "getWWW(String,String)" -- see getWWW -- get a web page
• "height(String)" -- see height -- height of a net
• "help(String)" -- see help -- view documentation nodes
• httpHeaders(String) -- prepend http headers to a string
• ideal(String) -- make an ideal using classic Macaulay syntax
• "importFrom(String,List)" -- see importFrom -- import symbols to the current private dictionary
• "installPackage(String)" -- see installPackage -- load and install a package and its documentation
• length(String) -- length of a string
• "lines(String)" -- see lines -- split a string into lines
• "lines(String,String)" -- see lines -- split a string into lines
• linkFile(String,String) -- make a new link to a file
• "loadPackage(String)" -- see loadPackage -- load a package
• makeDirectory(String) -- make a directory
• "match(List,String)" -- see match -- regular expression matching
• "match(String,String)" -- see match -- regular expression matching
• matrix(String) -- make a matrix using classic Macaulay syntax
• monomialIdeal(String) -- make a monomial ideal using classic Macaulay syntax
• "moveFile(String)" -- see moveFile(String,String)
• moveFile(String,String)
• "needsPackage(String)" -- see needsPackage -- load a package if not already loaded
• "String ^ ZZ" -- see Net ^ ZZ -- raise a net or string
• net(String) -- convert a string to a net
• "NetFile << String" -- see NetFile -- the class of all net files
• "newPackage(String)" -- see newPackage -- the preamble of a package
• "openDatabase(String)" -- see openDatabase -- open a database file
• "openDatabaseOut(String)" -- see openDatabaseOut -- open a database file for writing
• openIn(String) -- open an input file
• "openInOut(String)" -- see openInOut -- open an input output file
• openListener(String) -- open a port for listening
• openOut(String) -- open an output file
• openOutAppend(String) -- open an output file for appending
• "package(String)" -- see package -- get containing package
• "packageTemplate(String)" -- see packageTemplate -- a template for a package
• poly(String) -- make a polynomial using classic Macaulay syntax
• "profile(String,Function)" -- see profile -- profile a function
• "readPackage(String)" -- see readPackage -- read the package preamble
• "regex(String,String)" -- see regex -- evaluate a regular expression search
• "regex(String,ZZ,String)" -- see regex -- evaluate a regular expression search
• "regex(String,ZZ,ZZ,String)" -- see regex -- evaluate a regular expression search
• "regexQuote(String)" -- see regexQuote -- escape special characters in regular expressions
• Ring _ String -- get a ring variable by name
• "runProgram(Program,String)" -- see runProgram -- run an external program
• "runProgram(Program,String,String)" -- see runProgram -- run an external program
• "scanLines(Function,String)" -- see scanLines -- apply a function to each line of a file
• searchPath(List,String) -- search a path for a file
• "searchPath(String)" -- see searchPath(List,String) -- search a path for a file
• "select(String,String)" -- see select(String,String,String) -- select and reformat substrings matching a regular expression
• select(String,String,String) -- select and reformat substrings matching a regular expression
• "separate(String)" -- see separate -- split a string into substrings using a regular expression
• "separate(String,String)" -- see separate -- split a string into substrings using a regular expression
• "separate(String,ZZ,String)" -- see separate -- split a string into substrings using a regular expression
• setRandomSeed(String) -- set starting point for random number generator
• source(String) (missing documentation)
• source(String,Number) (missing documentation)
• source(String,String) (missing documentation)
• "splitWWW(String)" -- see splitWWW -- separate an http response into header and body
• "stacksProject(String,String)" -- see stacksProject -- link to a Stacks Project tag
• String * Number (missing documentation)
• String * String (missing documentation)
• String * String = Thing (missing documentation)
• String .. String -- a sequence of consecutive strings
• String ..< String -- a sequence of consecutive strings, not including the endpoint
• String ^ Sequence -- vertically stacked copies of a string
• String ~ (missing documentation)
• String ~ = Thing (missing documentation)
• symlinkDirectory(String,String) -- make symbolic links for all files in a directory tree
• "TEST(String)" -- see TEST -- add a test for a package
• "uninstallPackage(String)" -- see uninstallPackage -- uninstall a package and remove its documentation
• "new URL from String" -- see URL -- a type representing a URL
• value(String) -- evaluate a string
• "viewHelp(String)" -- see viewHelp -- view online documentation in a web browser
• "width(String)" -- see width(Net) -- width of a net
• "wikipedia(String)" -- see wikipedia -- link to a Wikipedia article
• "wikipedia(String,String)" -- see wikipedia -- link to a Wikipedia article

Fixed objects of class String :

• copyright -- a string containing the copyright notice for Macaulay2
• currentFileDirectory -- the directory containing the current input file
• currentFileName -- the current source file
• "docTemplate" -- see doc -- a simple documentation function
• docExample -- an example of a documentation string
• newline -- the new line character sequence
• rootPath
• rootURI
• testExample -- an example of a test string
• "currentString" -- see value(String) -- evaluate a string

For the programmer

The object String is a type, with ancestor classes Net < Thing.