TABLE OF CONTENTS


Yass/Pages [ Packages ]

[ Top ] [ Packages ]

FUNCTION

 Provide code to create pages from Markdown files

SOURCE

package Pages is

Pages/Pages.Generate_Site_Exception [ Exceptions ]

[ Top ] [ Pages ] [ Exceptions ]

FUNCTION

 Raised when generating site was interrupted

SOURCE

   Generate_Site_Exception: exception;

Pages/Pages.Copy_File [ Subprograms ]

[ Top ] [ Pages ] [ Subprograms ]

FUNCTION

 Copy file with full path FileName to proper location in site output
 directory with full path Directory

SOURCE

   procedure Copy_File(File_Name, Directory: String) with
      Pre => File_Name'Length > 0 and Directory'Length > 0,
      Test_Case => (Name => "Test_Copy_File", Mode => Nominal);

PARAMETERS

 File_Name - Full path to the file which will be copied
 Directory - Full path to the directory where file will be added

Pages/Pages.Create_Empty_File [ Subprograms ]

[ Top ] [ Pages ] [ Subprograms ]

FUNCTION

 Create empty markdown file with default tags and with full path FileName

SOURCE

   procedure Create_Empty_File(File_Name: String) with
      Pre => File_Name'Length > 0,
      Test_Case => (Name => "Test_Create_Empty_File", Mode => Nominal);

PARAMETERS

 File_Name - Full path to the Markdown file which will be created

Pages/Pages.Create_Page [ Subprograms ]

[ Top ] [ Pages ] [ Subprograms ]

FUNCTION

 Create page from file with full path FileName in directory with full
 path Directory

SOURCE

   procedure Create_Page(File_Name, Directory: String) with
      Pre => File_Name'Length > 0 and Directory'Length > 0,
      Test_Case => (Name => "Test_Create_Page", Mode => Nominal);

PARAMETERS

 File_Name - Full path to the Markdown file which will be processed
 Directory - Full path to the directory where newly create HTML file will
             be added

Pages/Pages.Get_Layout_Name [ Subprograms ]

[ Top ] [ Pages ] [ Subprograms ]

FUNCTION

 Get name of layout used in the page with full path FileName

SOURCE

   function Get_Layout_Name(File_Name: String) return String with
      Pre => File_Name'Length > 0,
      Test_Case => (Name => "Test_Get_Layout_Name", Mode => Nominal);

PARAMETERS

 File_Name - Full path to the file which name layout will be check

RESULT

 Name of the layout used by the file