Common Importing Problems: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
(New page: ==Things to watch out for== ===Missing equations and/or figures=== None of our images or equations will have been imported. Compare the page to the existing reference * Options or Descr...)
 
imported>Jeremy
No edit summary
Line 1: Line 1:
==Things to watch out for==
Some of the things to watch out for:


===Missing equations and/or figures===
===Missing equations and/or figures===
None of our images or equations will have been imported. Compare the page to the existing reference  
None of our images or equations will have been imported. Compare the page to the existing reference  


* Options or Description lines which got converted into bulleted, bolded format (as if they were an option or input description):
===Munged Options or Description lines===
**'''In''' the case of an error, this function will return an empty array.
Some options and description text lines got converted into bulleted, bolded format (as if they were an option or input description):
::<nowiki>*'''In''' the case of an error, this function will return an empty array.</nowiki>
*'''In''' the case of an error, this function will return an empty array.
:<nowiki>*'''In''' the case of an error, this function will return an empty array.</nowiki>


:'''SOLUTION''': remove <tt>*</tt> and <tt><nowiki>'''</nowiki></tt> markup.
'''SOLUTION''': remove <tt>*</tt> and <tt><nowiki>'''</nowiki></tt> markup.


* Code segments with broken up lines
===Broken-up Code Segments===
  peakdef = peakstruct('',3);
  peakdef = peakstruct('',3);


Line 17: Line 18:
  peakdef(2) = peakstruct('PVoigt1');
  peakdef(2) = peakstruct('PVoigt1');


:'''SOLUTION''': remove blank lines between code lines
'''SOLUTION''': remove blank lines between code lines
      
      
* Example segments using : indenting instead of prefix of spaces or "pre" tags
===Wrongly Formatted Example Segments===
Example segments using : indenting instead of prefix of spaces or "pre" tags
<pre>
<pre>
     ===Examples===
     ===Examples===
Line 26: Line 28:
     :peakdef(2) = peakstruct('PVoigt1');
     :peakdef(2) = peakstruct('PVoigt1');
</pre>
</pre>
:'''SOLUTION''': delete : and convert to &lt;pre&gt; tags
'''SOLUTION''': delete : and convert to &lt;pre&gt; tags

Revision as of 12:54, 9 September 2008

Some of the things to watch out for:

Missing equations and/or figures

None of our images or equations will have been imported. Compare the page to the existing reference

Munged Options or Description lines

Some options and description text lines got converted into bulleted, bolded format (as if they were an option or input description):

  • In the case of an error, this function will return an empty array.
*'''In''' the case of an error, this function will return an empty array.

SOLUTION: remove * and ''' markup.

Broken-up Code Segments

peakdef = peakstruct(,3);
disp(peakdef(2))
peakdef(2) = peakstruct('PVoigt1');

SOLUTION: remove blank lines between code lines

Wrongly Formatted Example Segments

Example segments using : indenting instead of prefix of spaces or "pre" tags

     ===Examples===
     :peakdef = peakstruct('',3);
     :disp(peakdef(2))
     :peakdef(2) = peakstruct('PVoigt1');

SOLUTION: delete : and convert to <pre> tags