From bd2b72ad08348337e4d04f830f7d09c2abea1f21 Mon Sep 17 00:00:00 2001 From: Joe Groff Date: Mon, 15 Feb 2010 14:18:26 -0800 Subject: [PATCH] update vocabs and tools.deploy docs to mention icon files --- basis/tools/deploy/deploy-docs.factor | 4 +++- core/vocabs/loader/loader-docs.factor | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) mode change 100644 => 100755 basis/tools/deploy/deploy-docs.factor mode change 100644 => 100755 core/vocabs/loader/loader-docs.factor diff --git a/basis/tools/deploy/deploy-docs.factor b/basis/tools/deploy/deploy-docs.factor old mode 100644 new mode 100755 index 2cbb2869de..a552bd04fb --- a/basis/tools/deploy/deploy-docs.factor +++ b/basis/tools/deploy/deploy-docs.factor @@ -11,7 +11,9 @@ ARTICLE: "prepare-deploy" "Preparing to deploy an application" } ; ARTICLE: "deploy-resources" "Deployed resource files" -"To include additional files in your deployed application, specify their names in a vocabulary's " { $snippet "resources.txt" } " file. The " { $snippet "resources.txt" } " file contains one glob pattern per line. These patterns are expanded relative to the vocabulary directory; files outside of the vocabulary directory cannot be referenced. If a file inside the vocabulary directory matches any of these patterns, it will be included in deployed applications that reference the vocabulary. If a subdirectory matches, its contents will be included recursively." ; +"To include additional files in your deployed application, specify their names in a vocabulary's " { $snippet "resources.txt" } " file. The " { $snippet "resources.txt" } " file contains one glob pattern per line. These patterns are expanded relative to the vocabulary directory; files outside of the vocabulary directory cannot be referenced. If a file inside the vocabulary directory matches any of these patterns, it will be included in deployed applications that reference the vocabulary. If a subdirectory matches, its contents will be included recursively." +$nl +"If the deployed vocabulary includes an icon file for the current platform (" { $snippet "icon.ico" } " on Windows, or " { $snippet "icon.icns" } " on MacOS X), it will be embedded in the deployed application as its GUI icon." ; ARTICLE: "tools.deploy.usage" "Deploy tool usage" "Once the necessary deployment flags have been set, the application can be deployed:" diff --git a/core/vocabs/loader/loader-docs.factor b/core/vocabs/loader/loader-docs.factor old mode 100644 new mode 100755 index 7db3cdd5c2..ce4a319a42 --- a/core/vocabs/loader/loader-docs.factor +++ b/core/vocabs/loader/loader-docs.factor @@ -52,6 +52,8 @@ $nl { { $snippet "foo/bar/summary.txt" } " - a one-line description." } { { $snippet "foo/bar/tags.txt" } " - a whitespace-separated list of tags which classify the vocabulary. Consult " { $link "vocab-tags" } " for a list of existing tags you can reuse." } } +"An icon file representing the vocabulary can also be provided. A file named " { $snippet "icon.ico" } " will be used as the application icon when the application is deployed on Windows. A file named " { $snippet "icon.icns" } " will be used when the application is deployed on MacOS X." +$nl "The " { $link POSTPONE: USE: } " and " { $link POSTPONE: USING: } " words load vocabularies which have not been loaded yet, as needed." $nl "Vocabularies can also be loaded at run time, without altering the vocabulary search path. This is done by calling a word which loads a vocabulary if it is not in the image, doing nothing if it is:"