From: Pearson, G. (NIH/NLM/L. [C] <gpe...@ma...> - 2010-07-20 14:53:25
|
Are you proposing to expand the old names such as "req" and "dep"? If so, do you have a tool to do so automatically, to revise all the internal links that would otherwise break? - Glenn ________________________________ From: Dar...@ma... [mailto:Dar...@ma...] Sent: Monday, July 19, 2010 2:19 PM To: di...@li... Cc: 'di...@li...' Subject: Re: [sahana-discuss] [New Wiki] - Guidelines and Standards Quick Guide Hi Glenn, I understand the concern; though I wonder how often anyone making a link manually types it instead of a copy/paste. The use of fully names was intended to reduce confusion for non-Community members, or those just buying in. When looking at pro-grade FOSS wikis there are few abbreviations - I've modelled some of ours after the Wordpress Codex, which I one of the best I've seen: http://codex.wordpress.org/Main_Page (obviously, there's is built with Wordpress, but the idea still stands). Also, I think deployments may have more of an external audience than you think. I know if I were head of a major government organization who was looking at Sahana as a disaster management solution I would want to know where they'd been before, how it went, and what they took the time to learn from it. While it's already been approved, if the Community has strong feelings I'd like to hear them (though lets not spend too much time debating). -Darlene - Darlene McCullough Content Manager; NYC CUNY Sahana Project CUNY School of Professional Studies Dar...@ma... "Pearson, Glenn (NIH/NLM/LHC) [C]" <gpe...@ma...> 07/19/2010 01:32 PM Please respond to di...@li... To "'di...@li...'" <di...@li...> cc Subject Re: [sahana-discuss] [New Wiki] - Guidelines and Standards Quick Guide Darlene - About this standards rule: - Abbreviations must not be used for namespaces. This would imply that "req" would become "requirements", "dep" would become "deployments", etc. Seems like a lot of typing when referencing a link, for something (namespace id) that ideally wouldn't attract much user attention. If this has already been discussed and I just missed it, we don't have to chew it again. - Glenn ________________________________ From: Dar...@ma... [mailto:Dar...@ma...] Sent: Monday, July 19, 2010 11:33 AM To: di...@li... Subject: [sahana-discuss] [New Wiki] - Guidelines and Standards Quick Guide Hi Sahana Community, Below is some additional information about the changes to the wiki. While Thursday's e-mail focused on workflow and who was doing the work; this guide is aimed at practises on the wiki. It's best used by breesing over now and keeping handy for reference when you're entering something on the wiki. Later this week I'll provide some informaiton about structure and our next steps. Thank you, Darlene - Darlene McCullough Content Manager; NYC CUNY Sahana Project CUNY School of Professional Studies Dar...@ma... ---- Wiki Standards & Guidelines Quick Guide For the purposes of our wiki, Standards and Guidelines are not synonymous: * Standards govern the "Home:" namespace and are considered best practices everywhere else. * Guidelines are universal for the entirety of the wiki As they're more immediately applicable for the entire community, I'll cover guidelines first. Guidelines: Structure: * Breadcrumbs will be active to aid navigation. Administrators will maintain structures so that breadcrumbs remain active and relevant. * <Project Name> Wiki Administrators and their associated Boards or Committees will agree on a basic structure at the creation of their namespace. (Meaning PMCs are responsible for creating the structures for their projects.) Talking versus Editing * Articles should be written to express information to be referenced as much as possible. * Discussion in regards to policy, structure, changes, approach, and other topics should be made on the Discussion tab of a topic. Language * Pages should be in English, unless related to a translation project or another project requiring multiple languages. * As a best practice, namespaces will generally be governed by the style rules of wikipedia as they are easily accessible and continue to evolve with our common language: http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style * No vulgar, abusive, or diminutive content will be accepted or tolerated. * All material included on wiki.sahanafoundation.com will be managed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 United States License. All wiki contributions are subject to this copyright. Page Names * Page names will be straightforward and easily referenced. * All page names will be in Title Case; meaning significant words capitalized and properly spaced. * No special characters will be used in the creation of a page name and page names will not be in camel case. * When choosing a page name the most active phrase possible will be used; keeping in mind what a user who was searching for would use as their search terms. Duplication * Duplicate pages should be avoided. Before creating a new page a user will search for any existing pages that could be expanded on before making the new page. * Instructions exist here for reference if duplicates are found: http://wiki.sahanafoundation.org/doku.php/standards:wiki_standards_and_guidelines#duplication1<http://wiki.sahanafoundation.org/doku.php/standards:wiki_standards_and_guidelines> Obsolescence and Depreciation Over the life of the wiki some pages will become obsolete. In these instances the page will be retained for historical reference. A clear label and graphic will be added to the top of the page, before the page content, to denote it as obsolete. A link to the currently relevant and comparable information will be made under this label. Linking Linking is strongly encouraged to help the viability of the wiki. There are two types of links: internal and external. Links should be made "in text" and adequately labeled to describe what they are referencing. When external reference links be given they should also be labeled. Links internal to the wiki, but to another namespace, should use internal wiki links. Standards Standards govern the "Home:" namespace and are best practises for the other spaces in our wiki. They build upon the Guidelines above. Structure: * All pages will have a title matching the name of the wiki link and following the naming conventions detailed in this document. * A Wiki Administrator page will be established and maintained and a link included in the left column of the wiki. The Sahana Wiki Administrators are responsible for updating this page with information on the namespaces in use, the Board or Committee responsible for each namespace, and the Wiki Administrator appointed by those boards, including how to contact them. Anyone making requests in regards to a specific wiki will be referred to the Wiki Administrator page for information on whom to contact. Templates * DokuWiki offers a template structure as part of the program. When there is a regularly used format, or a standard created, a template will be recommended by the SIC and set up by the SWAs. Talking Versus Editing * The discussion page will be used for conversation about the topic of the page as well as talk about what should be included. * Before a major change is made to a page, comments about the change should be made on the Discussion tab. Language * The wiki style will be generally governed by the Wikipedia Manual of Style: http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Namespaces * Namespaces must be one word. Project namespaces are the name of the project * Abbreviations must not be used for namespaces. Page Names * Page names must be written in title case (not camel case). Significant words must be capitalized and properly spaced. * Special characters may not be used, nor will camel case. Duplication Duplication instructions for the "Home:" namespace exist here: http://wiki.sahanafoundation.org/doku.php/standards:wiki_standards_and_guidelines#duplication1<http://wiki.sahanafoundation.org/doku.php/standards:wiki_standards_and_guidelines>------------------------------------------------------------------------------ This SF.net email is sponsored by Sprint What will you do first with EVO, the first 4G phone? Visit sprint.com/first -- http://p.sf.net/sfu/sprint-com-first_______________________________________________ di...@li... https://lists.sourceforge.net/lists/listinfo/sahana-maindev |