TUTORIAL: how to format your question with markup

Asked by Oleg Komarov on 6 Aug 2011

Latest activity Edited by madhan ravi on 12 Nov 2018

1,326 views (last 30 days)

[INDEX]

--------------------------------------------------------------------------------------------------------------------------------------

[MOTIVATION]

Why should we use markups in the body of our questions?

The answer is a question: which of the two versions is more likely to be understood in a glimpse and has more chances to be answered by our readers?

< Consider the following question >

I have a vector of weights W=[10,20,30,50,23434,1,2.4,2] and a matrix A=rand(100,8) and I would like to find the row-wise weighted sum of A. I am proceeding in the following way: B=zeros(size(A)); for c=1:numel(W) B(:,c)=A(:,c)*W(c); end B=sum(B,2); Somehow I get huge numbers can you please help?

< Now, consider its formatted version >

I have a vector of weights W = [10,20,30,50,23434,1,2.4,2] and a matrix A = rand(100,8) and I would like to find the row-wise weighted sum of A.

I am proceeding in the following way:

B = zeros(size(A));
for c = 1:numel(W)
    B(:,c) = A(:,c)*W(c);
end
B = sum(B,2);

Somehow I get huge numbers can you please help?

--------------------------------------------------------------------------------------------------------------------------------------

[AKNOWLEDGMENTS]

In alphabetical order by nickname, thanks for their suggestions to:

Walter Roberson

--------------------------------------------------------------------------------------------------------------------------------------

[LOG]

06 Aug 2011, 13:17 BST - created and added boldface.gif
06 Aug 2011, 14:59 BST - added italic.gif
06 Aug 2011, 18:58 BST - added index section
07 Aug 2011, 00:03 BST - added code.gif and tutorial series section
07 Aug 2011, 01:50 BST - added monospaced.gif, numlist.gif, bullist.gif and hyperlink.gif
13 Aug 2011, 14:27 BST - added motivation section
18 Aug 2011, 01:44 BST - added aknowledgments section and link to wish-list

--------------------------------------------------------------------------------------------------------------------------------------

[TUTORIAL Series]

How to ask a question (on Answers) and get a fast answer

Do not forget to read the Markup help (located on the top-right corner of the Body pane)

Vote on Wish-list for MATLAB Answer sections my post if you think that a tutorial section on top of Answers could be useful.

14 Comments

Show 11 older comments

Sean de Wolski on 18 Oct 2012

Me too.

Ryan on 18 Oct 2012

@Elige: Yes... the first two used tinypic the latter used uploadhouse. I uploaded the first two .gif's to uploadhouse for you.

Walter Roberson on 16 Apr 2018

That is not relevant to this discussion. You should ask your own Question about it.

8 Answers

Link

Answer by Oleg Komarov on 7 Aug 2011

CODE

4 Comments

Show 1 older comment

Image Analyst on 10 May 2014

Another tip: please, please, please indent your code in MATLAB correctly first, before pasting it in.

To do this highlight your code in the MATLAB editor (for example type "Ctrl a" to select all the text in the editor), then type "Ctrl i". This "fixes/standardizes" your indentations. Then , paste your code in, and then click the "{} Code" icon. DO NOT CLICK "{} Code" before you paste in your code. That will not work.

Trude Mashburn on 12 Jun 2018

I updated my question and content based on your instructions. However, the code is not showing in this application as I had it formatted.

Stephen Cobeldick on 12 Jun 2018

@Trude Mashburn: I just checked your question, and none of the code text has been indented.

Select the code text
Click the {} Code button
Ensure that there is a trailing empty line
Check the formatting in the preview pane, make changes as required.
Click Submit to save the new formatting.

An alternative to using the {} Code button is to simply put two space characters at the start of each code line.

Link

Answer by Oleg Komarov on 6 Aug 2011

BOLDFACE

1 Comment

Walter Roberson on 10 Aug 2011

Note: the bold mode only works between pairs of * in the same paragraph. If you highlight several paragraphs (with empty lines between them) and click on the Bold button, although an * will be put on the first line and last line of the selection, the bold will "break" because of the empty lines.

Link

Answer by Oleg Komarov on 6 Aug 2011

Edited by Oleg Komarov on 8 Aug 2013

ITALIC

1 Comment

Walter Roberson on 10 Aug 2011

Note: the italic mode only works between pairs of underscores in the same paragraph. If you highlight several paragraphs (with empty lines between them) and click on the Italic button, although an underscore will be put on the first line and last line of the selection, the italics will "break" because of the empty lines.

Link

Answer by Oleg Komarov on 7 Aug 2011

MONOSPACED

1 Comment

Walter Roberson on 12 Aug 2011

Note: the monospaced mode only works between pairs of bars in the same paragraph. If you highlight several paragraphs (with empty lines between them) and click on the monospace button, although an bar will be put on the first line and last line of the selection, the monospace will "break" because of the empty lines.

Link

Answer by Oleg Komarov on 7 Aug 2011

NUMBERED LIST

3 Comments

Walter Roberson on 7 Aug 2011

Note: here must be a blank line before and after the # list

Walter Roberson on 8 Aug 2011

Note: there must be a space after the #

Walter Roberson on 12 Aug 2011

Note: the numbering sequence restarts at each empty line, so do _not_ put blank lines between the portions.

Note: the # must be after a "real" line break, where carriage return was typed at the end of the previous line; it is not sufficient to put it at what looks like the beginning of a line, if the line has been automatically wrapped down from the previous line.

Link

Answer by Oleg Komarov on 7 Aug 2011

BULLETED LIST

3 Comments

Walter Roberson on 7 Aug 2011

Note: there must be a blank line before and after the * list.

Walter Roberson on 8 Aug 2011

Note: there must be a space after the *

Walter Roberson on 12 Aug 2011

Note: the * must be after a "real" line break, where carriage return was typed at the end of the previous line; it is not sufficient to put it at what looks like the beginning of a line, if the line has been automatically wrapped down from the previous line.

Link

Answer by Oleg Komarov on 7 Aug 2011

HYPERLINK

1 Comment

Walter Roberson on 7 Aug 2011

Simple hyperlinks are not converted automatically by the site: that is being done by browsers.

Note: ensure that there is no whitespace space immediately after the < or immediately before the > or else the link will not be created.

Note: there must be whitespace (or beginning of line) immediately before the < or else the link will not be created. In particular, some people like to put links in brackets such as (<some link or other>) and that will not work because there must be a space before the < .

Link

Answer by Image Analyst on 13 Aug 2016

Edited by Image Analyst on 13 Aug 2016

To insert an image into the body of your post, click this icon:

and either browse to a file on your computer, or specify a URL of an image on the web.

You might find it easy to use http://snag.gy. You can just type alt-PrintScreen (in Windows) to capture the active window into the clipboard. Then go to this web site and type control-v to paste it in. You can then crop if it you want. It gives you a URL that you can then paste into the URL field you see when you click the green and brown frame icon:

You can also use the paper clip icon to attach an image file to your post, but it will not be displayed. It will appear as a filename beneath your text. We would then have to right click that filename and save it to our computer, and then open the image in MATLAB or some other image file viewer. This is less convenient for readers because they can't see your picture immediately.

6 Comments

Show 3 older comments

madhan ravi on 11 Nov 2018

Click the green and brown frame icon to insert the image into the body of the message.

I did it but still it displays as a file , does it have to do anything with the image format because it's a screenshot?

Image Analyst on 11 Nov 2018

After you click Insert Image, try putting a blank line before the < < and a blank line after the > >.

madhan ravi on 11 Nov 2018

Thank you sir Image Analyst it turned out only jpg format can be viewed directly

You are now following this question