Syntax
Milestones
The syntax for milestones is [[@datatype:reference]]. For example:
- [[@Headword:Rome]] It uses the language from the Word document, else specify @Headword+<language>
- [[@Bible:jn 3:16]]
- [[@GreekStrongs:G3056]]
- [[@DayOfYear:January 17]] This would tend to be used in calendar devotionals that could be used in any year
- [[@YearMonthDay:Jan 17, 2012]] This would tend to be used in lectionaries that would be used in a specific year
- [[@Page:513]] or [[@VolumePage: 1,513]]
If you’re unsure how to find out the name of the datatype and reference, there are step-by-step instructions available.
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:
- [[Rome, City of >> Headword:Rome]] this will link to the current resource if the milestone is present
- [[Bible:Jn 3:16]] most Bible links are created automatically, which means you don’t need to tag them
- [[GreekStrongs:G3056]]
- [[DayOfYear:January 17]]
- [[YearMonthDay:Jan 17, 2012]]
- [[Page:513]] Page numbers always link to the current resource
If you’re unsure how to find out the name of the datatype and reference, there are step-by-step instructions available.
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:
- Page offsets are not yet supported e.g. logosres:hlmnbblhbk;ref=Page.p_591;off=759 will go to the start of the page. It is possible to link directly to a heading, even if that heading is in the middle of the page, but doing so is rather fiddly.
- To open a lectionary to today’s reading specify ref=YearMonthDay.today e.g. logosres:BCPDOLECT;ref=YearMonthDay.today
Fields
The syntax for Fields is {{field-on:<fieldname>}} ... {{field-off:<fieldname>}} OR use a Word style field:<fieldname>. For example:
- {{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 words-of-christ or WOC.
For a list of fieldnames see http://wiki.logos.com/Search_Fields_List.
Building Personal Books
Create the book
Your book is built from one or more Word .docx files. Add text or paste text from your original and add milestones, fields, links and other syntax elements as necessary. You can generate footnotes and use Word Heading styles for your articles/chapters as this will automatically generate a TOC. Text and syntax elements should use the Normal style and can be intermingled. Keep formatting consistent between the files of your book.
Note that milestones can be on the same line as the Heading because they are not visible in the resource, including TOC. Also remember that milestones are the only way to index the content of the article.
See Examples for other suggestions.
Build the book
- Go to Tools > Personal Books
- Click Add book
- Enter Title
- Enter Author (optional)
- Enter Copyright message and Description (optional)
- Choose the book Type (default: Monograph).
- Choose a Language (it is hoped that more will be added in the future)
- Click Add field for a menu of optional fields (Abbreviated Title is displayed)
- 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
- 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 (right-click a file to remove it).
- Click Build book
After the book is built (aka “compiled”) it should automatically open in a tab and begin Indexing.
Rebuilding a Book
Make changes to your docx files, Add or remove any BODY FILES and then click Build book.
It will recompile, recreate the resource file and then Index it.
Problems you may encounter
- If you get the message “Build Failed – Could not remove existing resource” it will advise you to close all open panels, but a restart works best.
- You may still get some Warnings/Errors when the build succeeds, but they can be ignored if the document appears to be converted properly. View this PB errors page for more information and possible solutions.
- Your milestones and links may appear to be correct but if they aren’t recognised by Logos you can often fix them in Microsoft Word by following these steps:
- Save your Word document as an RTF file and close it.
- Re-open the RTF file and Save as a Word .docx file.
- Logos can crash without generating a log file. If this happens to you please send the document to logos4feedback@logos.com so they can test the document.
If the document doesn’t get converted properly report the issue as a Bug on the appropriate Logos Forum.
Hints and Tips
Add a Search
First perform your search in the Search tool, then click on the Search menu and click on URL to copy the query to the clipboard. Then paste it into your document e.g. logos4:Search;kind=Basic;q=Word1_OR_Word2;match=stem
Consistent formatting is essential to getting your links compiled correctly e.g. it is almost impossible to notice different styles having the same font+size. Here is the best way to achieve this in MS Word:-
- place your cursor somewhere in the document that has the desired formatting (style + font).
- press CTRL+SHIFT+C to copy the formatting
- select the text/link.
- right click> Styles> Clear formating (or select Clear All in the Styles box)
- press CTRL+SHIFT+V to paste the formatting.
There are many free converters, mostly online. Afterward you may have to use your word processor to convert to docx.
Hidden hyperlinks
A datatype reference, particularly bible ones, can display duplicated entries in a hover popup. The reference may look OK in the docx file and the resource but there is a hidden hyperlink. You can fix with Word’s Remove Hyperlink or select a number of references and use Ctrl+Shift+F9.
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).
Labels
Use the syntax [[label >> link]].
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.
Pictures and Images
You can paste images from Logos or .bmp (bitmap) format directly into your document. Others must be inserted from the hard drive and with Text Wrapping (on right click menu) set to In Line.
Note: Neither method works with Word 2003, so you have to save to docx from Word 2007 or Skydrive.
Search Fields
Fields appear in the Search panel drop-down. Note that Red Letter text is “Words of Christ” and that you can only search for (tagged) Bible text in a Bible.
Search Results
Results appear in the Search panel under My Books but the section may need to be opened. Results from the Collections section of Passage Guide are also separated and PB’s will appear after any Logos books!
Searchable TOC Entries
If you want your TOC entries (Article heading, Chapters, Bible Book names, Pericope headings) to be searchable as a Heading field enclose them with {{field-on:Heading}} / {{field-off:Heading}} tags on separate lines.
Searching Bibles
You can use Bible Search for Bibles tagged with the bible search field, but Morph Search is not currently supported (see Lemmas).
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.
Word hyperlinks
Hyperlinks can be used to access different parts of your PB via Word Headings and Bookmarks. If hyperlinks to Headings do not compile then try a Resource link with your PB as the resource.