RE: Indicating Code Sample Line Breaks
Neil, Are the code lines individually in table cells, or are all of the lines really in a single table cell? Must be a pain if it's only one large cell... I presume each line is a separate paragraph. If not I have no idea how to automate this at all. If these are not numbered, you could include an autonumber on the RIGHT side that displays a character from the symbol or wingding families (using a defined character format tag) to illustrate the carriage return symbol, such as 0xBF in the Symbol font. Check in your 'character map' for an appropriate choice. You can set the Left indent at some value greater than the First line indent so the continuation is indented as desired. On Thursday, November 29, 2007 01:59 PM, Neil Tubb wrote: | Please help me...I'm working on an SDK programming guide, and I have | some sample code lines that are just too long. I am told I need to | indicate that the lines are breaking with some kind of an carriage | return arrow icon, and then indent the following line. | | Does anyone have any good ideas on how to do this in FrameMaker? I'm | using Frame 7.1 on Windows XP. My code samples are done in a single | table cell. | | | Thanks in advance, | Neil - Lester --- Lester C. Smalley Email: lsmalley AT infocon DOT com Information Consultants, Inc. Phone: 302-239-2942 FAX: 302-239-1712 Yorklyn, DE 19736 Web: www.infocon.com --- ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
Re: Indicating Code Sample Line Breaks
I put each line of code into a single cell -- if you're doing that, just set an indent for the subsequent lines. I've never put anything at the end of the line and never had anyone fail to understand that a hanging first line and indented following lines indicated that the line wrapped. Manually adding a special character would be possible, but a real PITA to maintain... If you had to do it, you could create a second column to the right of the code sample just wide enough for a character or two and create a paragraph tag that would generate the symbol. And then only use that character format in the cell for lines that wrap. That would still allow you to cut and paste freely in the code column. Art On Nov 29, 2007 1:59 PM, Neil Tubb [EMAIL PROTECTED] wrote: Hi all, Please help me...I'm working on an SDK programming guide, and I have some sample code lines that are just too long. I am told I need to indicate that the lines are breaking with some kind of an carriage return arrow icon, and then indent the following line. Does anyone have any good ideas on how to do this in FrameMaker? I'm using Frame 7.1 on Windows XP. My code samples are done in a single table cell. -- Art Campbell [EMAIL PROTECTED] ... In my opinion, there's nothing in this world beats a '52 Vincent and a redheaded girl. -- Richard Thompson No disclaimers apply. DoD 358 ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
RE: Indicating Code Sample Line Breaks
Oops - too hasty a reply. Autonumbering at the end of the paragraph is truly at the end - at the right side of the last line. So my suggestion won't cut it unless you create two different formats, one for the first line only w/ autonumbering, and another for subsequent lines without that is indented as desired. Art's answer suggesting a second column and dedicated paragraph format for the 'return' symbol is cleaner, and I think easier to implement and manage. On Thursday, November 29, 2007 02:14 PM, Lester C. Smalley wrote: . | If these are not numbered, you could include an autonumber on the RIGHT | side that displays a character from the symbol or wingding families | (using a defined character format tag) to illustrate the carriage return | symbol, such as 0xBF in the Symbol font. Check in your 'character map' | for an appropriate choice. - Lester --- Lester C. Smalley Email: lsmalley AT infocon DOT com Information Consultants, Inc. Phone: 302-239-2942 FAX: 302-239-1712 Yorklyn, DE 19736 Web: www.infocon.com --- ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
RE: Indicating Code Sample Line Breaks
Put the code in a cell or leave it in the body, makes no difference to the user. Code in the body of the text is easier to maintain in docs. Indent the line continuation. Do not put any character at the end of a broken line. Coders know that lines break. Non-code characters intended to visually indicate a line break will bite you. If the first word of a following line tries to jump back up to the end of the previous line, force it to the following line with invisible space(s) as needed. The point of the code sample is to present it in a manner that's acceptable to coders. -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Art Campbell Sent: Thursday, November 29, 2007 1:13 PM To: Neil Tubb Cc: [EMAIL PROTECTED] Subject: Re: Indicating Code Sample Line Breaks I put each line of code into a single cell -- if you're doing that, just set an indent for the subsequent lines. I've never put anything at the end of the line and never had anyone fail to understand that a hanging first line and indented following lines indicated that the line wrapped. Manually adding a special character would be possible, but a real PITA to maintain... If you had to do it, you could create a second column to the right of the code sample just wide enough for a character or two and create a paragraph tag that would generate the symbol. And then only use that character format in the cell for lines that wrap. That would still allow you to cut and paste freely in the code column. Art On Nov 29, 2007 1:59 PM, Neil Tubb [EMAIL PROTECTED] wrote: Hi all, Please help me...I'm working on an SDK programming guide, and I have some sample code lines that are just too long. I am told I need to indicate that the lines are breaking with some kind of an carriage return arrow icon, and then indent the following line. Does anyone have any good ideas on how to do this in FrameMaker? I'm using Frame 7.1 on Windows XP. My code samples are done in a single table cell. -- Art Campbell [EMAIL PROTECTED] ... In my opinion, there's nothing in this world beats a '52 Vincent and a redheaded girl. -- Richard Thompson No disclaimers apply. DoD 358 ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/kmcdaniel%40pavtech. com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info. ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
RE: Indicating Code Sample Line Breaks
Thanks for the replies everyone! All I was asking about was lines that wrapped...sounds like most think that simply indenting will cover it off. It was a developer that told me to put in a visual indicator...why would this bite me? Very odd. -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Kelly McDaniel Sent: Thursday, November 29, 2007 3:05 PM To: [EMAIL PROTECTED] Subject: RE: Indicating Code Sample Line Breaks Put the code in a cell or leave it in the body, makes no difference to the user. Code in the body of the text is easier to maintain in docs. Indent the line continuation. Do not put any character at the end of a broken line. Coders know that lines break. Non-code characters intended to visually indicate a line break will bite you. If the first word of a following line tries to jump back up to the end of the previous line, force it to the following line with invisible space(s) as needed. The point of the code sample is to present it in a manner that's acceptable to coders. -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Art Campbell Sent: Thursday, November 29, 2007 1:13 PM To: Neil Tubb Cc: [EMAIL PROTECTED] Subject: Re: Indicating Code Sample Line Breaks I put each line of code into a single cell -- if you're doing that, just set an indent for the subsequent lines. I've never put anything at the end of the line and never had anyone fail to understand that a hanging first line and indented following lines indicated that the line wrapped. Manually adding a special character would be possible, but a real PITA to maintain... If you had to do it, you could create a second column to the right of the code sample just wide enough for a character or two and create a paragraph tag that would generate the symbol. And then only use that character format in the cell for lines that wrap. That would still allow you to cut and paste freely in the code column. Art On Nov 29, 2007 1:59 PM, Neil Tubb [EMAIL PROTECTED] wrote: Hi all, Please help me...I'm working on an SDK programming guide, and I have some sample code lines that are just too long. I am told I need to indicate that the lines are breaking with some kind of an carriage return arrow icon, and then indent the following line. Does anyone have any good ideas on how to do this in FrameMaker? I'm using Frame 7.1 on Windows XP. My code samples are done in a single table cell. -- Art Campbell [EMAIL PROTECTED] ... In my opinion, there's nothing in this world beats a '52 Vincent and a redheaded girl. -- Richard Thompson No disclaimers apply. DoD 358 ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/kmcdaniel%40pavtech. com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info. ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/neil.tubb%40solacesy stems.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info. ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
RE: Indicating Code Sample Line Breaks
Where you insert hidden a CR/LF, if the user expands their window, the break is maintained. Where you insert a visible CRLF (just for example) and the user expands their window, the wrapped line rejoins the previous line and includes the visible line break indicator, which is not part of the code. -Original Message- From: Neil Tubb [mailto:[EMAIL PROTECTED] Sent: Thursday, November 29, 2007 2:10 PM To: Kelly McDaniel; [EMAIL PROTECTED] Subject: RE: Indicating Code Sample Line Breaks Thanks for the replies everyone! All I was asking about was lines that wrapped...sounds like most think that simply indenting will cover it off. It was a developer that told me to put in a visual indicator...why would this bite me? Very odd. -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Kelly McDaniel Sent: Thursday, November 29, 2007 3:05 PM To: [EMAIL PROTECTED] Subject: RE: Indicating Code Sample Line Breaks Put the code in a cell or leave it in the body, makes no difference to the user. Code in the body of the text is easier to maintain in docs. Indent the line continuation. Do not put any character at the end of a broken line. Coders know that lines break. Non-code characters intended to visually indicate a line break will bite you. If the first word of a following line tries to jump back up to the end of the previous line, force it to the following line with invisible space(s) as needed. The point of the code sample is to present it in a manner that's acceptable to coders. -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Art Campbell Sent: Thursday, November 29, 2007 1:13 PM To: Neil Tubb Cc: [EMAIL PROTECTED] Subject: Re: Indicating Code Sample Line Breaks I put each line of code into a single cell -- if you're doing that, just set an indent for the subsequent lines. I've never put anything at the end of the line and never had anyone fail to understand that a hanging first line and indented following lines indicated that the line wrapped. Manually adding a special character would be possible, but a real PITA to maintain... If you had to do it, you could create a second column to the right of the code sample just wide enough for a character or two and create a paragraph tag that would generate the symbol. And then only use that character format in the cell for lines that wrap. That would still allow you to cut and paste freely in the code column. Art On Nov 29, 2007 1:59 PM, Neil Tubb [EMAIL PROTECTED] wrote: Hi all, Please help me...I'm working on an SDK programming guide, and I have some sample code lines that are just too long. I am told I need to indicate that the lines are breaking with some kind of an carriage return arrow icon, and then indent the following line. Does anyone have any good ideas on how to do this in FrameMaker? I'm using Frame 7.1 on Windows XP. My code samples are done in a single table cell. -- Art Campbell [EMAIL PROTECTED] ... In my opinion, there's nothing in this world beats a '52 Vincent and a redheaded girl. -- Richard Thompson No disclaimers apply. DoD 358 ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/kmcdaniel%40pavtech. com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info. ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/neil.tubb%40solacesy stems.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info. ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
Re: Indicating Code Sample Line Breaks
And also, if they're using a PDF, it screws up the ability to cut-and-paste a line if they want to. Art On Nov 29, 2007 3:09 PM, Neil Tubb [EMAIL PROTECTED] wrote: Thanks for the replies everyone! All I was asking about was lines that wrapped...sounds like most think that simply indenting will cover it off. It was a developer that told me to put in a visual indicator...why would this bite me? Very odd. -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Kelly McDaniel Sent: Thursday, November 29, 2007 3:05 PM To: [EMAIL PROTECTED] Subject: RE: Indicating Code Sample Line Breaks Put the code in a cell or leave it in the body, makes no difference to the user. Code in the body of the text is easier to maintain in docs. Indent the line continuation. Do not put any character at the end of a broken line. Coders know that lines break. Non-code characters intended to visually indicate a line break will bite you. If the first word of a following line tries to jump back up to the end of the previous line, force it to the following line with invisible space(s) as needed. The point of the code sample is to present it in a manner that's acceptable to coders. -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Art Campbell Sent: Thursday, November 29, 2007 1:13 PM To: Neil Tubb Cc: [EMAIL PROTECTED] Subject: Re: Indicating Code Sample Line Breaks I put each line of code into a single cell -- if you're doing that, just set an indent for the subsequent lines. I've never put anything at the end of the line and never had anyone fail to understand that a hanging first line and indented following lines indicated that the line wrapped. Manually adding a special character would be possible, but a real PITA to maintain... If you had to do it, you could create a second column to the right of the code sample just wide enough for a character or two and create a paragraph tag that would generate the symbol. And then only use that character format in the cell for lines that wrap. That would still allow you to cut and paste freely in the code column. Art On Nov 29, 2007 1:59 PM, Neil Tubb [EMAIL PROTECTED] wrote: Hi all, Please help me...I'm working on an SDK programming guide, and I have some sample code lines that are just too long. I am told I need to indicate that the lines are breaking with some kind of an carriage return arrow icon, and then indent the following line. Does anyone have any good ideas on how to do this in FrameMaker? I'm using Frame 7.1 on Windows XP. My code samples are done in a single table cell. -- Art Campbell [EMAIL PROTECTED] ... In my opinion, there's nothing in this world beats a '52 Vincent and a redheaded girl. -- Richard Thompson No disclaimers apply. DoD 358 -- Art Campbell [EMAIL PROTECTED] ... In my opinion, there's nothing in this world beats a '52 Vincent and a redheaded girl. -- Richard Thompson No disclaimers apply. DoD 358 ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
RE: Indicating Code Sample Line Breaks
Neil Tubb wrote: It was a developer that told me to put in a visual indicator. Of course. This is a new low, though... I mean, you expect programmers to be incapable of putting themselves in their users' shoes, but this one can't even put himself in his OWN shoes. I doubt that he's ever seen code samples formatted with carriage-return arrow icons to indicate wrapped lines, and I KNOW he'd be annoyed if those arrow symbols were embedded in text he tried to copy-and-paste from code samples... Yet he came up with this boneheaded idea anyway. As others have said, indentation alone will usually be enough to indicate to your readers that a long line has wrapped. If the code samples themselves contain multiple levels of indentation, you may need to slightly adjust your vertical spacing so that the pieces of a wrapped line are grouped more tightly than unwrapped lines. And... If a visual wrapped-line indicator MUST be included, it'd be best to use whatever character the programming language uses (e.g., backslash for C or C++), so the code has a chance of working if your reader copies it straight from the docs into his or her program. -Andrew === Andrew Warren - [EMAIL PROTECTED] === Synaptics, Inc - Santa Clara, CA ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
