March 10th, 2001

lj_doc: Complete protocol reference in XML, with stylesheets

All of the documentation for LJ's client/server protocol is now available in DocBook XML format.

Users with Internet Explorer 5 can view the XML using multistyle.htm, which allows you to switch quickly between 6 different stylesheets I've uploaded. (Most of the stylesheets emulate the appearance of the existing HTML pages, selecting different information for display). I've done this mainly to demonstrate how XSL stylesheets can be used with the XML documents.

All of the stylesheets are in the same directory as multistyle.htm. The document itself consists of protocol.xml (12 KB) and 3 auxiliary files:
  • allmodes.xml (60 KB) -- reference entries for the individual protocol modes.
  • protocol.dtd (8 KB) -- the document type definition (DTD).
  • iso-num.ent (5 KB) -- entity definitions for numeric and special graphic characters.
Notice that multistyle.htm loads these files only once; all navigation between different parts of the documentation is accomplished using XSL and JScript.

The stripping out of 3 linebreaks (which I mentioned last weekend) has not been fixed yet.

Unless somebody has better ideas, here's what I'll do next:
  1. Explain in English how to write documents that comply with the DTD.
  2. Look at the PHP Manual to see which of its features would be beneficial in LJ documentation.
  3. Look into the possibility of using IE5 as an offline editor for LiveJournal documentation in XML format. Is anyone else interested in being able to do this?
As I understand it, plans to add server-side support for XML documentation are on hold pending completion of the server code audit.

(When I first posted this, I said I was also planning to write a DocBook-compatible DTD for LiveJournal's database schema documentation. That documentation is nothing but tables, though, so DocBook doesn't seem appropriate. For tabular data, a custom XML document type is more useful, and designing it is a trivial exercise.)

Earlier related threads:
January 15-17
February 20-21
February 26-28
March 2-4
March 6
Think a Little

(no subject)

Hm.. I should post this in Lj_dev possibly, okay first anyone want to tell me where this should go. I have a feeling it would take too long over in suggestions.

For support can someone add a link below customizing about the process of "Embedding journals" it used to be there, I swear. But its gone now. Anyway. It would make it a bit easier over in Support. Hm.. there are a few other things that could be added to those lists that come up a lot. Has someone been rearranging those lists? There are a lot missing.. A few rather, but still missing.
James Dean - Mannequin

Part 1 of 2 - sorry ;)

Ok between jaebird and myself I realized how several of the FAQs are on the FAQ page yet never made it to the "Have a question" page... I need to get working on that I really just flat out forgot that not only were some of the FAQs not edited for grammar - but were also never added to that new/improved support site. My fault - it's tough enough to get users to look on one of the page sometimes - having them spread out between the two = more support requests probably came in than needed to.

Anyway, jae also pointed out that the font stuff is not really as accessible as it should be but since much of that goes hand in hand with the other HTML / how do I edit my styles issues I whipped up the following... Any complaints to it being put up on the support / FAQ stuff? And yes I realize it is rough - but I am thinking this is better than nothing on the issue.

------------------

Fonts, misc. HTML

For information on Fonts (http://www.livejournal.com/support/faqbrowse.bml?faqid=12)

Currently LiveJournal does not offer tutorials HTML commands (which can be used in the LJ style system).

Version 2 of the style system (S2) is currently being developed - until S2 is implemented we will not be updating any FAQS on the style system / questions regarding it. The reason is simple: with the system being changed it just makes more sense for us to wait and document - more fully - the new system. A full tutorial is time consuming and requires the efforts of many people. It is very likely that any documentation that we would create for the style system would be outdated before we could have a completed version online.

This lack of documentation may be frustrating so how is the current lack of a comprehensive tutorial better for you, the user? Some users find the current style system confusing - we realize this and are currently working to create a more user-friendly system. Many of our volunteers just don't have the time to assist users in the way that they would like to. No matter how much we were to document the current system it could not compete with the new improved style system. Once the new system is in place we'll try our hardest to better document the customization features - until then we thank you for your patience.
James Dean - Mannequin

part 2 of 2

Links and images come up time and time again - especially with the recent flood of free web space providers saying umm NO to external links... This is even rougher than the Style stuff I posted in part one - Be gentle I'm trying to do these from memory on my computer which is not online and then bringing them to the computer that I do have net access on... Actually with my memory I think they came out OK *grin*

__________

Links

How do I put a link in my journal?

Example: I want to link to http://www.livejournal.com in my journal

<a href="http://www.livejournal.com">Check out LiveJournal here</a>

The first part - <a href="http://www.livejournal.com"> - being where you want link to

The second part - Check out LiveJournal here - being what you want the link actual link to appear as on your journal entry

The third part </a> is where the code ends.

The quotes around the address you are linking to is VERY important - the link may not work properly without them.

___________________________________

What if I want to use a picture link instead of words?

The above code still applies - replace the "Check out live journal here" with the image link

Example - you still want to link to LiveJournal but this time you want to do so using a picture that you have stored at http://www.yourisp.com/yourusername/lj.jpg then the link becomes:

<a href="http://www.livejournal.com"><img src="http://www.yourisp.com/yourusername/lj.jpg"></a>

The only difference being the second part of your code - replace "Check out LiveJournal Here" with an image tag... The <img src="url here"> simply means the source (location) of the image.

_____________________________

* Please note - As of now LJ does not offer any image storage space - this may change in the future.

Many of the free web space providers will NOT allow you to link to your stored images from another site.

Example - a LJ entry will not be able to display an image that is stored at Geocities.

Because the list providers that will or will not allow you to externally link to their space is ever-changing, LiveJournal is unable to provide you with a list of free image hosts.
Most ISPs today offer plenty of web space with accounts and will likely not ban you from linking to those pictures that you store there. Contact your ISP for further assistance.