Personal Books

Date copied from the wiki: 08/17/2011 16:44:17 Rev 72

Personal books are created in Microsoft Word and compiled in Logos using the Personal Books tool. They need to be saved as .docx files (Word 2007 or later, and compatibility mode should not be selected). The Personal Books tool is recently released, so some features may not work as expected. Personal Books was introduced in Logos 3 as Personal Book Builder and many users continue to refer to the tool as PBB.

Bugs you may encounter

You may encounter some bugs in the current implementation of PBBs and four are particularly problematic:
y

Microsoft Word can add extraneous tags to .docx documents and the compiler may not strip them all out, which often breaks milestones and links. There is a [[partial workaround >> http://wiki.logos.com/Personal_Books#Cleaning_your_.2edocx_file ]]. The compiler does not handle datatype links correctly (see below for terminology). When specifying a datatype link, the compiler creates both a datatype link to any resource, and an ordinary link to the current resource. This is correct only if the current resource has a location that matches the datatype. If it does not have that location, the compiler should not add the ordinary link because doing so prevents the datatype link working. The work around is that instead of clicking on the link, you can right-click on it, select the datatype and choose open. In some complex documents, Logos can crash without generating a log file. There is currently no workaround. If this happens to you, please send the document to logos4feedback@logos.com so they can test the document. A Build failed Could not remove existing resource message can occur occur often enough to be annoying. It will advise you to close all open panels but a restart works best.

Terminology
To create PBBs, you need to understand the types of tags that you can add to a document:
y

Milestones are not seen in the finished resource. Theyre hidden markers that indicate the location in a resource. For example, in a Bible, a milestone is needed at every verse. In a Dictionary, a milestone is needed at the beginning of every article. In many resources, milestones are also added at the beginning of each page. Datatype links are visible in the finished resource. As they name suggests, they add links to other resources or Bible passages. Datatype links dont link to a specific resource, but to

a datatype (such as Bible or Josephus). Logos will then open the link in the most highly prioritised resource that supports that datatype.
y

Resource links are also visible in the finished resource. As the name suggests, resource links link to specific resources, and optionally to a specific location in that resource. Fields are also called Search Fields. A Bible resource can have fields like footnote, bible, heading, words-of-christ; where bible refers to the manuscript text and words-of-christ refers to the words (within bible) spoken by Jesus.

Syntax
Milestones
The syntax for milestones is very simple: {{~ [[@datatype:reference]] }}. However, some reference types use a period instead of a colon. It is not yet understand why this is the case. For example:
y y y y y y

{{~ [[@Page:513]] }} {{~ [[@Bible:jn 3:16]] }} {{~ [[@Headword:Rome]] }}This used to be @Topic. It uses the language from the Word document, else specify @Headword+<language> {{~ [[@GreekStrongs:g3056]] }} {{~ [[@dayofyear.12.25]] }}This would tend to be used in calendar devotionals that could be used in any year {{~ [[@ymd.2011.5.23]] }}This would tend to be used in lectionaries that would be used in a specific year

Datatype links
The syntax for datatype links is very similar to milestones, but without the @ sign, and with an optional label{{~ [[label >> datatype:reference]] }}. For example:
y y y y y y

{{~ [[Bible:jn 3:16]] }} - most Bible links are created automatically, which means you dont need to tag them {{~ [[Rome>> Headword:Rome,_City_of]] }} {{~ [[GreekStrongs:G3056]] }} {{~ [[dayofyear.12.25]] }} {{~ [[ymd.2011.5.23]] }} {{~ [[Page:513]] }}Page numbers are treated differently from other datatypes. They are entered as a datatype link, but compiled only as a resource link (i.e. they will always link to the current resource).

Resource links
Open the resource to the desired place, select WIKI as the Copy Location method in the panel menu, then copy with Ctrl+Alt+C and paste the link with Ctrl+V. It uses the syntax {{~ [[label >> link]] }} so you can change the label as needed. Note If the link does not work its book and location will have to be re-typed in capital letters e.g. {{~ [[Authorship >> logosres:NBC;art=DEUTERONOMY3C]]}}. Page offsets are not yet supported e.g. {{~ logosres:hlmnbblhbk;ref=Page.p_591;off=759 }} will go to the start of the page.

Fields
The syntax for Fields is {{~ {{field-on:<fieldname>}} ... {{field-off:<fieldname>}} }} OR use a Word style field:fieldname. For example:
y y y

{{~ {{field-on:Bible}} }}For God so loved the world, {{~ {{field-off:Bible}} }} {{~ {{bible-on}}}}For God so loved the world, {{~ {{bible-off}} }} If above text has a Style called field:RedLetter then it will be compiled as red text.

For a list of fieldnames see http://wiki.logos.com/Search_Fields_List.

Table of Contents
The table of contents is generated automatically from Words styles (Heading 1, Heading 2, etc.). See How to add a Table of Contents to your Personal Book

Building Personal Books

To build a personal book: 1. Go to Tools > Personal Books 2. Click Add book 3. Enter Title and Author (currently Author is required, though it is hoped that in the future it will be possible to leave it blank) 4. Add an optional Copyright message and Description 5. Choose the book type (default: Monograph).

6. Choose a language (it is hoped that more will be added in the future) 7. Click Add field to drop down the menu of other optional fields you might want to add 8. Optionally add a cover image: Click Change... under the blank book cover and choose an image file from your hard disk. You can find usable image files for most published books by searching for their title on Google Images 9. Click Add file... and select the .docx file from your hard disk. You can add multiple .docx files to make up a book and use drag&drop to reorder them. (To remove a .docx file, rightclick on it and select Delete) 10. Click Build book After the book is built (aka compiled) it should automatically open in a tab.

Cleaning your .docx file

The Logos PBB compiler can be particular about the syntax of the Word document. Often, Microsoft Word will save documents that look fine on screen, but dont compile correctly. That can leave milestones and links which despite looking perfectly correct, arent recognised by Logos. You can often eliminate this issue in Microsoft Word by following these steps: 1. 2. 3. 4. Save your Word Document as an RTF file Close the document Re-open the RTF document Save the RTF document as a Word .docx file.

Other Information
Resource type requirements
y y y

y y

Ancient Manuscript: Apparatus: Bible: o create milestones for each verse o use Fields to separate Bible text o not fully working with Guides and Tools Bible Commentary: o You need to mark text which comments on a verse with a milestone like {{~ [[@Bible:jn 1:1-18]] }} o If your comment covers different passages then put milestones on successive lines o Commentaries as defined by Logos comment on every verse Bible Concordance: Bible Cross-Reference Index:

y y y

y y y y y y y y y y y

Bible Harmony: Bible Notes: see Bible Commentary o Unlike a commentary, Logos defines this as not commenting on every verse. Calendar Devotional: o requires tag in the format of{{~ [[@dayofyear.mm.dd]]}}(example{{~ [[@dayofyear.06.04]]}}) to function as a devotional. Cross-Reference Index: Dictionary: Encyclopedia: Grammar: Journal: Lectionary: Lexicon: Magazine: Manual: Monograph: no special requirements Thesaurus:

Labels
Use the syntax {{~ [[label >> link]] }}.

Word hyperlinks
If Word hyperlinks do not compile then try the syntax{{~ [[label >> link]] }}. However, if the link reference is then detected as a hyperlink (blue and underlined in Word) right-click on the link and choose Remove Hyperlink.

Ignore a reference
If you want a reference to be ignored by the compiler try the syntax{{~{{~ reference }} }}note the space before and after the reference.

Space is ignored (Workaround)

If space between words and codes (syntax) is ignored then expand the character spacing (Ctrl+D in Word 2007) by 1 or 2 pt.

Lemmas
The Lemma tab in the (right-click) context menu is not currently supported. But you can change the language setting in Word to Greek or Hebrew (after selecting the text) to get your prioritized lexicons in the lower portion of the context menu.

Searching
Results appear in the Search panel under My Books but the section has to be manually opened. Fields do not appear in the drop-down but recognised ones (see Resource Info) can be searched with the syntax fieldname:word.

Pictures and Images

These must be inserted from the hard drive and with Text Wrapping (on right click menu) set to In Line.

Reporting bugs
Please report bugs if the document doesnt get converted properly to a Logos book on the Logos 4 Windows or Logos 4 Mac, as appropriate.

Examples
Wiki pages
y y

How to add a Table of Contents to your Personal Book How to add a Footnote to your Personal Book

From the Forum

y y y y y

Commentary example, see this post. See [[this post>> http://community.logos.com/forums/p/36558/273924.aspx#273924 ]] regarding making a commentary series. Tag generator, see this post Macro page number generator, see [[this post>> http://community.logos.com/forums/p/35832/269118.aspx#269118 ]] Various PB tagging examples, see [[this post>> http://community.logos.com/forums/p/36303/274056.aspx#274056 ]]