java.lang.Object
- edu.uiuc.ncsa.security.util.help.MarkdownConverter

```
public class MarkdownConverter
extends Object
```
A command line tool that will take a help file and turn it into a Github style markdown document. This is very simple minded. Very! The interactive help is definitive, not the markdown.
Created by Jeff Gaynor
on 2/9/23 at 4:56 PM

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`INPUT_SWITCH`
`static String`	`MD_LINE_BREAK`
`static String`	`OUTPUT_SWITCH`
`static int`	`RC_FAIL`
`static int`	`RC_HELP`
`static int`	`RC_OK`
`static String`	`RESOURCE_SWITCH`
`static String`	`VERBOSE_SWITCH`

Constructor Summary

Constructors
Constructor Description

MarkdownConverter()

MarkdownConverter(InputLine inputLine)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`convert()`
`protected void`	`convertEntry(String name, String altName, String content, String examples)`
`HelpUtil`	`getHelpUtil()`
`PrintStream`	`getOutput()`
`protected int`	`init(InputLine inputLine)`
`protected int`	`init(List<String> resources, List<String> inFiles, String outFile, boolean isVerbose)`
`boolean`	`isSysOut()`
`static void`	`main(String[] args)`
`protected void`	`say()`	Prints a blank line
`protected void`	`say(String x)`
`void`	`setHelpUtil(HelpUtil helpUtil)`
`void`	`setOutput(PrintStream output)`
`void`	`setSysOut(boolean sysOut)`
`protected void`	`showHelp()`
`protected List<String>`	`toList(String x)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INPUT_SWITCH
```
public static String INPUT_SWITCH
```

RESOURCE_SWITCH
```
public static String RESOURCE_SWITCH
```

OUTPUT_SWITCH
```
public static String OUTPUT_SWITCH
```

VERBOSE_SWITCH
```
public static String VERBOSE_SWITCH
```

RC_OK
```
public static int RC_OK
```

RC_FAIL
```
public static int RC_FAIL
```

RC_HELP
```
public static int RC_HELP
```

MD_LINE_BREAK
```
public static String MD_LINE_BREAK
```

Constructor Detail

MarkdownConverter

public MarkdownConverter(InputLine inputLine)

MarkdownConverter
```
public MarkdownConverter()
```

Method Detail

main

public static void main(String[] args)
                 throws Throwable

Throws:: Throwable

toList

protected List<String> toList(String x)

init

protected int init(InputLine inputLine)

init

protected int init(List<String> resources,
                   List<String> inFiles,
                   String outFile,
                   boolean isVerbose)

isSysOut
```
public boolean isSysOut()
```

setSysOut

public void setSysOut(boolean sysOut)

getOutput
```
public PrintStream getOutput()
```

setOutput

public void setOutput(PrintStream output)

say
```
protected void say()
```
Prints a blank line

say
```
protected void say(String x)
```

showHelp
```
protected void showHelp()
```

getHelpUtil
```
public HelpUtil getHelpUtil()
```

setHelpUtil

public void setHelpUtil(HelpUtil helpUtil)

convertEntry

protected void convertEntry(String name,
                            String altName,
                            String content,
                            String examples)

convert
```
protected void convert()
```

Constructor	Description
`MarkdownConverter()`
`MarkdownConverter(InputLine inputLine)`

Class MarkdownConverter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INPUT_SWITCH

RESOURCE_SWITCH

OUTPUT_SWITCH

VERBOSE_SWITCH

RC_OK

RC_FAIL

RC_HELP

MD_LINE_BREAK

Constructor Detail

MarkdownConverter

MarkdownConverter

Method Detail

main

toList

init

init

isSysOut

setSysOut

getOutput

setOutput

say

say

showHelp

getHelpUtil

setHelpUtil

convertEntry

convert