[futurebasic] Re: [FB] Lots of Wiki Work

Message: < previous - next > : Reply : Subscribe : Cleanse
Home   : February 2008 : Group Archive : Group : All Groups

From: Alain Pastor <apastor@...>
Date: Thu, 07 Feb 2008 12:31:42 +0100
Christopher Wyatt a écrit :
> On Feb 6, 2008, at 10:15 AM, Ken Shmidheiser wrote:
> 
>> Chris wrote:
>>
>>> ...far more  knowledge to edit and complete once I have the basic 
>>> pages posted...
>>
>> One convention I would like to see while the Wiki is still in its 
>> infancy is the use of caps and lowers rather than all caps when 
>> defining FB language functions, statements and key words, i.e.
>>
>>     Def NewWindowPositionMethod
> 
> We will probably have to do that editing via "hand" (i.e. "time 
> consuming") after the pages I converted via grep/regx are up online. It 
> might be something I can hand edit on the main language reference page 
> this weekend, depending on my schedule. I'm swamped with actual work 
> (yeah, I know... I know...) that means I need to catch up with a few 
> things for conferences where I am expected to say something during the 
> alloted time.
> 
> I concur with the "camel case" style. Far better for coding.
> 

Editing by hand is unavoidable. The job can certainly be reduced if 
you're prepared to spend time creating a smart FB application to help in 
the process, but who's gonna write it?

Note also that the US Ref Manual and the US Help system have different 
writing conventions at this time.

In the Ref Manual:

- FB keywords: capitalized or camelized words and bold, however bold 
might suffice (ex.: *Print*, but not PRINT nor print)
- Toolbox calls: Apple's naming, bold, italics (all uppercase is 
particularly awful and illegible with long Toolbox names)
- Code: monospace font
- Parameters: italics (placeholder variables when describing syntax)
- Literal strings: bold (only when describing syntax. ex: R in Open "R",…)
- User functions: capitalized (fn MyFunction())
- Variables: starting with a lowercase.
- Globals: starting with the g character (lowercase)
- Sample code: indented

The French Ref Manual and the French Help system are more consistent, 
except that the web help pages introduce different colors for:

- FB keywords
- Toolbox calls (+ stretched font)
- Literal strings
- Constants
- Labels
- Remarks (+ proportional font)

All is done via CSS, and I believe the same can be done for the 
wiki-book, but I admit it's a lot of job. As I said earlier I have the 
US Ref manual in Word format, so searching text styles and adding span 
tags (with an appropriate class) surrounding the found strings should be 
feasible (cleaning would be necessary, though).

My understanding is that anyone who registers to wiki can have his own 
CSS that should override the default settings.

Is such a thing imaginable?

Alain