diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 43fa307..c92ca21 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-02T05:11:26","documenter_version":"1.7.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-02T05:38:26","documenter_version":"1.7.0"}} \ No newline at end of file diff --git a/dev/bibliography/index.html b/dev/bibliography/index.html index c87afd2..53f189d 100644 --- a/dev/bibliography/index.html +++ b/dev/bibliography/index.html @@ -13,4 +13,4 @@ )

Select a part of a bibliography based on a given selection set of keys. If complementary is true, selection designates which entries will not be kept. By default, complementary is set to false.

source
Bibliography.sort_bibliography! — Function
sort_bibliography!(
     bibliography::DataStructures.OrderedDict{String,Entry},
     sorting_rule::Symbol = :key
-    )

Sorts the bibliography in place.

The sorting order can be set by specifying the sorting_rule. The sorting is implemented via isless() functions. For detailed insight have a look at the isless() implementation of Julia and BibInternal.jl.

Supported symbols for sorting_rule are:

  • :key (default): sort by bibliography keys e.g. BibTeX keys or :id
  • the sorting rules defined in sorting_rules
Note:

The sorting is not following explicitly bibliographic alphabetizing conventions. It follows standard comparator behaviour implied by the implemented isless() functions (string comparators).

source
Bibliography.xcite — Method
xcite(entry)

Format the BibTeX cite output of an Entry for web export.

source
Bibliography.xfile — Method
xfile(entry)

Format the downloadable path of an Entry file for web export.

source
Bibliography.xin — Method
xin(entry)

Format the appears-in field of an Entry for web export.

source
Bibliography.xlabels — Method
xlabels(entry)

Format the labels of an Entry for web export.

source
Bibliography.xlink — Method
xlink(entry)

Format the download link of an Entry for web export.

source
Bibliography.xnames — Function
xnames(entry, editors = false; names = :full)

Format the name of an Entry for web export.

Arguments:

  • entry: an entry
  • editors: true if the name describes editors
  • names: :full (full names) or :last (last names + first name abbreviation)
source
Bibliography.xtitle — Method
xtitle(entry

Format the title of an Entry for web export.

source
Bibliography.xyear — Method
xyear(entry)

Format the year of an Entry for web export.

source
+ )

Sorts the bibliography in place.

The sorting order can be set by specifying the sorting_rule. The sorting is implemented via isless() functions. For detailed insight have a look at the isless() implementation of Julia and BibInternal.jl.

Supported symbols for sorting_rule are:

Note:

The sorting is not following explicitly bibliographic alphabetizing conventions. It follows standard comparator behaviour implied by the implemented isless() functions (string comparators).

source
Bibliography.xcite — Method
xcite(entry)

Format the BibTeX cite output of an Entry for web export.

source
Bibliography.xfile — Method
xfile(entry)

Format the downloadable path of an Entry file for web export.

source
Bibliography.xin — Method
xin(entry)

Format the appears-in field of an Entry for web export.

source
Bibliography.xlabels — Method
xlabels(entry)

Format the labels of an Entry for web export.

source
Bibliography.xlink — Method
xlink(entry)

Format the download link of an Entry for web export.

source
Bibliography.xnames — Function
xnames(entry, editors = false; names = :full)

Format the name of an Entry for web export.

Arguments:

  • entry: an entry
  • editors: true if the name describes editors
  • names: :full (full names) or :last (last names + first name abbreviation)
source
Bibliography.xtitle — Method
xtitle(entry

Format the title of an Entry for web export.

source
Bibliography.xyear — Method
xyear(entry)

Format the year of an Entry for web export.

source
diff --git a/dev/index.html b/dev/index.html index 6a034d5..1238c0b 100644 --- a/dev/index.html +++ b/dev/index.html @@ -65,4 +65,4 @@ items=Publications("publications.bib") ) ] -)

License

This software is under the GPLv2 license.

The main theme, and some items (BibTeX, Card, TimeLine) are inspired by the Word Press Faculty template of owwwlab, also under GPLv2. All elements inspired from that template can be found in the HTML/CSS code associated with those items.

+)

License

This software is under the GPLv2 license.

The main theme, and some items (BibTeX, Card, TimeLine) are inspired by the Word Press Faculty template of owwwlab, also under GPLv2. All elements inspired from that template can be found in the HTML/CSS code associated with those items.

diff --git a/dev/internal/index.html b/dev/internal/index.html index 717d58e..1187ce8 100644 --- a/dev/internal/index.html +++ b/dev/internal/index.html @@ -1,5 +1,5 @@ -Internals · StaticWebPages.jl

Internals

StaticWebPages.color_to_card — Constant
color_to_card

A dictionary to translate the enumeration in CardColor to actual HTML/CSS attributes. A card can be composed of either one or two colors.

source
StaticWebPages.color_to_label — Constant
color_to_label

A dictionary to translate the enumeration in ColorLabel to actual HTML/CSS labels. An optional black-text color for text is given (it defaults to white-text).

source
StaticWebPages.user_to_name — Constant
user_to_name

A dictionary to translate user id (such as GitHub id) to real name. Normal use is that if an entry is found, then the id will be replaced by the appropriate name. Otherwise, the id is kept in use.

When a list of id is too long, priority is given to the id with an associated name.

source
StaticWebPages.BackgroundColor — Type
FieldSort

An enumeration of the different background colors available. It will need to be adjusted for Theme and SubTheme.

  • bg_none
  • bg_white
  • bg_grey
source
StaticWebPages.ColorLabel — Type
ColorLabel

An enumeration of the different colors available for labels.

  • red
  • green
  • yellow
  • blue
  • orange
  • purple
  • cyan
  • magenta
  • lime
  • pink
  • teal
  • lavender
  • brown
  • beige
  • maroon
  • mint
  • olive
  • apricot
  • navy
  • grey
  • white
  • black

Currently, label colors cycle once the limit has been reached. Creation of cycles with different varieties of colors is welcomed.

source
StaticWebPages.Deck — Method
Deck(color::CardColor, args...)
-Deck(args...; color::CardColor=card_blue)

Construct a Deck with the cards in args. The Deck color can be set to: card_blue, card_green, card_red, card_orange, card_julia_blue, card_julia_green, card_julia_purple, card_julia_red.

source
StaticWebPages.Git — Method
Git(gh_rl::RepoLabels, git_filter)

Create a Git element with the elements found at gh_rl and filtered with git_filter.

source
StaticWebPages.Link — Type
Link

Structure to handle html links within an <: AbstractItem. Behaviour is similar to the <a> html markup.

source
StaticWebPages.Publications — Method
Publications(source::String; parser::Parser=bibtex, sort::FieldSort=required)

Import a bibliography from source using parser. Some sorting options can be given through sort. Please check the Bibliography.jl package.

source
StaticWebPages.Section — Method
Section(; keyargs...)

Create a new single column section.

  • bgcolor::BackgroundColor = bg_none: set the section background to bg_none (default background), bg_white, or bg_grey.
  • hide::Bool = false: if set to true, the section will not be built.
  • items::SectionItems=Nest(): the list of items in the section. Default to an empty Nested item.
  • title::String="".
  • title_size=0 : If set to 0, the size will be inherited.

)

source
StaticWebPages.GitBuilder — Method

GitBuilder(r, contributors)

Generate the Git struct according to the repository r. If r does not have all its fields specified (i.e. Nothing), then a default value is used instead.

Return g::Git

source
StaticWebPages.email — Method
email(address::String; content::String="contact", obfuscated::Bool=true)
-email(e::Email)

Construct an email link. Can be obfuscated (default) to avoid bots spams.

source
StaticWebPages.head — Method
head(info::Dict{String,String}, page::String)

Generate the head section for a page given the global info.

source
StaticWebPages.link — Method
link(content::String, href::String)
-link(l::Link)

Construct an html link within an <: AbstractItem. Behaviour is similar to the <a> html markup.

source
StaticWebPages.nav — Method
nav(info::Dict{String,String}, content::OrderedDict{String,Any}, page::String, opt_in::Bool)

Generate the navigation menu for a page given its content, and the global info. Please set opt_in to true to promote StaticWebPages.

source
StaticWebPages.page — Method
page(; keyargs...)

Constructor for Page.

  • background::BackgroundColor=bg_grey: by default, the first section of a page has a grey background.
  • hide::Bool=false: an hidden page is not generated. However, it will appear in the navigation menu.
  • sections::Vector{<:AbstractSection}=Vector{<:AbstractSection}(): list of sections that composes this page.
  • title::String="": Page's title, can be left empty.
source
StaticWebPages.to_name — Method
to_name(user::String)

Transform a user name as a repository collaborator to name (user). The name is taken from the global user_to_name dictionary.

source
+Internals · StaticWebPages.jl

Internals

StaticWebPages.color_to_card — Constant
color_to_card

A dictionary to translate the enumeration in CardColor to actual HTML/CSS attributes. A card can be composed of either one or two colors.

source
StaticWebPages.color_to_label — Constant
color_to_label

A dictionary to translate the enumeration in ColorLabel to actual HTML/CSS labels. An optional black-text color for text is given (it defaults to white-text).

source
StaticWebPages.user_to_name — Constant
user_to_name

A dictionary to translate user id (such as GitHub id) to real name. Normal use is that if an entry is found, then the id will be replaced by the appropriate name. Otherwise, the id is kept in use.

When a list of id is too long, priority is given to the id with an associated name.

source
StaticWebPages.BackgroundColor — Type
FieldSort

An enumeration of the different background colors available. It will need to be adjusted for Theme and SubTheme.

  • bg_none
  • bg_white
  • bg_grey
source
StaticWebPages.ColorLabel — Type
ColorLabel

An enumeration of the different colors available for labels.

  • red
  • green
  • yellow
  • blue
  • orange
  • purple
  • cyan
  • magenta
  • lime
  • pink
  • teal
  • lavender
  • brown
  • beige
  • maroon
  • mint
  • olive
  • apricot
  • navy
  • grey
  • white
  • black

Currently, label colors cycle once the limit has been reached. Creation of cycles with different varieties of colors is welcomed.

source
StaticWebPages.Deck — Method
Deck(color::CardColor, args...)
+Deck(args...; color::CardColor=card_blue)

Construct a Deck with the cards in args. The Deck color can be set to: card_blue, card_green, card_red, card_orange, card_julia_blue, card_julia_green, card_julia_purple, card_julia_red.

source
StaticWebPages.Git — Method
Git(gh_rl::RepoLabels, git_filter)

Create a Git element with the elements found at gh_rl and filtered with git_filter.

source
StaticWebPages.Link — Type
Link

Structure to handle html links within an <: AbstractItem. Behaviour is similar to the <a> html markup.

source
StaticWebPages.Publications — Method
Publications(source::String; parser::Parser=bibtex, sort::FieldSort=required)

Import a bibliography from source using parser. Some sorting options can be given through sort. Please check the Bibliography.jl package.

source
StaticWebPages.Section — Method
Section(; keyargs...)

Create a new single column section.

  • bgcolor::BackgroundColor = bg_none: set the section background to bg_none (default background), bg_white, or bg_grey.
  • hide::Bool = false: if set to true, the section will not be built.
  • items::SectionItems=Nest(): the list of items in the section. Default to an empty Nested item.
  • title::String="".
  • title_size=0 : If set to 0, the size will be inherited.

)

source
StaticWebPages.GitBuilder — Method

GitBuilder(r, contributors)

Generate the Git struct according to the repository r. If r does not have all its fields specified (i.e. Nothing), then a default value is used instead.

Return g::Git

source
StaticWebPages.email — Method
email(address::String; content::String="contact", obfuscated::Bool=true)
+email(e::Email)

Construct an email link. Can be obfuscated (default) to avoid bots spams.

source
StaticWebPages.head — Method
head(info::Dict{String,String}, page::String)

Generate the head section for a page given the global info.

source
StaticWebPages.link — Method
link(content::String, href::String)
+link(l::Link)

Construct an html link within an <: AbstractItem. Behaviour is similar to the <a> html markup.

source
StaticWebPages.nav — Method
nav(info::Dict{String,String}, content::OrderedDict{String,Any}, page::String, opt_in::Bool)

Generate the navigation menu for a page given its content, and the global info. Please set opt_in to true to promote StaticWebPages.

source
StaticWebPages.page — Method
page(; keyargs...)

Constructor for Page.

  • background::BackgroundColor=bg_grey: by default, the first section of a page has a grey background.
  • hide::Bool=false: an hidden page is not generated. However, it will appear in the navigation menu.
  • sections::Vector{<:AbstractSection}=Vector{<:AbstractSection}(): list of sections that composes this page.
  • title::String="": Page's title, can be left empty.
source
StaticWebPages.to_name — Method
to_name(user::String)

Transform a user name as a repository collaborator to name (user). The name is taken from the global user_to_name dictionary.

source
diff --git a/dev/items/index.html b/dev/items/index.html index 0f5ebe8..7556597 100644 --- a/dev/items/index.html +++ b/dev/items/index.html @@ -93,4 +93,4 @@ content = "content that appears as the email link", # ignored if obfuscated obfuscated = false )
link("research project", "research.html") # inner link
-link("StaticWebPages.jl", "https://github.com/Humans-of-Julia/StaticWebPages.jl")
+link("StaticWebPages.jl", "https://github.com/Humans-of-Julia/StaticWebPages.jl") diff --git a/dev/pages/index.html b/dev/pages/index.html index fc67a6f..131b131 100644 --- a/dev/pages/index.html +++ b/dev/pages/index.html @@ -43,4 +43,4 @@ items=github, ) ] -) +) diff --git a/dev/public/index.html b/dev/public/index.html index 2329586..e5887a8 100644 --- a/dev/public/index.html +++ b/dev/public/index.html @@ -1,3 +1,3 @@ -Public · StaticWebPages.jl

Public

StaticWebPages.Block — Type
Block

An item to construct a sequence of paragraphs with a (possibly empty) sequence of images on the side. Instead of images, an iframe's url can be given.

source
StaticWebPages.CardColor — Type
CardColor

An enumeration of the different background colors available. It will need to be adjusted for Theme and SubTheme.

  • card_blue
  • card_green
  • card_red
  • card_orange
  • cardjuliablue
  • cardjuliagreen
  • cardjuliapurple
  • cardjuliared
source
StaticWebPages.GitRepo — Type
GitRepo

A structure to store the URLs of git repositories and an associated filter for possible bot filtering.

source
StaticWebPages.GitRepo — Method
GitRepo(args::RepoLabels...; filter=["github-actions[bot]"])

Stores the URLs of git repositories and an associated filter. By default filters "github-actions[bot]".

source
StaticWebPages.TimeLine — Method
TimeLine(color::TimeLineColor, args::Dot...)
-TimeLine(args::Dot...; color=tl_blue)

Construct a TimeLime with the dots in args. The TimeLine color can be set to: tl_blue, tl_green, tl_red, tl_orange, tl_julia_blue, tl_julia_green, tl_julia_purple, tl_julia_red, tl_julia.

source
StaticWebPages.TimeLineColor — Type
TimeLineColor

An enumeration of the different TimeLinecolors available. It will need to be adjusted forThemeandSubTheme`.

  • tl_blue
  • tl_green
  • tl_red
  • tl_orange
  • tljuliablue
  • tljuliagreen
  • tljuliapurple
  • tljuliared
  • tl_julia
source
StaticWebPages.export_site — Method
export_site(; d::Dict{String,String}=local_info, rm_dir::Bool=false, opt_in::Bool=false)

Export the generated website based on d (default to local_info). The content and site folders need to be valid. If rm_dir is true, the site folder will be deleted before the website is generated.

Users can choose to support StaticWebPages.jl by setting opt_in to true. This will add a small banner in the side navigation menu stating "This website was generated using StaticWebPages.jl" and links to the GitHub repository.

source
StaticWebPages.images — Method
images(args::Image...)

Construct an ordered sequence of images for a Block item. An Image should be given as a Pair of strings.

source
+Public · StaticWebPages.jl

Public

StaticWebPages.Block — Type
Block

An item to construct a sequence of paragraphs with a (possibly empty) sequence of images on the side. Instead of images, an iframe's url can be given.

source
StaticWebPages.CardColor — Type
CardColor

An enumeration of the different background colors available. It will need to be adjusted for Theme and SubTheme.

  • card_blue
  • card_green
  • card_red
  • card_orange
  • cardjuliablue
  • cardjuliagreen
  • cardjuliapurple
  • cardjuliared
source
StaticWebPages.GitRepo — Type
GitRepo

A structure to store the URLs of git repositories and an associated filter for possible bot filtering.

source
StaticWebPages.GitRepo — Method
GitRepo(args::RepoLabels...; filter=["github-actions[bot]"])

Stores the URLs of git repositories and an associated filter. By default filters "github-actions[bot]".

source
StaticWebPages.TimeLine — Method
TimeLine(color::TimeLineColor, args::Dot...)
+TimeLine(args::Dot...; color=tl_blue)

Construct a TimeLime with the dots in args. The TimeLine color can be set to: tl_blue, tl_green, tl_red, tl_orange, tl_julia_blue, tl_julia_green, tl_julia_purple, tl_julia_red, tl_julia.

source
StaticWebPages.TimeLineColor — Type
TimeLineColor

An enumeration of the different TimeLinecolors available. It will need to be adjusted forThemeandSubTheme`.

  • tl_blue
  • tl_green
  • tl_red
  • tl_orange
  • tljuliablue
  • tljuliagreen
  • tljuliapurple
  • tljuliared
  • tl_julia
source
StaticWebPages.export_site — Method
export_site(; d::Dict{String,String}=local_info, rm_dir::Bool=false, opt_in::Bool=false)

Export the generated website based on d (default to local_info). The content and site folders need to be valid. If rm_dir is true, the site folder will be deleted before the website is generated.

Users can choose to support StaticWebPages.jl by setting opt_in to true. This will add a small banner in the side navigation menu stating "This website was generated using StaticWebPages.jl" and links to the GitHub repository.

source
StaticWebPages.images — Method
images(args::Image...)

Construct an ordered sequence of images for a Block item. An Image should be given as a Pair of strings.

source
diff --git a/dev/themes/index.html b/dev/themes/index.html index 3ff5aeb..42b9360 100644 --- a/dev/themes/index.html +++ b/dev/themes/index.html @@ -1,2 +1,2 @@ -Theming · StaticWebPages.jl

Themes

The only available theme for the moment is using Zurb foundation responsive front-end. Customization of this theme and addition of other themes are expected in a near future (contributions/suggestions/requests are welcome).

+Theming · StaticWebPages.jl

Themes

The only available theme for the moment is using Zurb foundation responsive front-end. Customization of this theme and addition of other themes are expected in a near future (contributions/suggestions/requests are welcome).