Common Importing Problems: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
imported>Jeremy
Line 1: Line 1:
Some of the 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 manual entry ("doc <functionname>" will open the HTML page). Images are all stored in the PLS_Toolbox/help folder.
None of our images or equations will have been imported. Compare the page to the existing reference manual entry ("doc <functionname>" will open the HTML page). Images are all stored in the PLS_Toolbox/help folder.



Revision as of 12:57, 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 manual entry ("doc <functionname>" will open the HTML page). Images are all stored in the PLS_Toolbox/help folder.

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