Home » Developing U++ » Documentation » Style & T++....
|
|
|
|
| Re: Style & T++.... [message #18076 is a reply to message #18075] |
Tue, 09 September 2008 20:35   |
 |
mirek
Messages: 14291
Registered: November 2005
|
Ultimate Member |
|
|
| cbpporter wrote on Tue, 09 September 2008 12:16 |
Well, the ruler is a much better solution than that tab thing. But I do not like the fact that the ruler is displayed above the current paragraph, not below. Also, this way the first item has a ruler also, which is ugly.
|
You can remove it from the first...
Another possibility is to use single paragraph as ruler.
Anyway, I must admit that this solution is much easier w.r.t. paging issues.
| Quote: |
Also, you can not have an expression like: "here is the list with something: <ruler> item1".
|
Note that even now, there is "item_next" style without ruler exactly to solve this problem....
You need this also when documenting a set of methods with single description (BTW, one more reason to use T++ instead of Doxygen).
| Quote: |
Also, "Size" and "Sizef" type description have their type name with a dark gray color. Is this part of the style?
|
No. A mistake. BTW, in the process I have introduced some bug into RichText which I then have fixed (and it caused gray in some cases) -> make sure you update your ide....
| Quote: |
Next step would be to make the inserted definitions obey the style. Right now a lot of manual fine tuning is needed.
|
Well, that is why I have started this thread 
Let us make it perfect and I will then try to provide tools to automate the process....
Mirek
|
|
|
|
|
|
|
|
| Re: Style & T++.... [message #18083 is a reply to message #18081] |
Wed, 10 September 2008 04:20 |
cbpporter
Messages: 1428
Registered: September 2007
|
Ultimate Contributor |
|
|
I reordered the styles with HR in regard. I attached the file rather than commit it. No use committing every stylistic change until it is more stable.
So how can we make styling more easy and consistent?
By having inserted definition be formated correctly:
1. Keywords must be all colored with the keyword color. Ideally it would be chooseable and not hardcoded, but since Qtf styles are paragraph related, I don't know how to best do this.
2. Other elements like <, >, (, & can maintain their dark gray color, but most be consistent again.
3. Typenames or function names must be black and consistent.
4. Template parameters should have their own color, as green in the example.
5. After the definition, a new paragraph with the "desc" style must be created, but without two spaces on it.
6. The nest paragraph must be auto inserted with style "breakhead", which is a short space up to the HR. This style must have the next paragraph style set to "breakline".
7. The next paragraph must be inserted as "breakline" which is a HR with small font size, the same size as breakhead. These names can be changed, but "breakhead" nad "breakline", or their new names must sort lexicographically this way. The next paragraph style of breakline is "item".
8. There are two definition styles: item and class. This can be fine tuned.
Other stuff:
1. Styles like "item" should have a flag to disable spell checking.
2. In the future, the Topic++ Browser should do a substitution on styles according to a configuration dialog, to allow a bigger font size for example, or a different color scheme for the visually impaired or people with just poor LCDs where a font 10 can not be read.
Edit: attachment removed
[Updated on: Wed, 10 September 2008 04:42] Report message to a moderator |
|
|
|
|
|
|
|
|
|
| Re: Style & T++.... [message #18091 is a reply to message #18083] |
Wed, 10 September 2008 11:15 |
|
mirek
Messages: 14291
Registered: November 2005
|
Ultimate Member |
|
|
| cbpporter wrote on Tue, 09 September 2008 22:20 |
I 3. Typenames or function names must be black and consistent.
|
The problem is that typenames in signatures are links (and links are blue underlined).
| Quote: |
5. After the definition, a new paragraph with the "desc" style must be created, but without two spaces on it.
6. The nest paragraph must be auto inserted with style "breakhead", which is a short space up to the HR. This style must have the next paragraph style set to "breakline".
7. The next paragraph must be inserted as "breakline" which is a HR with small font size, the same size as breakhead. These names can be changed, but "breakhead" nad "breakline", or their new names must sort lexicographically this way. The next paragraph style of breakline is "item".
|
Show me in Size
| Quote: |
8. There are two definition styles: item and class. This can be fine tuned.
|
Yes, there already are. Anyway, I believe we will have to find some way how to deal with that parameter list (at T++ user level).
Well, of course, the most simple way is to forget about it and describe parameters in 'desc'. I would vote for this, it leads to most dense style. Anyway, maybe we should have listing parameters as option or maybe even be able to insert them later?
Actually, inserting later makes the most sense.
| Quote: |
2. In the future, the Topic++ Browser should do a substitution on styles according to a configuration dialog, to allow a bigger font size for example, or a different color scheme for the visually impaired or people with just poor LCDs where a font 10 can not be read.
|
You can increase the font size in help browser by clicking the icon with "A"
Mirek
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Re: Style & T++.... [message #18140 is a reply to message #18138] |
Fri, 12 September 2008 15:27 |
cbpporter
Messages: 1428
Registered: September 2007
|
Ultimate Contributor |
|
|
I can see some nice progress. Unfortunately, applying the style destroy the formating for function definition, so they must be reformatted or reinserted. Small price to pay.
As for the no bolds formating, I don't know what to say: it doesn't feel wrong but it doesn't fell right either. But fine by me.
A couple of issues:
1. Latest SVN doesn't compile (under Linux). There is a _DBG_ somewhere. Sorry, I corrected it before I could take a note where it was, but is is easy to find.
2. When entering a multi line declaration, like a template one, both lines have a code reference set, so all references will have a counter of 2. This is worst in the case of classes, where clicking on a link towards them will open up a dialog letting me choose between two links that point to the same item.
3. Also, when inserting the same templated method, the second line starts with a non breaking space. That space is ugly. On the same second line, a template parameter like "T" is not green, only on the first line. I think all instances of template parameters should be colored distinctively.
And congratulations on the parser progress. I loaded up some problem code that I had by hand, and it worked! I must test all my code that had problems, but things look very promising  .
[Updated on: Fri, 12 September 2008 15:27] Report message to a moderator |
|
|
|
| Re: Style & T++.... [message #18141 is a reply to message #18140] |
Fri, 12 September 2008 16:49 |
|
mirek
Messages: 14291
Registered: November 2005
|
Ultimate Member |
|
|
| Quote: |
1. Latest SVN doesn't compile (under Linux). There is a _DBG_ somewhere. Sorry, I corrected it before I could take a note where it was, but is is easy to find.
|
Ops, sorry, once again I broken my ruler "compile ide in optimal mode" before commiting.
| Quote: |
2. When entering a multi line declaration, like a template one, both lines have a code reference set, so all references will have a counter of 2.
|
Hm, the question is whether to fix counter or put the reference to one paragraph only...
| Quote: |
3. Also, when inserting the same templated method, the second line starts with a non breaking space. That space is ugly. On the same second line, a template parameter like "T" is not green, only on the first line. I think all instances of template parameters should be colored distinctively.
|
I have noticed this. Will fix ASAP.
| Quote: |
And congratulations on the parser progress. I loaded up some problem code that I had by hand, and it worked! I must test all my code that had problems, but things look very promising .
|
Yeah, it was pretty lucky idea
Mirek
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Re: Style & T++.... [message #18339 is a reply to message #18338] |
Tue, 23 September 2008 18:00 |
|
mirek
Messages: 14291
Registered: November 2005
|
Ultimate Member |
|
|
| chickenk wrote on Tue, 23 September 2008 11:54 |
Hi,
I just noticed, while examining the new style for Size documentation page, that the element using the "shead" style were non-antialiased... It seems that a non-antialiasing formatting symbol was added to the shead style.
Removing the character 't' in file Size$en-us.tpp line 7, column 17 corrects that.
Mirek, was that intended or has this character been spuriously inserted since you implemented code for non-antialiased style ? Maybe some forgotten tests...  else, it may be something worth checking.
regards,
Lionel
|
Well, that is very interesting. It is not even possible to set non-AA style in T++.
Either cbpporter was trying something (?) or there is bug in QTF parser or encoder... (or somewhere else).
Mirek
|
|
|
|
|
|
|
|
| Re: Style & T++.... [message #18370 is a reply to message #18364] |
Thu, 25 September 2008 07:57 |
chickenk
Messages: 171
Registered: May 2007
Location: Grenoble, France
|
Experienced Member |
|
|
ok,
so indeed it was useful getting a bit deeper about that...
Thanks for investigating!
Lionel
|
|
|
|
Goto Forum:
Current Time: Sun Aug 02 11:18:57 GMT+2 2026
Total time taken to generate the page: 0.01580 seconds
|
U++ framework
Search
Help
Members
Register
Login
Home
.
