Discussion:
Question about documenting code and 2 paragraph formats that should appear in the same row
(too old to reply)
Caroline Tabach
2018-10-23 08:49:03 UTC
Permalink
Hi,

I am converting a Word doc with a lot of code to Frame (2017).

Some rows of code are numbered and some are indented.

Would you make another set of tags for code numbered and indented
(different font and type from body)

In addition, there are lines or paragraph where I have both code - in the
paragraph tag - "code" and regular text which should have the style body,
completely mixed in the same line

What is the best way to deal with this?

To make a new paragraph tag for the body text that is run in? (can this be
done)
Or make a character tag for the text that should not be in the "code" tag

Any other tips for documenting code?

Thanks
--
Caroline Tabach
Technical/Marcom Writer
e-mail: ***@gmail.com
_______________________________________________

This message is from the Framers mailing list

Send messages to ***@lists.frameusers.com
Visit the list's homepage at http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to ***@frameusers.com
Yves Barbion
2018-10-23 09:08:30 UTC
Permalink
Hi Caroline

I'd create a paragraph format named "codeblock" and a character format
named "codephrase", similar to what's been done in DITA:

http://docs.oasis-open.org/dita/v1.2/os/spec/langref/codeph.html#codeph

http://docs.oasis-open.org/dita/v1.2/os/spec/langref/codeblock.html#codeblock

Cheers

Yves Barbion
Post by Caroline Tabach
Hi,
I am converting a Word doc with a lot of code to Frame (2017).
Some rows of code are numbered and some are indented.
Would you make another set of tags for code numbered and indented
(different font and type from body)
In addition, there are lines or paragraph where I have both code - in the
paragraph tag - "code" and regular text which should have the style body,
completely mixed in the same line
What is the best way to deal with this?
To make a new paragraph tag for the body text that is run in? (can this be
done)
Or make a character tag for the text that should not be in the "code" tag
Any other tips for documenting code?
Thanks
--
Caroline Tabach
Technical/Marcom Writer
_______________________________________________
This message is from the Framers mailing list
Visit the list's homepage at http://www.frameusers.com
Archives located at
http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
_______________________________________________

This message is from the Framers mailing list

Send messages to ***@lists.frameusers.com
Visit the list's homepage at http://www.frameusers.com
Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to ***@frameusers.com

Continue reading on narkive:
Loading...