Launch HyperCities

Archive for November, 2009

On the web, like in Project Muse or Wikipedia, citations generally take the form of endnotes: clicking on a note in a piece of text scrolls your browser to the bottom of the page, where the corresponding endnote is contained. This doesn’t work in Hypercities, unfortunately, but Hypercitities has something better: citations that open a new window with the text inside them. The procedure for creating these is a little bit complex, but it’s easy once you get the hang of it.

First, each citation must have a reference code unique within that particular piece of content. This code can be something as simple as ’1′ for the first one, ’2′ for the second, and so on, but the important thing is that they must be unique within the description of that particular object. You can reuse the same codes in different objects, even if they’re within the same collection. Codes are used to link the links (the piece of text you click on) to the text that is displayed in the window when it pops up. They can contain letters and numbers, but please avoid other characters or spaces.

Once you have your list of codes, you can begin to enter them. If the content is already in Hypercities, you enter it using the editor. You can also add them to a KML file if you’re planning to upload your collection as a KML file.

Using the edit window:


1) Open the edit window. Once it’s open, click on the HTML button.

Your text should look different now, with a lot of codes you didn’t see before between greater-than and less-than characters. This is because you are now editing the HTML code that controls how your text is displayed.


2) Find the piece of text you would like the user to click on to display the footnote.


3) Just before this piece of text, without a space, insert the following code:

<citation refcode=”ref1“>

Replace “ref1″ with the code for this citation.


4) After the text the user will click on to display the citation, you must close the tag. Again, right after that text, enter the following text:


Do this for all your citations.


5) At the very end of the document, you enter the text that will be displayed for each citation.

If not, what this means is that you need to create another list of all the text you want to create. Use the following template.

<CitationList> (This needs to appear before the first citation)

<citation refcode=”ref1“>Here is the text to be displayed</citation>

<citation refcode=”ref2“>Here is the text to be displayed for your second footnote</citation>

(Put more citations here)

</CitationList> (This needs to appear after the last citation)


HTML is allowed within the <citation> elements, but don’t put anything else between the <CitationList> and the <citation> tags inside it.

If you know XML, we are creating a CitationList element with citation children that have “ref” attributes with the same refcodes that you used before. The text of these children will be what is displayed in the new window when the user clicks on the link.

Please note: the text that the user clicks on to display the citation will automatically appear blue, superscripted, and underlined. Do not apply these styles yourself. In fact, if you put a <sup> tag around the text, it will be double-superscripted.

If you’re uploading a KML file, just follow steps 2-5, and make sure these all of this appears in the CDATA section of the description element of each object. The CitationList must also appear inside the CDATA element at the end of it.