Compare commits
21 Commits
89245f2553
...
main
Author | SHA1 | Date | |
---|---|---|---|
aa97a738b4 | |||
ddf489c2c4 | |||
54a4d6dbc3 | |||
294319a205 | |||
1d97560c40 | |||
81fa5c38de | |||
6365e963c5 | |||
d1f7738f09 | |||
5cb0ef6b87 | |||
2608e870cc | |||
bd57c6fbf5 | |||
4cb72677db | |||
36b2842ee9 | |||
884d456e48 | |||
05d2c48b57 | |||
86440af01f | |||
a2ed35a26d | |||
1b6441e03e | |||
5f5c250272 | |||
6e717a8cf7 | |||
87d54788db |
1
.gitignore
vendored
1
.gitignore
vendored
@ -2,3 +2,4 @@ config.json
|
||||
.build
|
||||
.swiftpm
|
||||
Package.resolved
|
||||
Issues.md
|
||||
|
@ -65,7 +65,7 @@ struct Element {
|
||||
let sortIndex: Int?
|
||||
|
||||
/**
|
||||
All files which may occur in content but is stored externally.
|
||||
All files which may occur in content but are stored externally.
|
||||
|
||||
Missing files which would otherwise produce a warning are ignored when included here.
|
||||
- Note: This property defaults to an empty set.
|
||||
@ -240,6 +240,10 @@ struct Element {
|
||||
guard let metadata = GenericMetadata(source: source, log: log) else {
|
||||
return nil
|
||||
}
|
||||
let state: PageState = log.cast(metadata.state, "state", source: source)
|
||||
guard state != .ignored else {
|
||||
return nil
|
||||
}
|
||||
|
||||
var isValid = true
|
||||
|
||||
@ -248,7 +252,7 @@ struct Element {
|
||||
self.topBarTitle = log.unused(metadata.topBarTitle, "topBarTitle", source: source)
|
||||
self.date = metadata.date.unwrapped { log.cast($0, "date", source: source) }
|
||||
self.endDate = metadata.endDate.unwrapped { log.cast($0, "endDate", source: source) }
|
||||
self.state = log.cast(metadata.state, "state", source: source)
|
||||
self.state = state
|
||||
self.sortIndex = metadata.sortIndex
|
||||
// TODO: Propagate external files from the parent if subpath matches?
|
||||
self.externalFiles = Element.rootPaths(for: metadata.externalFiles, path: path)
|
||||
@ -315,7 +319,7 @@ struct Element {
|
||||
}
|
||||
}
|
||||
|
||||
func getExternalPageMap(language: String) -> [String : String] {
|
||||
func getExternalPageMap(language: String, log: MetadataInfoLogger) -> [String : String] {
|
||||
var result = [String : String]()
|
||||
if let ext = getExternalLink(for: language) {
|
||||
result[id] = ext
|
||||
@ -323,7 +327,10 @@ struct Element {
|
||||
result[id] = path + Element.htmlPagePathAddition(for: language)
|
||||
}
|
||||
elements.forEach { element in
|
||||
element.getExternalPageMap(language: language).forEach { key, value in
|
||||
element.getExternalPageMap(language: language, log: log).forEach { key, value in
|
||||
if result[key] != nil {
|
||||
log.error("Page id '\(key)' is used twice", source: value)
|
||||
}
|
||||
result[key] = value
|
||||
}
|
||||
}
|
||||
@ -337,6 +344,10 @@ struct Element {
|
||||
var needsFirstSection: Bool {
|
||||
showMostRecentSection || !featuredPages.isEmpty
|
||||
}
|
||||
|
||||
var hasVisibleChildren: Bool {
|
||||
!elements.filter { $0.state == .standard }.isEmpty
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: Paths
|
||||
@ -362,7 +373,7 @@ extension Element {
|
||||
}
|
||||
|
||||
var hasNestingElements: Bool {
|
||||
elements.contains { $0.containsElements }
|
||||
elements.contains { $0.hasVisibleChildren }
|
||||
}
|
||||
|
||||
func itemsForOverview(_ count: Int? = nil) -> [Element] {
|
||||
@ -421,7 +432,7 @@ extension Element {
|
||||
- Returns: The relative url from a localized page of the element to the target file.
|
||||
*/
|
||||
func relativePathToOtherSiteElement(file: String) -> String {
|
||||
guard !file.hasPrefix("/") else {
|
||||
guard !file.hasPrefix("/"), !file.hasPrefix("https://"), !file.hasPrefix("http://") else {
|
||||
return file
|
||||
}
|
||||
// Note: The element `path` is missing the last component
|
||||
@ -431,7 +442,7 @@ extension Element {
|
||||
|
||||
// Find the common elements of the path, which can be discarded
|
||||
var index = 0
|
||||
while pageParts[index] == ownParts[index] {
|
||||
while index < pageParts.count && index < ownParts.count && pageParts[index] == ownParts[index] {
|
||||
index += 1
|
||||
}
|
||||
// The relative path needs to go down to the first common folder,
|
||||
|
@ -15,6 +15,11 @@ enum PageState: String {
|
||||
Generate the page, but don't include it in overviews of the parent.
|
||||
*/
|
||||
case hidden
|
||||
|
||||
/**
|
||||
Completely ignore the element.
|
||||
*/
|
||||
case ignored
|
||||
}
|
||||
|
||||
extension PageState {
|
||||
@ -23,7 +28,7 @@ extension PageState {
|
||||
switch self {
|
||||
case .standard, .draft:
|
||||
return true
|
||||
case .hidden:
|
||||
case .hidden, .ignored:
|
||||
return false
|
||||
}
|
||||
}
|
||||
@ -32,9 +37,7 @@ extension PageState {
|
||||
switch self {
|
||||
case .standard:
|
||||
return true
|
||||
case .draft:
|
||||
return false
|
||||
case .hidden:
|
||||
case .draft, .hidden, .ignored:
|
||||
return false
|
||||
}
|
||||
}
|
||||
@ -47,7 +50,7 @@ extension PageState: StringProperty {
|
||||
}
|
||||
|
||||
static var castFailureReason: String {
|
||||
"Page state must be 'standard', 'draft' or 'hidden'"
|
||||
"Page state must be 'standard', 'draft', 'hidden', or 'ignored'"
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -56,6 +56,11 @@ extension String {
|
||||
return parts.dropLast().joined(separator: separator) + content + separator + parts.last!
|
||||
}
|
||||
|
||||
/**
|
||||
Remove everything behind the first separator.
|
||||
|
||||
Also removes the separator itself. If the separator is not contained in the string, then the full string is returned.
|
||||
*/
|
||||
func dropAfterFirst<T>(_ separator: T) -> String where T: StringProtocol {
|
||||
components(separatedBy: separator).first!
|
||||
}
|
||||
@ -67,10 +72,25 @@ extension String {
|
||||
|
||||
extension Substring {
|
||||
|
||||
func dropBeforeFirst(_ separator: String) -> String {
|
||||
guard contains(separator) else {
|
||||
return String(self)
|
||||
}
|
||||
return components(separatedBy: separator).dropFirst().joined(separator: separator)
|
||||
}
|
||||
|
||||
func between(_ start: String, and end: String) -> String {
|
||||
components(separatedBy: start).last!
|
||||
.components(separatedBy: end).first!
|
||||
}
|
||||
|
||||
func between(first: String, andLast last: String) -> String {
|
||||
dropBeforeFirst(first).dropAfterLast(last)
|
||||
}
|
||||
|
||||
func last(after: String) -> String {
|
||||
components(separatedBy: after).last!
|
||||
}
|
||||
}
|
||||
|
||||
extension String {
|
||||
|
@ -3,6 +3,7 @@ import Foundation
|
||||
enum VideoType: String, CaseIterable {
|
||||
case mp4
|
||||
case m4v
|
||||
case webm
|
||||
|
||||
var htmlType: String {
|
||||
switch self {
|
||||
@ -10,6 +11,8 @@ enum VideoType: String, CaseIterable {
|
||||
return "video/mp4"
|
||||
case .m4v:
|
||||
return "video/mp4"
|
||||
case .webm:
|
||||
return "video/webm"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -99,8 +99,11 @@ struct HTMLElementsGenerator {
|
||||
"""
|
||||
}
|
||||
|
||||
func scriptInclude(path: String) -> String {
|
||||
"<script src=\"\(path)\"></script>"
|
||||
func scriptInclude(path: String, asModule: Bool) -> String {
|
||||
if asModule {
|
||||
return "<script type=\"module\" src=\"\(path)\"></script>"
|
||||
}
|
||||
return "<script src=\"\(path)\"></script>"
|
||||
}
|
||||
|
||||
func codeHighlightFooter() -> String {
|
||||
|
@ -4,12 +4,8 @@ import Splash
|
||||
|
||||
struct PageContentGenerator {
|
||||
|
||||
private let largeImageIndicator = "*large*"
|
||||
|
||||
private let factory: TemplateFactory
|
||||
|
||||
private let swift = SyntaxHighlighter(format: HTMLOutputFormat())
|
||||
|
||||
private let siteRoot: Element
|
||||
|
||||
private let results: GenerationResultsHandler
|
||||
@ -20,43 +16,89 @@ struct PageContentGenerator {
|
||||
self.results = results
|
||||
}
|
||||
|
||||
func generate(page: Element, language: String, content: String) -> (content: String, includesCode: Bool) {
|
||||
var hasCodeContent = false
|
||||
var largeImageCount = 0
|
||||
func generate(page: Element, language: String, content: String) -> (content: String, headers: RequiredHeaders) {
|
||||
let parser = PageContentParser(
|
||||
factory: factory,
|
||||
siteRoot: siteRoot,
|
||||
results: results,
|
||||
page: page,
|
||||
language: language)
|
||||
return parser.generatePage(from: content)
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
final class PageContentParser {
|
||||
|
||||
private let pageLinkMarker = "page:"
|
||||
|
||||
private let largeImageIndicator = "*large*"
|
||||
|
||||
private let factory: TemplateFactory
|
||||
|
||||
private let swift = SyntaxHighlighter(format: HTMLOutputFormat())
|
||||
|
||||
private let siteRoot: Element
|
||||
|
||||
private let results: GenerationResultsHandler
|
||||
|
||||
private let page: Element
|
||||
|
||||
private let language: String
|
||||
|
||||
private var headers = RequiredHeaders()
|
||||
|
||||
private var largeImageCount: Int = 0
|
||||
|
||||
init(factory: TemplateFactory, siteRoot: Element, results: GenerationResultsHandler, page: Element, language: String) {
|
||||
self.factory = factory
|
||||
self.siteRoot = siteRoot
|
||||
self.results = results
|
||||
self.page = page
|
||||
self.language = language
|
||||
}
|
||||
|
||||
func generatePage(from content: String) -> (content: String, headers: RequiredHeaders) {
|
||||
headers = .init()
|
||||
|
||||
let imageModifier = Modifier(target: .images) { html, markdown in
|
||||
processMarkdownImage(markdown: markdown, html: html, page: page, language: language, largeImageCount: &largeImageCount)
|
||||
self.processMarkdownImage(markdown: markdown, html: html)
|
||||
}
|
||||
let codeModifier = Modifier(target: .codeBlocks) { html, markdown in
|
||||
if markdown.starts(with: "```swift") {
|
||||
let code = markdown.between("```swift", and: "```").trimmed
|
||||
return "<pre><code>" + swift.highlight(code) + "</pre></code>"
|
||||
return "<pre><code>" + self.swift.highlight(code) + "</pre></code>"
|
||||
}
|
||||
hasCodeContent = true
|
||||
self.headers.insert(.codeHightlighting)
|
||||
return html
|
||||
}
|
||||
let linkModifier = Modifier(target: .links) { html, markdown in
|
||||
handleLink(page: page, language: language, html: html, markdown: markdown)
|
||||
self.handleLink(html: html, markdown: markdown)
|
||||
}
|
||||
let htmlModifier = Modifier(target: .html) { html, markdown in
|
||||
handleHTML(page: page, language: language, html: html, markdown: markdown)
|
||||
self.handleHTML(html: html, markdown: markdown)
|
||||
}
|
||||
let headlinesModifier = Modifier(target: .headings) { html, markdown in
|
||||
self.handleHeadlines(html: html, markdown: markdown)
|
||||
}
|
||||
|
||||
let parser = MarkdownParser(modifiers: [imageModifier, codeModifier, linkModifier, htmlModifier])
|
||||
return (parser.html(from: content), hasCodeContent)
|
||||
let parser = MarkdownParser(modifiers: [imageModifier, codeModifier, linkModifier, htmlModifier, headlinesModifier])
|
||||
return (parser.html(from: content), headers)
|
||||
|
||||
}
|
||||
|
||||
private func handleLink(page: Element, language: String, html: String, markdown: Substring) -> String {
|
||||
private func handleLink(html: String, markdown: Substring) -> String {
|
||||
let file = markdown.between("(", and: ")")
|
||||
if file.hasPrefix("page:") {
|
||||
let pageId = file.replacingOccurrences(of: "page:", with: "")
|
||||
if file.hasPrefix(pageLinkMarker) {
|
||||
let textToChange = file.dropAfterFirst("#")
|
||||
let pageId = textToChange.replacingOccurrences(of: pageLinkMarker, with: "")
|
||||
guard let pagePath = results.getPagePath(for: pageId, source: page.path, language: language) else {
|
||||
// Remove link since the page can't be found
|
||||
return markdown.between("[", and: "]")
|
||||
}
|
||||
// Adjust file path to get the page url
|
||||
let url = page.relativePathToOtherSiteElement(file: pagePath)
|
||||
return html.replacingOccurrences(of: file, with: url)
|
||||
return html.replacingOccurrences(of: textToChange, with: url)
|
||||
}
|
||||
|
||||
if let filePath = page.nonAbsolutePathRelativeToRootForContainedInputFile(file) {
|
||||
@ -66,7 +108,7 @@ struct PageContentGenerator {
|
||||
return html
|
||||
}
|
||||
|
||||
private func handleHTML(page: Element, language: String, html: String, markdown: Substring) -> String {
|
||||
private func handleHTML(html: String, markdown: Substring) -> String {
|
||||
// TODO: Check HTML code in markdown for required resources
|
||||
//print("[HTML] Found in page \(page.path):")
|
||||
//print(markdown)
|
||||
@ -77,20 +119,37 @@ struct PageContentGenerator {
|
||||
return html
|
||||
}
|
||||
|
||||
private func processMarkdownImage(markdown: Substring, html: String, page: Element, language: String, largeImageCount: inout Int) -> String {
|
||||
private func handleHeadlines(html: String, markdown: Substring) -> String {
|
||||
let id = markdown
|
||||
.last(after: "#")
|
||||
.trimmed
|
||||
.filter { $0.isNumber || $0.isLetter || $0 == " " }
|
||||
.lowercased()
|
||||
.components(separatedBy: " ")
|
||||
.filter { $0 != "" }
|
||||
.joined(separator: "-")
|
||||
let parts = html.components(separatedBy: ">")
|
||||
return parts[0] + " id=\"\(id)\">" + parts.dropFirst().joined(separator: ">")
|
||||
}
|
||||
|
||||
private func processMarkdownImage(markdown: Substring, html: String) -> String {
|
||||
// Split the markdown 
|
||||
// There are several known shorthand commands
|
||||
// For images: 
|
||||
// For videos: 
|
||||
// For svg with custom area: 
|
||||
// For downloads: 
|
||||
// For a simple boxes: 
|
||||
// For downloads: ; ...)
|
||||
// For a simple box: 
|
||||
// For 3D models: 
|
||||
// A fancy page link: 
|
||||
// External pages: 
|
||||
let fileAndTitle = markdown.between("(", and: ")")
|
||||
let alt = markdown.between("[", and: "]").nonEmpty
|
||||
guard let fileAndTitle = markdown.between(first: "](", andLast: ")").removingPercentEncoding else {
|
||||
results.warning("Invalid percent encoding for markdown image", source: page.path)
|
||||
return ""
|
||||
}
|
||||
let alt = markdown.between("[", and: "]").nonEmpty?.removingPercentEncoding
|
||||
if let alt = alt, let command = ShorthandMarkdownKey(rawValue: alt) {
|
||||
return handleShortHandCommand(command, page: page, language: language, content: fileAndTitle)
|
||||
return handleShortHandCommand(command, content: fileAndTitle)
|
||||
}
|
||||
|
||||
let file = fileAndTitle.dropAfterFirst(" ")
|
||||
@ -98,37 +157,39 @@ struct PageContentGenerator {
|
||||
|
||||
let fileExtension = file.lastComponentAfter(".").lowercased()
|
||||
if let _ = ImageType(fileExtension: fileExtension) {
|
||||
return handleImage(page: page, file: file, rightTitle: title, leftTitle: alt, largeImageCount: &largeImageCount)
|
||||
return handleImage(file: file, rightTitle: title, leftTitle: alt, largeImageCount: &largeImageCount)
|
||||
}
|
||||
if let _ = VideoType(rawValue: fileExtension) {
|
||||
return handleVideo(page: page, file: file, optionString: alt)
|
||||
return handleVideo(file: file, optionString: alt)
|
||||
}
|
||||
switch fileExtension {
|
||||
case "svg":
|
||||
return handleSvg(page: page, file: file, area: alt)
|
||||
return handleSvg(file: file, area: alt)
|
||||
case "gif":
|
||||
return handleGif(page: page, file: file, altText: alt ?? "gif image")
|
||||
return handleGif(file: file, altText: alt ?? "gif image")
|
||||
default:
|
||||
return handleFile(page: page, file: file, fileExtension: fileExtension)
|
||||
return handleFile(file: file, fileExtension: fileExtension)
|
||||
}
|
||||
}
|
||||
|
||||
private func handleShortHandCommand(_ command: ShorthandMarkdownKey, page: Element, language: String, content: String) -> String {
|
||||
private func handleShortHandCommand(_ command: ShorthandMarkdownKey, content: String) -> String {
|
||||
switch command {
|
||||
case .downloadButtons:
|
||||
return handleDownloadButtons(page: page, content: content)
|
||||
return handleDownloadButtons(content: content)
|
||||
case .externalLink:
|
||||
return handleExternalButtons(page: page, content: content)
|
||||
return handleExternalButtons(content: content)
|
||||
case .includedHtml:
|
||||
return handleExternalHTML(page: page, file: content)
|
||||
return handleExternalHTML(file: content)
|
||||
case .box:
|
||||
return handleSimpleBox(page: page, content: content)
|
||||
return handleSimpleBox(content: content)
|
||||
case .pageLink:
|
||||
return handlePageLink(page: page, language: language, pageId: content)
|
||||
return handlePageLink(pageId: content)
|
||||
case .model3d:
|
||||
return handle3dModel(content: content)
|
||||
}
|
||||
}
|
||||
|
||||
private func handleImage(page: Element, file: String, rightTitle: String?, leftTitle: String?, largeImageCount: inout Int) -> String {
|
||||
private func handleImage(file: String, rightTitle: String?, leftTitle: String?, largeImageCount: inout Int) -> String {
|
||||
let imagePath = page.pathRelativeToRootForContainedInputFile(file)
|
||||
let left: String
|
||||
let createFullScreenVersion: Bool
|
||||
@ -169,7 +230,7 @@ struct PageContentGenerator {
|
||||
return factory.largeImage.generate(content)
|
||||
}
|
||||
|
||||
private func handleVideo(page: Element, file: String, optionString: String?) -> String {
|
||||
private func handleVideo(file: String, optionString: String?) -> String {
|
||||
let options: [PageVideoTemplate.VideoOption] = optionString.unwrapped { string in
|
||||
string.components(separatedBy: " ").compactMap { optionText -> PageVideoTemplate.VideoOption? in
|
||||
guard let optionText = optionText.trimmed.nonEmpty else {
|
||||
@ -182,15 +243,45 @@ struct PageContentGenerator {
|
||||
return option
|
||||
}
|
||||
} ?? []
|
||||
// TODO: Check page folder for alternative video versions
|
||||
let sources: [PageVideoTemplate.VideoSource] = [(url: file, type: .mp4)]
|
||||
|
||||
let filePath = page.pathRelativeToRootForContainedInputFile(file)
|
||||
results.require(file: filePath, source: page.path)
|
||||
let prefix = file.lastComponentAfter("/").dropAfterLast(".")
|
||||
|
||||
// Find all video files starting with the name of the video as a prefix
|
||||
var sources: [PageVideoTemplate.VideoSource] = []
|
||||
do {
|
||||
let folder = results.contentFolder.appendingPathComponent(page.path)
|
||||
let filesInFolder = try FileManager.default.contentsOfDirectory(atPath: folder.path)
|
||||
sources += selectVideoFiles(with: prefix, from: filesInFolder)
|
||||
} catch {
|
||||
results.warning("Failed to check for additional videos", source: page.path)
|
||||
}
|
||||
// Also look in external files
|
||||
sources += selectVideoFiles(with: prefix, from: page.externalFiles)
|
||||
.map { (page.relativePathToFileWithPath($0.url), $0.type) }
|
||||
|
||||
// Require all video files
|
||||
sources.forEach {
|
||||
let path = page.pathRelativeToRootForContainedInputFile($0.url)
|
||||
results.require(file: path, source: page.path)
|
||||
}
|
||||
// Sort, so that order of selection in browser is defined
|
||||
sources.sort { $0.url < $1.url }
|
||||
return factory.video.generate(sources: sources, options: options)
|
||||
}
|
||||
|
||||
private func handleGif(page: Element, file: String, altText: String) -> String {
|
||||
private func selectVideoFiles<T>(with prefix: String, from all: T) -> [PageVideoTemplate.VideoSource] where T: Sequence, T.Element == String {
|
||||
all.compactMap {
|
||||
guard $0.lastComponentAfter("/").hasPrefix(prefix) else {
|
||||
return nil
|
||||
}
|
||||
guard let type = VideoType(rawValue: $0.lastComponentAfter(".").lowercased()) else {
|
||||
return nil
|
||||
}
|
||||
return (url: $0, type: type)
|
||||
}
|
||||
}
|
||||
|
||||
private func handleGif(file: String, altText: String) -> String {
|
||||
let imagePath = page.pathRelativeToRootForContainedInputFile(file)
|
||||
results.require(file: imagePath, source: page.path)
|
||||
|
||||
@ -202,7 +293,7 @@ struct PageContentGenerator {
|
||||
return factory.html.image(file: file, width: width, height: height, altText: altText)
|
||||
}
|
||||
|
||||
private func handleSvg(page: Element, file: String, area: String?) -> String {
|
||||
private func handleSvg(file: String, area: String?) -> String {
|
||||
let imagePath = page.pathRelativeToRootForContainedInputFile(file)
|
||||
results.require(file: imagePath, source: page.path)
|
||||
|
||||
@ -239,18 +330,18 @@ struct PageContentGenerator {
|
||||
return factory.html.svgImage(file: file, part: part, altText: altText)
|
||||
}
|
||||
|
||||
private func handleFile(page: Element, file: String, fileExtension: String) -> String {
|
||||
private func handleFile(file: String, fileExtension: String) -> String {
|
||||
results.warning("Unhandled file \(file) with extension \(fileExtension)", source: page.path)
|
||||
return ""
|
||||
}
|
||||
|
||||
private func handleDownloadButtons(page: Element, content: String) -> String {
|
||||
private func handleDownloadButtons(content: String) -> String {
|
||||
let buttons = content
|
||||
.components(separatedBy: ";")
|
||||
.compactMap { button -> (file: String, text: String, downloadName: String?)? in
|
||||
let parts = button.components(separatedBy: ",")
|
||||
guard parts.count == 2 || parts.count == 3 else {
|
||||
results.warning("Invalid button definition", source: page.path)
|
||||
results.warning("Invalid download definition with \(parts)", source: page.path)
|
||||
return nil
|
||||
}
|
||||
let file = parts[0].trimmed
|
||||
@ -266,7 +357,7 @@ struct PageContentGenerator {
|
||||
return factory.html.downloadButtons(buttons)
|
||||
}
|
||||
|
||||
private func handleExternalButtons(page: Element, content: String) -> String {
|
||||
private func handleExternalButtons(content: String) -> String {
|
||||
let buttons = content
|
||||
.components(separatedBy: ";")
|
||||
.compactMap { button -> (url: String, text: String)? in
|
||||
@ -275,7 +366,10 @@ struct PageContentGenerator {
|
||||
results.warning("Invalid external link definition", source: page.path)
|
||||
return nil
|
||||
}
|
||||
let url = parts[0].trimmed
|
||||
guard let url = parts[0].trimmed.addingPercentEncoding(withAllowedCharacters: .urlQueryAllowed) else {
|
||||
results.warning("Invalid external link \(parts[0].trimmed)", source: page.path)
|
||||
return nil
|
||||
}
|
||||
let title = parts[1].trimmed
|
||||
|
||||
return (url, title)
|
||||
@ -283,12 +377,12 @@ struct PageContentGenerator {
|
||||
return factory.html.externalButtons(buttons)
|
||||
}
|
||||
|
||||
private func handleExternalHTML(page: Element, file: String) -> String {
|
||||
private func handleExternalHTML(file: String) -> String {
|
||||
let path = page.pathRelativeToRootForContainedInputFile(file)
|
||||
return results.getContentOfRequiredFile(at: path, source: page.path) ?? ""
|
||||
}
|
||||
|
||||
private func handleSimpleBox(page: Element, content: String) -> String {
|
||||
private func handleSimpleBox(content: String) -> String {
|
||||
let parts = content.components(separatedBy: ";")
|
||||
guard parts.count > 1 else {
|
||||
results.warning("Invalid box specification", source: page.path)
|
||||
@ -299,13 +393,17 @@ struct PageContentGenerator {
|
||||
return factory.makePlaceholder(title: title, text: text)
|
||||
}
|
||||
|
||||
private func handlePageLink(page: Element, language: String, pageId: String) -> String {
|
||||
private func handlePageLink(pageId: String) -> String {
|
||||
guard let linkedPage = siteRoot.find(pageId) else {
|
||||
// Checking the page path will add it to the missing pages
|
||||
_ = results.getPagePath(for: pageId, source: page.path, language: language)
|
||||
// Remove link since the page can't be found
|
||||
return ""
|
||||
}
|
||||
guard linkedPage.state == .standard else {
|
||||
// Prevent linking to unpublished content
|
||||
return ""
|
||||
}
|
||||
var content = [PageLinkTemplate.Key: String]()
|
||||
|
||||
content[.title] = linkedPage.title(for: language)
|
||||
@ -340,4 +438,29 @@ struct PageContentGenerator {
|
||||
// We assume that the thumbnail images are already required by overview pages.
|
||||
return factory.pageLink.generate(content)
|
||||
}
|
||||
|
||||
private func handle3dModel(content: String) -> String {
|
||||
let parts = content.components(separatedBy: ";")
|
||||
guard parts.count > 1 else {
|
||||
results.warning("Invalid 3d model specification", source: page.path)
|
||||
return ""
|
||||
}
|
||||
let file = parts[0]
|
||||
guard file.hasSuffix(".glb") else {
|
||||
results.warning("Invalid 3d model file \(file) (must be .glb)", source: page.path)
|
||||
return ""
|
||||
}
|
||||
|
||||
// Ensure that file is available
|
||||
let filePath = page.pathRelativeToRootForContainedInputFile(file)
|
||||
results.require(file: filePath, source: page.path)
|
||||
|
||||
// Add required file to head
|
||||
headers.insert(.modelViewer)
|
||||
|
||||
let description = parts.dropFirst().joined(separator: ";")
|
||||
return """
|
||||
<model-viewer alt="\(description)" src="\(file)" ar shadow-intensity="1" camera-controls touch-action="pan-y"></model-viewer>
|
||||
"""
|
||||
}
|
||||
}
|
||||
|
@ -24,12 +24,12 @@ struct PageGenerator {
|
||||
let inputContentPath = page.path + "/\(language).md"
|
||||
let metadata = page.localized(for: language)
|
||||
let nextLanguage = page.nextLanguage(for: language)
|
||||
let (pageContent, pageIncludesCode) = makeContent(
|
||||
let (pageContent, additionalHeaders) = makeContent(
|
||||
page: page, metadata: metadata, language: language, path: inputContentPath)
|
||||
|
||||
var content = [PageTemplate.Key : String]()
|
||||
content[.language] = language
|
||||
content[.head] = factory.pageHead.generate(page: page, language: language, includesCode: pageIncludesCode)
|
||||
content[.head] = factory.pageHead.generate(page: page, language: language, headers: additionalHeaders)
|
||||
let sectionUrl = page.sectionUrl(for: language)
|
||||
content[.topBar] = factory.topBar.generate(sectionUrl: sectionUrl, languageButton: nextLanguage, page: page)
|
||||
content[.contentClass] = "content"
|
||||
@ -42,7 +42,7 @@ struct PageGenerator {
|
||||
content[.nextPageUrl] = navLink(from: page, to: nextPage, language: language)
|
||||
content[.footer] = results.getContentOfOptionalFile(at: page.additionalFooterContentPath, source: page.path)
|
||||
|
||||
if pageIncludesCode {
|
||||
if additionalHeaders.contains(.codeHightlighting) {
|
||||
let highlightCode = factory.factory.html.codeHighlightFooter()
|
||||
content[.footer] = (content[.footer].unwrapped { $0 + "\n" } ?? "") + highlightCode
|
||||
}
|
||||
@ -74,7 +74,7 @@ struct PageGenerator {
|
||||
return factory.factory.html.makeNextText(text)
|
||||
}
|
||||
|
||||
private func makeContent(page: Element, metadata: Element.LocalizedMetadata, language: String, path: String) -> (content: String, includesCode: Bool) {
|
||||
private func makeContent(page: Element, metadata: Element.LocalizedMetadata, language: String, path: String) -> (content: String, headers: RequiredHeaders) {
|
||||
if let raw = results.getContentOfMdFile(at: path, source: page.path)?.trimmed.nonEmpty {
|
||||
let (content, includesCode) = contentGenerator.generate(page: page, language: language, content: raw)
|
||||
return (content, includesCode)
|
||||
|
@ -14,7 +14,7 @@ struct PageHeadGenerator {
|
||||
self.results = results
|
||||
}
|
||||
|
||||
func generate(page: Element, language: String, includesCode: Bool = false) -> String {
|
||||
func generate(page: Element, language: String, headers: RequiredHeaders = .init()) -> String {
|
||||
let metadata = page.localized(for: language)
|
||||
|
||||
var content = [PageHeadTemplate.Key : String]()
|
||||
@ -36,17 +36,16 @@ struct PageHeadGenerator {
|
||||
content[.image] = factory.html.linkPreviewImage(file: linkPreviewImageName)
|
||||
}
|
||||
content[.customPageContent] = results.getContentOfOptionalFile(at: page.additionalHeadContentPath, source: page.path)
|
||||
if includesCode {
|
||||
let scriptPath = "assets/js/highlight.js"
|
||||
let relative = page.relativePathToOtherSiteElement(file: scriptPath)
|
||||
let includeText = factory.html.scriptInclude(path: relative)
|
||||
if let head = content[.customPageContent] {
|
||||
content[.customPageContent] = head + "\n" + includeText
|
||||
} else {
|
||||
content[.customPageContent] = includeText
|
||||
}
|
||||
}
|
||||
|
||||
let head = (content[.customPageContent].unwrapped { [$0] } ?? []) + headers
|
||||
.sorted { $0.rawValue < $1.rawValue }
|
||||
.map { option in
|
||||
let scriptPath = "assets/js/\(option.rawValue)"
|
||||
let relative = page.relativePathToOtherSiteElement(file: scriptPath)
|
||||
return factory.html.scriptInclude(path: relative, asModule: option.asModule)
|
||||
}
|
||||
|
||||
content[.customPageContent] = head.joined(separator: "\n")
|
||||
return factory.pageHead.generate(content)
|
||||
}
|
||||
}
|
||||
|
@ -26,4 +26,9 @@ enum ShorthandMarkdownKey: String {
|
||||
A pretty link to another page on the site.
|
||||
*/
|
||||
case pageLink = "page"
|
||||
|
||||
/**
|
||||
A 3D model to display
|
||||
*/
|
||||
case model3d = "3d"
|
||||
}
|
||||
|
@ -38,7 +38,7 @@ struct SiteGenerator {
|
||||
elementsToProcess.append(contentsOf: element.linkedElements)
|
||||
|
||||
processAllFiles(for: element)
|
||||
if !element.elements.isEmpty {
|
||||
if element.hasVisibleChildren {
|
||||
overviewGenerator.generate(section: element, language: language)
|
||||
} else {
|
||||
pageGenerator.generate(
|
||||
|
@ -416,8 +416,7 @@ final class GenerationResultsHandler {
|
||||
guard existingJob.width != job.width else {
|
||||
return
|
||||
}
|
||||
warning("Different width \(existingJob.width) as \(job.path) (width \(job.width))",
|
||||
destination: job.destination, path: existingJob.path)
|
||||
warning("Existing job with width \(existingJob.width) (from \(existingJob.path)), but width \(job.width)", destination: job.destination, path: existingJob.path)
|
||||
}
|
||||
|
||||
// MARK: Visual output
|
||||
|
15
Sources/Generator/Processing/RequiredHeaders.swift
Normal file
15
Sources/Generator/Processing/RequiredHeaders.swift
Normal file
@ -0,0 +1,15 @@
|
||||
import Foundation
|
||||
|
||||
enum HeaderFile: String {
|
||||
case codeHightlighting = "highlight.js"
|
||||
case modelViewer = "model-viewer.js"
|
||||
|
||||
var asModule: Bool {
|
||||
switch self {
|
||||
case .codeHightlighting: return false
|
||||
case .modelViewer: return true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
typealias RequiredHeaders = Set<HeaderFile>
|
@ -51,7 +51,7 @@ struct LocalizedSiteTemplate {
|
||||
self.month = df2
|
||||
|
||||
let df3 = DateFormatter()
|
||||
df3.dateFormat = "dd"
|
||||
df3.dateFormat = "d"
|
||||
df3.locale = Locale(identifier: language)
|
||||
self.day = df3
|
||||
|
||||
|
@ -53,7 +53,10 @@ private func loadSiteData(in folder: URL, runFolder: URL) throws -> (root: Eleme
|
||||
print(" Error: No site root loaded, aborting generation")
|
||||
return nil
|
||||
}
|
||||
let pageMap = root.languages.map { (language: $0.language, pages: root.getExternalPageMap(language: $0.language)) }
|
||||
let pageMap = root.languages.map { language in
|
||||
(language: language.language,
|
||||
pages: root.getExternalPageMap(language: language.language, log: log))
|
||||
}
|
||||
log.printMetadataScanOverview(languages: root.languages.count)
|
||||
return (root, pageMap)
|
||||
}
|
||||
|
Reference in New Issue
Block a user