The LDP HOWTO Generator Test

Stein Gjoen

V0.02 2003-10-18

This document give a quick demonstration of the LDP HOWTO Generator while verifying the generator functionality.

1. Introduction

Starting the process of writing a HOWTO can be time consuming. This generator is designed to overcome this problem. This document is itself created with the Generator and thus verifies that it works as designed.

1.1 Copyright

This document is Copyright © 2003-10-18 Stein Gjoen. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.

1.2 Disclaimer

Use the information in this document at your own risk. I disavow any potential liability for the contents of this document. Use of the concepts, examples, and/or other content of this document is entirely at your own risk.

All copyrights are owned by their owners, unless specifically noted otherwise. Use of a term in this document should not be regarded as affecting the validity of any trademark or service mark.

Naming of particular products or brands should not be seen as endorsements.

You are strongly recommended to take a backup of your system before major installation and backups at regular intervals.

1.3 News

After numerous beta versions this is the first public release. Initial testing helped locating bugs in the generator itself.

1.4 Credits

None yet...

2. Structure

This is based on the large Template and follows the same structure which is the default of this generator.

3. Technologies

All is performed with JavaScript on a browser. The web page itself is validated as valid HTML 4.01 Transitional on the W3C Validator.

JavaScript is used extensively and works with version 1.2 or later.

No cgi-bin is required or even used here. Thus it is possible to work off-line.

4. Implementation

Just write in plain ascii text. Formatting and special features are described in the large Template.

Nevertheless remember to escape underscore, ampersand and less than characters.

5. Maintenance

Note that this Generator is only for the initial SGML authoring; it is as yet not possible to continue updating a document in this Generator.

Plans are underway for on-line editing elsewhere.

6. Advanced Issues

While LinuxDoc SGML looks familiar to those who know HTML the markup is nevertheless different. Please refer to the Templates for details on the specifics.

7. Troubleshooting

Incorrect use of special characters will cause problems. The Generator will catch a few potential problems but not all.

8. Further Information

Please refer to the Templates and the man pages for the LinuxDoc SGML package. Latest version is 1.0.9, an unofficial version.

9. Getting Help

Trouble with the Generator? Please contact the author for details and have the log at hand.

10. Concluding Remarks

Try it. Small test at first since there is no reload feature here. Then go for it.

11. Questions and Answers

Q: How do I get a paragraph break? A: Just make a double lineshift (one blank line).

12. Examples

Well, this is one example. Please check the SGML code that was generated.