Support the Arctic Sea Ice Forum and Blog
« previous next »
Pages: [1]   Go Down

Author Topic: ASIF Style Guide  (Read 4708 times)

Florifulgurator

  • Grease ice
  • Posts: 805
  • Virtual world alter ego / अवतार of Martin Gisser
    • View Profile
  • Liked: 249
  • Likes Given: 384
ASIF Style Guide
« on: January 24, 2020, 07:03:11 AM »
§1.

For quotations xxx use
Quote
[quote][size=10pt]xxx[/size][/quote]
except for minor quotations.


<snip, at your service; N.>
« Last Edit: January 24, 2020, 01:10:47 PM by Neven »
Logged
"The ideal subject of totalitarian rule is not the convinced Nazi or committed communist, but rather people for whom the difference between facts and fiction, true and false, no longer exists." ~ Hannah Arendt
"Солдаты всех стран, соединяйтесь!" ~ Florifulgurator 1986

gerontocrat

  • Multi-year ice
  • Posts: 22166
    • View Profile
  • Liked: 5435
  • Likes Given: 70
Re: ASIF Style Guide
« Reply #1 on: January 24, 2020, 06:10:22 PM »
Quote from: Florifulgurator on January 24, 2020, 07:03:11 AM
§1.

For quotations xxx use
Quote
[quote][size=10pt]xxx[/size][/quote]
except for minor quotations.


<snip, at your service; N.>
What we need is an AI application for ASIF postings.

Then every post can be automatically rewritten (including typeface, sentence construction, permitted paragraph length, permitted obscenities et al) according to mandatory ASIF standards as prescribed by ??

So you think I am joking?
Logged
"Para a Causa do Povo a Luta Continua!"
"And that's all I'm going to say about that". Forrest Gump
"Damn, I wanted to see what happened next" (Epitaph)

Florifulgurator

  • Grease ice
  • Posts: 805
  • Virtual world alter ego / अवतार of Martin Gisser
    • View Profile
  • Liked: 249
  • Likes Given: 384
Re: ASIF Style Guide
« Reply #2 on: January 26, 2020, 02:34:14 AM »
Quote from: gerontocrat on January 24, 2020, 06:10:22 PM
So you think I am joking?
Dunno :)
------------------------

"Style Guide" comes from software industry.  It is mostly about how to format the code.

Bad software style guides prescribe too rigidly how to code, i.e. the ideas and constructs to use in algorithms etc.  (E.g. "Don't even use GOTO to escape nested loops." or "Four brackets is too many." (Common examples from verbal style guidance by wannabe chief engineers. My personal records are 7 nested IFs and 5 nested FORs (as demanded by the problems, not my ego). Regarding GOTO ask Stroustrup and forget about Dijkstra.  8)))

A good style guide should also give some reason for the prescriptions.  That I missed in §1. But the reason should be obvious :)
Quote
Have mercy with folks with bad eye sight.


------------------------
P.S.: The font size management of the forum software is doubly bad coding...  8)
https://en.wikipedia.org/wiki/Point_(typography)
« Last Edit: January 26, 2020, 03:41:44 AM by Florifulgurator »
Logged
"The ideal subject of totalitarian rule is not the convinced Nazi or committed communist, but rather people for whom the difference between facts and fiction, true and false, no longer exists." ~ Hannah Arendt
"Солдаты всех стран, соединяйтесь!" ~ Florifulgurator 1986

Florifulgurator

  • Grease ice
  • Posts: 805
  • Virtual world alter ego / अवतार of Martin Gisser
    • View Profile
  • Liked: 249
  • Likes Given: 384
Re: ASIF Style Guide
« Reply #3 on: January 26, 2020, 02:36:05 AM »
§2.

Number Style Guide entries for reference.
Logged
"The ideal subject of totalitarian rule is not the convinced Nazi or committed communist, but rather people for whom the difference between facts and fiction, true and false, no longer exists." ~ Hannah Arendt
"Солдаты всех стран, соединяйтесь!" ~ Florifulgurator 1986

nanning

  • Nilas ice
  • Posts: 2487
  • 0Kg CO₂, 37 KWh/wk,125L H₂O/wk, No offspring
    • View Profile
  • Liked: 273
  • Likes Given: 23367
Re: ASIF Style Guide
« Reply #4 on: January 26, 2020, 11:22:42 AM »
^^
"My personal records are 7 nested IFs and 5 nested FORs (as demanded by the problems,"

You have not put pre-conditions, post-conditions and nested invariants in every loop i guess? Being rigid minimizes the amount of bugs and is better for other people to read your code and adapt it in my opinion.
Have you looked at other languages for your problems? Prolog?
I am curious. What do you mean with "personal records" because it doesn't seem to be a database.


I think a clear style guide would be good. I wouldn't want AI to restructure because information and quality of communication gets lost I fear, sorry gerontocrat :).
Logged
"It is preoccupation with possessions, more than anything else, that prevents us from living freely and nobly" - Bertrand Russell
"It is preoccupation with what other people from your groups think of you, that prevents you from living freely and nobly" - Nanning
Why do you keep accumulating stuff?

Florifulgurator

  • Grease ice
  • Posts: 805
  • Virtual world alter ego / अवतार of Martin Gisser
    • View Profile
  • Liked: 249
  • Likes Given: 384
Re: ASIF Style Guide
« Reply #5 on: January 26, 2020, 10:04:09 PM »
Nanning, can we move that to another thread?  (It's been some time, having given up on the industry alreay 2 times in my life. But I want to return to programming soon...)
Logged
"The ideal subject of totalitarian rule is not the convinced Nazi or committed communist, but rather people for whom the difference between facts and fiction, true and false, no longer exists." ~ Hannah Arendt
"Солдаты всех стран, соединяйтесь!" ~ Florifulgurator 1986

nanning

  • Nilas ice
  • Posts: 2487
  • 0Kg CO₂, 37 KWh/wk,125L H₂O/wk, No offspring
    • View Profile
  • Liked: 273
  • Likes Given: 23367
Re: ASIF Style Guide
« Reply #6 on: January 27, 2020, 06:58:22 AM »
I'll see you in the Arctic café.
Do you want to sit at the bar or at a table?
Can I offer you a drink?
Will you please put your smartphone away?

disclaimer: My knowledge is not up to date.
Logged
"It is preoccupation with possessions, more than anything else, that prevents us from living freely and nobly" - Bertrand Russell
"It is preoccupation with what other people from your groups think of you, that prevents you from living freely and nobly" - Nanning
Why do you keep accumulating stuff?

Florifulgurator

  • Grease ice
  • Posts: 805
  • Virtual world alter ego / अवतार of Martin Gisser
    • View Profile
  • Liked: 249
  • Likes Given: 384
Re: ASIF Style Guide
« Reply #7 on: January 31, 2020, 09:56:43 PM »
§3.
γνῶθι σεαυτόν

<TODO: add-edit reference(s) to manual(s)>
« Last Edit: January 31, 2020, 10:03:03 PM by Florifulgurator »
Logged
"The ideal subject of totalitarian rule is not the convinced Nazi or committed communist, but rather people for whom the difference between facts and fiction, true and false, no longer exists." ~ Hannah Arendt
"Солдаты всех стран, соединяйтесь!" ~ Florifulgurator 1986

HapHazard

  • Grease ice
  • Posts: 888
  • Chillin' on Cold Mountain.
    • View Profile
  • Liked: 303
  • Likes Given: 5553
Re: ASIF Style Guide
« Reply #8 on: February 06, 2020, 11:08:28 AM »

͖͙̬͇̜͇̭̗̘̜̻̬̫̙̺̭̀̍̋̾̐ͪͩ͑͂͟ͅͅ
̛͖͖͚̺͍̍̈̒̊͒ͦ̂̒̀͒͋̅́
̵̧̢͈̲͙͈̲͚̣͈̙̖͙͌ͫ̔̐̇̀͟
ͨ͆̅͐́̄̓ͪ̊ͧ̉ͫ͊͗ͭ҉̡͈̘̭̗͙̪͖͚.̸̝͔̤͙̖͓͙̥̰̮͓͕͎̘̫̣͑ͫͭͪͪ͗ͫ̔̋̅͂́̍ͥ̿ͯ͆͠
̸̮̠͚̫̲͉͇̻͙̤̂̌͛ͯ̉̀͝͡
̒͛̇ͬ̽͛͛̔̄̽̏̌͌͂͏̶̵̸̗̻̤̺̰̬͈̹͈͇͇̯̟̰͜
̨̭͙͉̠̺͚̱̽̋̏̂̽̇́z̡ͯͪ͗ͫͦ͡҉̭̦̦̤̘͚͚̥̬͢͠ͅa͗̌͋ͣ̆ͬͮ̒͜͏̴̨̰͍̦̫̭̮͎̥̞̩͕̠̙̭̙̟̭̜̕l̴̢̛̛͓̮͖͈͍ͩ̊͊̂͒ͥ̆̍͆̇̅g̡̢ͥͥ͆͆ͮͫ̀͆̽ͪ̂͒̍͌̔͌͐̿҉̲̪͚̳͙̪̣̤̜͖̳ͅͅo͑ͭ̉̊̿̀҉̵̡̤̪̫̬͍̳̩̹̩̭̮
̴̴̨̜͖̘̤̳̤̣̥̙͍̺̤ͫ͂͌̎̒̒ͮͦ̉ͨͫ͝ͅ
̧̢͇͔̠̳ͬ̒̑̿̀̓ͪ̄ͦͩ̃̐ͭ̚͜͢ͅṫ̸͎͕͍ͮ̀̂͐̎͛͊̊̀̕͟͜ͅe̢̢̩͍͉͉̼̥̫ͫ̏͐ͧ̈̇̑̏̽̏ͭ̀̕s̸̼͔̩̩̣̰̱͕̦̙̖͖͎̜̗ͪͯ̎̌ͬ̈̀ͅt̛̰̠̩̮̹̣̗̥͍̭͖͈̻̙͇̱̭̲̓̐̅ͫ̐ͥ̓ͪͤͣ́̿ͯ̽̃ͨ͢͡
̈́̿̓ͭ̃ͨ̾ͯ̈́́̇̉ͤ̇̄͘҉̢̥̳̮̲̙͚̰̬͈͕̟̞.̴͕̭̤͖̙̥̮͖̰̥͉̫̟̟̬̆͑͒͌ͫͪ̒̆͐
̵̵̧̫͚͙̟̘̅̆̓̎̑͊͛̏̆ͭ͐ͨͬ͘
̵̸̱̞̤̖̦̬͚̱̙͚̼͕̊͑ͪ̿̓͆̎ͮ̋͘͞
̶̧̗͚̳͙͈͖̹͖͇̼̦̹ͨ̍͌ͧ̄͛̀.̵̷̨̑ͪ̋̒̔̂͛͡͏̼̖̥̮̠̘͓̩̯͉̠͓
̢̡̧͎̫̫͚̱̞͕̭͕̤̠͎̅͊͂͗ͣ̄ͤ͋ͪ̌̃ͥ̔ͥ͝
̣̖̭̲͇̣̺̣̦͂ͬͪ͛ͦ̋̅̂͊̄͛̄̍̓͌͋̇ͭ̔͝͝
̸̢͚̤͕͈̝̜͚͓̲̬͍͚͈͓̪̦͈̖ͯ̌͊̓̽͒̀͂̕͜͡
̶̓̄̑ͩ҉̥̠͙̟̤̭͟ͅ.̛̘͎͉̟͚͖̗͙̩̰̯̗̩̦͚ͭ͗̓̌̓̿͋̃͒̽̒
͛͂̓͌͋̄ͭͮ͊̑̄̿͋ͩ̆̇͒̌́͏̦̩̗̞͉͍ͅ
̵̸̧̨̯͕̻ͧͨ̅̎̔͗͗͐̓͌̈́̕
̵̢̭̠̰̰̲̳̎́͌̃ͣ̈̒̏̑̎̊̾͋ͩ.ͪ̂̊̽͏̨̡͏̰̳̥̬̘̝͖̜͚͙͖̤̲͙̜͓̺
̥̱̹͓͙̬̮̹̤̞͓͇̺̟̾͋̂̾ͯ̽ͣ̄́͗̍̓́͠
͎̺̰̰̝̹͎̻̒̑̾̄̉ͯ͊ͮ̓͂͟͝
̴̨̢̱̺̖̟̰͈̤̪̪͓̺̞̻̣̣̱̓̅ͫͪ̋̅̔͂̽͊͂̕ͅ
̵̛͕̩̱̜͆͛͗̈́ͫͤ̀́͟.͆ͥ̅͒̋͜͏҉̶̦̠̞̭̟̘͔
Logged
If I call you out but go no further, the reason is Brandolini's law.

blumenkraft

  • Guest
Re: ASIF Style Guide
« Reply #9 on: February 06, 2020, 11:22:07 AM »
✧ʕ̢̣̣̣̣̩̩̩̩·͡˔·ོɁ̡̣̣̣̣̩̩̩̩✧ woooooohooooooo
Logged

oren

  • First-year ice
  • Posts: 9993
    • View Profile
  • Liked: 3674
  • Likes Given: 4248
Re: ASIF Style Guide
« Reply #10 on: July 22, 2020, 08:14:02 PM »
Cross posting from the melting season thread, as I felt it was out of context there.

Quote from: blumenkraft
PSA: Using the quote feature (select text, click the 'Insert Quote' button - the button with the speech bubble) helps readers to distinguish quotes from original content.
Logged

kassy

  • First-year ice
  • Posts: 8933
    • View Profile
  • Liked: 2108
  • Likes Given: 2023
Re: ASIF Style Guide
« Reply #11 on: July 22, 2020, 09:37:32 PM »
And please write your text outside the quote bubble.
Logged
Þetta minnismerki er til vitnis um að við vitum hvað er að gerast og hvað þarf að gera. Aðeins þú veist hvort við gerðum eitthvað.

blumenkraft

  • Guest
Re: ASIF Style Guide
« Reply #12 on: July 26, 2020, 11:07:27 AM »
Repost from the other thread belongs here as well!

Quote from: blumenkraft on July 26, 2020, 11:02:26 AM
Something Freegrass and i found out only recently: Externally hosted GIFs (via [ img ] tag linked files from other websites) will autoplay (automatically download), no matter the canvas size.

If you want your GIF to behave to forum rules (click to play) you have to upload it to the forum server as an attachment to your post.

A GIF should always be >500 pixels (in at least one direction) in order to save data traffic.

Very small GIFs (smaller than 1MB of file size) can be below this canvas size. It doesn't hurt too much traffic-wise if those would auto-play.
Logged

blumenkraft

  • Guest
Re: ASIF Style Guide
« Reply #13 on: August 04, 2020, 10:06:39 PM »
PSA: On the issue of screenshots from very large monitors!

Sometimes screenshots are very big in file size (>5MB).

The problem is, this is way too big for just a picture.

If you have a very big .PNG file like that, please upload your screenshots to https://www1.lunapic.com/editor/ and save them as JPGs. They will be only a fraction of that size. This saves the forum server a lot of traffic (traffic is still expensive). Please keep in mind that every time someone clicks that thread it will be downloaded (which is a few thousand times a day) until your post is the 51st in the list.

Also, there are folks on the forum with a data capped internet connection. They just can't afford this massive data download.

Thanks for your understanding.
Logged

blumenkraft

  • Guest
Re: ASIF Style Guide
« Reply #14 on: August 04, 2020, 10:12:03 PM »
Quote from: blumenkraft on August 04, 2020, 10:06:39 PM
...until your post is the 51st in the list. ...

And there is one more tip for everyone who wants to save themself and the forum server data traffic. You can set the message shown per thread to 10 posts in your user settings.

To do that, click 'Profile' > 'Look and Layout' (on the left) > 'Messages to display per page:'
Logged

oren

  • First-year ice
  • Posts: 9993
    • View Profile
  • Liked: 3674
  • Likes Given: 4248
Re: ASIF Style Guide
« Reply #15 on: September 03, 2020, 05:58:25 PM »
Very good advice from SteveMDFP, cross-posted from another thread.

Quote from: SteveMDFP on September 03, 2020, 05:55:18 PM
Quote from: Freegrass on September 03, 2020, 05:18:01 PM
I did a search and nothing came up.

The built-in search function is rubbish, I'm afraid.  For future reference, Google does a better job of finding threads. E.g.,
https://www.google.com/search?q=%22melt+pond%22+physics+site%3Bforum.arctic-sea-ice.net

On the search line, one would type:
"melt pond" physics site:forum.arctic-sea-ice.net

The "site:" part is incredibly useful for restricting to a domain or site.  You can also specify, e.g., "filetype:"  And more.
Logged
Pages: [1]   Go Up
« previous next »