YAWC Online Word Template User Guide
Introduction
Welcome to the YAWC Online User Guide. This guide shows you how to create high-quality web pages directly from Microsoft Word (any version), without any knowledge of HTML, the markup language used for web pages. Publishing web pages using YAWC Online improves on the standard Word function to save a document in HTML format in a number of ways.
- YAWC Online adds top and side navigation bars, and other style information, to your documents as it converts them, so that the resulting web pages automatically conform to the look and feel of the website on which they will be published.
- YAWC Online generates high-quality HTML markup, which is suitable for reading by people with disabilities of all kinds, so your web pages are equally accessible to users of all abilities.
- YAWC Online allows you to maintain metadata in your Word document which will make it easier for users to search your website and find the information they require.
- YAWC Online can automatically upload the web pages it generates directly to the correct destination on your website, so that you can publish content directly, in a single step, rather than tediously having to navigate to the right location on the local file system and remote web server with a separate FTP client application.
Word mark-up guidelines
Web pages normally consist of the following components.
- Text (Headings, lists and paragraphs of text)
- Tables
- Graphics
- Hyperlinks
- Metadata
The following sections provide more information on how to write these document components in such a way that they appear properly as web page content. The basic principle to remember is that MS-Word has predefined styles for each of these components; by using them, you can create a high-quality web page. If you do not use them, the quality and appearance of the web page will not be as you expect. To view styles as you type, select YAWC>Utilities>Show/hide style area. This will display paragraph styles in a resizable window on the left side of your MS-Word window area.
Text
It is important for readability reasons that you define a clear hierarchical structure for each web page. Structure is defined using headings of various levels. Many short web pages may contain no headings other than the title, but longer documents may use many heading levels to break the information in the document up into manageable chunks.
Applying Heading styles
There are a variety of ways of applying heading styles in a document. The YAWC menu and toolbar enable you to apply heading styles using shortcut keys or single mouse-clicks. Use the following keyboard shortcuts to apply heading styles.
|
Press |
For this style |
|---|---|
| Ctrl-T | Title |
| Ctrl-1 | Heading 1 |
| Ctrl-2 | Heading 2 |
| Ctrl-3 | Heading 3 |
| Ctrl-4 | Heading 4 |
Alternatively, on the YAWC toolbar, click on the letter T, or any of the numbers 1 to 4, to convert the current paragraph to a title or heading. In the YAWC menu, choose 'Heading Styles…' and the title or heading level you require. Finally, you can also use ALT-SHIFT-RIGHTARROW to apply a heading level one lower than the last applied heading.
Do not use bold or font size to create a heading! Although this might look OK, the resulting web page is much more difficult to read for people with disabilities, and YAWC is designed to create pages equally accessible to everyone.
Applying List styles
The YAWC menu and toolbar enable you to apply list styles using shortcut keys or single mouse-clicks. Use the following keyboard shortcuts to apply list styles.
|
Press |
For this style |
|---|---|
| Ctrl+9 | List Number |
| Ctrl+Shft+9 | List Number 2 |
| Ctrl+8 | List Bullet |
| Ctrl+Shft+8 | List Bullet 2 |
| Ctrl+7 | List Continue |
| Ctrl+Shft+7 | List Continue 2 |
Alternatively, on the YAWC toolbar, click on the bullet or numbered list icons to convert the current paragraph to a list. In the YAWC menu, choose 'List Styles…' and the list style you require.
Do not use the bullet or numbered list icons in the format toolbar to create a list! Although this might look OK, the resulting web page is much more difficult to read for people with disabilities, and YAWC is designed to create pages equally accessible to everyone.
Choosing an appropriate list style
Use a bullet list (List Bullet style) to itemise a series of points where order is not particularly important, for example, a list of alternative colours.
Use a numbered list (List Number style) to itemise a sequence of items have a particular order, for example, a list of steps in a procedure.
Use a list continuation style (List Continue style) to add a second paragraph of text to a list item, without generating a second bullet or number icon.
Use the List style if you want to create a list with your own numbering sequence. This is often required for complex legal documents, which have quite idiosyncratic paragraph numbering conventions. The list style provides only indentation in this case, and does not add a bullet symbol or number to each paragraph.
To create nested lists, multiple levels of list style are available, for example List Number 2, List Number 3, List Number 4, etc. Each list level provides a larger indent, so it is easy to distinguish items from different levels.
Example of a List:
- This line uses the List Number paragraph style.
- This uses the List Number paragraph style.
This is a continuation paragraph. It is styled as List Continue.
- This is the start of the nested numbered list. It is styled as List Number 2.
- This is the second item in the nested numbered list. It is
styled as List Number 2.
This is continuity paragraph preceded by a soft return. It is styled as List Number 2.
- This is a continuation of the original numbered list. Note
that the number does not continue in the correct sequence. It should be numbered
3. This is a limitation of Word and can be ignored. It will convert to a 3 in
the web page. If preferred, you can manually override the number using the
command YAWC>List Styles>Restart List Numbering.
- is the start of a nested bulleted list. It is styled as List Bullet 2.
- is the second item in the nested bulleted list. It is styled
as List Bullet 2.
This is continuity paragraph preceded by a soft return. It is styled as List Bullet 2.
- Returning to the original numbered list again. This line should be numbered 4. It is styled as List Number.
Note: In some cases, MS-Word may not number nested numbered lists correctly. List items may begin again at 1. This can be solved in a number of ways. 1. Select the problem list item, choose Format>Bullets and Numbering>Modify, and change the Start At value to the required number. 2. Select all list items, format them with the List Number style, and then re-format each lower-level nested list with the appropriate style. The number on the top level list should retain the correct sequence.
Character styles
Character styles are not part of document structure, but are used to apply a particular presentation, usually bold or italic to a word or phrase in a paragraph. Applying a character style is easy, getting rid of it sometimes not. To remoce a character-level style, select the entire text that is styled incorrectly, and press Ctrl+Space (Control key and space bar).
| Press | For this style |
|---|---|
| Ctrl+B | Bold |
| Ctrl+I | Italic |
| Ctrl+SPACE | Default paragraph font |
| Ctrl+K | Hyperlink |
| Quote |
Tables
Any tables you create in MS-Word will be converted into similar tables in your web page. Most word table presentation features are not possible to re-create in HTML, so only simple table presentations are possible. When creating tables, we recommend that you always supply a title before the table, using the Table Title style. This is to improve the readability of the page for people with disabilities. You can also include a Table Summary, which can be a longer description of the information the table is intended to convey. See the example below.
Use the YAWC>Table Styles>Insert Data Table to insert a new table with all the styles already present. If modifying an existing table, make sure to select the heading rows and apply the style Tables>Heading Rows Repeat to them.
|
Acronym |
Meaning |
|---|---|
| CSS | Cascading Style Sheet |
| HTML | Hyper Text Markup Language |
| W3C | World-Wide Web Consortium |
| XML | Extensible Markup Language |
Layout tables
Sometimes you may want to use a table for layout purposes rather than to display tabular information, for example, to present a long list in 2 or 3 columns across a page, minimising vertical scrolling. In this case, use the Table Summary style to specify that the table is for layout. Do not include a Table Title for layout tables.
Generally you should not have borders on layout tables, so choose the table format '(none)' from the list of formats in the Table>AutoFormat dialog box. See the example below.
| Red | Cyan | Orange |
| Green | Magenta | Indigo |
| Blue | Yellow | Violet |
Graphics
Microsoft Word supports many different image formats, but when publishing information on the web, only 3 formats are generally used: GIF, JPEG, and PNG. JPEG format is suitable for photographs, and GIF format for most other types of graphic. PNG is a newer format designed to replace GIF images, but not supported on older browsers.
In Word you can choose to either embed images inside the Word document, or link them. If you link the image, then the image is stored as a separate file and referenced from the Word document. If the image is changed, it will also change when viewed or published in the Word document. If the image is embedded, then the original image is no longer used, and changes must be made within Word (using the Picture Editor).
It is good practice to link, rather than embed images, and manage images separately from text content. However, this requires extra effort, so if images are used only occasionally, it may be easier to embed them in Word.
If you cannot convert images into a web-compatible format, embed them in your Word document, and YAWC Online will convert them for you. The resulting image quality may not be as good as you would like, though.
If your operating system is Windows 98 or older, you probably cannot edit images without purchasing additional software. In Windows 2000/XP, you can use Microsoft Paint to convert images to GIF or JPEG format.
Embedding images
Use the following steps to link an image into your Word document.
- Copy your images as GIFs or JPEGS to the same folder as your Word document or in a folder directly below it e.g. images/fig01-01.gif.
- Place the cursor on the paragraph of your document where you want to insert the image.
- Choose Insert>Picture>From File...
- Select the image you want to insert, and click OK (Word 97) or Insert (Word 2000/XP).
Linking images
When linking images, you must ensure they are in a web-compatible format (GIF, JPEG, or PNG), and upload the images directly to the correct location on your website (using FTP). You must also place the local copy of the image in the same location relative to your local Word document.
Use the following steps to link an image to your Word document.
- Copy your images as GIFs or JPEGS to the same folder as your Word document or in a folder directly below it e.g. images/fig01-01.gif.
- Place the cursor on the paragraph of your document where you want to insert the image.
- Choose Insert>Picture>From File...
- In Word 97, select the image you want to insert, select the Link to file option, clear the Float over text and Save with document options and click OK.
- In Word 2000, select the image you want to insert, click on the down-arrow to the right of the Insert button, and click on the Link to file button.
- Ensure that the link to the image is correct. Choose Edit>Links.... The links are likely to have relative path names.
- Select the Change Source... button and select the images again. Select the Update button. This ensures that the reference to the image location will be correct in the web page. Note the link for the image named "link1.gif" has been changed:
Tip: To quickly change a number of absolute paths to linked images; turn on Field Codes and use Edit/Replace to replace the common absolute path with nothing.
Hyperlinks
Hyperlinks are the phrases of blue underlined text on web pages that allow you to browse between pages. The location or address of a web page is called a URL. You can create hyperlinks in Microsoft Word in a number of ways. There are different types of hyperlink, and the most convenient method to use depends on the location of the target page.
- A page on another website requires an external hyperlink, which must use the form protocol://domain/path (e.g. http://www.yoursite.com/about.htm).
- A page on the same website requires a local hyperlink, which may be absolute or relative.
- A heading or section on the same page requires an internal hyperlink, which is always relative.
External hyperlinks
An external hyperlink is one which points to a page on another website rather than your own. To create an external hyperlink, simply type in the complete URL or address. Microsoft Word will automatically convert the URL to the predefined character style Hyperlink. If you wish to replace the actual URL with a more understandable name, press Ctrl+K to edit the hyperlink and replace the Text to display field with the name.
It may be easier to type in the page title first, then select the title, press <Ctrl>+K, and enter the full URL.
Internal hyperlinks
Internal hyperlinks are links to another part of the same document, and are directly analogous to bookmarks in Microsoft Word. To insert an internal hyperlink to a heading, press Ctrl+K,
- Type the words you want to link into your Word document, and select the text.
- Press Ctrl+K to open the Insert Hyperlink dialog box.
- Select Place in this document, and an expandible tree of the headings and bookmarks in your document will be displayed.
- Expand the Headings tree list, and select the heading you require.
- Click OK. The text will be underlined and blue.
Local hyperlinks
Relative hyperlinks are links to another web page or document on the same website as the current document. Local hyperlinks can be relative or absolute, and do not include either the protocol or domain parts of the URL. A browser will automatically assume the link is to the same website as the linking page.
A relative link specifies the path to the file, starting from the current directory, for example, ../press/2003/index.htm. An absolute link specifies the path to a file, starting from the base of the directory structure, and always begins with a forward slash, for example /press/2003/index.htm. Use the following steps to create a relative hyperlink.
- Type the words you want to link into your Word document, and select the text.
- Press Ctrl+K to open the Insert Hyperlink dialog box.
- Type the path to the target link in the field 'Type the file or web page name'. Use forward than back slashes (i.e. '/', not '\'). In Word 97, you should also check the Use relative paths for hyperlinks box.
- Click OK. The text will be underlined and blue.
Hints on using hyperlinks
- When inserting a hyperlink, do not use the text 'Click here'. Instead, use a more informative text string, like '2003 Press Releases'.
- If you are creating a long web page, consider putting an internal Table of Contents at the top of the page, with links to each major section heading. Readers can then easily jump to the particular section they want. It also acts as a summary of the page. Format a ToC like this as a bullet list.
- When two links are adjacent to each other, make sure there is some text between them that is not linked, so that readers can clearly see that they have different targets.
Metadata
Metadata is information about your document. This information helps search engines on the web to index your information better, making it easier for people to find the right information. YAWC provides support for Dublin Core Metadata, which is the de facto standard for the web. Select YAWC>Edit Metadata… to view the metadata dialog box. This box is divided into 3 tabs, one for required metadata (Mandatory), one for desirable metadata (Recommended), and one for other metadata which may be needed only for certain types of pages. This categorisation follows the Irish Public Service Metadata Standard (IPSMS).
Some metadata is predefined and constant for a particular website, for example, the name of the publisher, the language, the format, and a rights notice. Other metadata is specific to a page, such as the Identifier, which should normally be the location (URL) of the page on its website, including the website address.
| Metadata field name | Description | Default |
|---|---|---|
| Title | The title of this page, as entered on the Title style at the top of the document | {titleFromDocument} |
| Creator | The subdivision of an organisation (e.g. Accounts Dept.) or the name of the person who created or is responsible for this page. | None |
| Subject | Keywords describing this document | None |
| Publisher | The name of the organisation responsible for publishing this document | Set in configuration file |
| Date created | Date the document was first published in this format | {createdDate} |
| Date modified | Date of last modification | {modifiedDate} |
| Identifier | URL of document | |
| Type | Usually one of a small set of pre-defined types, e.g. Press Release, Speech, Form, Legislation | None |
| Metadata field name | Description | Default |
|---|---|---|
| Contributor | Person, such as an editor, who helped in creating the page | |
| Format | Internet MIME type for the page | text/html |
| Source | Original source from which material was created | |
| Language | The main language of the page | En |
| Relation | ||
| Coverage | Geographic or temporal coverage of document (e.g. Ireland, Dublin; 2001 | |
| Rights | Copyright conditions under which information is published |
Identifier metadata field
YAWC Online uses the Identifier metadata field to deduce where the page should be published, so it is important that this field is correctly filled in. The field should contain a minimum of the domain name and the directory path.
The filename can be entered explicitly (e.g. http://www.domain.ie/path/index.htm ), or implicitly using the {auto} keyword (e.g. http://www.domain.ie/path/{auto} ). Entering the name implicitly is probably the better approach, as it is safer. If you create a new page by copying an existing file in the same directory, then the Identifier will be automatically correct, and the original page wont be overwritten when the new page is published.
Enter the filename explicitly if you want to override the default name YAWC Online generates. There are two situations when you might want this.
- Web servers expect a default file name in each directory, for example index.htm (Apache webserver) or default.htm (Microsoft IIS webserver). If you don't want to call the Word file index.doc or default.doc, then you could give it a more descriptive name, but specify the exact name in the Identifier field.
- If your website uses ASP or server-parsed pages, then you might want .asp, .shtml or .php rather than .htm suffixes. Specify the exact name in the Identifier field to achieve this.
Converting your document into a web page
Once you have written your document, you should save it in an appropriate location, wherever other documents published on your website are maintained. (YAWC Online must be set up and configured for your particular website. The steps required to do this are described in the YAWC Online Administration Guide.).
There are two methods to publish your Word file as a web page.
- In Word, use the YAWC>Convert and Preview… command. This will prompt you for your username and password, then upload and convert the current Word document, display a preview in a dialog box, and allow you to publish the page if you are happy with it, or cancel if not.
- In your web browser, go to www.yawconline.com and log in with your username and password. Then click the "Browse" button to open a file selection dialog box, and select the Word file you wish to convert. Then click the "Upload and Convert" button to convert the file and preview it, and publish it if it is OK.
The YAWC Menu
The following commands are available from the YAWC menu and toolbar.
- Edit Metadata – View and edit Dublin Core metadata fields for the document.
- Convert and Preview – Upload, convert and preview the current Word file as a web page.
- Verify – Check the structure of the current file for errors.
- Heading styles – Apply a heading level or title style to the current paragraph.
- List styles – Apply a list style to the current paragraph.
- Table styles – Apply table styles, or create a new 4x4 table.
- Paragraph styles – Apply one of a number of paragraph-level styles to the current paragraph (e.g. Normal, Table Title, BlockQuote).
- Character styles – Apply one of a number of character-level styles to the selected text (e.g. Bold, Italic, Hyperlink), or reset to the default font.
- Manage – Create a new Word file, or delete an existing web page.
- Utilities – Carry out one of a number of miscellaneous commands.
- About – Information about the current version of YAWC.
