Microdown icon indicating copy to clipboard operation
Microdown copied to clipboard
verified publisher icon pillar-markup

help class contents into comment

Open Ducasse opened this issue 3 years ago • 2 comments

We can paste this into a class comment (when we can browse class comments again).

This application helps to tweak the design settings of your Microdown document(s), with a selection of beautiful CSS themes. It also provides options to configure the exported HTML document, and to preview the results. You can also export the HTML without any style, and build your own custom design from scratch.'

Output file name: The exported HTML file name. If not specified, then index.html will be used.

Output folder: Exported files will be written in the specified directory. If does not exists, it will be created.

Overwrite option. When checked, it will overwrite previously exported HTML files and its parent directory (the output folder) without confirmation.

'HTML validation requires the DOCTYPE declaration. If the web page coding does not include a DOCTYPE Declaration (DTD or Document Type Declaration) or it is done incorrectly, you will not be able to use a HTML (HyperText Markup Language) Validator to check the page coding.

Types of DTD:

  • Strict DTD: Used for web pages that exclude attributes and elements that W3C expects to phase out as CSS support grows
  • Transitional DTD: Used for web pages that include attributes and elements that W3C expects to phase out as CSS support grows
  • Frameset DTD: Used for web pages with frames

XHTML Versions

  • In XHTML 1.1 document type definition (DTD), allows the addition of modules.
  • In XHTML 1.0 Frameset: In XHTML 1.0 Frameset document type definition (DTD), framesets can be used.
  • XHTML 1.0 Transitional: In XHTML 1.0 Transitional document type definition (DTD), deprecated elements are allowed.
  • XHTML 1.0 Strict: In XHTML 1.0 Strict document type definition (DTD), deprecated tags are not supported and the code must be written according to the XML Specification.

HTML Versions

  • HTML 4.01 Frameset: In HTML 4.01 Frameset document type definition (DTD),Frames can be used.
  • HTML 4.01 Transitional: In HTML 4.01 Transitional document type definition (DTD) allows some older PUBLIC and attributes that have been deprecated.
  • HTML 4.01 Strict: In HTML 4.01 Strict document type definition (DTD) all those elements and attributes are included that do not appear in frameset documents or that have not been deprecated.

Embedded style sheets allows one to define style sheet information into an HTML document as a whole in one place. This enables to deliver style specific to one page or during testing purposes. This is useful also if you want to isolate a web page from other (linked) resources.

Ducasse avatar Dec 03 '22 19:12 Ducasse

I am unfortunately still hit on my reading, so I might have misunderstood something there. I just wanted to point out that there are a number of URL which is currently understood by Microdown, in particular:

  • MicPharoImageResourceReference (pharo:/class/selector/arg1/arg2) - which can be used for both images and MD, but is called Image by history.

In the document browser, there is also:

  • MicPharoClassCommentResourceReference (comment://class/className)
  • MicPharoPackageCommentResourceReference (comment://package/categoryName) These are particular useful in combination with <!inputFile|path="one of the above"!>, it allow contents to be drawn from class methods and to combine class methods into a document.

kasperosterbye avatar Dec 04 '22 10:12 kasperosterbye

Hi kasper

I removed the help class and I just move the 3 paragraphs here because in P11 I cannot see class comments anymore.

S

Ducasse avatar Dec 04 '22 11:12 Ducasse