Component: SimpleWebPage

SimpleWebPage

Creates a simple web page, for publishing a list of files.

The input folder may contain folders, and files. A simple index.html will be generated, with a link for each file/folder. Output contains a copy of the input files.

Version	1.3
Bundle	tools
Categories	HTML
Authors	Ville Rantanen (ville.rantanen@helsinki.fi)
Issue tracker	View/Report issues
Requires	Python
Source files	component.xml style.css template.html SWP.py
Usage	Example with default values SimpleWebPage( //in = BinaryFolder, //inArray = BinaryFile, //content = TextFile, //style = TextFile, //annotation = CSV, //tableArray = BinaryFolder, contentString = "", contentStyle = "", footer = "Generated with Anduril.", index = "", size = 256, tableArrayExpand = "", thumbnails = false, title = "" )

Version

1.3

Bundle

tools

Categories

HTML

Authors

Ville Rantanen (ville.rantanen@helsinki.fi)

Issue tracker

View/Report issues

Requires

Python

Source files

component.xml style.css template.html SWP.py

Usage

Example with default values

Inputs

Name	Type	Mandatory	Description
in	BinaryFolder	Optional	Folder of files / folders to publish.
inArray	Array<BinaryFile>	Optional	Array of files to publish.
content	TextFile	Optional	Snippet of HTML code or plain text
style	TextFile	Optional	Snippet of CSS code replacing the default stylesheet.
annotation	CSV	Optional	A CSV with 2 columns, first that matches to file/folder name, and second describing the item.
tableArray	Array<BinaryFolder>	Optional	Array of Folders with files or HTML snippets to present at table. Array keys are the table header names. See tableArrayExpand parameter. The table element has ID tableArray. The folders have to have the same number of files, and they are sorted with "human" sorting.

Name

Type

Mandatory

Description

BinaryFolder

Optional

Folder of files / folders to publish.

inArray

Array<BinaryFile>

Optional

Array of files to publish.

content

TextFile

Optional

Snippet of HTML code or plain text

style

TextFile

Optional

Snippet of CSS code replacing the default stylesheet.

annotation

CSV

Optional

A CSV with 2 columns, first that matches to file/folder name, and second describing the item.

tableArray

Array<BinaryFolder>

Optional

Array of Folders with files or HTML snippets to present at table. Array keys are the table header names. See tableArrayExpand parameter. The table element has ID tableArray. The folders have to have the same number of files, and they are sorted with "human" sorting.

Name	Type	Description
out	HTML	A Folder with index.html and input files with links to them.

Name

Type

Description

out

HTML

A Folder with index.html and input files with links to them.

Parameters

Name	Type	Default	Description
contentString	string	""	Snippet of HTML code or plain text.
contentStyle	string	""	Snippet of CSS code appending the input style.
footer	string	"Generated with Anduril."	Snippet of HTML code or plain text for footer row.
index	string	""	Default index file in folders. e.g. index.html
size	int	256	Pixel size for thumbnails.
tableArrayExpand	string	""	Comma separated list of column header names to be read and inserted on the page. If a name is not mentioned, the file is linked (default behavior).
thumbnails	boolean	false	Create thumbnails for common graphics files.
title	string	""	Title for the page.

Name

Type

Default

Description

contentString

string

Snippet of HTML code or plain text.

contentStyle

string

Snippet of CSS code appending the input style.

footer

string

"Generated with Anduril."

Snippet of HTML code or plain text for footer row.

index

string

Default index file in folders. e.g. index.html

size

int

256

Pixel size for thumbnails.

tableArrayExpand

string

Comma separated list of column header names to be read and inserted on the page. If a name is not mentioned, the file is linked (default behavior).

thumbnails

boolean

false

Create thumbnails for common graphics files.

title

string

Title for the page.

Test cases

Test case	Parameters▼	IN in	IN inArray	IN content	IN style	IN annotation	IN tableArray	OUT out
case1	properties	in	(missing)	(missing)	style	(missing)	(missing)	out
	title=Test page, contentString=Example listing of files
case2_annotation	properties	in	(missing)	(missing)	style	annotation	(missing)	out
	title=Test page, contentString=Example listing of files, index=index.html
case3_images	properties	in	(missing)	(missing)	style	annotation	(missing)	out
	title=Test page, contentString=Example listing of files, index=index.html, thumbnails=true

Test case

Parameters▼

IN
in

IN
inArray

IN
content

IN
style

IN
annotation

IN
tableArray

OUT
out

case1

properties

(missing)

style

(missing)

out

title=Test page,
contentString=Example listing of files

case2_annotation

(missing)

(missing)

title=Test page,
contentString=Example listing of files,
index=index.html

case3_images

(missing)

(missing)

title=Test page,
contentString=Example listing of files,
index=index.html,
thumbnails=true

Test network

Display TestNetwork

import anduril.tools._ import anduril.builtin._ import org.anduril.runtime._ object SimpleWebPageNetwork { val CSVs=Record[CSV]("CSVs") val SNIPPETs=Record[BinaryFile]("SNIPPETs") val HTMLs=Record[HTMLFile]("HTMLs") val PLOTs=Record[Latex]("PLOTs") val ANNOTs=Record[TextFile]("ANNOTs") for (i <- 1 to 10) { // Generate CSV data CSVs("csv"+i)=Randomizer(columns=2, rows=5).out // Plot it PLOTs("plot"+i)=Plot2D(x=CSVs("csv"+i),y=CSVs("csv"+i), xColumns="Column1", yColumns="Column2", plotType="l").out // CSV to HTML snippet SNIPPETs("csv"+i)=Pandoc(in=makeArray(CSVs("csv"+i)), CSVFormat="%0.3f", from="CSV", to="html", basename="csv"+i ).out("csv"+i) // CSV to full HTML page HTMLs("csv"+i)=HTMLTable(in=CSVs("csv"+i), title="Table"+i).out ANNOTs(i)=StringInput("<h3>This is file "+i+" annotation</h3> <a href=\"http://www.anduril.org\">Created with Anduril</a>").out } // Combine report files as folders val SNIPPETFiles=Array2Folder(rec2Array(SNIPPETs), fileMode="@key@.htmlsnippet") val HTMLFiles=Array2Folder(rec2Array(HTMLs), fileMode="@key@.html") val PLOTFiles=FolderCombiner(in=rec2Array(PLOTs), exclude=".*tex") val ANNOTFiles=Array2Folder(rec2Array(ANNOTs), fileMode="@key@.txt") // Combine plots, HTML tables, and snippets on one web page val WebPage=SimpleWebPage(tableArray=makeArray("Plot"->PLOTFiles, "Table"->HTMLFiles, "Content"->SNIPPETFiles, "Annotations"->ANNOTFiles), tableArrayExpand="Content,Annotations", thumbnails=true) }

Anduril

SimpleWebPage

Inputs

Outputs

Parameters

Test cases

Test network