Web Stitcher Plugin
Last Modified: 11/27/2006
Home | The Basics | File Manager | Web Stitcher | HTMLtoPDF | Share Manager | ItemWizard | HemMedia
About Web Stitcher Plugin
About Web Stitcher Plugin
Web Stitcher is a plugin, which automates embedding webs within webs. It creates all Master Web and SubWeb relationships, builds link HTML and inserts it into the Header HTML of all webs involved. Note: some web styles are not compatible with Web Stitcher. You will be notified of this if you attempt to stitch such webs.
Web Stitcher is a plugin, which automates embedding webs within webs. It creates all Master Web and SubWeb relationships, builds link HTML and inserts it into the Header HTML of all webs involved. Note: some web styles are not compatible with Web Stitcher. You will be notified of this if you attempt to stitch such webs.
Introduction to Master Webs and SubWebs
Hemingway webs can be become parts of other Hemingway webs. When one web becomes part of another, we call it a 'SubWeb.' The 'owner' of the SubWeb is called the 'Master Web.'
This relationship between 'Master Web' and 'SubWeb' allows for the 'home page' of the SubWeb to actually be the 'home page' of the Master Web. In this case, when a user clicks on the home page link on the SubWeb, it will take the user to the home page of the master web instead of the home page of the SubWeb.
This is achieved by going to the Web Settings 2 tab (of the Web Settings) of the SubWeb and checking 'This web is a SubWeb of another' and adding the URL of the Master Web.
(Note: relative URL's are recommended. So, instead of putting:
http://www.mywebs.com/masterweb/default.htm
you would put:
../masterweb/default.htm
This relative link takes you up a folder (..) then down the 'maserweb' folder and to the 'default.htm' page.)
Also, the name you wish to have as the 'Master Web' link can be put into the Master Web Name field.
Now, we're only half done. This has the effect of making the home page of the Master Web also the home page of the SubWeb. What this doesn't do is create a link from the Master Web to the Sub Web. To do this, one would create a Section on the Master Web and link it to a page on the SubWeb - preferably not the home page of the SubWeb, as it is not available (because it is a SubWeb).
This rather time-consuming process must be completed for each and every SubWeb. Web Stitcher automates this. Instead of creating Sections in the Master Web, Web Stitcher creates a set of links at the top of the page for all Master Webs and SubWebs.
This relationship between 'Master Web' and 'SubWeb' allows for the 'home page' of the SubWeb to actually be the 'home page' of the Master Web. In this case, when a user clicks on the home page link on the SubWeb, it will take the user to the home page of the master web instead of the home page of the SubWeb.
This is achieved by going to the Web Settings 2 tab (of the Web Settings) of the SubWeb and checking 'This web is a SubWeb of another' and adding the URL of the Master Web.
(Note: relative URL's are recommended. So, instead of putting:
http://www.mywebs.com/masterweb/default.htm
you would put:
../masterweb/default.htm
This relative link takes you up a folder (..) then down the 'maserweb' folder and to the 'default.htm' page.)
Also, the name you wish to have as the 'Master Web' link can be put into the Master Web Name field.
Now, we're only half done. This has the effect of making the home page of the Master Web also the home page of the SubWeb. What this doesn't do is create a link from the Master Web to the Sub Web. To do this, one would create a Section on the Master Web and link it to a page on the SubWeb - preferably not the home page of the SubWeb, as it is not available (because it is a SubWeb).
This rather time-consuming process must be completed for each and every SubWeb. Web Stitcher automates this. Instead of creating Sections in the Master Web, Web Stitcher creates a set of links at the top of the page for all Master Webs and SubWebs.
Web Stitcher Operation
Upon launching Web Stitcher, you will see a dialog asking whether you would like to check for new MenuTypes at the Altuit Library. You can press the OK button to add new MenuTypes for WebStitcher. More on MenuTypes later.
Toolbar Controls
There are two toolbar controls: Start Over and Stop. Start Over does exactly that, removes all Web Stitcher settings (not MenuTypes) and allows you to begin anew. Stop interrupts any server transaction typified by the activity animation at the upper right. When stitching multiple webs, it can take some time, so if you wish you may use the Stop button to exit the stitching process - though it will not reverse any changes already made.
The Process: Steps 1-3
1. Choose the Main Web
First you choose from the list on the left the web you wish to Designate the Main Web. Note, the columns at the right tell you the web style and whether or not it is stitchable. Custom templates may or may not be stitchable based upon whether they have been designed to include the Header HTML web setting. You can click on a web to choose it, then give it a name for the other webs to link to it.
2. Choose SubWeb(s)
Next, you are presented with a list of all the other webs available to be SubWebs of the Main Web. Click on a web to select it as a SubWeb.
3. Choose SubWeb Section Link
Next, you are presented with a list of all pages in the chosen SubWeb. You should select a page which will be the 'entry point' for the SubWeb. You should not choose the default.htm page as it will not always be available. Once a page is chosen, you are prompted for a link name for this SubWeb.
Now, continue to step 2 and repeat steps 2 and 3 for as many SubWebs as you wish to have linked to the Main Web.
When you have completed choosing your Main Web and SubWebs, you may proceed to step 4.
First you choose from the list on the left the web you wish to Designate the Main Web. Note, the columns at the right tell you the web style and whether or not it is stitchable. Custom templates may or may not be stitchable based upon whether they have been designed to include the Header HTML web setting. You can click on a web to choose it, then give it a name for the other webs to link to it.
2. Choose SubWeb(s)
Next, you are presented with a list of all the other webs available to be SubWebs of the Main Web. Click on a web to select it as a SubWeb.
3. Choose SubWeb Section Link
Next, you are presented with a list of all pages in the chosen SubWeb. You should select a page which will be the 'entry point' for the SubWeb. You should not choose the default.htm page as it will not always be available. Once a page is chosen, you are prompted for a link name for this SubWeb.
Now, continue to step 2 and repeat steps 2 and 3 for as many SubWebs as you wish to have linked to the Main Web.
When you have completed choosing your Main Web and SubWebs, you may proceed to step 4.
Steps 4-5
4. Choose Menu Type
If you recall, Web Stitcher builds HTML links and inserts them into every page of each web chosen. The Choose Menu Type popup menu lists the available HTML templates you may choose. Each template is designed to work with a specific Hemingway Style. Here are some of the Menu Type Templates:
Corporate Light and Dark - creates text links with appropriate text styles for the Corporate Light and Dark style templates.
ImageTable_and_Background* -creates HTML for buttons including a table background. Useful in any style template.
ImageTable_Left* - creates HTML for buttons and aligns them left (just right of the logo)
ImageTable_Right* -creates HTML for buttons and aligns them right (always at the right of the page)
PortalandSubPortalText -creates text links with appropriate text styles for the Portal and SubPortal style templates.
Text Buttons -creates text links only with no style settings whatsoever. This is the simplest MenuType and is a good one to study if you wish to make your own.
*while the HTML text is built and correctly inserted, it is up to you to build the images for these MenuTypes. After building, a message is displayed with a list of the images needed for this MenuType. You can use ButtonGadget (www.buttongadget.com) or other program to build the files. Name them exactly as mentioned in the list, and import them to the Main Web ONLY using the File Manager Plugin. They will now all work in the Main Web and SubWebs.
5. Stitch Webs Button
After you select a MenuType, then you can press the Stitch Webs button. It will take between a few seconds and a couple of minutes to stitch all the webs, depending upon how many webs you have selected. Once finished, you will be prompted to view the webs. Also, there may be comments about the stitching, so please read them in the log area -especially if you've chosen to use images.
If you recall, Web Stitcher builds HTML links and inserts them into every page of each web chosen. The Choose Menu Type popup menu lists the available HTML templates you may choose. Each template is designed to work with a specific Hemingway Style. Here are some of the Menu Type Templates:
Corporate Light and Dark - creates text links with appropriate text styles for the Corporate Light and Dark style templates.
ImageTable_and_Background* -creates HTML for buttons including a table background. Useful in any style template.
ImageTable_Left* - creates HTML for buttons and aligns them left (just right of the logo)
ImageTable_Right* -creates HTML for buttons and aligns them right (always at the right of the page)
PortalandSubPortalText -creates text links with appropriate text styles for the Portal and SubPortal style templates.
Text Buttons -creates text links only with no style settings whatsoever. This is the simplest MenuType and is a good one to study if you wish to make your own.
*while the HTML text is built and correctly inserted, it is up to you to build the images for these MenuTypes. After building, a message is displayed with a list of the images needed for this MenuType. You can use ButtonGadget (www.buttongadget.com) or other program to build the files. Name them exactly as mentioned in the list, and import them to the Main Web ONLY using the File Manager Plugin. They will now all work in the Main Web and SubWebs.
5. Stitch Webs Button
After you select a MenuType, then you can press the Stitch Webs button. It will take between a few seconds and a couple of minutes to stitch all the webs, depending upon how many webs you have selected. Once finished, you will be prompted to view the webs. Also, there may be comments about the stitching, so please read them in the log area -especially if you've chosen to use images.
Designing your own MenuTypes
This section is for those familiar with HTML and simple programming concepts.
The MenuTypes are located in the folder:
C:\Documents and Settings\All Users\Application Data\Altuit\Hem2\Plugins\MenuTypes
A MenuType is a .txt file and is loaded whenever the Web Stitcher plugin is loaded. It consists of HTML and variables and is used as a template to render the Header HTML for each web being stitched. You can create your own MenuType files and put them in the folder above and they will load with the others the next time Web Stitcher is launched.
Variable are denoted by a % before and after the variable name. The available variables to use inside an HTML string are:
%MainWebLinkName% is the name used to link to the Main Web
%SubWebLinkName% is the name used to link to a SubWeb
%MainWebURL% is the URL destination for the Main Web
%SubWebURL%, is the URL destination for the SubWeb
%MainWebName% is the name (as used in the URL) for the Main Web
%SubWebName% is the name (as used in the URL) for the SubWeb
Below is the text of the TextButtons.txt MenuType:
---MainWeb Menu--- variables are: %MainWebLinkName%, %SubWebLinkName%, %MainWebURL%, %SubWebURL%, %MainWebName%, %SubWebName%
***| %MainWebLinkName% |*** <a href="%SubWebURL%">%SubWebLinkName%</a> | ***
---SubWeb Menu---
***| <a href="%MainWebURL%">%MainWebLinkName%</a> | *** <a href="%SubWebURL%">%SubWebLinkName%</a> | **OR** %SubWebLinkName% | ***
---Finish Message---
This is a Horizontal Template with Text Links. The Main Web is on the left. Each Link is separated by a "|".
Line 1 is:
---MainWeb Menu--- variables are: %MainWebLinkName%, %SubWebLinkName%, %MainWebURL%, %SubWebURL%, %MainWebName%, %SubWebName%
and should not be changed
The second line renders the HTML to be used for the Main Web:
*** | %MainWebLinkName% | *** <a href="%SubWebURL%">%SubWebLinkName%</a> | ***
The delimeter is "***"
The first item in this line is the HTML for what is displayed as the Main Web link. It uses the variables %MainWebURL% and %MainWebLinkName%. In this case they are surrounded by an 'href' tag.
The second item in this line is the HTML for each SubWeb. This HTML is repeated once for each SubWeb. The variables for this item are: %SubWebURL% and %SubWebLinkName%
Line 3 is blank and should not be changed
Line 4 is "---SubWeb Menu---" and should not be changed
Line 5 renders the HTML to be used when on any SubPortal pages:
*** | <a href="%MainWebURL%">%MainWebLinkName%</a> | *** <a href="%SubWebURL%">%SubWebLinkName%</a> | **OR** %SubWebLinkName% | ***
The first item in this line is the HTML for what is displayed as the Main Web link. It uses the variables (denoted by a % before and after the variable name), %MainWebURL% and %MainWebLinkName%. In this case they are surrounded by an 'href' tag.
The second item in this line is the HTML for each SubWeb. This HTML is repeated once for each SubWeb. Included in the second item is **OR**. This renders the HTML (with embedded variables) following **OR** for the SubWeb which is the current page, and renders the HTML preceding **OR** for each SubWeb which is NOT the current page. This way you can have 'down state' button if you like for the page you are on. The variables used in this item are: %SubWebURL% and %SubWebLinkName%
Line 6 is blank and should not be changed
Line 7 is "---Finish Message---" and should not be changed
Line 8 is any message you would like the operator of Web Stitcher to see upon a successful web stitching operation.
It is helpful to look at different MenuType files to see how they are used.
The MenuTypes are located in the folder:
C:\Documents and Settings\All Users\Application Data\Altuit\Hem2\Plugins\MenuTypes
A MenuType is a .txt file and is loaded whenever the Web Stitcher plugin is loaded. It consists of HTML and variables and is used as a template to render the Header HTML for each web being stitched. You can create your own MenuType files and put them in the folder above and they will load with the others the next time Web Stitcher is launched.
Variable are denoted by a % before and after the variable name. The available variables to use inside an HTML string are:
%MainWebLinkName% is the name used to link to the Main Web
%SubWebLinkName% is the name used to link to a SubWeb
%MainWebURL% is the URL destination for the Main Web
%SubWebURL%, is the URL destination for the SubWeb
%MainWebName% is the name (as used in the URL) for the Main Web
%SubWebName% is the name (as used in the URL) for the SubWeb
Below is the text of the TextButtons.txt MenuType:
---MainWeb Menu--- variables are: %MainWebLinkName%, %SubWebLinkName%, %MainWebURL%, %SubWebURL%, %MainWebName%, %SubWebName%
***| %MainWebLinkName% |*** <a href="%SubWebURL%">%SubWebLinkName%</a> | ***
---SubWeb Menu---
***| <a href="%MainWebURL%">%MainWebLinkName%</a> | *** <a href="%SubWebURL%">%SubWebLinkName%</a> | **OR** %SubWebLinkName% | ***
---Finish Message---
This is a Horizontal Template with Text Links. The Main Web is on the left. Each Link is separated by a "|".
Line 1 is:
---MainWeb Menu--- variables are: %MainWebLinkName%, %SubWebLinkName%, %MainWebURL%, %SubWebURL%, %MainWebName%, %SubWebName%
and should not be changed
The second line renders the HTML to be used for the Main Web:
*** | %MainWebLinkName% | *** <a href="%SubWebURL%">%SubWebLinkName%</a> | ***
The delimeter is "***"
The first item in this line is the HTML for what is displayed as the Main Web link. It uses the variables %MainWebURL% and %MainWebLinkName%. In this case they are surrounded by an 'href' tag.
The second item in this line is the HTML for each SubWeb. This HTML is repeated once for each SubWeb. The variables for this item are: %SubWebURL% and %SubWebLinkName%
Line 3 is blank and should not be changed
Line 4 is "---SubWeb Menu---" and should not be changed
Line 5 renders the HTML to be used when on any SubPortal pages:
*** | <a href="%MainWebURL%">%MainWebLinkName%</a> | *** <a href="%SubWebURL%">%SubWebLinkName%</a> | **OR** %SubWebLinkName% | ***
The first item in this line is the HTML for what is displayed as the Main Web link. It uses the variables (denoted by a % before and after the variable name), %MainWebURL% and %MainWebLinkName%. In this case they are surrounded by an 'href' tag.
The second item in this line is the HTML for each SubWeb. This HTML is repeated once for each SubWeb. Included in the second item is **OR**. This renders the HTML (with embedded variables) following **OR** for the SubWeb which is the current page, and renders the HTML preceding **OR** for each SubWeb which is NOT the current page. This way you can have 'down state' button if you like for the page you are on. The variables used in this item are: %SubWebURL% and %SubWebLinkName%
Line 6 is blank and should not be changed
Line 7 is "---Finish Message---" and should not be changed
Line 8 is any message you would like the operator of Web Stitcher to see upon a successful web stitching operation.
It is helpful to look at different MenuType files to see how they are used.
Technology by: Altuit, Inc. | top