Reference for writing newbieDoc articles using lyx
Prev		Next

2. How to build the newbieDoc template from scratch

You will not want to do this very often, if at all. Just use the newbieDoc template as a starting point for your article. However, for the curious, this is how I built the template using the newbieDoc article (DocBook) lyx styles.

2.1. Copyright licence information

2.1.1. Drop-down styles list

Put the licence information in at the top of the lyx document. You need to enter the information inside an SGML comment at the very top, in front of the section title. Choose SGML from the list of styles and enter the text between  tags.

The default style is Standard. Change the style to SGML using the drop-down style list.

Drop-down styles list:   SGML

Copy and paste the following text or type in your own.

	Cutting and pasting from other documents
	You could copy and paste the text from a browser or a text editor. If so, paste 'as paragraphs' using LyX's 'Paste External Selection' command: Edit -> Paste External Selection -> as Paragraphs

Cutting and pasting from other documents

You could copy and paste the text from a browser or a text editor. If so, paste 'as paragraphs' using LyX's 'Paste External Selection' command:

Edit -> Paste External Selection -> as Paragraphs

Menu bar:    Edit -> Paste External Selection -> as Paragraphs

2.1.2. Save the lyx file

If you call this project build-template.en , save the lyx file as build-template.en.lyx .

Menu bar:    File -> Save -> build-template.en -> Save

2.1.3. Create the SGML file

Export the file to DocBook and render the resulting SGML file.

Menu bar:    File -> Export -> DocBook

The resulting SGML file is called build-template.en.sgml. Here is the SGML resulting from an export to DocBook:

<!-- newbiedoc-lyx-reference.en.lyx, newbiedoc-lyx-reference.en.sgml,
Copyright (c) 2002 your name, your email address, newbieDoc project,
http://newbiedoc.sourceforge.net. 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, with no
Front-Cover Texts, and with no Back-Cover Texts. A copy of
the license can be found at
http://www.fsf.org/copyleft/fdl.html. -->

This copyright notice will appear in the SGML document as well as the document. It will not appear in the rendered HTML document. You must include it separately, perhaps in an appendix. You can check this by generating the HTML file from the SGML file using sgmltools.

$ sgmltools -b onehtml -s newbiedoc-onehtml.dsl build-template.en.sgml

2.2. Page header

This is a header that will appear on every sheet (except the first page) of a multiple page article. The page header only appears in the title bar of an HTML document with only a single page (eg if you use the “onehtml” backend to sgmltools).

Press the <ENTER> key to start a new style. It will default to the Standard style. Change the style by choosing PageHeader from the drop-down list of styles. Enter your text for the page header.

Drop-down styles list:    PageHeader

LyX main window:    Page Header:     Your text

2.3. Article title

This will usually be the same text as the page header.

Press the <ENTER> key to start a new style. Change the style by choosing Title from the drop-down list of styles. Enter your text for the article title.

Drop-down styles list:    Title

LyX main window:    Title:     Your text

2.4. Author's name

Press the <ENTER> key to start a new style. First choose Firstname from the drop-down list of styles. Enter your first name.

Drop-down styles list:    Firstname

LyX main window:    Author's first name:     Your first name

Repeat for your surname.

Drop-down styles list:    Surname
LyX main window:    Author's surname:     Your surname

2.5. Affiliation

	The order matters
	The Affiliation style is like a wrapper. You must add Affiliation after you have entered its contents (Email).

2.5.1. Email

Press the <ENTER> key to start a new style. First choose Email from the drop-down list of styles. Enter your email address.

Drop-down styles list:    Email
LyX main window:    Author's email:     your-address@example.com

2.5.2. Affiliation, address

Now add the wrapper. Place the insertion point (vertical, flashing bar) just in front of your email address and press the <ENTER> key. The insertion point appears on a new, blank line between Author's surname and Author's email.

LyX main window: 

Author's surname:     Your surname
|
Author's email:     your-address@example.com

Select Affiliation from the drop-down list of styles.

Drop-down styles list:    Affiliation

Author's email now appears underneath Affiliation, address

LyX main window: 

Affiliation, address
    Author's email: your-address@example.com

2.6. Revision history

	The order matters
	The revision details must be entered first, then they are wrapped in Revision number. There may be more than one Revision number. They must all be wrapped in Revision history.

2.6.1. Date

Move the insertion point to the end of the email address. Press the <ENTER> key. Choose the Date style for the new line and enter the date of the revision.

Drop-down styles list:    Date

LyX main window:     Revision date:     today's date

2.6.2. Initials

Move the insertion point to the end of today's date. Press the <ENTER> key. Choose the Initials style for the new line and enter your initials.

Drop-down styles list:    Initials

LyX main window:     Reviser's initials:     your initials

2.6.3. Revision remark

Move the insertion point to the end of your initials. Press the <ENTER> key. Choose the RevisionRemark style for the new line and enter a summary of any changes you have made.

Drop-down styles list:    RevisionRemark

LyX main window:    Revision remark:     A meaningful comment

2.6.4. Revision

Now add the wrapper. Place the insertion point (vertical, flashing bar) just to the left of your Date entry, and press the <ENTER> key. The insertion point appears on a new, blank line between Author's email: and Revision date: .

LyX main window: 

     Author's email:     your-address@example.com
|
     Revision date:     today's date

Select Revision from the drop-down list of styles and enter a revision number. If this is the first draft of your article you could give it the revision number 0.01.

Drop-down styles list:    Revision

The Revision details now look like this:

LyX main window:

      Revision (number):      0.01
      Revision date:     today's date
      Reviser's initials:     you
      Revision remark:     A meaningful comment

Wrap the Revision with Revision history. Place the insertion point just to the left of your Revision entry, and press the <ENTER> key. The insertion point appears on a new, blank line between Author's email: and Revision (number): .

LyX main window:

     Author's email: your-address@example.com
|
      Revision (number):  0.01

Select RevisionHistory from the drop-down list of styles.

Drop-down styles list:    RevisionHistory

Your fully wrapped Revision history looks like this.

LyX main window:

Revision history
      Revision (number):  0.01
      Revision date: today's date
      Reviser's initials: you
      Revision remark: A meaningful comment

You can add new revisions later, either above Revision (number), or below Revision remark. Be consistent though. Include Date, Initials and RevisionRemark. Then insert the Revision (number) wrapper at the top of the details.

2.7. Abstract

Position the insertion point at the end of your Revision remark comment.

Press the <ENTER> key to start a new style and choose Abstract from the drop-down list of styles. Enter a summary of your article. You can only have one paragraph in your Abstract.

Drop-down styles list:    Abstract

LyX main window:    Abstract:     Your summary text (one paragraph only)

That's it!

Prev	Home	Next
Quick start		lyxstyles used in newbieDoc