Common documentation

Byte-Welt - Projekte / Projects DockingFrames
1

Hello,

if you like you can pull a few improvements of the documentation:

The improvements are basically for me so I can more easily read the documentation.

commit c46e3fa560c3c1e0cb6b7866be7b7600949df912
Author: Erwin Mueller erwin.mueller@deventm.org
Date: Sat Mar 23 14:07:03 2013 +0100

Use KOMA script to style the document

* make the page bigger for more text
* add heading and footer
* add logo for DockingFrames based on the screenshot of the demo

commit 54c7cbfc9d104f76bf3c083f1f9b822f865e44a9
Author: Erwin Mueller erwin.mueller@deventm.org
Date: Sat Mar 23 13:29:14 2013 +0100

Make links in a blue color in Pdf document

commit 57330ae1fb54e7ce496714fb6111d7433e8a5109
Author: Erwin Mueller erwin.mueller@deventm.org
Date: Sat Mar 23 13:27:13 2013 +0100

Cleanup main latex file

Put styles in pagestyles.sty and included packages in defaultpackages.sty.
Add encoding and language definition.
Replace package url with hyperref, to make references in Pdf as
clickable links.

commit 8305005a0e9e6620c0acf361c0421c19cb15a898
Author: Erwin Mueller erwin.mueller@deventm.org
Date: Sat Mar 23 13:25:08 2013 +0100

Remove and ignore latex artifacts
2

I’ve already spend the entire day working on the framework (and other stuff), but I will most certainly check out the changes as soon as I find the time.

Some of the changes you make sound very interesting, like the hyperlinks :slight_smile:

3

Yes I’m working very frequent with Latex. I create documents for documentations of my software or other documentation. Presentations, too.

But I need to fix some bugs introduces by me in your docu. Mostly it is with \src style, because no word break. So the text line we get over the page. Also you are using frequent \linebreak that causes more problems.

4

I never found out how to create a \src style that breaks the words, or at least does proper aligning. That resulted in the linebreaks… I guess if “src” would properly work, all linebreaks could be deleted.

5

But the problem with \linebreak is:

http://www.personal.ceu.hu/tex/breaking.htm#linebreak
The \linebreak command causes LaTeX to stretch the line so it extends to the right margin.
That means something like:
aaa bbbbb cccc

You can use just \ or \*

One option to break \src is to add \ so it will look like:

Some text Some text Some text Some text Some text Some text 
Some text Some text Some text Some text Some text Your
Method Some text Some text Some text Some text Some text

The other option is to add hyphenation to the method and class names. Latex have a list of the hyphenations for each language. But of course it doesn’t know any for your custom made up names.

6

I just fetched your improvements, it really looks much better now :eek:

I’ll search for a solution with these linebreaks before the next release of a stable version :wink: