I think the manual is really good. But I have some suggestions ;)

I will not comment on English language level, because I'm not my mother tongue, but it seems good to me : at least I have no problem understanding it.

  • A small mistake "no their own Key" -> "not their own Key" (Introduction, Declaring persistent type)
  • In PDF some spaces seems to have disappeared in code samples. For example sample for "Introduction, Declaring persistent type" contains "publicstring". Many samples have this problem.
  • Maybe the appendix should be grouped a the end, so that we can save paper when printing.
  • I noticed there is no real documentation on Namespace synonyms in domain options : could you give more precise explanation on this point, and a sample?
  • In Linq chapter, the Lock() method is not really explained : I think the sample means to skip objects that are locked. A more precise explanation would be useful with the sample.

(based on http://dataobjectsdotnet.googlecode.com ... Manual.pdf )

This thread was imported from our support forum. The original discussion may contain more detailed answer.

asked Jan 12 '10 at 11:00

olorin's gravatar image


Thanks a lot for your comments - the bugs will be fixed. Btw, spaces also aren't properly displayed in IE in original HTML files, so this proves Acrobat fully relies on IE while doing conversion.

(Jan 12 '10 at 11:00) Alex Yakunin Alex%20Yakunin's gravatar image

Lock() is planned to be explained in "Concurrency control" section (TODO, I'm working on this).

(Jan 12 '10 at 11:00) Alex Yakunin Alex%20Yakunin's gravatar image

Probably a good option. Will someone else vote for this?

(Jan 12 '10 at 11:00) Alex Yakunin Alex%20Yakunin's gravatar image

Just finished reading it. Well done guys =) Looking forward to Disconnected State and Version Tracking though!

(Jan 12 '10 at 11:00) ara ara's gravatar image

One Answer:

I just fixed a set of major issues related to single-page HTML & PDF versions of Manual:

  • Wrong spacing (both). That's because single-page (merged) version was produced by our own tool, and this tool really didn't keep all the spaces earlier (there are XDocument-based transformations, so it was pretty easy to get this bug).

  • No bookmarks in PDF.

  • Page breaks in PDF aren't based on CSS rules. I finally found a good way of converting everything into PDF ;)

  • There were some issues with links as well. It's really simple: all links that can be followed are shown as-is, so you can type them from even printed Manual. Of course, they're clickable in PDF version.

So now it is fully ready for printing, and that's really cool.

Issues left (except content-related ones):

  • Table of contents does not include page numbers. It seems I'll be unable to fix this automatically.

  • Its size is 9Mb now :( I'll try to reduce it later.

P.S. New PDF manual will appear @ Google Code ~ in 15 minutes.

answered Jan 25 '10 at 00:43

Alex%20Yakunin's gravatar image

Alex Yakunin

(Jan 25 '10 at 00:43) Alex Yakunin Alex%20Yakunin's gravatar image
Your answer
Please start posting your answer anonymously - your answer will be saved within the current session and published after you log in or create a new account. Please try to give a substantial answer, for discussions, please use comments and please do remember to vote (after you log in)!
toggle preview

powered by OSQA