[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: RE: [dita-adoption-fasc] DITA XML.org topic page idea: Best practices for writing topics for delivery as HTML and PDF
Thanks Carol. I have no strong opinions, but a few general thoughts: - Writers should be bold in adding things to the wiki (http://en.wikipedia.org/wiki/Be_bold_in_editing_articles). I think our philosophy at least for ourselves as an editorial board, if not the rest of the world, is that if you think a writing task is worth your own effort, you should feel free to do it. - Taking ideas from newsgroups is good, however doing a direct copy/paste can violate copyright even if attribution is given. - When people ask me things like "What is DTD and DITA?" I point them to the Wikipedia articles on "DTD" and on "DITA". In order to give a useful answer to this question you have to reframe it into two separate questions: What is a DTD? and What is DITA? These two questions are meaningful separately, but I think it would only prolong the confusion if we try to answer them in one article. Cheers, Su-Laine Su-Laine Yeo Interaction Design Specialist JustSystems Canada, Inc. Office: 778-327-6356 syeo@justsystems.com http://na.justsystems.com -----Original Message----- From: Carol Geyer [mailto:carol.geyer@oasis-open.org] Sent: Monday, February 09, 2009 8:10 AM To: dita-adoption-fasc@lists.oasis-open.org Subject: [dita-adoption-fasc] DITA XML.org topic page idea: Best practices for writing topics for delivery as HTML and PDF DITA XML.org SC, Some threads on dita-users@yahoo lend themselves to becoming topic pages on the DITA XML.org wiki knowledgebase. We've done this is the past; for example, "Migrating legacy content" [1] is a compilation of several yahoo posts. Would the "Best practices for writing topics for delivery as HTML and PDF" (below) make a good wiki topic page? If so, we could create a new wiki page and excerpt/summarize what's been posted on the list, crediting the authors. Then we could notify the dita-users list that the page is there and invite others to add/edit the page. The other recent yahoo thread I thought worth considering is "What is DTD and DITA". Carol [1] http://dita.xml.org/wiki/migrating-legacy-content -----Original Message----- From: dita-users@yahoogroups.com [mailto:dita-users@yahoogroups.com] On Behalf Of Patrick Quinlan Sent: Monday, February 09, 2009 10:21 AM To: dita-users@yahoogroups.com Subject: RE: [dita-users] Re: Best practices for writing topics that may be delivered as HTML and PDF Hi Sowmya, I second Julio's suggestion. We create quite a few topics that are output to both PDF and HTML, and use conditional text to indicate, for example, images that are in different resolutions for each output. Beyond this, try to make sure that your content is as succinct as possible. Generally speaking, if you write content as though it is going online, it will remain effective in print. However, if you write content for print (which tends to be more long-winded) it is not as effective when put online. In my experience, doing so takes some getting used to for authors who've been writing print content for a while. We happen to use XMetaL, so I'm not sure if other tools have these features, but we added the conditional text to XMetaL's config file, and color coded the conditions. That way when someone opens a file, it is easy to see how much conditional text there is, and what content is meant for which output. For some of our deliverables, we set conditions on topicrefs in the map. Sometimes it is easier to make entire topics conditional, instead of including a bunch of "print" text followed by a bunch of "online" text. Figuring out how much conditional text is too much for one topic is completely subjective, of course. Lastly, authors need to understand that text that is not set to a condition will appear in both outputs. HTH, Patrick From: dita-users@yahoogroups.com [mailto:dita-users@yahoogroups.com] On Behalf Of Julio Vaquez Sent: Monday, February 09, 2009 8:45 AM To: dita-users@yahoogroups.com Subject: [dita-users] Re: Best practices for writing topics that may be delivered as HTML and PDF Hi Sowmya, If you are creating a single topic to source both HTML and PDF, you probably want to set an attribute value to express that specifically and then filter the information such that when processing for HTML the object is presented but when processing for PDF you display some text. HTH, Julio J. Vazquez SDI --- In dita-users@yahoogroups.com <mailto:dita-users%40yahoogroups.com> , "sowmya_k" <Sowmya_k@...> wrote: > > Hi, > Are there any best practices / guidelines for content that may be > delivered as HTML and PDF? > For e.g. it would be better to not include object tags to run applets, > flash objects etc. directly in the topic. Topics with object tags may > not be suitable for pdf outputs. > > How do we handle such cases? Should we include conditional text based > on type of output? What are some other cases to watch out for? > > Thanks > Sowmya > __._,_.___ Messages in this topic <http://groups.yahoo.com/group/dita-users/message/13150;_ylc=X3oDMTM3aHN xa GJkBF9TAzk3MzU5NzE0BGdycElkAzEyNzQ0MjA5BGdycHNwSWQDMTcwNjAzMDM5MARtc2dJZ AM xMzE1NQRzZWMDZnRyBHNsawN2dHBjBHN0aW1lAzEyMzQxOTI4OTMEdHBjSWQDMTMxNTA-> ( xMzE1NQRzZWMDZnRyBHNsawN2dHBjBHN0aW1lAzEyMzQxOTI4OTMEdHBjSWQDMTMxNTA-> 3 xMzE1NQRzZWMDZnRyBHNsawN2dHBjBHN0aW1lAzEyMzQxOTI4OTMEdHBjSWQDMTMxNTA-> ) Reply (via web post) <http://groups.yahoo.com/group/dita-users/post;_ylc=X3oDMTJycjBuMHAyBF9T Az k3MzU5NzE0BGdycElkAzEyNzQ0MjA5BGdycHNwSWQDMTcwNjAzMDM5MARtc2dJZAMxMzE1NQ Rz ZWMDZnRyBHNsawNycGx5BHN0aW1lAzEyMzQxOTI4OTM-?act=reply&messageNum=13155> | Start a new topic <http://groups.yahoo.com/group/dita-users/post;_ylc=X3oDMTJmcWx2ODJoBF9T Az k3MzU5NzE0BGdycElkAzEyNzQ0MjA5BGdycHNwSWQDMTcwNjAzMDM5MARzZWMDZnRyBHNsaw Nu dHBjBHN0aW1lAzEyMzQxOTI4OTM-> Messages <http://groups.yahoo.com/group/dita-users/messages;_ylc=X3oDMTJmMTc4dGJl BF 9TAzk3MzU5NzE0BGdycElkAzEyNzQ0MjA5BGdycHNwSWQDMTcwNjAzMDM5MARzZWMDZnRyBH Ns awNtc2dzBHN0aW1lAzEyMzQxOTI4OTM-> | Files <http://groups.yahoo.com/group/dita-users/files;_ylc=X3oDMTJnbml1bGNxBF9 TA zk3MzU5NzE0BGdycElkAzEyNzQ0MjA5BGdycHNwSWQDMTcwNjAzMDM5MARzZWMDZnRyBHNsa wN maWxlcwRzdGltZQMxMjM0MTkyODkz> | Photos <http://groups.yahoo.com/group/dita-users/photos;_ylc=X3oDMTJmYnF1NGVpBF 9T Azk3MzU5NzE0BGdycElkAzEyNzQ0MjA5BGdycHNwSWQDMTcwNjAzMDM5MARzZWMDZnRyBHNs aw NwaG90BHN0aW1lAzEyMzQxOTI4OTM-> | Links <http://groups.yahoo.com/group/dita-users/links;_ylc=X3oDMTJnOXU5Y2N1BF9 TA zk3MzU5NzE0BGdycElkAzEyNzQ0MjA5BGdycHNwSWQDMTcwNjAzMDM5MARzZWMDZnRyBHNsa wN saW5rcwRzdGltZQMxMjM0MTkyODkz> | Database <http://groups.yahoo.com/group/dita-users/database;_ylc=X3oDMTJkNzIxOTJm BF 9TAzk3MzU5NzE0BGdycElkAzEyNzQ0MjA5BGdycHNwSWQDMTcwNjAzMDM5MARzZWMDZnRyBH Ns awNkYgRzdGltZQMxMjM0MTkyODkz> | Polls <http://groups.yahoo.com/group/dita-users/polls;_ylc=X3oDMTJnZHNzZmxjBF9 TA zk3MzU5NzE0BGdycElkAzEyNzQ0MjA5BGdycHNwSWQDMTcwNjAzMDM5MARzZWMDZnRyBHNsa wN wb2xscwRzdGltZQMxMjM0MTkyODkz> | Members <http://groups.yahoo.com/group/dita-users/members;_ylc=X3oDMTJmaXRnNjduB F9 TAzk3MzU5NzE0BGdycElkAzEyNzQ0MjA5BGdycHNwSWQDMTcwNjAzMDM5MARzZWMDZnRyBHN sa wNtYnJzBHN0aW1lAzEyMzQxOTI4OTM-> MARKETPLACE ________________________________ From kitchen basics to easy recipes - join the Group from Kraft Foods <http://us.ard.yahoo.com/SIG=13r4gr0nj/M=493064.12016295.13271503.108355 68 /D=groups/S=1706030390:MKP1/Y=YAHOO/EXP=1234200093/L=/B=MeqtAUPDhE4-/J=1 23 4192893630988/A=5530388/R=0/SIG=11nuutlas/*http://explore.yahoo.com/grou ps /kraftmealsmadesimple/> Yahoo! Groups <http://groups.yahoo.com/;_ylc=X3oDMTJlMjlxbmMxBF9TAzk3NDc2NTkwBGdycElkA zE yNzQ0MjA5BGdycHNwSWQDMTcwNjAzMDM5MARzZWMDZnRyBHNsawNnZnAEc3RpbWUDMTIzNDE 5M jg5Mw--> Change settings via the Web <http://groups.yahoo.com/group/dita-users/join;_ylc=X3oDMTJnY2NsY21tBF9T Az k3NDc2NTkwBGdycElkAzEyNzQ0MjA5BGdycHNwSWQDMTcwNjAzMDM5MARzZWMDZnRyBHNsaw Nz dG5ncwRzdGltZQMxMjM0MTkyODkz> (Yahoo! ID required) Change settings via email: Switch delivery to Daily Digest <mailto:dita-users-digest@yahoogroups.com?subject=Email Delivery: Digest> | Switch format to Traditional <mailto:dita-users-traditional@yahoogroups.com?subject=Change Delivery Format: Traditional> Visit Your Group <http://groups.yahoo.com/group/dita-users;_ylc=X3oDMTJlZzY4bzEzBF9TAzk3N Dc 2NTkwBGdycElkAzEyNzQ0MjA5BGdycHNwSWQDMTcwNjAzMDM5MARzZWMDZnRyBHNsawNocGY Ec 3RpbWUDMTIzNDE5Mjg5Mw--> | Yahoo! Groups Terms of Use <http://docs.yahoo.com/info/terms/> | Unsubscribe <mailto:dita-users-unsubscribe@yahoogroups.com?subject=> Recent Activity * 15 New Members <http://groups.yahoo.com/group/dita-users/members;_ylc=X3oDMTJnYWo5aXJvB F9 TAzk3MzU5NzE0BGdycElkAzEyNzQ0MjA5BGdycHNwSWQDMTcwNjAzMDM5MARzZWMDdnRsBHN sa wN2bWJycwRzdGltZQMxMjM0MTkyODkz> Visit Your Group <http://groups.yahoo.com/group/dita-users;_ylc=X3oDMTJmc2g5bGJnBF9TAzk3M zU 5NzE0BGdycElkAzEyNzQ0MjA5BGdycHNwSWQDMTcwNjAzMDM5MARzZWMDdnRsBHNsawN2Z2h wB HN0aW1lAzEyMzQxOTI4OTM-> Yahoo! Finance It's Now Personal <http://us.ard.yahoo.com/SIG=13ovs0efj/M=493064.12016257.12445664.867457 8/ D=groups/S=1706030390:NC/Y=YAHOO/EXP=1234200093/L=/B=MuqtAUPDhE4-/J=1234 19 2893630988/A=4507179/R=0/SIG=12de4rskk/*http://us.rd.yahoo.com/evt=50284 /* http://finance.yahoo.com/personal-finance> Guides, news, advice & more. Need traffic? Drive customers <http://us.ard.yahoo.com/SIG=13o3gj5vq/M=493064.12016308.12445700.867457 8/ D=groups/S=1706030390:NC/Y=YAHOO/EXP=1234200093/L=/B=M.qtAUPDhE4-/J=1234 19 2893630988/A=3848644/R=0/SIG=131l83flq/*http://searchmarketing.yahoo.com /a rp/srchv2.php?o=US2006&cmp=Yahoo&ctv=Groups5&s=Y&s2=&s3=&b=50> With search ads on Yahoo! Yahoo! Groups Stay healthy <http://us.ard.yahoo.com/SIG=13opkc5n0/M=493064.12662708.12980600.867457 8/ D=groups/S=1706030390:NC/Y=YAHOO/EXP=1234200093/L=/B=NOqtAUPDhE4-/J=1234 19 2893630988/A=5349274/R=0/SIG=11nhsqmjq/*http://advision.webevents.yahoo. co m/EverydayWellness/> and discover other people who can help. . <http://geo.yahoo.com/serv?s=97359714/grpId=12744209/grpspId=1706030390/ ms gId=13155/stime=1234192893/nc1=4507179/nc2=3848644/nc3=5349274> __,_._,___
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]