Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The trivial-project Reference Manual

This is the trivial-project Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 06:56:06 2025 GMT+0.

Next: Systems, Previous: The trivial-project Reference Manual, Up: The trivial-project Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The trivial-project Reference Manual [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.

trivial-project

Previous: Systems, Up: Systems [Contents][Index]

2.1 `trivial-project`

A simple project skeleton generator with key-value substitution

Author

StackSmith <fpgasm@apple2.x10.mx>

License

BSD Simplified (2-clause)

Version

1.0.0

Dependencies

cl-ppcre (system).
alexandria (system).

Source

trivial-project.asd.

Child Components

package.lisp (file).
params.lisp (file).
trivial-project.lisp (file).

Next: Packages, Previous: Systems, Up: The trivial-project Reference Manual [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

Previous: Files, Up: Files [Contents][Index]

Next: trivial-project/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `trivial-project/trivial-project.asd`

Source: trivial-project.asd.
Parent Component: trivial-project (system).
ASDF Systems: trivial-project.

Next: trivial-project/params.lisp, Previous: trivial-project/trivial-project.asd, Up: Lisp [Contents][Index]

3.1.2 `trivial-project/package.lisp`

Source: trivial-project.asd.
Parent Component: trivial-project (system).
Packages: trivial-project.

Next: trivial-project/trivial-project.lisp, Previous: trivial-project/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `trivial-project/params.lisp`

Dependency

package.lisp (file).

Source

trivial-project.asd.

Parent Component

trivial-project (system).

Internals

*extensions* (special variable).
*files* (special variable).
*output-path* (special variable).
extensions-initialize (function).
filename-action (function).
files-initialize (function).
initial-keys (function).
local-template (function).
set-params-from-file (function).
set-params-from-list (function).

Previous: trivial-project/params.lisp, Up: Lisp [Contents][Index]

3.1.4 `trivial-project/trivial-project.lisp`

Dependency

params.lisp (file).

Source

trivial-project.asd.

Parent Component

trivial-project (system).

Public Interface

make-project (function).

Internals

*params* (special variable).
all-files-below (function).
process-file (function).
process-files (function).
process-string (function).

Next: Definitions, Previous: Files, Up: The trivial-project Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

trivial-project

Previous: Packages, Up: Packages [Contents][Index]

4.1 `trivial-project`

Source

package.lisp.

Nickname

tp

Use List

alexandria.
common-lisp.

Public Interface

make-project (function).

Internals

*extensions* (special variable).
*files* (special variable).
*output-path* (special variable).
*params* (special variable).
all-files-below (function).
extensions-initialize (function).
filename-action (function).
files-initialize (function).
initial-keys (function).
local-template (function).
process-file (function).
process-files (function).
process-string (function).
set-params-from-file (function).
set-params-from-list (function).

Next: Indexes, Previous: Packages, Up: The trivial-project Reference Manual [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: make-project (&rest params &key name &allow-other-keys) ¶

Create a project named (name must be a string) based on a template and other keys.

Package: trivial-project.
Source: trivial-project.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Special variables
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: *extensions* ¶

Package: trivial-project.
Source: params.lisp.

Special Variable: *files* ¶

Package: trivial-project.
Source: params.lisp.

Special Variable: *output-path* ¶

Package: trivial-project.
Source: params.lisp.

Special Variable: *params* ¶

Package: trivial-project.
Source: trivial-project.lisp.

Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: all-files-below (directory root) ¶

collect all filenames at or below root, relative to root, as strings

Package: trivial-project.
Source: trivial-project.lisp.

Function: extensions-initialize () ¶

Package: trivial-project.
Source: params.lisp.

Function: filename-action (enoughpath) ¶

Package: trivial-project.
Source: params.lisp.

Function: files-initialize () ¶

Package: trivial-project.
Source: params.lisp.

Function: initial-keys (params) ¶

Package: trivial-project.
Source: params.lisp.

Function: local-template () ¶

Package: trivial-project.
Source: params.lisp.

Function: process-file (srcpath destpath) ¶

Package: trivial-project.
Source: trivial-project.lisp.

Function: process-files () ¶

Package: trivial-project.
Source: trivial-project.lisp.

Function: process-string (string &optional regex) ¶

Package: trivial-project.
Source: trivial-project.lisp.

Function: set-params-from-file (path &key in) ¶

Package: trivial-project.
Source: params.lisp.

Function: set-params-from-list (list) ¶

set (overwriting) *params* from plist-like list

Package: trivial-project.
Source: params.lisp.

Previous: Definitions, Up: The trivial-project Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	A E F I L M P S

	Index Entry	Section

A
	`all-files-below`:	Private ordinary functions

E
	`extensions-initialize`:	Private ordinary functions

F
	`filename-action`:	Private ordinary functions
	`files-initialize`:	Private ordinary functions
	`Function, all-files-below`:	Private ordinary functions
	`Function, extensions-initialize`:	Private ordinary functions
	`Function, filename-action`:	Private ordinary functions
	`Function, files-initialize`:	Private ordinary functions
	`Function, initial-keys`:	Private ordinary functions
	`Function, local-template`:	Private ordinary functions
	`Function, make-project`:	Public ordinary functions
	`Function, process-file`:	Private ordinary functions
	`Function, process-files`:	Private ordinary functions
	`Function, process-string`:	Private ordinary functions
	`Function, set-params-from-file`:	Private ordinary functions
	`Function, set-params-from-list`:	Private ordinary functions

I
	`initial-keys`:	Private ordinary functions

L
	`local-template`:	Private ordinary functions

M
	`make-project`:	Public ordinary functions

P
	`process-file`:	Private ordinary functions
	`process-files`:	Private ordinary functions
	`process-string`:	Private ordinary functions

S
	`set-params-from-file`:	Private ordinary functions
	`set-params-from-list`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`extensions`:	Private special variables
	`files`:	Private special variables
	`output-path`:	Private special variables
	`params`:	Private special variables

S
	`Special Variable, extensions`:	Private special variables
	`Special Variable, files`:	Private special variables
	`Special Variable, output-path`:	Private special variables
	`Special Variable, params`:	Private special variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	F P S T

	Index Entry	Section

F
	`File, package.lisp`:	The trivial-project/package․lisp file
	`File, params.lisp`:	The trivial-project/params․lisp file
	`File, trivial-project.asd`:	The trivial-project/trivial-project․asd file
	`File, trivial-project.lisp`:	The trivial-project/trivial-project․lisp file

P
	`Package, trivial-project`:	The trivial-project package
	`package.lisp`:	The trivial-project/package․lisp file
	`params.lisp`:	The trivial-project/params․lisp file

S
	`System, trivial-project`:	The trivial-project system

T
	`trivial-project`:	The trivial-project system
	`trivial-project`:	The trivial-project package
	`trivial-project.asd`:	The trivial-project/trivial-project․asd file
	`trivial-project.lisp`:	The trivial-project/trivial-project․lisp file

The trivial-project Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 trivial-project

3 Files

3.1 Lisp

3.1.1 trivial-project/trivial-project.asd

3.1.2 trivial-project/package.lisp

3.1.3 trivial-project/params.lisp

3.1.4 trivial-project/trivial-project.lisp

4 Packages

4.1 trivial-project

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `trivial-project`

3.1.1 `trivial-project/trivial-project.asd`

3.1.2 `trivial-project/package.lisp`

3.1.3 `trivial-project/params.lisp`

3.1.4 `trivial-project/trivial-project.lisp`

4.1 `trivial-project`