GuideML FAQ
Created | Updated Feb 5, 2003
Welcome to the GuideML FAQ. This is where you can find information about GuideML, the markup language of DNA.
Contents of this Section
- What is GuideML and how can I find out how to use it?
- How do I create an article in GuideML?
- How do I put pictures in my GuideML articles?
- Can I upload pictures to DNA?
- What's 'Approved GuideML'?
- What's this 'GuideML parser' I keep hearing about?
- Can I include JavaScript in my GuideML articles?
- Can I include HTML in my GuideML articles?
- Why doesn't the <LINK> tag work properly with URLs that have & in them?
- My article/Personal Space has suddenly become wider than my screen. What has happened?
What is GuideML and how can I find out how to use it?
GuideML is the markup language of the Guide, and you can find out all about how to use it at the DNA GuideML Clinic, where you will also find a list of all the tags that GuideML supports.
In a nutshell, GuideML is a tag-based XML system that enables you to change the look of text in an article, and to change its layout. That's it, really, and if you've ever come across HTML, you'll find it very easy to pick up - indeed, a number of the tags are based on HTML tags in the first place.
We find the easiest way to learn GuideML is to use it, and the GuideML Clinic is a very handy place to check out for tips on usage, known bugs and so on. You might also like to read the Introduction to GuideML.
How do I create an article in GuideML?
When you create an article in the Article Editor, you can choose the type of the article using the three buttons below the article edit box. Simply ensure that the article type is set to GuideML, and that your article is in the right format (in other words it has the right structure for a GuideML article, as described here).
You can convert text articles to GuideML by changing the article type, but please note you still have to ensure the article body is in correctly-structured GuideML; all this conversion does it to add <GUIDE> and <BODY> tags in the right places.
How do I put pictures in my GuideML articles?
You can include pictures in GuideML articles by using the <PICTURE> tag. You can only include pictures that are stored on the relevant DNA site's servers, so you should ask the teams on the individual sites for information on picture availability.
Can I upload pictures to DNA?
Currently you can't upload pictures to DNA, and can't use off-site pictures either. However, at some stage in the future we do hope to offer some kind of image uploading facility.
What's 'Approved GuideML'?
Approved GuideML is a specific subset of GuideML that's allowed into sections of sites that implement an editorial process, such as h2g2's Edited Guide. It's fine for members to use all sorts of flashy and groovy markup tags on their pages, but we've picked a subset that allows Editors to maintain a grip on the quality in their editorialised sections. Flashing text might be great for fans of psychedelia, but not in the edited articles, and non-Approved GuideML will normally be removed during the editorial process.
The GuideML Clinic lists the tags that are allowed through editiorial processes (when used correctly, of course).
What's this 'GuideML parser' I keep hearing about?
The GuideML parser is the software that takes everything that you enter into articles, Conversation Forums or Journals and displays it, in a different way depending on the skin being used. During this process the parser also does some clever things, like turning :-) into a smiley face in Conversation Forums and Journals. It also tries to report any GuideML syntax errors so you can fix them.
You can find out more in the article A787034.
Can I include JavaScript in my GuideML articles?
No, you cannot include JavaScript in your articles.
Can I include HTML in my GuideML articles?
You can include most HTML tags in your GuideML articles, as long as they follow the GuideML syntax rules. For example, to include a horizontal rule in your articles you should use <HR/> instead of <HR>.
The best way to find out whether you can use specific HTML tags in GuideML is to try them out. You can't break anything, after all, and the worst that can happen is that it doesn't work.
Why doesn't the <LINK> tag work properly with URLs that have & in them?
It is illegal to use standalone ampersands anywhere in GuideML (this applies to all XML languages). Instead of the & you should use & - even in URLs in tags like <LINK HREF>.
The Article Editor does its best to trap illegal use of ampersands, but stick to the golden rule: anywhere you want an ampersand, write & and you will get one. This is how XML works, because the ampersand is one of the few reserved characters.
My article/Personal Space has suddenly become wider than my screen. What has happened?
Your browser tries to resize your page to fit its window by wrapping text. However, if you have included a really long word (such as a URL) in your Journal, or a really long title in a header or box title, then you can make it impossible for the site to resize your page.
