templates.hpp File Reference

templates: encoded skeletons used to scaffold new NoTeX projects. More...

#include <optional>
#include <string>
#include <string_view>
#include <vector>

Go to the source code of this file.

Namespaces
namespace	notex
namespace	notex::templates

Enumerations
enum class	notex::templates::ProjectType { notex::templates::MONO , notex::templates::MULTI }

Functions
std::string_view	notex::templates::to_string (ProjectType type)
std::optional< ProjectType >	notex::templates::project_type_from_string (std::string_view name)
	Parses a project type name.
std::string	notex::templates::mono_main (std::string_view class_path)
	Generates the entry file for a single-file project.
std::string	notex::templates::multi_main (std::string_view class_path, const std::vector< std::string > &section_stems={"1_introduction"})
	Generates the entry file for a multi-file project, referencing section_stems in order.
std::string	notex::templates::section_stem (int number, std::string_view title)
	Computes the filename stem (no directory, no extension) for a numbered section.
std::string	notex::templates::section (int number, std::string_view title)
	Generates a numbered section subfile.
std::string	notex::templates::bibliography_starter ()

Detailed Description

templates: encoded skeletons used to scaffold new NoTeX projects.

Mirrors the structure of the reference projects under examples/, but generalised: no repository-specific paths or content, and always beginning from a single introductory section. Kept in step by hand with examples/mono/ and examples/multi/ whenever either changes.

Definition in file templates.hpp.